build based on 0cc66aa

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-01T13:32:18","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-01T13:33:07","documenter_version":"1.7.0"}}

dev/DrawingGraphs/index.html

@@ -38,4 +38,4 @@
 toDotFile(dfg, "/tmp/test.dot")
 # Open with xdot
 # run(`xdot /tmp/test.dot`)
-# nothing # hide</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../GraphData/">« Using Graph Elements</a><a class="docs-footer-nextpage" href="../ref_api/">Quick 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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 1 November 2024 13:32">Friday 1 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+# nothing # hide</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../GraphData/">« Using Graph Elements</a><a class="docs-footer-nextpage" href="../ref_api/">Quick 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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 1 November 2024 13:33">Friday 1 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/GraphData/index.html

@@ -28,4 +28,4 @@
 # Delete it
 deleteVariableSolverData!(dfg, :x0, :parametric)</code></pre><h4 id="Small-Data"><a class="docs-heading-anchor" href="#Small-Data">Small Data</a><a id="Small-Data-1"></a><a class="docs-heading-anchor-permalink" href="#Small-Data" title="Permalink"></a></h4><p>Small data allows you to assign a dictionary to variables. It is a useful way to keep small amounts of string data in a variable. As it is stored in the graph itself, large entries will slow the graph down, so if data should exceed a few bytes/kb, it should rather be saved in bigData.</p><ul><li><a href="../services_ref/#DistributedFactorGraphs.getSmallData-Tuple{AbstractDFG, Symbol, Symbol}"><code>getSmallData</code></a></li><li><a href="../services_ref/#DistributedFactorGraphs.setSmallData!-Tuple{DFGVariable, Dict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}}"><code>setSmallData!</code></a></li></ul><p>Example:</p><pre><code class="language-julia hljs">setSmallData!(x0, Dict(&quot;entry&quot;=&gt;&quot;entry value&quot;))
 getSmallData(x0)</code></pre><h4 id="Big-Data"><a class="docs-heading-anchor" href="#Big-Data">Big Data</a><a id="Big-Data-1"></a><a class="docs-heading-anchor-permalink" href="#Big-Data" title="Permalink"></a></h4><h3 id="Factors"><a class="docs-heading-anchor" href="#Factors">Factors</a><a id="Factors-1"></a><a class="docs-heading-anchor-permalink" href="#Factors" title="Permalink"></a></h3><h2 id="Graph-Related-Data"><a class="docs-heading-anchor" href="#Graph-Related-Data">Graph-Related Data</a><a id="Graph-Related-Data-1"></a><a class="docs-heading-anchor-permalink" href="#Graph-Related-Data" title="Permalink"></a></h2><p>DFG can store data in the graph itself (as opposed to inside graph elements). When you retrieve distributed factor graphs from a database, this information is carried along. If you are working with an in-memory graph, the DFG structure contains the graph itself as well as <code>Agent</code> and <code>Graph</code> data.</p><p>Graphs reside inside a hierarchy made up in the following way:</p><ul><li>Agent<ul><li>Metadata</li><li>BlobEntries</li></ul></li><li>Graph<ul><li>Metadata</li><li>BlobEntries</li></ul></li></ul><p>This data can be retrieved with the follow functions:</p><ul><li><a href="../services_ref/#DistributedFactorGraphs.getAgentMetadata-Tuple{AbstractDFG}"><code>getAgentMetadata</code></a></li><li><a href="../services_ref/#DistributedFactorGraphs.getGraphMetadata-Tuple{AbstractDFG}"><code>getGraphMetadata</code></a></li></ul><p>It can be set using the following functions:</p><ul><li><a href="../services_ref/#DistributedFactorGraphs.setAgentMetadata!-Tuple{AbstractDFG, Dict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}}"><code>setAgentMetadata!</code></a></li><li><a href="../services_ref/#DistributedFactorGraphs.setGraphMetadata!-Tuple{AbstractDFG, Dict{Symbol, Union{Bool, Float64, Int64, Vector{Bool}, Vector{Float64}, Vector{Int64}, Vector{String}, String}}}"><code>setGraphMetadata!</code></a></li></ul><p>Example of using graph-level data:</p><pre><code class="language-julia hljs">setAgentMetadata!(dfg, Dict(:a =&gt; &quot;Hello&quot;))
-getAgentMetadata(dfg)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../BuildingGraphs/">« Building Graphs</a><a class="docs-footer-nextpage" href="../DrawingGraphs/">Drawing Graphs »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 1 November 2024 13:32">Friday 1 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+getAgentMetadata(dfg)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../BuildingGraphs/">« Building Graphs</a><a class="docs-footer-nextpage" href="../DrawingGraphs/">Drawing Graphs »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 1 November 2024 13:33">Friday 1 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>