updated docs

This commit is contained in:
Davis King 2011-08-24 21:38:43 -04:00
parent 8d6cec1d36
commit 69839d403f
2 changed files with 70 additions and 0 deletions

View File

@ -31,6 +31,11 @@
<item>murmur_hash3</item>
<item>running_stats</item>
<item>running_scalar_covariance</item>
<item>mean_sign_agreement</item>
<item>correlation</item>
<item>covariance</item>
<item>r_squared</item>
<item>mean_squared_error</item>
<item>running_covariance</item>
<item>random_subset_selector</item>
<item>randomly_subsample</item>
@ -295,6 +300,66 @@
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>mean_sign_agreement</name>
<file>dlib/statistics.h</file>
<spec_file link="true">dlib/statistics/statistics_abstract.h</spec_file>
<description>
This is a function for computing the probability that
matching elements of two std::vectors have the same sign.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>correlation</name>
<file>dlib/statistics.h</file>
<spec_file link="true">dlib/statistics/statistics_abstract.h</spec_file>
<description>
This is a function for computing the correlation between
matching elements of two std::vectors.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>covariance</name>
<file>dlib/statistics.h</file>
<spec_file link="true">dlib/statistics/statistics_abstract.h</spec_file>
<description>
This is a function for computing the covariance between
matching elements of two std::vectors.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>r_squared</name>
<file>dlib/statistics.h</file>
<spec_file link="true">dlib/statistics/statistics_abstract.h</spec_file>
<description>
This is a function for computing the R squared coefficient between
matching elements of two std::vectors.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>mean_squared_error</name>
<file>dlib/statistics.h</file>
<spec_file link="true">dlib/statistics/statistics_abstract.h</spec_file>
<description>
This is a function for computing the mean squared error between
matching elements of two std::vectors.
</description>
</component>
<!-- ************************************************************************* -->
<component>

View File

@ -131,6 +131,11 @@
<term file="algorithms.html" name="point_rotator"/>
<term file="algorithms.html" name="running_stats"/>
<term file="algorithms.html" name="running_scalar_covariance"/>
<term file="algorithms.html" name="mean_sign_agreement"/>
<term file="algorithms.html" name="correlation"/>
<term file="algorithms.html" name="covariance"/>
<term file="algorithms.html" name="r_squared"/>
<term file="algorithms.html" name="mean_squared_error"/>
<term file="algorithms.html" name="running_covariance"/>
<term file="algorithms.html" name="random_subset_selector"/>
<term file="algorithms.html" name="randomly_subsample"/>