Skip to content

Commit

Permalink
build based on d171886
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 7, 2024
1 parent 1445feb commit 1a97ee6
Show file tree
Hide file tree
Showing 16 changed files with 1,251 additions and 0 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2024-04-07T13:19:41","documenter_version":"1.3.0"}}
2 changes: 2 additions & 0 deletions dev/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Public API Reference · CompositeTypes.jl</title><meta name="title" content="Public API Reference · CompositeTypes.jl"/><meta property="og:title" content="Public API Reference · CompositeTypes.jl"/><meta property="twitter:title" content="Public API Reference · CompositeTypes.jl"/><meta name="description" content="Documentation for CompositeTypes.jl."/><meta property="og:description" content="Documentation for CompositeTypes.jl."/><meta property="twitter:description" content="Documentation for CompositeTypes.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">CompositeTypes.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">API</span><ul><li class="is-active"><a class="tocitem" href>Public API Reference</a><ul class="internal"><li><a class="tocitem" href="#Constants"><span>Constants</span></a></li><li><a class="tocitem" href="#Functions"><span>Functions</span></a></li><li><a class="tocitem" href="#Types"><span>Types</span></a></li></ul></li><li><a class="tocitem" href="../internal/">Internal API Reference</a></li></ul></li><li><a class="tocitem" href="../indexing/">Indexing submodule</a></li><li><a class="tocitem" href="../display/">Display submodule</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API</a></li><li class="is-active"><a href>Public API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Public API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaApproximation/CompositeTypes.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/main/docs/src/api.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Public-API-Reference"><a class="docs-heading-anchor" href="#Public-API-Reference">Public API Reference</a><a id="Public-API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Public-API-Reference" title="Permalink"></a></h1><p>This is an exhaustive list of all exported constants, types and functions in <code>CompositeTypes.jl</code>.</p><h2 id="Constants"><a class="docs-heading-anchor" href="#Constants">Constants</a><a id="Constants-1"></a><a class="docs-heading-anchor-permalink" href="#Constants" title="Permalink"></a></h2><h2 id="Functions"><a class="docs-heading-anchor" href="#Functions">Functions</a><a id="Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Functions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CompositeTypes.component-Tuple{Any, Vararg{Any, N} where N}" href="#CompositeTypes.component-Tuple{Any, Vararg{Any, N} where N}"><code>CompositeTypes.component</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">component(x, I...)</code></pre><p>The component of <code>x</code> that corresponds to the given index.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/d171886edc69dfd07fff6dc54f3a26a14f164712/src/CompositeTypes.jl#L34-L38">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CompositeTypes.components-Tuple{Any}" href="#CompositeTypes.components-Tuple{Any}"><code>CompositeTypes.components</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">components(x)</code></pre><p>The components of the composite object <code>x</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/d171886edc69dfd07fff6dc54f3a26a14f164712/src/CompositeTypes.jl#L20-L24">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CompositeTypes.iscomposite-Tuple{Any}" href="#CompositeTypes.iscomposite-Tuple{Any}"><code>CompositeTypes.iscomposite</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">iscomposite(x)</code></pre><p>Is <code>x</code> a composite object?</p><p>If an object is composite, then its components can be queried using the <code>components</code> function.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/d171886edc69dfd07fff6dc54f3a26a14f164712/src/CompositeTypes.jl#L10-L17">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CompositeTypes.ncomponents-Tuple{Any}" href="#CompositeTypes.ncomponents-Tuple{Any}"><code>CompositeTypes.ncomponents</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">ncomponents(x)</code></pre><p>The number of components of composite object <code>x</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/d171886edc69dfd07fff6dc54f3a26a14f164712/src/CompositeTypes.jl#L27-L31">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CompositeTypes.setcomponent!-Tuple{Any, Any, Vararg{Any, N} where N}" href="#CompositeTypes.setcomponent!-Tuple{Any, Any, Vararg{Any, N} where N}"><code>CompositeTypes.setcomponent!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">setcomponent!(x, v, I...)</code></pre><p>Set the component of <code>x</code> that corresponds to the given index to <code>v</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaApproximation/CompositeTypes.jl/blob/d171886edc69dfd07fff6dc54f3a26a14f164712/src/CompositeTypes.jl#L41-L45">source</a></section></article><h2 id="Types"><a class="docs-heading-anchor" href="#Types">Types</a><a id="Types-1"></a><a class="docs-heading-anchor-permalink" href="#Types" title="Permalink"></a></h2></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../internal/">Internal API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Sunday 7 April 2024 13:19">Sunday 7 April 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 1a97ee6

Please sign in to comment.