Moved all the sparse vector documentation into the linear algebra page.

docs/docs/linear_algebra.xml

@@ -17,6 +17,19 @@
             can be found in
             the <a href="matrix_ex.cpp.html">matrix example program</a>.
          </p>
+
+         <p>
+            Most of the linear algebra tools deal with dense matrices.  However, there is also
+            a limited amount of support for working with sparse matrices and vectors.
+            In particular, the dlib tools represent sparse vectors using the container objects
+            in the C++ STL.  For details, see the notes at the top of 
+            <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">dlib/svm/sparse_vector_abstract.h</a>.
+         </p>
+         <p>
+            Finally, note that all the dense matrix tools can be obtained by #including <tt>&lt;dlib/matrix.h&gt;</tt>
+            while the sparse vector tools can be obtained by #including <tt>&lt;dlib/sparse_vector.h&gt;</tt>.  The 
+            geometry tools can be used by #including <tt>&lt;dlib/geometry.h&gt;</tt>.
+         </p>
    
    </body>
 
@@ -26,7 +39,7 @@
     <top>
 
       <section>
-         <name>General Matrix Tools</name>
+         <name>Dense Matrix Tools</name>
          <item>matrix</item>
          <item nolink="true">
             <name>Basic_Math_Operators</name>
@@ -588,6 +601,72 @@
       </section>
 
 
+      <section>
+         <name>Sparse Vector Tools</name>
+         <item>sparse_to_dense</item> 
+
+         <item>
+            <name>distance_squared</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#distance_squared</link>
+         </item> 
+         <item>
+            <name>distance</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#distance</link>
+         </item> 
+         <item>
+            <name>assign</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#assign</link>
+         </item> 
+         <item>
+            <name>length_squared</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#length_squared</link>
+         </item> 
+         <item>
+            <name>length</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#length</link>
+         </item> 
+         <item>
+            <name>scale_by</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#scale_by</link>
+         </item> 
+         <item>
+            <name>add</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#add</link>
+         </item> 
+         <item>
+            <name>subtract</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#subtract</link>
+         </item> 
+         <item>
+            <name>max_index_plus_one</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#max_index_plus_one</link>
+         </item> 
+         <item>
+            <name>add_to</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#add_to</link>
+         </item> 
+         <item>
+            <name>subtract_from</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#subtract_from</link>
+         </item> 
+         <item>
+            <name>min</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#min</link>
+         </item> 
+         <item>
+            <name>max</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#max</link>
+         </item> 
+         <item>
+            <name>make_sparse_vector</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#make_sparse_vector</link>
+         </item> 
+         <item>
+            <name>sparse_matrix_vector_multiply</name>
+            <link>dlib/svm/sparse_vector_abstract.h.html#sparse_matrix_vector_multiply</link>
+         </item> 
+      </section>
+
     </top>
    </menu>
 
@@ -597,6 +676,20 @@
 
    <components>
    
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>sparse_to_dense</name>
+         <file>dlib/sparse_vector.h</file>
+         <spec_file link="true">dlib/svm/sparse_vector_abstract.h</spec_file>
+         <description>
+            This is a set of simple functions that take  
+            <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">sparse vectors</a> 
+            and converts them into equivalent dense vectors.  
+         </description>
+      </component>
+      
+      
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/ml.xml

@@ -224,7 +224,6 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
          <item>save_image_dataset_metadata</item> 
          <item>load_libsvm_formatted_data</item> 
          <item>save_libsvm_formatted_data</item> 
-         <item>sparse_to_dense</item>
          <item>fix_nonzero_indexing</item>
       </section>
 
@@ -244,7 +243,6 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
          <item>find_gamma_with_big_centroid_gap</item> 
          <item>compute_mean_squared_distance</item> 
          <item>kernel_matrix</item> 
-         <item>sparse vectors</item>
          <item>ranking_pair</item>
          <item>is_ranking_problem</item>
          <item>count_ranking_inversions</item>
@@ -986,19 +984,6 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
       </component>
       
       
-   <!-- ************************************************************************* -->
-
-      <component>
-         <name>sparse vectors</name>
-         <file>dlib/sparse_vector.h</file>
-         <spec_file>dlib/svm/sparse_vector_abstract.h</spec_file>
-         <description>
-            In dlib, sparse vectors are represented using the container objects
-            in the C++ STL. This file defines various useful functions for operating 
-            on these sparse vectors.
-         </description>
-      </component>
-      
    <!-- ************************************************************************* -->
 
       <component>
@@ -1806,7 +1791,7 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
             the LIBSVM format.  It loads the data into a std::vector of
             <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">sparse vectors</a>.
             If you want to load data into dense vectors (i.e.
-            dlib::matrix objects) then you can use the <a href="#sparse_to_dense">sparse_to_dense</a>
+            dlib::matrix objects) then you can use the <a href="linear_algebra.html#sparse_to_dense">sparse_to_dense</a>
             function to perform the conversion.  Also, some LIBSVM formatted files number
             their features beginning with 1 rather than 0.  If this bothers you, then you
             can fix it by using the <a href="#fix_nonzero_indexing">fix_nonzero_indexing</a> function
@@ -1828,19 +1813,6 @@ Davis E. King. <a href="http://jmlr.csail.mit.edu/papers/volume10/king09a/king09
          </description>
       </component>
       
-   <!-- ************************************************************************* -->
-      
-      <component>
-         <name>sparse_to_dense</name>
-         <file>dlib/sparse_vector.h</file>
-         <spec_file link="true">dlib/svm/sparse_vector_abstract.h</spec_file>
-         <description>
-            This is a simple function that takes a std::vector of 
-            <a href="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors">sparse vectors</a> 
-            and returns to you the equivalent std::vector of dense vectors. 
-         </description>
-      </component>
-      
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -223,7 +223,7 @@
          <term file="ml.html" name="save_image_dataset_metadata"/>
          <term file="ml.html" name="load_libsvm_formatted_data"/>
          <term file="ml.html" name="save_libsvm_formatted_data"/>
-         <term file="ml.html" name="sparse_to_dense"/>
+         <term file="linear_algebra.html" name="sparse_to_dense"/>
          <term file="ml.html" name="fix_nonzero_indexing"/>
          <term link="ml.html#mlp" name="multi-layer perceptron"/>
          <term link="ml.html#mlp" name="neural network"/>
@@ -360,8 +360,8 @@
          <term file="ml.html" name="radial_basis_kernel"/>
 
 
-         <term link="ml.html#sparse vectors" name="unsorted sparse vectors"/>
-         <term file="ml.html" name="sparse vectors"/>
+         <term link="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors" name="unsorted sparse vectors"/>
+         <term link="dlib/svm/sparse_vector_abstract.h.html#sparse_vectors" name="sparse vectors"/>
          <term file="ml.html" name="sparse_linear_kernel"/>
          <term file="ml.html" name="sparse_histogram_intersection_kernel"/>
          <term file="ml.html" name="sparse_polynomial_kernel"/>