Skip to content

Commit

Permalink
build based on ac02298
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 3, 2024
1 parent 58499dd commit 04bfde2
Show file tree
Hide file tree
Showing 32 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion dev/active-set/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@
end #end of main loop

return stp
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../uncons/">« Unconstrained optimization algorithm</a><a class="docs-footer-nextpage" href="../penalty/">Quadratic penalty algorithm »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../uncons/">« Unconstrained optimization algorithm</a><a class="docs-footer-nextpage" href="../penalty/">Quadratic penalty algorithm »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 dev/api/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/backls/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@
function ParamLS(;back_update :: Float64 = 0.1)
return new(back_update)
end
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fixed-point/">« A fixed point algorithm</a><a class="docs-footer-nextpage" href="../uncons/">Unconstrained optimization algorithm »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fixed-point/">« A fixed point algorithm</a><a class="docs-footer-nextpage" href="../uncons/">Unconstrained optimization algorithm »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 dev/benchmark/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@
finalize(nlp_cutest)
end #end of main loop</code></pre><pre><code class="nohighlight hljs">for name in names
@show stats[name]
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../run-optimsolver/">« Run optimization algorithms</a><a class="docs-footer-nextpage" href="../overfitting/">Overfitting »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../run-optimsolver/">« Run optimization algorithms</a><a class="docs-footer-nextpage" href="../overfitting/">Overfitting »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 dev/buffer/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@

solveIpopt(stop)
#Final status is :IterationLimit
@show stop.current_state.x, status(stop)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../linear-algebra/">« Solve linear algebra</a><a class="docs-footer-nextpage" href="../fixed-point/">A fixed point algorithm »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
@show stop.current_state.x, status(stop)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../linear-algebra/">« Solve linear algebra</a><a class="docs-footer-nextpage" href="../fixed-point/">A fixed point algorithm »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 dev/checkpointing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@
user_check_func! = save_check, max_iter = 99)
# Let&#39;s go
fixed_step_steepest_descent(stp)</code></pre><p>The algorithm has now generated two files <code>checkpoint_stopping_0.jld2</code> and <code>checkpoint_stopping_50.jld2</code> that can be analyzed.</p><pre><code class="nohighlight hljs">stp0 = load(&quot;checkpoint_stopping_0.jld2&quot;)[&quot;stp&quot;]
stp50 = load(&quot;checkpoint_stopping_50.jld2&quot;)[&quot;stp&quot;]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overfitting/">« Overfitting</a><a class="docs-footer-nextpage" href="../gradient-lbfgs/">Mix algorithms »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
stp50 = load(&quot;checkpoint_stopping_50.jld2&quot;)[&quot;stp&quot;]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overfitting/">« Overfitting</a><a class="docs-footer-nextpage" href="../gradient-lbfgs/">Mix algorithms »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 dev/example-basic-Newton/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
end

return stp
end</code></pre><p>This example shows the most basic features of Stopping. It does many checks for you. In this innocent-looking algorithm, the call to <code>update_and_start!</code> and <code>update_and_stop!</code> will verifies unboundedness of <code>x</code>, the time spent in the algorithm, the number of iterations (= number of call to <code>stop!</code>), and the domain of <code>x</code> (in case some of its components become <code>NaN</code> for instance).</p><h3 id="FAQ:-How-can-I-disable-some-checks-done-by-Stopping?"><a class="docs-heading-anchor" href="#FAQ:-How-can-I-disable-some-checks-done-by-Stopping?">FAQ: How can I disable some checks done by Stopping?</a><a id="FAQ:-How-can-I-disable-some-checks-done-by-Stopping?-1"></a><a class="docs-heading-anchor-permalink" href="#FAQ:-How-can-I-disable-some-checks-done-by-Stopping?" title="Permalink"></a></h3><p>The native instances of <code>AbstractStopping</code> available in Stopping.jl all contain an attribute <code>stop_remote</code>. This is a remote control for Stopping&#39;s checks.</p><pre><code class="language-julia hljs">typeof(stp.stop_remote) &lt;: StopRemoteControl #stop_remote is an instance of StopRemoteControl</code></pre><p>This attributes contains boolean values for each check done by Stopping, see</p><pre><code class="language-julia hljs">fieldnames(stp.stop_remote) #get all the attributes of the remote control</code></pre><p>For instance, we can remove the unboundedness and domain check done on <code>x</code> by setting:</p><pre><code class="language-julia hljs">stp.stop_remote = StopRemoteControl(unbounded_and_domain_x_check = false)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../howstopcheckoptimality/">« Optimality in Stopping</a><a class="docs-footer-nextpage" href="../idcard-stopremote/">Stop remote control »</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="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="Thursday 16 May 2024 21:02">Thursday 16 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p>This example shows the most basic features of Stopping. It does many checks for you. In this innocent-looking algorithm, the call to <code>update_and_start!</code> and <code>update_and_stop!</code> will verifies unboundedness of <code>x</code>, the time spent in the algorithm, the number of iterations (= number of call to <code>stop!</code>), and the domain of <code>x</code> (in case some of its components become <code>NaN</code> for instance).</p><h3 id="FAQ:-How-can-I-disable-some-checks-done-by-Stopping?"><a class="docs-heading-anchor" href="#FAQ:-How-can-I-disable-some-checks-done-by-Stopping?">FAQ: How can I disable some checks done by Stopping?</a><a id="FAQ:-How-can-I-disable-some-checks-done-by-Stopping?-1"></a><a class="docs-heading-anchor-permalink" href="#FAQ:-How-can-I-disable-some-checks-done-by-Stopping?" title="Permalink"></a></h3><p>The native instances of <code>AbstractStopping</code> available in Stopping.jl all contain an attribute <code>stop_remote</code>. This is a remote control for Stopping&#39;s checks.</p><pre><code class="language-julia hljs">typeof(stp.stop_remote) &lt;: StopRemoteControl #stop_remote is an instance of StopRemoteControl</code></pre><p>This attributes contains boolean values for each check done by Stopping, see</p><pre><code class="language-julia hljs">fieldnames(stp.stop_remote) #get all the attributes of the remote control</code></pre><p>For instance, we can remove the unboundedness and domain check done on <code>x</code> by setting:</p><pre><code class="language-julia hljs">stp.stop_remote = StopRemoteControl(unbounded_and_domain_x_check = false)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../howstopcheckoptimality/">« Optimality in Stopping</a><a class="docs-footer-nextpage" href="../idcard-stopremote/">Stop remote control »</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="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="Wednesday 3 July 2024 12:10">Wednesday 3 July 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 04bfde2

Please sign in to comment.