Rebuild documentation

ralna · May 8, 2024 · 8eda997 · 8eda997
1 parent 60f0644
commit 8eda997
Show file tree

Hide file tree

Showing 217 changed files with 42,940 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -7,9 +7,9 @@ STFC Rutherford Appleton Laboratory ([[email protected]](mailto:[email protected])).
 ## Documentation
 
 For detailed information about the SPRAL packages and API see [Fortran
-documentation](http://www.numerical.rl.ac.uk/spral/doc/latest/Fortran/)
+documentation](https://ralna.github.io/spral/_build/html/Fortran/)
 or [C
-documentation](http://www.numerical.rl.ac.uk/spral/doc/latest/C/).
+documentation](https://ralna.github.io/spral/_build/html/C/).
 
 ## Packages
 

diff --git a/doc/createweb.sh b/doc/createweb.sh
diff --git a/doc/C/conf.py → docs/C/conf.py b/doc/C/conf.py → docs/C/conf.py
diff --git a/doc/C/coord_format.rst → docs/C/coord_format.rst b/doc/C/coord_format.rst → docs/C/coord_format.rst
diff --git a/doc/C/csc_format.rst → docs/C/csc_format.rst b/doc/C/csc_format.rst → docs/C/csc_format.rst
diff --git a/doc/C/index.rst → docs/C/index.rst b/doc/C/index.rst → docs/C/index.rst
diff --git a/doc/C/install.rst → docs/C/install.rst b/doc/C/install.rst → docs/C/install.rst
diff --git a/doc/C/lsmr.rst → docs/C/lsmr.rst b/doc/C/lsmr.rst → docs/C/lsmr.rst
diff --git a/doc/C/matrix_util.rst → docs/C/matrix_util.rst b/doc/C/matrix_util.rst → docs/C/matrix_util.rst
diff --git a/doc/C/random.rst → docs/C/random.rst b/doc/C/random.rst → docs/C/random.rst
diff --git a/doc/C/random_matrix.rst → docs/C/random_matrix.rst b/doc/C/random_matrix.rst → docs/C/random_matrix.rst
diff --git a/doc/C/rutherford_boeing.rst → docs/C/rutherford_boeing.rst b/doc/C/rutherford_boeing.rst → docs/C/rutherford_boeing.rst
diff --git a/doc/C/scaling.rst → docs/C/scaling.rst b/doc/C/scaling.rst → docs/C/scaling.rst
diff --git a/doc/C/ssids.rst → docs/C/ssids.rst b/doc/C/ssids.rst → docs/C/ssids.rst
diff --git a/doc/C/ssmfe.rst → docs/C/ssmfe.rst b/doc/C/ssmfe.rst → docs/C/ssmfe.rst
diff --git a/doc/C/ssmfe_core.rst → docs/C/ssmfe_core.rst b/doc/C/ssmfe_core.rst → docs/C/ssmfe_core.rst
diff --git a/doc/C/ssmfe_expert.rst → docs/C/ssmfe_expert.rst b/doc/C/ssmfe_expert.rst → docs/C/ssmfe_expert.rst
diff --git a/doc/Fortran/conf.py → docs/Fortran/conf.py b/doc/Fortran/conf.py → docs/Fortran/conf.py
diff --git a/doc/Fortran/conventions.rst → docs/Fortran/conventions.rst b/doc/Fortran/conventions.rst → docs/Fortran/conventions.rst
diff --git a/doc/Fortran/coord_format.rst → docs/Fortran/coord_format.rst b/doc/Fortran/coord_format.rst → docs/Fortran/coord_format.rst
diff --git a/doc/Fortran/csc_format.rst → docs/Fortran/csc_format.rst b/doc/Fortran/csc_format.rst → docs/Fortran/csc_format.rst
diff --git a/doc/Fortran/index.rst → docs/Fortran/index.rst b/doc/Fortran/index.rst → docs/Fortran/index.rst
diff --git a/doc/Fortran/install.rst → docs/Fortran/install.rst b/doc/Fortran/install.rst → docs/Fortran/install.rst
diff --git a/doc/Fortran/lsmr.rst → docs/Fortran/lsmr.rst b/doc/Fortran/lsmr.rst → docs/Fortran/lsmr.rst
diff --git a/doc/Fortran/matrix_util.rst → docs/Fortran/matrix_util.rst b/doc/Fortran/matrix_util.rst → docs/Fortran/matrix_util.rst
diff --git a/doc/Fortran/random.rst → docs/Fortran/random.rst b/doc/Fortran/random.rst → docs/Fortran/random.rst
diff --git a/doc/Fortran/random_matrix.rst → docs/Fortran/random_matrix.rst b/doc/Fortran/random_matrix.rst → docs/Fortran/random_matrix.rst
diff --git a/doc/Fortran/rutherford_boeing.rst → docs/Fortran/rutherford_boeing.rst b/doc/Fortran/rutherford_boeing.rst → docs/Fortran/rutherford_boeing.rst
diff --git a/doc/Fortran/scaling.rst → docs/Fortran/scaling.rst b/doc/Fortran/scaling.rst → docs/Fortran/scaling.rst
diff --git a/doc/Fortran/ssids.rst → docs/Fortran/ssids.rst b/doc/Fortran/ssids.rst → docs/Fortran/ssids.rst
diff --git a/doc/Fortran/ssmfe.rst → docs/Fortran/ssmfe.rst b/doc/Fortran/ssmfe.rst → docs/Fortran/ssmfe.rst
diff --git a/doc/Fortran/ssmfe_core.rst → docs/Fortran/ssmfe_core.rst b/doc/Fortran/ssmfe_core.rst → docs/Fortran/ssmfe_core.rst
diff --git a/doc/Fortran/ssmfe_expert.rst → docs/Fortran/ssmfe_expert.rst b/doc/Fortran/ssmfe_expert.rst → docs/Fortran/ssmfe_expert.rst
diff --git a/doc/STFC-Logo.png → docs/STFC-Logo.png b/doc/STFC-Logo.png → docs/STFC-Logo.png
diff --git a/docs/_build/html/C/.buildinfo b/docs/_build/html/C/.buildinfo
@@ -0,0 +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: 9be5e82a2ad22e9a17dcfcb91ca0981e
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/C/.doctrees/coord_format.doctree b/docs/_build/html/C/.doctrees/coord_format.doctree
diff --git a/docs/_build/html/C/.doctrees/csc_format.doctree b/docs/_build/html/C/.doctrees/csc_format.doctree
diff --git a/docs/_build/html/C/.doctrees/environment.pickle b/docs/_build/html/C/.doctrees/environment.pickle
diff --git a/docs/_build/html/C/.doctrees/index.doctree b/docs/_build/html/C/.doctrees/index.doctree
diff --git a/docs/_build/html/C/.doctrees/install.doctree b/docs/_build/html/C/.doctrees/install.doctree
diff --git a/docs/_build/html/C/.doctrees/lsmr.doctree b/docs/_build/html/C/.doctrees/lsmr.doctree
diff --git a/docs/_build/html/C/.doctrees/matrix_util.doctree b/docs/_build/html/C/.doctrees/matrix_util.doctree
diff --git a/docs/_build/html/C/.doctrees/random.doctree b/docs/_build/html/C/.doctrees/random.doctree
diff --git a/docs/_build/html/C/.doctrees/random_matrix.doctree b/docs/_build/html/C/.doctrees/random_matrix.doctree
diff --git a/docs/_build/html/C/.doctrees/rutherford_boeing.doctree b/docs/_build/html/C/.doctrees/rutherford_boeing.doctree
diff --git a/docs/_build/html/C/.doctrees/scaling.doctree b/docs/_build/html/C/.doctrees/scaling.doctree
diff --git a/docs/_build/html/C/.doctrees/ssids.doctree b/docs/_build/html/C/.doctrees/ssids.doctree
diff --git a/docs/_build/html/C/.doctrees/ssmfe.doctree b/docs/_build/html/C/.doctrees/ssmfe.doctree
diff --git a/docs/_build/html/C/.doctrees/ssmfe_core.doctree b/docs/_build/html/C/.doctrees/ssmfe_core.doctree
diff --git a/docs/_build/html/C/.doctrees/ssmfe_expert.doctree b/docs/_build/html/C/.doctrees/ssmfe_expert.doctree
diff --git a/docs/_build/html/C/_sources/coord_format.rst.txt b/docs/_build/html/C/_sources/coord_format.rst.txt
@@ -0,0 +1,49 @@
+=========================
+Coordinate (Coord) Format
+=========================
+
+This standard data format consists of the following data:
+
+.. code-block:: C
+
+   int    m;         /* number of rows (unsymmetric only) */
+   int    n;         /* number of columns */
+   int    ne;        /* number of entries in matrix (may have type int64_t) */
+   int    row[ne];   /* row indices */
+   int    col[ne];   /* column indices */
+   double val[ne];   /* numerical values */
+
+The arrays should be set such that the ``k``-th entry is in row
+``row[k]`` and column ``col[k]`` with value ``val[k]``. Entries that are
+zero, including those on the diagonal, need not be specified.
+
+For **symmetric matrices**, only the lower *or* upper triangular entries of
+:math:`A` should be supplied. For **unsymmetric matrices**, all entries in the
+matrix should be supplied. Duplicate entries will be summed and out-of-range
+entries will be ignored.
+
+Some SPRAL routines offer only input in :doc:`CSC format<csc_format>`, you
+may need to use routines from the :doc:`matrix_util` package to convert
+data from Coordinate to CSC format.
+
+To illustrate the Coordinate format, the matrix
+
+.. math::
+
+   \left( \begin{array}{ccccc}
+      1.1 & 2.2 &     & 3.3 &     \\
+      2.2 &     & 4.4 &     &     \\
+          & 4.4 & 5.5 &     & 6.6 \\
+      3.3 &     &     & 7.7 & 8.8 \\
+          &     & 6.6 & 8.8 & 9.9
+   \end{array} \right)
+
+is described by the following data:
+
+.. code-block:: C
+
+   int    n     = 5;
+   int    ne    = 9;
+   int    row[] = { 1,   2,   3,   4,   3,   5,   4,   5,   5 };
+   int    col[] = { 1,   1,   2,   1,   3,   3,   4,   4,   5 };
+   double val[] = { 1.1, 2.2, 4.4, 3.3, 5.5, 6.6, 7.7, 8.8, 9.9 };
diff --git a/docs/_build/html/C/_sources/csc_format.rst.txt b/docs/_build/html/C/_sources/csc_format.rst.txt
@@ -0,0 +1,53 @@
+=====================================
+Compressed Sparse Column (CSC) Format
+=====================================
+
+This standard data format consists of the following data:
+
+.. code-block:: C
+
+   int    m;                  /* number of rows (unsymmetric only) */
+   int    n;                  /* number of columns */
+   int    ptr[n+1];           /* column pointers (may have type int64_t) */
+   int    row[ ptr[n]-1 ];    /* row indices */
+   double val[ ptr[n]-1 ];    /* numerical values */
+
+Non-zero matrix entries are ordered by increasing column index and stored in
+the arrays `row[]` and `val[]` such that `row[k]` holds
+the row number and `val[k]` holds the value of the k-th entry.
+The `ptr[]` array stores column pointers such that `ptr[i]` is
+the position in `row[]` and `val[]` of
+the first entry in the i-th column, and `ptr[n]` is
+the total number of entries. `ptr[]` may be either `int` or `int64_t`.
+There must be no duplicate or out of range entries.
+Entries that are zero, including those on the diagonal, need not be specified.
+
+For **symmetric matrices**, only the lower triangular entries of :math:`A`
+should be supplied. For **unsymmetric matrices**, all entries in the matrix
+should be supplied.
+
+Note that most SPRAL routines offer **no checking** of user data, and the
+behaviour of these routines with misformatted data is undefined. You may use
+routines from the :doc:`matrix_util` package to convert data to and
+check data stored in this format.
+
+To illustrate the CSC format, the matrix
+
+.. math::
+
+   \left( \begin{array}{ccccc}
+      1.1 & 2.2 &     & 3.3 &     \\
+      2.2 &     & 4.4 &     &     \\
+          & 4.4 & 5.5 &     & 6.6 \\
+      3.3 &     &     & 7.7 & 8.8 \\
+          &     & 6.6 & 8.8 & 9.9
+   \end{array} \right)
+
+is described by the following data:
+
+.. code-block:: C
+
+   int    n     = 5;
+   int    ptr[] = { 1,             4,   5,        7,        9,    10 };
+   int    row[] = { 1,   2,   4,   3,   3,   5,   4,   5,   5 };
+   double val[] = { 1.1, 2.2, 3.3, 4.4, 5.5, 6.6, 7.7, 8.8, 9.9 };
diff --git a/docs/_build/html/C/_sources/index.rst.txt b/docs/_build/html/C/_sources/index.rst.txt
@@ -0,0 +1,47 @@
+.. spral documentation master file, created by
+   sphinx-quickstart on Mon Feb 15 15:20:34 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+The Sparse Parallel Robust Algorithms Library
+=============================================
+
+Introduction
+
+.. toctree::
+   :maxdepth: 1
+
+   install
+
+Data Formats
+
+.. toctree::
+   :maxdepth: 1
+
+   csc_format
+   coord_format
+
+Packages:
+
+.. toctree::
+   :maxdepth: 1
+
+   lsmr
+   matrix_util
+   random
+   random_matrix
+   rutherford_boeing
+   scaling
+   ssids
+   ssmfe
+   ssmfe_expert
+   ssmfe_core
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/doc/install.rst → docs/_build/html/C/_sources/install.rst.txt b/doc/install.rst → docs/_build/html/C/_sources/install.rst.txt