Rebuild documentation

jfowkes · May 7, 2024 · 94c4537 · 94c4537
1 parent ae37ea1
commit 94c4537
Show file tree

Hide file tree

Showing 47 changed files with 540 additions and 78 deletions.
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: acd3c0465b25639e3197c6221482f3ab
+config: 95bbf751aadd0eb7c2241b867e10e103
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/history.rst.txt b/docs/_build/html/_sources/history.rst.txt
@@ -2,6 +2,12 @@ Version History
 ===============
 This section lists the different versions of PyCUTEst and the updates between them.
 
+Version 1.7.0 (7 May 2024)
+--------------------------
+* New sobj function to evaluate the objective and sparse gradient
+* New sgrad function to evaluate the sparse gradient only
+* Document the need to install Python headers on Ubuntu
+
 Version 1.6.2 (9 Apr 2024)
 --------------------------
 * Migrate from setup.py to pyproject.toml

diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -10,7 +10,7 @@ Python interface to the CUTEst optimization test environment
 
 **Release:** |version|
 
-**Date:** 9 April 2024
+**Date:** 7 May 2024
 
 **Author:** `Jaroslav Fowkes <jaroslav.fowkes@maths.ox.ac.uk>`_ and `Lindon Roberts <https://lindonroberts.github.io/>`_
 

diff --git a/docs/_build/html/_sources/install.rst.txt b/docs/_build/html/_sources/install.rst.txt
@@ -6,6 +6,7 @@ Requirements
 PyCUTEst requires the following software to be installed:
 
 * Python 3 (http://www.python.org/)
+* Python 3 Headers (:code:`apt install python3-dev` on Ubuntu, already included on macOS)
 * CUTEst (see below)
 
 **Please Note:** Currently PyCUTEst only supports Mac and Linux. For Windows 10 (or later), PyCUTEst can be used through the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/>`_, following the Linux installation instructions.

diff --git a/docs/_build/html/_sources/interface.rst.txt b/docs/_build/html/_sources/interface.rst.txt
@@ -24,6 +24,8 @@ The methods available for each :code:`CUTEstProblem` instance are:
 
 For large-scale problems, you may want to get vectors/matrices as sparse matrices. We have the following methods which return sparse matrices:
 
+* `sobj(x[, gradient]) <methods/pycutest.CUTEstProblem.sobj.html>`_: (sparse) evaluate objective (and optionally its gradient)
+* `sgrad(x[, index]) <methods/pycutest.CUTEstProblem.sgrad.html>`_: (sparse) evaluate objective gradient or specific constraint gradient
 * `scons(x[, index, gradient]) <methods/pycutest.CUTEstProblem.scons.html>`_: (sparse) evaluate constraint(s) and optionally their Jacobian/its gradient
 * `slagjac(x[, v]) <methods/pycutest.CUTEstProblem.slagjac.html>`_: (sparse) evaluate gradient of objective/Lagrangian and Jacobian of constraints
 * `sphess(x[, v]) <methods/pycutest.CUTEstProblem.sphess.html>`_: (sparse) evaluate Hessian of objective or Lagrangian
@@ -84,10 +86,12 @@ Please click on a :code:`CUTEstProblem` method below for full documentation:
    hess 
    ihess 
    hprod 
-   gradhess
+   gradhess 
    report 
+   sobj 
+   sgrad 
    scons 
    slagjac 
    sphess 
    isphess 
-   gradsphess
+   gradsphess 
diff --git a/docs/_build/html/_sources/methods/pycutest.CUTEstProblem.sgrad.rst.txt b/docs/_build/html/_sources/methods/pycutest.CUTEstProblem.sgrad.rst.txt
@@ -0,0 +1,6 @@
+CUTEstProblem.sgrad
+===================
+
+.. currentmodule:: pycutest
+
+.. automethod:: CUTEstProblem.sgrad
diff --git a/docs/_build/html/_sources/methods/pycutest.CUTEstProblem.sobj.rst.txt b/docs/_build/html/_sources/methods/pycutest.CUTEstProblem.sobj.rst.txt
@@ -0,0 +1,6 @@
+CUTEstProblem.sobj
+==================
+
+.. currentmodule:: pycutest
+
+.. automethod:: CUTEstProblem.sobj
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.6.2',
+    VERSION: '1.7.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/_build/html/building.html b/docs/_build/html/building.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Building Test Problems &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Building Test Problems &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/_build/html/contributing.html b/docs/_build/html/contributing.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Contributing &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Contributing &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/_build/html/example.html b/docs/_build/html/example.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Example Usage &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Example Usage &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.all_cached_problems.html b/docs/_build/html/functions/pycutest.all_cached_problems.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.all_cached_problems &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.all_cached_problems &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.clear_cache.html b/docs/_build/html/functions/pycutest.clear_cache.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.clear_cache &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.clear_cache &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.find_problems.html b/docs/_build/html/functions/pycutest.find_problems.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.find_problems &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.find_problems &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.import_problem.html b/docs/_build/html/functions/pycutest.import_problem.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.import_problem &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.import_problem &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.print_available_sif_params.html b/docs/_build/html/functions/pycutest.print_available_sif_params.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.print_available_sif_params &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.print_available_sif_params &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/functions/pycutest.problem_properties.html b/docs/_build/html/functions/pycutest.problem_properties.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>pycutest.problem_properties &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>pycutest.problem_properties &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Index &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -32,7 +32,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -219,10 +219,14 @@ <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methods/pycutest.CUTEstProblem.scons.html#pycutest.CUTEstProblem.scons">scons() (pycutest.CUTEstProblem method)</a>
+</li>
+      <li><a href="methods/pycutest.CUTEstProblem.sgrad.html#pycutest.CUTEstProblem.sgrad">sgrad() (pycutest.CUTEstProblem method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methods/pycutest.CUTEstProblem.slagjac.html#pycutest.CUTEstProblem.slagjac">slagjac() (pycutest.CUTEstProblem method)</a>
+</li>
+      <li><a href="methods/pycutest.CUTEstProblem.sobj.html#pycutest.CUTEstProblem.sobj">sobj() (pycutest.CUTEstProblem method)</a>
 </li>
       <li><a href="methods/pycutest.CUTEstProblem.sphess.html#pycutest.CUTEstProblem.sphess">sphess() (pycutest.CUTEstProblem method)</a>
 </li>

diff --git a/docs/_build/html/history.html b/docs/_build/html/history.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Version History &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Version History &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -34,7 +34,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -53,6 +53,7 @@
 <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Version History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-1-7-0-7-may-2024">Version 1.7.0 (7 May 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-6-2-9-apr-2024">Version 1.6.2 (9 Apr 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-6-1-8-mar-2024">Version 1.6.1 (8 Mar 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-1-6-0-24-jan-2024">Version 1.6.0 (24 Jan 2024)</a></li>
@@ -96,6 +97,14 @@
   <section id="version-history">
 <h1>Version History<a class="headerlink" href="#version-history" title="Permalink to this heading"></a></h1>
 <p>This section lists the different versions of PyCUTEst and the updates between them.</p>
+<section id="version-1-7-0-7-may-2024">
+<h2>Version 1.7.0 (7 May 2024)<a class="headerlink" href="#version-1-7-0-7-may-2024" title="Permalink to this heading"></a></h2>
+<ul class="simple">
+<li><p>New sobj function to evaluate the objective and sparse gradient</p></li>
+<li><p>New sgrad function to evaluate the sparse gradient only</p></li>
+<li><p>Document the need to install Python headers on Ubuntu</p></li>
+</ul>
+</section>
 <section id="version-1-6-2-9-apr-2024">
 <h2>Version 1.6.2 (9 Apr 2024)<a class="headerlink" href="#version-1-6-2-9-apr-2024" title="Permalink to this heading"></a></h2>
 <ul class="simple">

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PyCUTEst &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>PyCUTEst &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -34,7 +34,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -83,8 +83,8 @@
 <h1>PyCUTEst<a class="headerlink" href="#pycutest" title="Permalink to this heading"></a></h1>
 <section id="python-interface-to-the-cutest-optimization-test-environment">
 <h2>Python interface to the CUTEst optimization test environment<a class="headerlink" href="#python-interface-to-the-cutest-optimization-test-environment" title="Permalink to this heading"></a></h2>
-<p><strong>Release:</strong> 1.6.2</p>
-<p><strong>Date:</strong> 9 April 2024</p>
+<p><strong>Release:</strong> 1.7.0</p>
+<p><strong>Date:</strong> 7 May 2024</p>
 <p><strong>Author:</strong> <a class="reference external" href="mailto:jaroslav&#46;fowkes&#37;&#52;&#48;maths&#46;ox&#46;ac&#46;uk">Jaroslav Fowkes</a> and <a class="reference external" href="https://lindonroberts.github.io/">Lindon Roberts</a></p>
 <p>PyCUTEst is a Python interface to <a class="reference external" href="https://github.com/ralna/CUTEst">CUTEst</a>, a Fortran package for testing optimization software <a class="footnote-reference brackets" href="#id4" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>. It is based on the interface originally developed for CUTEr by <a class="reference external" href="http://www.fe.uni-lj.si/en/the_faculty/staff/alphabetically/55/">Prof. Arpad Buermen</a> <a class="footnote-reference brackets" href="#id5" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a>. Currently it supports Mac and Linux only, although on Windows 10 (and later) it can be used through the <a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl/">Windows Subsystem for Linux</a>, following the Linux installation instructions.</p>
 <p>In essence, this package gives convenient access to a large collection of nonlinear optimization test problems.</p>
@@ -155,6 +155,7 @@ <h2>Citing PyCUTEst<a class="headerlink" href="#citing-pycutest" title="Permalin
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="history.html">Version History</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="history.html#version-1-7-0-7-may-2024">Version 1.7.0 (7 May 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="history.html#version-1-6-2-9-apr-2024">Version 1.6.2 (9 Apr 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="history.html#version-1-6-1-8-mar-2024">Version 1.6.1 (8 Mar 2024)</a></li>
 <li class="toctree-l2"><a class="reference internal" href="history.html#version-1-6-0-24-jan-2024">Version 1.6.0 (24 Jan 2024)</a></li>

diff --git a/docs/_build/html/install.html b/docs/_build/html/install.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; PyCUTEst v1.6.2 documentation</title>
+  <title>Installation &mdash; PyCUTEst v1.7.0 documentation</title>
       <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <!--[if lt IE 9]>
@@ -35,7 +35,7 @@
             PyCUTEst
           </a>
               <div class="version">
-                1.6.2
+                1.7.0
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -97,6 +97,7 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
 <p>PyCUTEst requires the following software to be installed:</p>
 <ul class="simple">
 <li><p>Python 3 (<a class="reference external" href="http://www.python.org/">http://www.python.org/</a>)</p></li>
+<li><p>Python 3 Headers (<code class="code docutils literal notranslate"><span class="pre">apt</span> <span class="pre">install</span> <span class="pre">python3-dev</span></code> on Ubuntu, already included on macOS)</p></li>
 <li><p>CUTEst (see below)</p></li>
 </ul>
 <p><strong>Please Note:</strong> Currently PyCUTEst only supports Mac and Linux. For Windows 10 (or later), PyCUTEst can be used through the <a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl/">Windows Subsystem for Linux</a>, following the Linux installation instructions.</p>