build based on e1609d9

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.0","generation_timestamp":"2024-10-11T23:45:41","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-02T14:41:20","documenter_version":"1.7.0"}}

dev/classification/index.html

@@ -5,4 +5,4 @@
                       only_nonlinear_con=false, only_equ_con=false,
                       only_ineq_con=false, custom_filter=*)</code></pre><p>Returns a subset of the CUTEst problems using the classification file <code>classf.json</code>.</p><p><strong>Keyword arguments</strong></p><ul><li><p><code>min_var</code> and <code>max_var</code> set the number of variables in the problem;</p></li><li><p><code>min_con</code> and <code>max_con</code> set the number of constraints in the problem (use <code>max_con=0</code> for unconstrained or <code>min_con=1</code> for constrained);</p></li><li><p><code>only_*</code> flags are self-explaining. Note that they appear in conflicting pairs. Both can be false, but only one can be true.</p></li><li><p><code>objtype</code> is the classification of the objective function according to the <a href="https://ralna.github.io/SIFDecode/html/classification/">MASTSIF classification</a>. It can be a number, a symbol, a string, or an array of those.</p><ul><li><code>1</code>, <code>:none</code> or <code>&quot;none&quot;</code> means there is no objective function;</li><li><code>2</code>, <code>:constant</code> or <code>&quot;constant&quot;</code> means the objective function is a constant;</li><li><code>3</code>, <code>:linear</code> or <code>&quot;linear&quot;</code> means the objective function is a linear functional;</li><li><code>4</code>, <code>:quadratic</code> or <code>&quot;quadratic&quot;</code> means the objective function is quadratic;</li><li><code>5</code>, <code>:sum_of_squares</code> or <code>&quot;sum_of_squares&quot;</code> means the objective function is a sum of squares;</li><li><code>6</code>, <code>:other</code> or <code>&quot;other&quot;</code> means the objective function is none of the above.</li></ul></li><li><p><code>contype</code> is the classification of the constraints according to the same MASTSIF classification file.</p><ul><li><code>1</code>, <code>:unc</code> or <code>&quot;unc&quot;</code> means there are no constraints at all;</li><li><code>2</code>, <code>:fixed_vars</code> or <code>&quot;fixed_vars&quot;</code> means the only constraints are fixed variables;</li><li><code>3</code>, <code>:bounds</code> or <code>&quot;bounds&quot;</code> means the only constraints are bounded variables;</li><li><code>4</code>, <code>:network</code> or <code>&quot;network&quot;</code> means the constraints represent the adjacency matrix of a (linear) network;</li><li><code>5</code>, <code>:linear</code> or <code>&quot;linear&quot;</code> means the constraints are linear;</li><li><code>6</code>, <code>:quadratic</code> or <code>&quot;quadratic&quot;</code> means the constraints are quadratic;</li><li><code>7</code>, <code>:other</code> or <code>&quot;other&quot;</code> means the constraints are more general.</li></ul></li><li><p><code>custom_filter</code>: A function to apply additional filtering to the problem data. This data is provided as a dictionary with the following fields:</p><ul><li><p><code>&quot;objtype&quot;</code>: String representing the objective function type. It can be one of the following:</p><ul><li><code>&quot;none&quot;</code>, <code>&quot;constant&quot;</code>, <code>&quot;linear&quot;</code>, <code>&quot;quadratic&quot;</code>, <code>&quot;sum_of_squares&quot;</code>, <code>&quot;other&quot;</code></li></ul></li><li><p><code>&quot;contype&quot;</code>: String representing the constraint type. It can be one of the following:</p><ul><li><code>&quot;unc&quot;</code>, <code>&quot;fixed_vars&quot;</code>, <code>&quot;bounds&quot;</code>, <code>&quot;network&quot;</code>, <code>&quot;linear&quot;</code>, <code>&quot;quadratic&quot;</code>, <code>&quot;other&quot;</code></li></ul></li><li><p><code>&quot;regular&quot;</code>: Boolean indicating whether the problem is regular or not.</p><ul><li><code>&quot;derivative_order&quot;</code>: Integer representing the order of the highest derivative available.</li></ul></li><li><p><code>&quot;origin&quot;</code>: String indicating the origin of the problem. Possible values are <code>&quot;academic&quot;</code>, <code>&quot;modelling&quot;</code>, or <code>&quot;real&quot;</code>.</p></li><li><p><code>&quot;has_interval_var&quot;</code>: Boolean indicating whether the problem includes interval variables.</p></li><li><p><code>&quot;variables&quot;</code>: Dictionary with fields related to variables:</p><ul><li><code>&quot;can_choose&quot;</code>: Boolean indicating whether you can change the number of variables via parameters.</li><li><code>&quot;number&quot;</code>: Integer representing the number of variables (default if <code>&quot;can_choose&quot;</code> is true).</li><li><code>&quot;fixed&quot;</code>: Integer representing the number of fixed variables.</li><li><code>&quot;free&quot;</code>: Integer representing the number of free variables.</li><li><code>&quot;bounded_below&quot;</code>: Integer representing the number of variables bounded only from below.</li><li><code>&quot;bounded_above&quot;</code>: Integer representing the number of variables bounded only from above.</li><li><code>&quot;bounded_both&quot;</code>: Integer representing the number of variables bounded from both below and above.</li></ul></li><li><p><code>&quot;constraints&quot;</code>: Dictionary with fields related to constraints:</p><ul><li><code>&quot;can_choose&quot;</code>: Boolean indicating whether you can change the number of constraints via parameters.</li><li><code>&quot;number&quot;</code>: Integer representing the number of constraints (default if <code>&quot;can_choose&quot;</code> is true).</li><li><code>&quot;equality&quot;</code>: Integer representing the number of equality constraints.</li><li><code>&quot;ineq_below&quot;</code>: Integer representing the number of inequalities of the form <code>c(x) ≥ cl</code>.</li><li><code>&quot;ineq_above&quot;</code>: Integer representing the number of inequalities of the form <code>c(x) ≤ cu</code>.</li><li><code>&quot;ineq_both&quot;</code>: Integer representing the number of inequalities of the form <code>cl ≤ c(x) ≤ cu</code>.</li><li><code>&quot;linear&quot;</code>: Integer representing the number of linear constraints.</li><li><code>&quot;nonlinear&quot;</code>: Integer representing the number of nonlinear constraints.</li></ul></li></ul></li></ul><pre><code class="language-julia hljs">filtered_problems1 = select_sif_problems(; min_var=10, max_var=100, only_linear_con=true)
 filtered_problems2 = select_sif_problems(; max_con=0)
-filtered_problems3 = select_sif_problems(; min_con=1)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl/blob/4bc6b913d8b1b3986119df8afbe90881d06592fb/src/classification.jl#L30-L102">source</a></section></article><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="CUTEst.build_classification" href="#CUTEst.build_classification"><code>CUTEst.build_classification</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">build_classification()</code></pre><p>Creates the file <code>classf.json</code>, running each problem in <code>CLASSF.DB</code> and extracting the necessary information. It should be left alone, unless you think it is not updated. If you do, please open an issue.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl/blob/4bc6b913d8b1b3986119df8afbe90881d06592fb/src/classification.jl#L171-L177">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sifdecoder/">« Managing SIF files</a><a class="docs-footer-nextpage" href="../core/">Using CUTEst core functions »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 11 October 2024 23:45">Friday 11 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+filtered_problems3 = select_sif_problems(; min_con=1)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl/blob/e1609d9f4914a09b81da1e4857ba0e8f74f39d81/src/classification.jl#L30-L102">source</a></section></article><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="CUTEst.build_classification" href="#CUTEst.build_classification"><code>CUTEst.build_classification</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">build_classification()</code></pre><p>Creates the file <code>classf.json</code>, running each problem in <code>CLASSF.DB</code> and extracting the necessary information. It should be left alone, unless you think it is not updated. If you do, please open an issue.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl/blob/e1609d9f4914a09b81da1e4857ba0e8f74f39d81/src/classification.jl#L171-L177">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../sifdecoder/">« Managing SIF files</a><a class="docs-footer-nextpage" href="../core/">Using CUTEst core functions »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Saturday 2 November 2024 14:41">Saturday 2 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -18,4 +18,4 @@
 end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">nh = 50, nnzh = 153
 nh = 100, nnzh = 303
 nh = 150, nnzh = 1203
-nh = 200, nnzh = 603</code></pre><p><code>finalize(nlp)</code> is automatically handled by the garbage collector; however, you may need to call it manually if you want to recreate a model with the same problem but of a different size.</p><h2 id="Working-with-CUTEst-directly"><a class="docs-heading-anchor" href="#Working-with-CUTEst-directly">Working with CUTEst directly</a><a id="Working-with-CUTEst-directly-1"></a><a class="docs-heading-anchor-permalink" href="#Working-with-CUTEst-directly" title="Permalink"></a></h2><p>We have also implemented functions to allow direct access to CUTEst functions through a core API, which serves as a wrapper for CUTEst. For more information, see the section on the core interface.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Overview of CUTEst.jl »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Friday 11 October 2024 23:45">Friday 11 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+nh = 200, nnzh = 603</code></pre><p><code>finalize(nlp)</code> is automatically handled by the garbage collector; however, you may need to call it manually if you want to recreate a model with the same problem but of a different size.</p><h2 id="Working-with-CUTEst-directly"><a class="docs-heading-anchor" href="#Working-with-CUTEst-directly">Working with CUTEst directly</a><a id="Working-with-CUTEst-directly-1"></a><a class="docs-heading-anchor-permalink" href="#Working-with-CUTEst-directly" title="Permalink"></a></h2><p>We have also implemented functions to allow direct access to CUTEst functions through a core API, which serves as a wrapper for CUTEst. For more information, see the section on the core interface.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Overview of CUTEst.jl »</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><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Saturday 2 November 2024 14:41">Saturday 2 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>