Skip to content

Commit

Permalink
build based on 1687a4b
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 24, 2023
1 parent b54e89d commit ba009d6
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@

Number of iterations = 3
Number of function evaluations = 3
</code></pre><p>The <code>spgbox!</code> function mutates the content of the input <code>x</code> vector (and will not allocate anything if the auxiliary vectors are provide d as described <a href="https://m3g.github.io/SPGBox.jl/stable/options/#Memory-preallocation">here</a>). Use <code>spgbox</code>, to internaly copy the <code>x</code> array and not mutate it. </p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">User 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="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="Monday 24 July 2023 10:32">Monday 24 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><p>The <code>spgbox!</code> function mutates the content of the input <code>x</code> vector (and will not allocate anything if the auxiliary vectors are provide d as described <a href="https://m3g.github.io/SPGBox.jl/stable/options/#Memory-preallocation">here</a>). Use <code>spgbox</code>, to internaly copy the <code>x</code> array and not mutate it. </p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">User 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="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="Monday 24 July 2023 10:35">Monday 24 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/options/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

SPGBOX RESULT:

Convergence achieved. (Return from callback: false).
Convergence achieved.

Final objective function value = 0.0
Sample of best point = Vector{Float64}[ 1.0, 2.0, 3.0]
Expand Down Expand Up @@ -54,4 +54,4 @@
</code></pre><p>And these arrays will be passed as arguments to the <code>spgbox!</code> function:</p><pre><code class="language-julia-repl hljs">julia&gt; @btime spgbox!($f,$g!,$x,vaux=$auxvecs)
3.414 ms (0 allocations: 0 bytes)
</code></pre><p>While SPG is very memory efficient, pré-allocation of the arrays reduces significanltly the use of memory, which might be important for multiple executions of the the same code, for example in multi-start approach for global-minimum search.</p><h3 id="fprev"><a class="docs-heading-anchor" href="#fprev">Size and preallocation of <code>fprev</code></a><a id="fprev-1"></a><a class="docs-heading-anchor-permalink" href="#fprev" title="Permalink"></a></h3><p>The auxiliary vector <code>fprev</code> stores the information of the function value of the last <code>m</code> function evaluations, which is the number of non-monotone steps allowed. Thus, it is a vector of size <code>m</code> which is also preallocated by <code>SPGBox.VAux</code>. By default, it is allocated to length <code>10</code>, which is the default value for <code>m</code>. If <code>m</code> is modified by the user and preallocation will be done, the new <code>m</code> value must be provided to <code>SPGBox.VAux</code>, with:</p><pre><code class="language-julia-repl hljs">julia&gt; auxvecs = SPGBox.VAux(x,f(x),m=5)
</code></pre><h1 id="Additional-keywords-available"><a class="docs-heading-anchor" href="#Additional-keywords-available">Additional keywords available</a><a id="Additional-keywords-available-1"></a><a class="docs-heading-anchor-permalink" href="#Additional-keywords-available" title="Permalink"></a></h1><p>Additional keywords available:</p><table><tr><th style="text-align: center">Keyword</th><th style="text-align: center">Type</th><th style="text-align: center">Meaning</th><th style="text-align: center">Default value</th></tr><tr><td style="text-align: center"><code>iprint</code></td><td style="text-align: center"><code>Integer</code></td><td style="text-align: center">Printing details (0, 1, or 2)</td><td style="text-align: center"><code>0</code></td></tr><tr><td style="text-align: center"><code>project_x0</code></td><td style="text-align: center"><code>Bool</code></td><td style="text-align: center">Projects, or not, the initial point on the bounds.</td><td style="text-align: center"><code>true</code></td></tr><tr><td style="text-align: center"><code>callback</code></td><td style="text-align: center"><code>Union{&lt;:Function,Nothing}</code></td><td style="text-align: center">Callback function</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"><code>lower</code></td><td style="text-align: center"><code>AbstractVecOrMat</code></td><td style="text-align: center">Array of lower bounds</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"><code>upper</code></td><td style="text-align: center"><code>AbstractVecOrMat</code></td><td style="text-align: center">Array of upper bounds</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"></td><td style="text-align: center"></td><td style="text-align: center"></td><td style="text-align: center"></td></tr></table></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« User guide</a><a class="docs-footer-nextpage" href="../reference/">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="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="Monday 24 July 2023 10:32">Monday 24 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><h1 id="Additional-keywords-available"><a class="docs-heading-anchor" href="#Additional-keywords-available">Additional keywords available</a><a id="Additional-keywords-available-1"></a><a class="docs-heading-anchor-permalink" href="#Additional-keywords-available" title="Permalink"></a></h1><p>Additional keywords available:</p><table><tr><th style="text-align: center">Keyword</th><th style="text-align: center">Type</th><th style="text-align: center">Meaning</th><th style="text-align: center">Default value</th></tr><tr><td style="text-align: center"><code>iprint</code></td><td style="text-align: center"><code>Integer</code></td><td style="text-align: center">Printing details (0, 1, or 2)</td><td style="text-align: center"><code>0</code></td></tr><tr><td style="text-align: center"><code>project_x0</code></td><td style="text-align: center"><code>Bool</code></td><td style="text-align: center">Projects, or not, the initial point on the bounds.</td><td style="text-align: center"><code>true</code></td></tr><tr><td style="text-align: center"><code>callback</code></td><td style="text-align: center"><code>Union{&lt;:Function,Nothing}</code></td><td style="text-align: center">Callback function</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"><code>lower</code></td><td style="text-align: center"><code>AbstractVecOrMat</code></td><td style="text-align: center">Array of lower bounds</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"><code>upper</code></td><td style="text-align: center"><code>AbstractVecOrMat</code></td><td style="text-align: center">Array of upper bounds</td><td style="text-align: center"><code>nothing</code></td></tr><tr><td style="text-align: center"></td><td style="text-align: center"></td><td style="text-align: center"></td><td style="text-align: center"></td></tr></table></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« User guide</a><a class="docs-footer-nextpage" href="../reference/">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="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="Monday 24 July 2023 10:35">Monday 24 July 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit ba009d6

Please sign in to comment.