Commit cc0b205d authored by Davis King's avatar Davis King

Moved all the linear algebra/matrix tools onto their own documentation page.

parent 16011071
This diff is collapsed.
This diff is collapsed.
...@@ -303,7 +303,7 @@ ...@@ -303,7 +303,7 @@
<spec_file link="true">dlib/graph_utils/function_objects_abstract.h</spec_file> <spec_file link="true">dlib/graph_utils/function_objects_abstract.h</spec_file>
<description> <description>
This is a simple function object that computes squared euclidean distance This is a simple function object that computes squared euclidean distance
between two <a href="containers.html#matrix">matrix</a> objects. between two <a href="linear_algebra.html#matrix">matrix</a> objects.
</description> </description>
<examples> <examples>
<example>linear_manifold_regularizer_ex.cpp.html</example> <example>linear_manifold_regularizer_ex.cpp.html</example>
......
...@@ -233,7 +233,7 @@ Then <a href="mailto:davis@dlib.net">email me</a> the dlibchanges.hg file and I' ...@@ -233,7 +233,7 @@ Then <a href="mailto:davis@dlib.net">email me</a> the dlibchanges.hg file and I'
or any number of other objects that manage resources such as memory for you. If you want or any number of other objects that manage resources such as memory for you. If you want
an array use std::vector (or the checked <a href="containers.html#std_vector_c">std_vector_c</a>). an array use std::vector (or the checked <a href="containers.html#std_vector_c">std_vector_c</a>).
If you want to make a lookup table use a <a href="containers.html#map">map</a>. If you want If you want to make a lookup table use a <a href="containers.html#map">map</a>. If you want
a two dimensional array use <a href="containers.html#matrix">matrix</a> or a two dimensional array use <a href="linear_algebra.html#matrix">matrix</a> or
<a href="containers.html#array2d">array2d</a>. <a href="containers.html#array2d">array2d</a>.
</p> </p>
<p> <p>
......
...@@ -975,7 +975,7 @@ ...@@ -975,7 +975,7 @@
<spec_file link="true">dlib/image_transforms/equalize_histogram_abstract.h</spec_file> <spec_file link="true">dlib/image_transforms/equalize_histogram_abstract.h</spec_file>
<description> <description>
This global function computes an image's histogram and returns it in the This global function computes an image's histogram and returns it in the
form of a column or row <a href="containers.html#matrix">matrix</a> object. form of a column or row <a href="linear_algebra.html#matrix">matrix</a> object.
</description> </description>
</component> </component>
...@@ -1295,7 +1295,7 @@ ...@@ -1295,7 +1295,7 @@
<spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file> <spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file>
<description> <description>
This routine is a tool for transforming images using some kind of point mapping This routine is a tool for transforming images using some kind of point mapping
function (e.g. <a href="algorithms.html#point_transform_affine">point_transform_affine</a>) function (e.g. <a href="linear_algebra.html#point_transform_affine">point_transform_affine</a>)
and pixel interpolation tool (e.g. <a href="#interpolate_quadratic">interpolate_quadratic</a>). and pixel interpolation tool (e.g. <a href="#interpolate_quadratic">interpolate_quadratic</a>).
An example application of this routine is for image rotation. Indeed, it is how An example application of this routine is for image rotation. Indeed, it is how
<a href="#rotate_image">rotate_image</a> is implemented. <a href="#rotate_image">rotate_image</a> is implemented.
...@@ -1639,7 +1639,7 @@ ...@@ -1639,7 +1639,7 @@
<spec_file link="true">dlib/image_processing/box_overlap_testing_abstract.h</spec_file> <spec_file link="true">dlib/image_processing/box_overlap_testing_abstract.h</spec_file>
<description> <description>
This object is a simple function object for determining if two This object is a simple function object for determining if two
<a href="algorithms.html#rectangle">rectangles</a> overlap. <a href="linear_algebra.html#rectangle">rectangles</a> overlap.
</description> </description>
</component> </component>
......
...@@ -104,7 +104,7 @@ ...@@ -104,7 +104,7 @@
<li><b>Numerical Algorithms</b> <li><b>Numerical Algorithms</b>
<ul> <ul>
<li>A fast <a href="containers.html#matrix">matrix</a> object implemented using the expression <li>A fast <a href="linear_algebra.html#matrix">matrix</a> object implemented using the expression
templates technique and capable of using BLAS and LAPACK libraries when available.</li> templates technique and capable of using BLAS and LAPACK libraries when available.</li>
<li>Numerous linear algebra and mathematical operations are defined for the matrix object such as the <li>Numerous linear algebra and mathematical operations are defined for the matrix object such as the
<a href="dlib/matrix/matrix_la_abstract.h.html#svd">singular value decomposition</a>, <a href="dlib/matrix/matrix_la_abstract.h.html#svd">singular value decomposition</a>,
......
This diff is collapsed.
...@@ -25,6 +25,11 @@ ...@@ -25,6 +25,11 @@
<link>ml.html</link> <link>ml.html</link>
<chm_sub>ml.xml</chm_sub> <chm_sub>ml.xml</chm_sub>
</item> </item>
<item>
<name>Linear Algebra</name>
<link>linear_algebra.html</link>
<chm_sub>linear_algebra.xml</chm_sub>
</item>
<item> <item>
<name>Bayesian Nets</name> <name>Bayesian Nets</name>
<link>bayes.html</link> <link>bayes.html</link>
......
...@@ -392,7 +392,7 @@ ...@@ -392,7 +392,7 @@
<spec_file link="true">dlib/is_kind.h</spec_file> <spec_file link="true">dlib/is_kind.h</spec_file>
<description> <description>
This is a template where is_matrix&lt;T&gt;::value == true when T This is a template where is_matrix&lt;T&gt;::value == true when T
is a <a href="containers.html#matrix">matrix</a> object or some kind is a <a href="linear_algebra.html#matrix">matrix</a> object or some kind
of matrix expression. of matrix expression.
</description> </description>
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
programming approach using C++ templates. In particular, each algorithm is parameterized programming approach using C++ templates. In particular, each algorithm is parameterized
to allow a user to supply either one of the predefined dlib kernels (e.g. <a to allow a user to supply either one of the predefined dlib kernels (e.g. <a
href="#radial_basis_kernel">RBF</a> operating href="#radial_basis_kernel">RBF</a> operating
on <a href="containers.html#matrix">column vectors</a>), or a new on <a href="linear_algebra.html#matrix">column vectors</a>), or a new
<a href="using_custom_kernels_ex.cpp.html">user defined kernel</a>. <a href="using_custom_kernels_ex.cpp.html">user defined kernel</a>.
Moreover, the implementations of the algorithms are totally separated from the data on Moreover, the implementations of the algorithms are totally separated from the data on
which they operate. This makes the dlib implementation generic enough to operate on which they operate. This makes the dlib implementation generic enough to operate on
......
...@@ -15,18 +15,20 @@ ...@@ -15,18 +15,20 @@
<term file="dlib/algs.h.html" name="stack_based_memory_block"/> <term file="dlib/algs.h.html" name="stack_based_memory_block"/>
<term file="algorithms.html" name="move_rect"/> <term file="linear_algebra.html" name="matrix"/>
<term file="algorithms.html" name="translate_rect"/> <term file="linear_algebra.html" name="move_rect"/>
<term file="algorithms.html" name="resize_rect"/> <term file="linear_algebra.html" name="translate_rect"/>
<term file="algorithms.html" name="resize_rect_width"/> <term file="linear_algebra.html" name="resize_rect"/>
<term file="algorithms.html" name="resize_rect_height"/> <term file="linear_algebra.html" name="resize_rect_width"/>
<term file="algorithms.html" name="centered_rect"/> <term file="linear_algebra.html" name="resize_rect_height"/>
<term file="algorithms.html" name="center"/> <term file="linear_algebra.html" name="centered_rect"/>
<term file="algorithms.html" name="nearest_point"/> <term file="linear_algebra.html" name="center"/>
<term file="algorithms.html" name="distance_to_rect_edge"/> <term file="linear_algebra.html" name="nearest_point"/>
<term file="algorithms.html" name="shrink_rect"/> <term file="linear_algebra.html" name="distance_to_rect_edge"/>
<term file="algorithms.html" name="grow_rect"/> <term file="linear_algebra.html" name="shrink_rect"/>
<term file="algorithms.html" name="dcenter"/> <term file="linear_algebra.html" name="grow_rect"/>
<term file="linear_algebra.html" name="dcenter"/>
<term file="algorithms.html" name="kalman_filter"/> <term file="algorithms.html" name="kalman_filter"/>
<term file="algorithms.html" name="rls_filter"/> <term file="algorithms.html" name="rls_filter"/>
...@@ -150,8 +152,8 @@ ...@@ -150,8 +152,8 @@
<term file="algorithms.html" name="randomly_sample_image_features"/> <term file="algorithms.html" name="randomly_sample_image_features"/>
<term file="algorithms.html" name="disjoint_subsets"/> <term file="algorithms.html" name="disjoint_subsets"/>
<term link="algorithms.html#disjoint_subsets" name="union-find"/> <term link="algorithms.html#disjoint_subsets" name="union-find"/>
<term file="algorithms.html" name="rectangle"/> <term file="linear_algebra.html" name="rectangle"/>
<term file="algorithms.html" name="border_enumerator"/> <term file="linear_algebra.html" name="border_enumerator"/>
<term file="graph_tools.html" name="edge"/> <term file="graph_tools.html" name="edge"/>
<term file="graph_tools.html" name="is_join_tree"/> <term file="graph_tools.html" name="is_join_tree"/>
<term file="graph_tools.html" name="create_join_tree"/> <term file="graph_tools.html" name="create_join_tree"/>
...@@ -182,13 +184,13 @@ ...@@ -182,13 +184,13 @@
<term file="graph_tools.html" name="is_clique"/> <term file="graph_tools.html" name="is_clique"/>
<term file="graph_tools.html" name="is_maximal_clique"/> <term file="graph_tools.html" name="is_maximal_clique"/>
<term file="algorithms.html" name="square_root"/> <term file="algorithms.html" name="square_root"/>
<term file="algorithms.html" name="vector"/> <term file="linear_algebra.html" name="vector"/>
<term file="algorithms.html" name="point"/> <term file="linear_algebra.html" name="point"/>
<term file="algorithms.html" name="rotate_point"/> <term file="linear_algebra.html" name="rotate_point"/>
<term file="algorithms.html" name="point_rotator"/> <term file="linear_algebra.html" name="point_rotator"/>
<term file="algorithms.html" name="point_transform"/> <term file="linear_algebra.html" name="point_transform"/>
<term file="algorithms.html" name="point_transform_affine"/> <term file="linear_algebra.html" name="point_transform_affine"/>
<term file="algorithms.html" name="rotation_matrix"/> <term file="linear_algebra.html" name="rotation_matrix"/>
<term file="algorithms.html" name="running_stats"/> <term file="algorithms.html" name="running_stats"/>
<term file="algorithms.html" name="running_scalar_covariance"/> <term file="algorithms.html" name="running_scalar_covariance"/>
<term file="algorithms.html" name="mean_sign_agreement"/> <term file="algorithms.html" name="mean_sign_agreement"/>
...@@ -369,7 +371,6 @@ ...@@ -369,7 +371,6 @@
<term file="containers.html" name="directed_graph"/> <term file="containers.html" name="directed_graph"/>
<term file="containers.html" name="array"/> <term file="containers.html" name="array"/>
<term file="containers.html" name="binary_search_tree"/> <term file="containers.html" name="binary_search_tree"/>
<term file="containers.html" name="matrix"/>
<term file="containers.html" name="enumerable"/> <term file="containers.html" name="enumerable"/>
<term file="containers.html" name="map_pair"/> <term file="containers.html" name="map_pair"/>
<term file="containers.html" name="map"/> <term file="containers.html" name="map"/>
...@@ -825,7 +826,7 @@ ...@@ -825,7 +826,7 @@
<term name="get_rect"> <term name="get_rect">
<term link="dlib/gui_widgets/drawable_abstract.h.html#get_rect" name="in drawable object"/> <term link="dlib/gui_widgets/drawable_abstract.h.html#get_rect" name="in drawable object"/>
<term link="algorithms.html#get_rect" name="for general matrix like objects"/> <term link="linear_algebra.html#get_rect" name="for general matrix like objects"/>
</term> </term>
<term file="dlib/gui_widgets/drawable_abstract.h.html" name="is_enabled"/> <term file="dlib/gui_widgets/drawable_abstract.h.html" name="is_enabled"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment