Skip to content

Commit

Permalink
build based on 4ed20a6
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 9, 2024
1 parent 9742a4b commit 27529fa
Show file tree
Hide file tree
Showing 253 changed files with 34,183 additions and 34,163 deletions.
2 changes: 1 addition & 1 deletion previews/PR3803/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-09T04:50:58","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-09T05:06:13","documenter_version":"1.4.1"}}
Binary file modified previews/PR3803/JuMP.pdf
Binary file not shown.
30 changes: 15 additions & 15 deletions previews/PR3803/api/JuMP.Containers/index.html

Large diffs are not rendered by default.

556 changes: 278 additions & 278 deletions previews/PR3803/api/JuMP/index.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,4 @@
julia> highs_knapsack([1.0, 2.0], [0.5, 0.5], 1.25)
2-element Vector{Float64}:
0.0
2.0</code></pre><p>We&#39;ve now gone from a algebraic model that looked identical to the mathematical model we started with, to a verbose function that uses HiGHS-specific functionality.</p><p>The difference between <code>algebraic_knapsack</code> and <code>highs_knapsack</code> highlights the benefit that algebraic modeling languages provide to users. Moreover, if we used a different solver, the solver-specific function would be entirely different. A key benefit of an algebraic modeling language is that you can change the solver without needing to rewrite the model.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/JuMP.Containers/">« JuMP.Containers</a><a class="docs-footer-nextpage" href="../bibliography/">Bibliography »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2.0</code></pre><p>We&#39;ve now gone from a algebraic model that looked identical to the mathematical model we started with, to a verbose function that uses HiGHS-specific functionality.</p><p>The difference between <code>algebraic_knapsack</code> and <code>highs_knapsack</code> highlights the benefit that algebraic modeling languages provide to users. Moreover, if we used a different solver, the solver-specific function would be entirely different. A key benefit of an algebraic modeling language is that you can change the solver without needing to rewrite the model.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/JuMP.Containers/">« JuMP.Containers</a><a class="docs-footer-nextpage" href="../bibliography/">Bibliography »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:06">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR3803/background/bibliography/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR3803/changelog/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR3803/developers/checklists/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@

## Optional

- [ ] Add package metadata to `docs/packages.toml`</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../roadmap/">« Roadmap</a><a class="docs-footer-nextpage" href="../../packages/solvers/">Introduction »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
- [ ] Add package metadata to `docs/packages.toml`</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../roadmap/">« Roadmap</a><a class="docs-footer-nextpage" href="../../packages/solvers/">Introduction »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:06">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR3803/developers/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@

$ git checkout master

$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request. It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../background/bibliography/">« Bibliography</a><a class="docs-footer-nextpage" href="../extensions/">Extensions »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
$ git pull</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>If you have suggestions to improve this guide, please make a pull request. It&#39;s particularly helpful if you do this after your first pull request because you&#39;ll know all the parts that could be explained better.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../background/bibliography/">« Bibliography</a><a class="docs-footer-nextpage" href="../extensions/">Extensions »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:06">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@
libCbc_path = &quot;/usr/local/Cellar/cbc/2.10.5/lib/libCbc.3.10.5&quot;
libOsiCbc_path = &quot;/usr/local/Cellar/cbc/2.10.5/lib/libOsiCbc.3.10.5&quot;
libcbcsolver_path = &quot;/usr/local/Cellar/cbc/2.10.5/lib/libCbcSolver.3.10.5&quot;</code></pre><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>Note that capitalization matters, so <code>libcbcsolver_path</code> corresponds to <code>libCbcSolver.3.10.5</code>.</p></div></div><h3 id="Override-entire-artifact"><a class="docs-heading-anchor" href="#Override-entire-artifact">Override entire artifact</a><a id="Override-entire-artifact-1"></a><a class="docs-heading-anchor-permalink" href="#Override-entire-artifact" title="Permalink"></a></h3><p>To use the homebrew install as our custom binary we add the following to <code>~/.julia/artifacts/Overrides.toml</code>:</p><pre><code class="language-julia hljs"># Override for Cbc_jll
e481bc81db5e229ba1f52b2b4bd57484204b1b06 = &quot;/usr/local/Cellar/cbc/2.10.5&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../extensions/">« Extensions</a><a class="docs-footer-nextpage" href="../style/">Style Guide »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
e481bc81db5e229ba1f52b2b4bd57484204b1b06 = &quot;/usr/local/Cellar/cbc/2.10.5&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../extensions/">« Extensions</a><a class="docs-footer-nextpage" href="../style/">Style Guide »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:06">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR3803/developers/extensions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,4 +305,4 @@
_function_barrier(names, model, F, S)
end
return names
end</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>It is important to explicitly type the <code>F</code> and <code>S</code> arguments. If you leave them untyped, for example, <code>function _function_barrier(names, model, F, S)</code>, Julia will not specialize the function calls and performance will not be improved.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../custom_solver_binaries/">Custom binaries »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>It is important to explicitly type the <code>F</code> and <code>S</code> arguments. If you leave them untyped, for example, <code>function _function_barrier(names, model, F, S)</code>, Julia will not specialize the function calls and performance will not be improved.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../custom_solver_binaries/">Custom binaries »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:06">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion previews/PR3803/developers/roadmap/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR3803/developers/style/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,4 @@

end # module TestPkg

TestPkg.runtests()</code></pre><p>Break the tests into multiple files, with one module per file, so that subsets of the codebase can be tested by calling <code>include</code> with the relevant file.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_solver_binaries/">« Custom binaries</a><a class="docs-footer-nextpage" href="../roadmap/">Roadmap »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 04:50">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
TestPkg.runtests()</code></pre><p>Break the tests into multiple files, with one module per file, so that subsets of the codebase can be tested by calling <code>include</code> with the relevant file.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../custom_solver_binaries/">« Custom binaries</a><a class="docs-footer-nextpage" href="../roadmap/">Roadmap »</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.4.1 on <span class="colophon-date" title="Friday 9 August 2024 05:05">Friday 9 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 27529fa

Please sign in to comment.