Skip to content

Commit

Permalink
deploy: 80204ef
Browse files Browse the repository at this point in the history
  • Loading branch information
gbin committed Jan 10, 2025
1 parent ddf2abb commit 3a01b3e
Show file tree
Hide file tree
Showing 56 changed files with 88 additions and 88 deletions.
2 changes: 1 addition & 1 deletion cu29/config/struct.Cnx.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pub store: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;,
<span class="comment">/* private fields */</span>
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This represents a connection between 2 tasks (nodes) in the configuration graph.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.msg" class="structfield section-header"><a href="#structfield.msg" class="anchor field">§</a><code>msg: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>Message type exchanged betwee src and dst.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.msg" class="structfield section-header"><a href="#structfield.msg" class="anchor field">§</a><code>msg: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><div class="docblock"><p>Message type exchanged between src and dst.</p>
</div><span id="structfield.batch" class="structfield section-header"><a href="#structfield.batch" class="anchor field">§</a><code>batch: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;</code></span><div class="docblock"><p>Tells Copper to batch messages before sending the buffer to the next node.
If None, Copper will just send 1 message at a time.
If Some(n), Copper will batch n messages before sending the buffer.</p>
Expand Down
2 changes: 1 addition & 1 deletion cu29/config/struct.CuConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
pub logging: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../prelude/struct.LoggingConfig.html" title="struct cu29::prelude::LoggingConfig">LoggingConfig</a>&gt;,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>CuConfig is the programmatic representation of the configuration graph.
It is a directed graph where nodes are tasks and edges are connections between tasks.</p>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.graph" class="structfield section-header"><a href="#structfield.graph" class="anchor field">§</a><code>graph: <a class="struct" href="https://docs.rs/petgraph/0.4/petgraph/graph_impl/stable_graph/struct.StableGraph.html" title="struct petgraph::graph_impl::stable_graph::StableGraph">StableGraph</a>&lt;<a class="struct" href="../prelude/struct.Node.html" title="struct cu29::prelude::Node">Node</a>, <a class="struct" href="../prelude/struct.Cnx.html" title="struct cu29::prelude::Cnx">Cnx</a>&gt;</code></span><span id="structfield.monitor" class="structfield section-header"><a href="#structfield.monitor" class="anchor field">§</a><code>monitor: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../prelude/struct.MonitorConfig.html" title="struct cu29::prelude::MonitorConfig">MonitorConfig</a>&gt;</code></span><span id="structfield.logging" class="structfield section-header"><a href="#structfield.logging" class="anchor field">§</a><code>logging: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../prelude/struct.LoggingConfig.html" title="struct cu29::prelude::LoggingConfig">LoggingConfig</a>&gt;</code></span><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-CuConfig" class="impl"><a class="src rightside" href="../../src/cu29_runtime/config.rs.html#415">Source</a><a href="#impl-CuConfig" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="../prelude/struct.CuConfig.html" title="struct cu29::prelude::CuConfig">CuConfig</a></h3><div class="docblock"><p>The implementation has a lot of conveinence methods to manipulate
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.graph" class="structfield section-header"><a href="#structfield.graph" class="anchor field">§</a><code>graph: <a class="struct" href="https://docs.rs/petgraph/0.4/petgraph/graph_impl/stable_graph/struct.StableGraph.html" title="struct petgraph::graph_impl::stable_graph::StableGraph">StableGraph</a>&lt;<a class="struct" href="../prelude/struct.Node.html" title="struct cu29::prelude::Node">Node</a>, <a class="struct" href="../prelude/struct.Cnx.html" title="struct cu29::prelude::Cnx">Cnx</a>&gt;</code></span><span id="structfield.monitor" class="structfield section-header"><a href="#structfield.monitor" class="anchor field">§</a><code>monitor: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../prelude/struct.MonitorConfig.html" title="struct cu29::prelude::MonitorConfig">MonitorConfig</a>&gt;</code></span><span id="structfield.logging" class="structfield section-header"><a href="#structfield.logging" class="anchor field">§</a><code>logging: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../prelude/struct.LoggingConfig.html" title="struct cu29::prelude::LoggingConfig">LoggingConfig</a>&gt;</code></span><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-CuConfig" class="impl"><a class="src rightside" href="../../src/cu29_runtime/config.rs.html#415">Source</a><a href="#impl-CuConfig" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="../prelude/struct.CuConfig.html" title="struct cu29::prelude::CuConfig">CuConfig</a></h3><div class="docblock"><p>The implementation has a lot of convenience methods to manipulate
the configuration to give some flexibility into programmatically creating the configuration.</p>
</div></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.add_node" class="method"><a class="src rightside" href="../../src/cu29_runtime/config.rs.html#417">Source</a><h4 class="code-header">pub fn <a href="#method.add_node" class="fn">add_node</a>(&amp;mut self, node: <a class="struct" href="../prelude/struct.Node.html" title="struct cu29::prelude::Node">Node</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Add a new node to the configuration graph.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_node" class="method"><a class="src rightside" href="../../src/cu29_runtime/config.rs.html#423">Source</a><h4 class="code-header">pub fn <a href="#method.get_node" class="fn">get_node</a>(&amp;self, node_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="../prelude/struct.Node.html" title="struct cu29::prelude::Node">Node</a>&gt;</h4></section></summary><div class="docblock"><p>Get the node with the given id.</p>
Expand Down
4 changes: 2 additions & 2 deletions cu29/curuntime/fn.compute_runtime_plan.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This is the main heuristics to compute an execution plan at compilation time. TODO: Make that heuristic plugable."><title>compute_runtime_plan in cu29::curuntime - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cu29" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (824759493 2025-01-09)" data-channel="nightly" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../cu29/index.html">cu29</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cu29::<wbr>curuntime</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">cu29</a>::<wbr><a href="index.html">curuntime</a></span><h1>Function <span class="fn">compute_runtime_plan</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/cu29_runtime/curuntime.rs.html#360">Source</a> </span></div><pre class="rust item-decl"><code>pub fn compute_runtime_plan(
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This is the main heuristics to compute an execution plan at compilation time. TODO: Make that heuristic pluggable."><title>compute_runtime_plan in cu29::curuntime - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cu29" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (824759493 2025-01-09)" data-channel="nightly" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../cu29/index.html">cu29</a><span class="version">0.5.2</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In cu29::<wbr>curuntime</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">cu29</a>::<wbr><a href="index.html">curuntime</a></span><h1>Function <span class="fn">compute_runtime_plan</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/cu29_runtime/curuntime.rs.html#360">Source</a> </span></div><pre class="rust item-decl"><code>pub fn compute_runtime_plan(
config: &amp;<a class="struct" href="../prelude/struct.CuConfig.html" title="struct cu29::prelude::CuConfig">CuConfig</a>,
) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../prelude/struct.CuExecutionLoop.html" title="struct cu29::prelude::CuExecutionLoop">CuExecutionLoop</a>, <a class="struct" href="../struct.CuError.html" title="struct cu29::CuError">CuError</a>&gt;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This is the main heuristics to compute an execution plan at compilation time.
TODO: Make that heuristic plugable.</p>
TODO: Make that heuristic pluggable.</p>
</div></details></section></div></main></body></html>
2 changes: 1 addition & 1 deletion cu29/curuntime/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
if loop_count is None, the loop is infinite.</div></li><li><div class="item-name"><a class="struct" href="struct.CuExecutionStep.html" title="struct cu29::curuntime::CuExecutionStep">CuExecution<wbr>Step</a></div><div class="desc docblock-short">This structure represents a step in the execution plan.</div></li><li><div class="item-name"><a class="struct" href="struct.CuRuntime.html" title="struct cu29::curuntime::CuRuntime">CuRuntime</a></div><div class="desc docblock-short">This is the main structure that will be injected as a member of the Application struct.
CT is the tuple of all the tasks in order of execution.
CL is the type of the copper list, representing the input/output messages for all the tasks.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.CuExecutionUnit.html" title="enum cu29::curuntime::CuExecutionUnit">CuExecution<wbr>Unit</a></div><div class="desc docblock-short">This structure represents a step in the execution plan.</div></li><li><div class="item-name"><a class="enum" href="enum.CuTaskType.html" title="enum cu29::curuntime::CuTaskType">CuTask<wbr>Type</a></div><div class="desc docblock-short">Copper tasks can be of 3 types:</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.compute_runtime_plan.html" title="fn cu29::curuntime::compute_runtime_plan">compute_<wbr>runtime_<wbr>plan</a></div><div class="desc docblock-short">This is the main heuristics to compute an execution plan at compilation time.
TODO: Make that heuristic plugable.</div></li><li><div class="item-name"><a class="fn" href="fn.find_task_type_for_id.html" title="fn cu29::curuntime::find_task_type_for_id">find_<wbr>task_<wbr>type_<wbr>for_<wbr>id</a></div></li></ul></section></div></main></body></html>
TODO: Make that heuristic pluggable.</div></li><li><div class="item-name"><a class="fn" href="fn.find_task_type_for_id.html" title="fn cu29::curuntime::find_task_type_for_id">find_<wbr>task_<wbr>type_<wbr>for_<wbr>id</a></div></li></ul></section></div></main></body></html>
Loading

0 comments on commit 3a01b3e

Please sign in to comment.