Gave the sparse vectors their own block in the documentation. This

way it is obvious what file to #include to get them.
This commit is contained in:
Davis King 2011-08-29 19:49:10 -04:00
parent bb59a32527
commit 7c95a2ac63
2 changed files with 16 additions and 5 deletions

View File

@ -210,10 +210,7 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
<item>find_gamma_with_big_centroid_gap</item>
<item>compute_mean_squared_distance</item>
<item>kernel_matrix</item>
<item>
<name>sparse vectors</name>
<link>dlib/svm/sparse_vector_abstract.h.html#sparse_vectors</link>
</item>
<item>sparse vectors</item>
@ -977,6 +974,20 @@ Davis E. King. <a href="http://www.jmlr.org/papers/volume10/king09a/king09a.pdf"
</component>
<!-- ************************************************************************* -->
<component>
<name>sparse vectors</name>
<file>dlib/svm.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>

View File

@ -267,7 +267,7 @@
<term file="ml.html" name="radial_basis_kernel"/>
<term file="dlib/svm/sparse_vector_abstract.h.html" name="sparse_vectors"/>
<term file="ml.html" name="sparse vectors"/>
<term file="ml.html" name="sparse_linear_kernel"/>
<term file="ml.html" name="sparse_polynomial_kernel"/>
<term file="ml.html" name="sparse_sigmoid_kernel"/>