Skip to content

Commit 457f090

Browse files
author
Documenter.jl
committed
build based on 97cbb72
1 parent 97fb39f commit 457f090

File tree

7 files changed

+8
-8
lines changed

7 files changed

+8
-8
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-17T03:48:52","documenter_version":"1.5.0"}}
1+
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-17T06:56:54","documenter_version":"1.5.0"}}

dev/core/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
<!DOCTYPE html>
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Core · CUTEst.jl</title><meta name="title" content="Core · CUTEst.jl"/><meta property="og:title" content="Core · CUTEst.jl"/><meta property="twitter:title" content="Core · CUTEst.jl"/><meta name="description" content="Documentation for CUTEst.jl."/><meta property="og:description" content="Documentation for CUTEst.jl."/><meta property="twitter:description" content="Documentation for CUTEst.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/style.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="CUTEst.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">CUTEst.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></li><li class="is-active"><a class="tocitem" href>Core</a></li><li><a class="tocitem" href="../reference/">Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Core</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Core</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaSmoothOptimizers/CUTEst.jl/blob/main/docs/src/core.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 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></h1><p>When working with CUTEst, we created a <strong>core</strong> interface, which is essentially a wrapper for the CUTEst functions. You probably don&#39;t want to use that, because the NLPModels interface is much more friendlier, as just as useful. See its tutorial.</p><p>CUTEst in Fortran defines functions called with <code>cutest_u*</code> or <code>cutest_c*</code>, for the unconstrained and constrained cases, respectively. For each of those, we dropped the <code>cutest_</code>, so the functions <code>cutest_ufn</code> and <code>cutest_cfn</code> are available as <code>ufn</code> and <code>cfn</code>. To use then you have to convert the types using <code>Cint</code> and <code>Cdouble</code>, and pass arrays because of the underlying pointers in Fortran. In practice, there isn&#39;t much improvement in calling these or <code>ccall</code>s, except for the use of the internal <code>cutest_lib</code>.</p><p><strong>Only use these functions if you really know what you&#39;re doing.</strong></p><p>If you want to use these functions, you should still decode the problem as an NLP, by doing</p><pre><code class="language-julia hljs">nlp = CUTEstModel(&quot;PROBLEM&quot;)
33
...
4-
finalize(nlp)</code></pre><p>Otherwise you&#39;ll have to manage the CUTEst library, the decoding, the file unit numbers, <code>OUTSDIF.d</code>, <code>setup</code>, etc.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</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="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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 03:48">Saturday 17 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4+
finalize(nlp)</code></pre><p>Otherwise you&#39;ll have to manage the CUTEst library, the decoding, the file unit numbers, <code>OUTSDIF.d</code>, <code>setup</code>, etc.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tutorial/">« Tutorial</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="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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 06:56">Saturday 17 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@
2525

2626
nh = 150, nnzh = 1203
2727

28-
nh = 200, nnzh = 603</code></pre><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 also have implemented function to allow access to the CUTEst functions directly: a core API which is only a wrapper for CUTEst. For more information see the section core.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="core/#Working-with-CUTEst-directly">Working with CUTEst directly</a></li><li><a href="#CUTEst.jl-documentation">CUTEst.jl documentation</a></li><li class="no-marker"><ul><li><a href="#CUTEst-brief-history">CUTEst brief history</a></li><li><a href="#Installing">Installing</a></li><li><a href="#Usage">Usage</a></li><li><a href="#Working-with-CUTEst-directly">Working with CUTEst directly</a></li><li><a href="#Contents">Contents</a></li></ul></li><li><a href="reference/#Reference">Reference</a></li><li class="no-marker"><ul><li><a href="reference/#Contents">Contents</a></li><li><a href="reference/#Index">Index</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 03:48">Saturday 17 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
28+
nh = 200, nnzh = 603</code></pre><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 also have implemented function to allow access to the CUTEst functions directly: a core API which is only a wrapper for CUTEst. For more information see the section core.</p><h2 id="Contents"><a class="docs-heading-anchor" href="#Contents">Contents</a><a id="Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Contents" title="Permalink"></a></h2><ul><li><a href="core/#Working-with-CUTEst-directly">Working with CUTEst directly</a></li><li><a href="#CUTEst.jl-documentation">CUTEst.jl documentation</a></li><li class="no-marker"><ul><li><a href="#CUTEst-brief-history">CUTEst brief history</a></li><li><a href="#Installing">Installing</a></li><li><a href="#Usage">Usage</a></li><li><a href="#Working-with-CUTEst-directly">Working with CUTEst directly</a></li><li><a href="#Contents">Contents</a></li></ul></li><li><a href="reference/#Reference">Reference</a></li><li class="no-marker"><ul><li><a href="reference/#Contents">Contents</a></li><li><a href="reference/#Index">Index</a></li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="tutorial/">Tutorial »</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.5.0 on <span class="colophon-date" title="Saturday 17 August 2024 06:56">Saturday 17 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/objects.inv

110 Bytes
Binary file not shown.

dev/reference/index.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

dev/search_index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)