Skip to content

Commit

Permalink
build based on caea221
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 22, 2023
1 parent fb8ea84 commit 4d19fcb
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-20T19:58:12","documenter_version":"1.1.2"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2023-11-22T18:29:44","documenter_version":"1.1.2"}}
12 changes: 6 additions & 6 deletions dev/algorithms/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

julia> result.cost

3.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/OperationsResearchModels.jl#L105-L141">source</a></section></article><h2 id="Transportation-Problem"><a class="docs-heading-anchor" href="#Transportation-Problem">Transportation Problem</a><a id="Transportation-Problem-1"></a><a class="docs-heading-anchor-permalink" href="#Transportation-Problem" 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="OperationsResearchModels.solve-Tuple{TransportationProblem}" href="#OperationsResearchModels.solve-Tuple{TransportationProblem}"><code>OperationsResearchModels.solve</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">solve(t)</code></pre><p><strong>Arguments</strong></p><p><code>a::TransportationProblem</code>: The problem in type of TransportationProblem</p><p><strong>Output</strong></p><p><code>TransportationResult</code>: The custom data type that holds problem, solution, and optimum cost. </p><p><strong>Description</strong></p><p>Solves a transportation problem given by an object of in type <code>TransportationProblem</code>.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; t = TransportationProblem(
3.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/OperationsResearchModels.jl#L105-L141">source</a></section></article><h2 id="Transportation-Problem"><a class="docs-heading-anchor" href="#Transportation-Problem">Transportation Problem</a><a id="Transportation-Problem-1"></a><a class="docs-heading-anchor-permalink" href="#Transportation-Problem" 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="OperationsResearchModels.solve-Tuple{TransportationProblem}" href="#OperationsResearchModels.solve-Tuple{TransportationProblem}"><code>OperationsResearchModels.solve</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">solve(t)</code></pre><p><strong>Arguments</strong></p><p><code>a::TransportationProblem</code>: The problem in type of TransportationProblem</p><p><strong>Output</strong></p><p><code>TransportationResult</code>: The custom data type that holds problem, solution, and optimum cost. </p><p><strong>Description</strong></p><p>Solves a transportation problem given by an object of in type <code>TransportationProblem</code>.</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; t = TransportationProblem(
[ 1 1 1 1;
2 2 2 2;
3 3 3 3],
Expand Down Expand Up @@ -49,7 +49,7 @@
Cost:
600.0
Solution:
[-0.0 -0.0 -0.0 100.0; 100.0 -0.0 -0.0 -0.0; -0.0 -0.0 100.0 -0.0; -0.0 100.0 -0.0 -0.0]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/OperationsResearchModels.jl#L53-L101">source</a></section></article><h2 id="Shortest-Path-and-Maximum-Flow"><a class="docs-heading-anchor" href="#Shortest-Path-and-Maximum-Flow">Shortest Path and Maximum Flow</a><a id="Shortest-Path-and-Maximum-Flow-1"></a><a class="docs-heading-anchor-permalink" href="#Shortest-Path-and-Maximum-Flow" title="Permalink"></a></h2><pre><code class="nohighlight hljs">solve(c::Vector{Connection}; problem::Union{::ShortestPathProblem, ::MaximumFlowProblem} = ShortestPathProblem)</code></pre><h3 id="Arguments"><a class="docs-heading-anchor" href="#Arguments">Arguments</a><a id="Arguments-1"></a><a class="docs-heading-anchor-permalink" href="#Arguments" title="Permalink"></a></h3><ul><li><code>c::Vector{Connection}</code>: Vector of connections </li><li><code>problem</code>: Type of problem. Either <code>ShortestPathProblem</code> or <code>MaximumFlowProblem</code></li></ul><h3 id="Example"><a class="docs-heading-anchor" href="#Example">Example</a><a id="Example-1"></a><a class="docs-heading-anchor-permalink" href="#Example" title="Permalink"></a></h3><pre><code class="language-julia hljs">julia&gt; conns = [
[-0.0 -0.0 -0.0 100.0; 100.0 -0.0 -0.0 -0.0; -0.0 -0.0 100.0 -0.0; -0.0 100.0 -0.0 -0.0]</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/OperationsResearchModels.jl#L53-L101">source</a></section></article><h2 id="Shortest-Path-and-Maximum-Flow"><a class="docs-heading-anchor" href="#Shortest-Path-and-Maximum-Flow">Shortest Path and Maximum Flow</a><a id="Shortest-Path-and-Maximum-Flow-1"></a><a class="docs-heading-anchor-permalink" href="#Shortest-Path-and-Maximum-Flow" title="Permalink"></a></h2><pre><code class="nohighlight hljs">solve(c::Vector{Connection}; problem::Union{::ShortestPathProblem, ::MaximumFlowProblem} = ShortestPathProblem)</code></pre><h3 id="Arguments"><a class="docs-heading-anchor" href="#Arguments">Arguments</a><a id="Arguments-1"></a><a class="docs-heading-anchor-permalink" href="#Arguments" title="Permalink"></a></h3><ul><li><code>c::Vector{Connection}</code>: Vector of connections </li><li><code>problem</code>: Type of problem. Either <code>ShortestPathProblem</code> or <code>MaximumFlowProblem</code></li></ul><h3 id="Example"><a class="docs-heading-anchor" href="#Example">Example</a><a id="Example-1"></a><a class="docs-heading-anchor-permalink" href="#Example" title="Permalink"></a></h3><pre><code class="language-julia hljs">julia&gt; conns = [
Connection(1, 2, 3),
Connection(1, 3, 2),
Connection(1, 4, 4),
Expand Down Expand Up @@ -101,7 +101,7 @@
&quot;model&quot; =&gt; A JuMP Model…
&quot;objective&quot; =&gt; 10.5921
&quot;z&quot; =&gt; [-0.0 -0.0 … 0.0 0.0; -0.0 -0.0 … 0.0 0.0; … ; 0.0 0.0 … -0.0 0.0; 0.0 0.0 … 0.0 -0.0]
&quot;y&quot; =&gt; [0.0, -0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, -0.0, 0.0 … 0.0, 0.0, 0.0, -0.0, 1.0, 0.0, -0.0,…</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/pmedian.jl#L13-L48">source</a></section></article><h2 id="Minimum-Spanning-Tree"><a class="docs-heading-anchor" href="#Minimum-Spanning-Tree">Minimum Spanning Tree</a><a id="Minimum-Spanning-Tree-1"></a><a class="docs-heading-anchor-permalink" href="#Minimum-Spanning-Tree" 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="OperationsResearchModels.MinimumSpanningTree.mst" href="#OperationsResearchModels.MinimumSpanningTree.mst"><code>OperationsResearchModels.MinimumSpanningTree.mst</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">mst(connections)</code></pre><p><strong>Arguments</strong></p><ul><li><code>connections::Vector{Connection}</code>: Vector of Connections </li></ul><p><strong>Description</strong></p><p>Obtains the minimum spanning tree. </p><p><strong>Output</strong></p><ul><li><code>::MstResult</code>: A MstResult object that holds the results. </li></ul><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; conns = Connection[
&quot;y&quot; =&gt; [0.0, -0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, -0.0, 0.0 … 0.0, 0.0, 0.0, -0.0, 1.0, 0.0, -0.0,…</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/pmedian.jl#L13-L48">source</a></section></article><h2 id="Minimum-Spanning-Tree"><a class="docs-heading-anchor" href="#Minimum-Spanning-Tree">Minimum Spanning Tree</a><a id="Minimum-Spanning-Tree-1"></a><a class="docs-heading-anchor-permalink" href="#Minimum-Spanning-Tree" 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="OperationsResearchModels.MinimumSpanningTree.mst" href="#OperationsResearchModels.MinimumSpanningTree.mst"><code>OperationsResearchModels.MinimumSpanningTree.mst</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">mst(connections)</code></pre><p><strong>Arguments</strong></p><ul><li><code>connections::Vector{Connection}</code>: Vector of Connections </li></ul><p><strong>Description</strong></p><p>Obtains the minimum spanning tree. </p><p><strong>Output</strong></p><ul><li><code>::MstResult</code>: A MstResult object that holds the results. </li></ul><p><strong>Examples</strong></p><pre><code class="language-julia hljs">julia&gt; conns = Connection[
Connection(1, 2, 10),
Connection(2, 3, 10),
Connection(3, 4, 10),
Expand All @@ -124,7 +124,7 @@
3-element Vector{Connection}:
Connection(3, 4, 10, &quot;x34&quot;)
Connection(1, 4, 10, &quot;x14&quot;)
Connection(2, 3, 10, &quot;x23&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/mst.jl#L77-L118">source</a></section></article><h2 id="CPM-(Critical-Path-Method)"><a class="docs-heading-anchor" href="#CPM-(Critical-Path-Method)">CPM (Critical Path Method)</a><a id="CPM-(Critical-Path-Method)-1"></a><a class="docs-heading-anchor-permalink" href="#CPM-(Critical-Path-Method)" 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="OperationsResearchModels.CPM.cpm" href="#OperationsResearchModels.CPM.cpm"><code>OperationsResearchModels.CPM.cpm</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cpm(activities)</code></pre><p><strong>Arguments</strong></p><ul><li><code>activities::Vector{CpmActivity}</code></li></ul><p><strong>Output</strong></p><ul><li><code>::CpmResult</code>: The object holds the results </li></ul><p><strong>Description</strong></p><p>Calculates CPM (Critical Path Method) and reports the critical path for a given set of activities. </p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; A = CpmActivity(&quot;A&quot;, 2);
Connection(2, 3, 10, &quot;x23&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/mst.jl#L77-L118">source</a></section></article><h2 id="CPM-(Critical-Path-Method)"><a class="docs-heading-anchor" href="#CPM-(Critical-Path-Method)">CPM (Critical Path Method)</a><a id="CPM-(Critical-Path-Method)-1"></a><a class="docs-heading-anchor-permalink" href="#CPM-(Critical-Path-Method)" 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="OperationsResearchModels.CPM.cpm" href="#OperationsResearchModels.CPM.cpm"><code>OperationsResearchModels.CPM.cpm</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">cpm(activities)</code></pre><p><strong>Arguments</strong></p><ul><li><code>activities::Vector{CpmActivity}</code></li></ul><p><strong>Output</strong></p><ul><li><code>::CpmResult</code>: The object holds the results </li></ul><p><strong>Description</strong></p><p>Calculates CPM (Critical Path Method) and reports the critical path for a given set of activities. </p><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; A = CpmActivity(&quot;A&quot;, 2);
julia&gt; B = CpmActivity(&quot;B&quot;, 3);
julia&gt; C = CpmActivity(&quot;C&quot;, 2, [A]);
julia&gt; D = CpmActivity(&quot;D&quot;, 3, [B]);
Expand All @@ -147,7 +147,7 @@
&quot;I&quot;

julia&gt; result.path == [B, E, G, I]
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/cpm.jl#L88-L127">source</a></section></article><h2 id="PERT-(Project-Evalutation-and-Review-Technique)"><a class="docs-heading-anchor" href="#PERT-(Project-Evalutation-and-Review-Technique)">PERT (Project Evalutation and Review Technique)</a><a id="PERT-(Project-Evalutation-and-Review-Technique)-1"></a><a class="docs-heading-anchor-permalink" href="#PERT-(Project-Evalutation-and-Review-Technique)" 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="OperationsResearchModels.CPM.pert" href="#OperationsResearchModels.CPM.pert"><code>OperationsResearchModels.CPM.pert</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">pert(activities)</code></pre><p><strong>Arguments</strong></p><ul><li><code>activities::Vector{PertActivity}</code>: Vector of Pert Activities. </li></ul><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; A = PertActivity(&quot;A&quot;, 1, 2, 3)
true</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/cpm.jl#L88-L127">source</a></section></article><h2 id="PERT-(Project-Evalutation-and-Review-Technique)"><a class="docs-heading-anchor" href="#PERT-(Project-Evalutation-and-Review-Technique)">PERT (Project Evalutation and Review Technique)</a><a id="PERT-(Project-Evalutation-and-Review-Technique)-1"></a><a class="docs-heading-anchor-permalink" href="#PERT-(Project-Evalutation-and-Review-Technique)" 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="OperationsResearchModels.CPM.pert" href="#OperationsResearchModels.CPM.pert"><code>OperationsResearchModels.CPM.pert</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">pert(activities)</code></pre><p><strong>Arguments</strong></p><ul><li><code>activities::Vector{PertActivity}</code>: Vector of Pert Activities. </li></ul><p><strong>Example</strong></p><pre><code class="language-julia hljs">julia&gt; A = PertActivity(&quot;A&quot;, 1, 2, 3)
PertActivity(&quot;A&quot;, 1.0, 2.0, 3.0, PertActivity[])

julia&gt; B = PertActivity(&quot;B&quot;, 3, 3, 3)
Expand All @@ -169,4 +169,4 @@
8.0

julia&gt; result.stddev
0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/f0ccdf128c3422edba19750904c225d1e5c80b1b/src/cpm.jl#L177-L209">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Monday 20 November 2023 19:58">Monday 20 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
0.0</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jbytecode/OperationsResearchModels.jl/blob/caea22192cda556749bef6d00802aa6e6d42a5fb/src/cpm.jl#L177-L209">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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Wednesday 22 November 2023 18:29">Wednesday 22 November 2023</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4d19fcb

Please sign in to comment.