updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402850

docs/docs/containers.xml

@@ -1339,11 +1339,15 @@
            case, by no means are you required to use the dlib cmake files. 
            </p>
            <p>
-              It is also worth nothing that all the preconditions of every function 
+              It is also worth noting that all the preconditions of every function 
               related to the matrix object are checked by <a href="metaprogramming.html#DLIB_ASSERT">DLIB_ASSERT</a>
               statements and thus can be enabled by #defining ENABLE_ASSERTS or DEBUG.  Doing
               this will cause your program to run slower but should catch any usage errors. 
            </p>
+           <p>
+              Finally, you don't need to #include anything to get the matrix extensions listed below.  
+              They are included by the <a href="dlib/matrix.h.html">dlib/matrix.h</a> file for you.
+            </p>
          </description>
          
          <examples>
@@ -1354,9 +1358,20 @@
             <extension>
                <name>matrix_utilities</name>
                <spec_file>dlib/matrix/matrix_utilities_abstract.h</spec_file>
-               <description>This extension contains miscellaneous utility functions
-                  for manipulating matrix objects.  Note that you don't need to #include
-                  anything to get them.  They are included by the <a href="dlib/matrix.h.html">dlib/matrix.h</a> file for you.
+               <description>
+                  This extension contains miscellaneous utility functions
+                  for manipulating matrix objects.  
+               </description>
+            </extension>
+
+            <extension>
+               <name>matrix_la</name>
+               <spec_file>dlib/matrix/matrix_la_abstract.h</spec_file>
+               <description>
+                  This extension contains linear algebra functions to calculate 
+                  QR, LU, Cholesky, eigenvalue, and singular value decompositions.  It also
+                  contains a few other miscellaneous functions that solve systems of 
+                  equations or calculate values derived from the above decompositions.
                </description>
             </extension>
 
@@ -1364,8 +1379,7 @@
                <name>matrix_math_functions</name>
                <spec_file>dlib/matrix/matrix_math_functions_abstract.h</spec_file>
                <description>This extension contains mathematical functions that operate on each
-                  element of a matrix independently.  Note that you don't need to #include
-                  anything to get them.  They are included by the <a href="dlib/matrix.h.html">dlib/matrix.h</a> file for you.
+                  element of a matrix independently.  
                </description>
             </extension>
 
@@ -1374,8 +1388,6 @@
                <spec_file>dlib/matrix/matrix_subexp_abstract.h</spec_file>
                <description>
                   This extension contains a number of functions for dealing with sub-matrices.  
-                  Note that you don't need to #include
-                  anything to get them.  They are included by the <a href="dlib/matrix.h.html">dlib/matrix.h</a> file for you.
                </description>
             </extension>
          </extensions>              

docs/docs/release_notes.xml

@@ -12,8 +12,11 @@
 
 <current>
 New Stuff:
+   - Matrix related
+      - Added QR, LU, Cholesky, and eigenvalue decomposition class objects
 
 Non-Backwards Compatible Changes:
+   - Renamed the cholesky_decomposition() function to chol()
 
 Bug fixes:
 

docs/docs/term_index.xml

@@ -506,13 +506,29 @@
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#matrix_cast" name="matrix_cast"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#set_all_elements" name="set_all_elements"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#tmp" name="tmp"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#cholesky_decomposition" name="cholesky_decomposition"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#array_to_matrix" name="array_to_matrix"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#vector_to_matrix" name="vector_to_matrix"/>
          <term link="dlib/matrix/matrix_math_functions_abstract.h.html#squared" name="squared"/>
          <term link="dlib/matrix/matrix_math_functions_abstract.h.html#cubed" name="cubed"/>
 
 
+         <term link="dlib/matrix/matrix_la_abstract.h.html#lu_decomposition" name="lu_decomposition"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#qr_decomposition" name="qr_decomposition"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#cholesky_decomposition" name="cholesky_decomposition"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#eigenvalue_decomposition" name="eigenvalue_decomposition"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#inv" name="inv"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#inv_lower_triangular" name="inv_lower_triangular"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#inv_upper_triangular" name="inv_upper_triangular"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#pinv" name="pinv"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#svd" name="svd"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#svd" name="singular value decomposition"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#svd2" name="svd2"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#svd3" name="svd3"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#det" name="det"/>
+         <term link="dlib/matrix/matrix_la_abstract.h.html#chol" name="chol"/>
+
+
+
          <term link="dlib/matrix/matrix_subexp_abstract.h.html#rowm" name="rowm"/>
          <term link="dlib/matrix/matrix_subexp_abstract.h.html#colm" name="colm"/>
          <term link="dlib/matrix/matrix_subexp_abstract.h.html#subm" name="subm"/>
@@ -524,16 +540,8 @@
 
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#pointwise_multiply" name="pointwise_multiply"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#equal" name="equal"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#inv" name="inv"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#inv_lower_triangular" name="inv_lower_triangular"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#inv_upper_triangular" name="inv_upper_triangular"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#pinv" name="pinv"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#pinv" name="pinv"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#svd" name="svd"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#svd" name="singular value decomposition"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#svd2" name="svd2"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#svd3" name="svd3"/>
-         <term link="dlib/matrix/matrix_utilities_abstract.h.html#det" name="det"/>
+
+
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#scale_columns" name="scale_columns"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#sort_columns" name="sort_columns"/>
          <term link="dlib/matrix/matrix_utilities_abstract.h.html#rsort_columns" name="rsort_columns"/>