Commit 853de6c2e5cf2c79bc80c39e93c1ebe7d75ee70b
1 parent
ff1aaab0
Clean-up documentation
Showing
2 changed files
with
12 additions
and
10 deletions
doc/source/admin/install_source.rst
| @@ -42,10 +42,10 @@ to compiling GammaLib. | @@ -42,10 +42,10 @@ to compiling GammaLib. | ||
| 42 | 42 | ||
| 43 | If cfitsio is not available as a prebuilt package, or if you encounter | 43 | If cfitsio is not available as a prebuilt package, or if you encounter |
| 44 | some problems with the prebuilt package, cfitsio can be downloaded from | 44 | some problems with the prebuilt package, cfitsio can be downloaded from |
| 45 | -`http://heasarc.gsfc.nasa.gov/fitsio <http://heasarc.gsfc.nasa.gov/fitsio>`_ | 45 | +`http://heasarc.gsfc.nasa.gov/fitsio <https://heasarc.gsfc.nasa.gov/fitsio/>`_ |
| 46 | and installed from the source files (for details, please refer to the | 46 | and installed from the source files (for details, please refer to the |
| 47 | installation instructions on the | 47 | installation instructions on the |
| 48 | -`HEASARC <http://heasarc.gsfc.nasa.gov/fitsio>`_ site). We recommend | 48 | +`HEASARC <https://heasarc.gsfc.nasa.gov/fitsio/>`_ site). We recommend |
| 49 | installation of cfitsio in the default GammaLib install directory as a | 49 | installation of cfitsio in the default GammaLib install directory as a |
| 50 | shared library by typing | 50 | shared library by typing |
| 51 | 51 | ||
| @@ -67,7 +67,7 @@ so that the header files become available. | @@ -67,7 +67,7 @@ so that the header files become available. | ||
| 67 | If readline and ncurses are not available as a prebuilt package, or if | 67 | If readline and ncurses are not available as a prebuilt package, or if |
| 68 | you encounter some problems with the prebuilt packages, both libraries | 68 | you encounter some problems with the prebuilt packages, both libraries |
| 69 | can be downloaded from | 69 | can be downloaded from |
| 70 | -`http://ftp.gnu.org/gnu/ <http://ftp.gnu.org/gnu/>`_ | 70 | +`https://ftp.gnu.org/gnu/ <https://ftp.gnu.org/gnu/>`_ |
| 71 | and installed from the source files. We recommend to put also those in the | 71 | and installed from the source files. We recommend to put also those in the |
| 72 | default GammaLib install directory ``/usr/local/gamma``. | 72 | default GammaLib install directory ``/usr/local/gamma``. |
| 73 | 73 |
doc/source/users/user_manual/modules/linalg/matrix_storage.rst
| @@ -51,12 +51,14 @@ This divides the storage requirements to hold the matrix elements by | @@ -51,12 +51,14 @@ This divides the storage requirements to hold the matrix elements by | ||
| 51 | almost a factor of two. | 51 | almost a factor of two. |
| 52 | 52 | ||
| 53 | Finally, quite often one has to deal with matrixes that contain a large | 53 | Finally, quite often one has to deal with matrixes that contain a large |
| 54 | -number of zeros. Such matrixes are called *sparse matrixes*. If only the | ||
| 55 | -non-zero elements of a sparse matrix are stored the memory requirements | ||
| 56 | -are considerably reduced. This goes however at the expense of matrix | ||
| 57 | -element access, which has become now more complex. In particular, | ||
| 58 | -filling efficiently a sparse matrix is a non-trivial problem (see | ||
| 59 | -:ref:`sec_matrix_filling`). Sparse matrix storage is implemented by | 54 | +number of zeros. |
| 55 | +Such matrixes are called *sparse matrixes*. | ||
| 56 | +If only the non-zero elements of a sparse matrix are stored the memory | ||
| 57 | +requirements are considerably reduced. | ||
| 58 | +This goes however at the expense of matrix element access, which has become | ||
| 59 | +now more complex. | ||
| 60 | +In particular, filling efficiently a sparse matrix is a non-trivial problem. | ||
| 61 | +Sparse matrix storage is implemented by | ||
| 60 | the :doxy:`GMatrixSparse` class. A :doxy:`GMatrixSparse` object contains | 62 | the :doxy:`GMatrixSparse` class. A :doxy:`GMatrixSparse` object contains |
| 61 | three one-dimensional arrays to store the matrix elements: a double type | 63 | three one-dimensional arrays to store the matrix elements: a double type |
| 62 | array that contains in continuous column-major order all non-zero | 64 | array that contains in continuous column-major order all non-zero |
| @@ -90,7 +92,7 @@ methods in an identical way. So from the semantics the user has not to worry | @@ -90,7 +92,7 @@ methods in an identical way. So from the semantics the user has not to worry | ||
| 90 | about the storage class. However, matrix element access speeds are not | 92 | about the storage class. However, matrix element access speeds are not |
| 91 | identical for all storage types, and if performance is an issue (as it | 93 | identical for all storage types, and if performance is an issue (as it |
| 92 | certainly always will be), the user has to consider matrix access more | 94 | certainly always will be), the user has to consider matrix access more |
| 93 | -carefully (see :ref:`sec_matrix_filling`). | 95 | +carefully. |
| 94 | 96 | ||
| 95 | You allocate a matrix using the constructors | 97 | You allocate a matrix using the constructors |
| 96 | 98 |