-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jul 10, 2023
1 parent
bbbaf7d
commit 92ed403
Showing
2 changed files
with
2 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>DynamicObjects.jl · DynamicObjects</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="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>DynamicObjects</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>DynamicObjects.jl</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>DynamicObjects.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DynamicObjects.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/nsiccha/DynamicObjects.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="DynamicObjects.jl"><a class="docs-heading-anchor" href="#DynamicObjects.jl">DynamicObjects.jl</a><a id="DynamicObjects.jl-1"></a><a class="docs-heading-anchor-permalink" href="#DynamicObjects.jl" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/nsiccha/DynamicObjects.jl">DynamicObjects.jl</a>.</p><article class="docstring"><header><a class="docstring-binding" id="DynamicObjects.DynamicObject" href="#DynamicObjects.DynamicObject"><code>DynamicObjects.DynamicObject</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DynamicObject{T}</code></pre><p>A <code>DynamicObject</code> is a thin named wrapper around a generic NamedTuple which enables function overloading. The type is inefficient computationally, but can enable more efficient prototyping/development.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/nsiccha/DynamicObjects.jl/blob/a5a036bb1265ce1f657e86919d9b4e820ece62e6/src/DynamicObjects.jl#L117-L122">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DynamicObjects.@dynamic_object" href="#DynamicObjects.@dynamic_object"><code>DynamicObjects.@dynamic_object</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@dynamic_object(name, args...)</code></pre><p>Defines a DynamicObject:</p><pre><code class="nohighlight hljs">@dynamic_object Rectangle height width</code></pre><p>defines a dynamic type called <code>Rectangle = DynamicObject{:Rectangle}</code> with defining attributes <code>height</code> and <code>width</code> and defines a constructor</p><pre><code class="nohighlight hljs">Rectangle(height, width; kwargs...) = DynamicObject{:Rectangle}((height=height, width=with, kwargs...))</code></pre><p>This dynamic type can be used in function definitions as </p><pre><code class="nohighlight hljs">area(what::Rectangle) = what.height * what.width</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/nsiccha/DynamicObjects.jl/blob/a5a036bb1265ce1f657e86919d9b4e820ece62e6/src/DynamicObjects.jl#L21-L40">source</a></section></article></article><nav class="docs-footer"><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="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 0.27.25 on <span class="colophon-date" title="Friday 7 July 2023 13:44">Friday 7 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>DynamicObjects.jl · DynamicObjects</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="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>DynamicObjects</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>DynamicObjects.jl</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>DynamicObjects.jl</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>DynamicObjects.jl</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/nsiccha/DynamicObjects.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="DynamicObjects.jl"><a class="docs-heading-anchor" href="#DynamicObjects.jl">DynamicObjects.jl</a><a id="DynamicObjects.jl-1"></a><a class="docs-heading-anchor-permalink" href="#DynamicObjects.jl" title="Permalink"></a></h1><p>Documentation for <a href="https://github.com/nsiccha/DynamicObjects.jl">DynamicObjects.jl</a>.</p><article class="docstring"><header><a class="docstring-binding" id="DynamicObjects.DynamicObject" href="#DynamicObjects.DynamicObject"><code>DynamicObjects.DynamicObject</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">DynamicObject{T}</code></pre><p>A <code>DynamicObject</code> is a thin named wrapper around a generic NamedTuple which enables function overloading. The type is inefficient computationally, but can enable more efficient prototyping/development.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/nsiccha/DynamicObjects.jl/blob/19f9dd1ff2c1856df0a7d6194f2063e2ad94b18f/src/DynamicObjects.jl#L117-L122">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="DynamicObjects.@dynamic_object" href="#DynamicObjects.@dynamic_object"><code>DynamicObjects.@dynamic_object</code></a> — <span class="docstring-category">Macro</span></header><section><div><pre><code class="language-julia hljs">@dynamic_object(name, args...)</code></pre><p>Defines a DynamicObject:</p><pre><code class="nohighlight hljs">@dynamic_object Rectangle height width</code></pre><p>defines a dynamic type called <code>Rectangle = DynamicObject{:Rectangle}</code> with defining attributes <code>height</code> and <code>width</code> and defines a constructor</p><pre><code class="nohighlight hljs">Rectangle(height, width; kwargs...) = DynamicObject{:Rectangle}((height=height, width=with, kwargs...))</code></pre><p>This dynamic type can be used in function definitions as </p><pre><code class="nohighlight hljs">area(what::Rectangle) = what.height * what.width</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/nsiccha/DynamicObjects.jl/blob/19f9dd1ff2c1856df0a7d6194f2063e2ad94b18f/src/DynamicObjects.jl#L21-L40">source</a></section></article></article><nav class="docs-footer"><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="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 0.27.25 on <span class="colophon-date" title="Monday 10 July 2023 05:29">Monday 10 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.