Skip to content

D
dlib
Commit cc0b205d authored by Davis King's avatar Davis King
Browse files
Options

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

parent 16011071
Show whitespace changes
Inline Side-by-side
Showing with 1021 additions and 962 deletions
docs/docs/algorithms.xml
View file @ cc0b205d
......@@ -86,32 +86,6 @@
<item>rls_filter</item>
</section>
<section>
<name>Geometry</name>
<item>border_enumerator</item>
<item>rectangle</item>
<item>vector</item>
<item>point</item>
<item>rotate_point</item>
<item>point_rotator</item>
<item>point_transform</item>
<item>point_transform_affine</item>
<item>rotation_matrix</item>
<item>get_rect</item>
<item>centered_rect</item>
<item>center</item>
<item>dcenter</item>
<item>shrink_rect</item>
<item>grow_rect</item>
<item>translate_rect</item>
<item>resize_rect</item>
<item>resize_rect_width</item>
<item>resize_rect_height</item>
<item>move_rect</item>
<item>nearest_point</item>
<item>distance_to_rect_edge</item>
</section>
</top>
</menu>
......@@ -284,7 +258,7 @@
<spec_file>dlib/general_hash/hash_abstract.h</spec_file>
<description>
This is a set of convenience functions for invoking <a href="#murmur_hash3">murmur_hash3</a>
on std::strings, std::vectors, std::maps, or <a href="containers.html#matrix">dlib::matrix</a> objects.
on std::strings, std::vectors, std::maps, or <a href="linear_algebra.html#matrix">dlib::matrix</a> objects.
<p>
As an aside, the hash() for matrix objects is defined <a href="dlib/matrix/matrix_utilities_abstract.h.html#hash">here</a>.
It has the same interface as all the others.
......@@ -305,54 +279,6 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>rectangle</name>
<file>dlib/geometry.h</file>
<spec_file>dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This object represents a rectangular region inside a Cartesian
coordinate system. It allows you to easily represent and manipulate
rectangles.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>border_enumerator</name>
<file>dlib/geometry.h</file>
<spec_file>dlib/geometry/border_enumerator_abstract.h</spec_file>
<description>
This object is an <a href="containers.html#enumerable">enumerator</a>
over the border <a href="#point">points</a> of a
<a href="#rectangle">rectangle</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>vector</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This object represents a two or three dimensional vector.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This object represents a point inside a Cartesian coordinate system.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -664,103 +590,6 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>nearest_point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and a
<a href="#point">point</a> and returns the point in the given
rectangle that is nearest to the given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>distance_to_rect_edge</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and a
<a href="#point">point</a> and returns the Manhattan distance between
the rectangle's edge and the point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>move_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and moves
it so that it's upper left corner occupies the given location.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect_height</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given height but otherwise with the
same edge points as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect_width</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given width but otherwise with the
same edge points as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given size but with the same upper
left corner as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>translate_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and moves
it by a given number of units along the x and y axis relative to
where it was before the move.
</description>
</component>
<!-- ************************************************************************* -->
<component>
......@@ -795,151 +624,6 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>center</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
Returns the center point of a <a href="#rectangle">rectangle</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>dcenter</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
Returns the center point of a <a href="#rectangle">rectangle</a>. This
is a version of <a href="#center">center()</a> which returns a double version
of the point rather than one which uses integers to represent the
result. Therefore, it is slightly more accurate.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>centered_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
There are various overloads of this function but the basic idea is
that it returns a <a href="#rectangle">rectangle</a> with a given
width and height and centered about a given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>shrink_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> object,
shrinks its borders by a given amount, and returns the result.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>grow_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> object,
grows its borders by a given amount, and returns the result.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotate_point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is a function that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about a given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_rotator</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about the origin.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_transform</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about the origin and then adds a
displacement vector.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_transform_affine</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that applies an affine transformation to a <a href="#vector">vector</a> or
<a href="#point">point</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotation_matrix</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is a method for creating 2D rotation matrices.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>get_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This is a simple template function that returns a rectangle
representing the size of a 2D container (e.g. <a href="containers.html#matrix">matrix</a> or
<a href="containers.html#array2d">array2d</a>).
</description>
</component>
<!-- ************************************************************************* -->
</components>
......
docs/docs/containers.xml
View file @ cc0b205d
......@@ -58,533 +58,6 @@
<item>directed_graph</item>
<item>graph</item>
<item>map</item>
<item>
<name>matrix</name>
<sub>
<item nolink="true">
<name>math</name>
<sub>
<item>
<name>exp</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#exp</link>
</item>
<item>
<name>log10</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#log10</link>
</item>
<item>
<name>log</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#log</link>
</item>
<item>
<name>sqrt</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sqrt</link>
</item>
<item>
<name>pow</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#pow</link>
</item>
<item>
<name>squared</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#squared</link>
</item>
<item>
<name>cubed</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cubed</link>
</item>
<item>
<name>sigmoid</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sigmoid</link>
</item>
<item>
<name>abs</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#abs</link>
</item>
<item>
<name>reciprocal</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#reciprocal</link>
</item>
<item>
<name>reciprocal_max</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#reciprocal_max</link>
</item>
<item>
<name>normalize</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#normalize</link>
</item>
<item>
<name>round</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#round</link>
</item>
<item>
<name>ceil</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#ceil</link>
</item>
<item>
<name>floor</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#floor</link>
</item>
<item>
<name>round_zeros</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#round_zeros</link>
</item>
<item>
<name>conj</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#conj</link>
</item>
<item>
<name>norm</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#norm</link>
</item>
<item>
<name>imag</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#imag</link>
</item>
<item>
<name>real</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#real</link>
</item>
<item>
<name>complex_matrix</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#complex_matrix</link>
</item>
<item>
<name>sin</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sin</link>
</item>
<item>
<name>cos</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cos</link>
</item>
<item>
<name>tan</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#tan</link>
</item>
<item>
<name>asin</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#asin</link>
</item>
<item>
<name>acos</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#acos</link>
</item>
<item>
<name>atan</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#atan</link>
</item>
<item>
<name>sinh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sinh</link>
</item>
<item>
<name>cosh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cosh</link>
</item>
<item>
<name>tanh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#tanh</link>
</item>
</sub>
</item>
<item nolink="true">
<name>linear_algebra</name>
<sub>
<item>
<name>inv</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv</link>
</item>
<item>
<name>pinv</name>
<link>dlib/matrix/matrix_la_abstract.h.html#pinv</link>
</item>
<item>
<name>svd</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd</link>
</item>
<item>
<name>svd2</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd2</link>
</item>
<item>
<name>svd3</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd3</link>
</item>
<item>
<name>det</name>
<link>dlib/matrix/matrix_la_abstract.h.html#det</link>
</item>
<item>
<name>trace</name>
<link>dlib/matrix/matrix_la_abstract.h.html#trace</link>
</item>
<item>
<name>chol</name>
<link>dlib/matrix/matrix_la_abstract.h.html#chol</link>
</item>
<item>
<name>inv_lower_triangular</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv_lower_triangular</link>
</item>
<item>
<name>inv_upper_triangular</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv_upper_triangular</link>
</item>
<item>
<name>lu_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#lu_decomposition</link>
</item>
<item>
<name>qr_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#qr_decomposition</link>
</item>
<item>
<name>cholesky_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#cholesky_decomposition</link>
</item>
<item>
<name>eigenvalue_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#eigenvalue_decomposition</link>
</item>
<item>
<name>real_eigenvalues</name>
<link>dlib/matrix/matrix_la_abstract.h.html#real_eigenvalues</link>
</item>
</sub>
</item>
<item nolink="true">
<name>sub_expressions</name>
<sub>
<item>
<name>range</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#range</link>
</item>
<item>
<name>subm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#subm</link>
</item>
<item>
<name>rowm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#rowm</link>
</item>
<item>
<name>colm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#colm</link>
</item>
<item>
<name>set_subm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_subm</link>
</item>
<item>
<name>set_colm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_colm</link>
</item>
<item>
<name>set_rowm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_rowm</link>
</item>
</sub>
</item>
<item nolink="true">
<name>statistics</name>
<sub>
<item>
<name>sum</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum</link>
</item>
<item>
<name>sum_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum_rows</link>
</item>
<item>
<name>sum_cols</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum_cols</link>
</item>
<item>
<name>prod</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#prod</link>
</item>
<item>
<name>mean</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#mean</link>
</item>
<item>
<name>max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#max</link>
</item>
<item>
<name>min</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#min</link>
</item>
<item>
<name>find_min_and_max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#find_min_and_max</link>
</item>
<item>
<name>index_of_min</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#index_of_min</link>
</item>
<item>
<name>index_of_max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#index_of_max</link>
</item>
<item>
<name>variance</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#variance</link>
</item>
<item>
<name>stddev</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#stddev</link>
</item>
<item>
<name>covariance</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#covariance</link>
</item>
<item>
<name>randm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#randm</link>
</item>
</sub>
</item>
<item nolink="true">
<name>utilities</name>
<sub>
<item>
<name>is_col_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_col_vector</link>
</item>
<item>
<name>is_row_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_row_vector</link>
</item>
<item>
<name>is_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_vector</link>
</item>
<item>
<name>const_temp_matrix</name>
<link>dlib/matrix/matrix_abstract.h.html#const_temp_matrix</link>
</item>
<item>
<name>diag</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#diag</link>
</item>
<item>
<name>diagm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#diagm</link>
</item>
<item>
<name>symmetric_matrix_cache</name>
<link>dlib/matrix/symmetric_matrix_cache_abstract.h.html</link>
</item>
<item>
<name>trans</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#trans</link>
</item>
<item>
<name>conv</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv</link>
</item>
<item>
<name>conv_same</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv_same</link>
</item>
<item>
<name>conv_valid</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv_valid</link>
</item>
<item>
<name>xcorr</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr</link>
</item>
<item>
<name>xcorr_same</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr_same</link>
</item>
<item>
<name>xcorr_valid</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr_valid</link>
</item>
<item>
<name>flip</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#flip</link>
</item>
<item>
<name>flipud</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#flipud</link>
</item>
<item>
<name>fliplr</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#fliplr</link>
</item>
<item>
<name>dot</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#dot</link>
</item>
<item>
<name>lowerm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#lowerm</link>
</item>
<item>
<name>upperm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#upperm</link>
</item>
<item>
<name>make_symmetric</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#make_symmetric</link>
</item>
<item>
<name>ones_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#ones_matrix</link>
</item>
<item>
<name>zeros_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#zeros_matrix</link>
</item>
<item>
<name>uniform_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#uniform_matrix</link>
</item>
<item>
<name>identity_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#identity_matrix</link>
</item>
<item>
<name>rotate</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#rotate</link>
</item>
<item>
<name>vector_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#vector_to_matrix</link>
</item>
<item>
<name>pointer_to_column_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointer_to_column_vector</link>
</item>
<item>
<name>pointer_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointer_to_matrix</link>
</item>
<item>
<name>reshape_to_column_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#reshape_to_column_vector</link>
</item>
<item>
<name>reshape</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#reshape</link>
</item>
<item>
<name>array_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#array_to_matrix</link>
</item>
<item>
<name>removerc</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#removerc</link>
</item>
<item>
<name>remove_row</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#remove_row</link>
</item>
<item>
<name>remove_col</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#remove_col</link>
</item>
<item>
<name>matrix_cast</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#matrix_cast</link>
</item>
<item>
<name>set_all_elements</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#set_all_elements</link>
</item>
<item>
<name>hash</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#hash</link>
</item>
<item>
<name>tmp</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#tmp</link>
</item>
<item>
<name>equal</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#equal</link>
</item>
<item>
<name>pointwise_multiply</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointwise_multiply</link>
</item>
<item>
<name>join_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#join_rows</link>
</item>
<item>
<name>join_cols</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#join_cols</link>
</item>
<item>
<name>tensor_product</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#tensor_product</link>
</item>
<item>
<name>scale_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#scale_columns</link>
</item>
<item>
<name>scale_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#scale_rows</link>
</item>
<item>
<name>sort_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sort_columns</link>
</item>
<item>
<name>rsort_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#rsort_columns</link>
</item>
<item>
<name>length</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#length</link>
</item>
<item>
<name>length_squared</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#length_squared</link>
</item>
<item>
<name>pixel_to_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pixel_to_vector</link>
</item>
<item>
<name>vector_to_pixel</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#vector_to_pixel</link>
</item>
<item>
<name>clamp</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#clamp</link>
</item>
<item>
<name>lowerbound</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#lowerbound</link>
</item>
<item>
<name>upperbound</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#upperbound</link>
</item>
<item>
<name>linspace</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#linspace</link>
</item>
<item>
<name>logspace</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#logspace</link>
</item>
<item>
<name>cartesian_product</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#cartesian_product</link>
</item>
</sub>
</item>
</sub>
</item>
<item>queue</item>
<item>reference_counter</item>
<item>type_safe_union</item>
......@@ -1788,93 +1261,6 @@
<!-- ************************************************************************* -->
<component>
<name>matrix</name>
<file>dlib/matrix.h</file>
<spec_file link="true">dlib/matrix/matrix_abstract.h</spec_file>
<description>
This is a 2D matrix object that enables you to write code that deals with
matrices using a simple syntax similar to what can be written in MATLAB. It is implemented using
the <a href="matrix_expressions_ex.cpp.html">expression templates</a> technique which allows it to eliminate the
temporary matrix objects that would normally be returned from expressions
such as M = A+B+C+D; Normally each invocation of the + operator would
construct and return a temporary matrix object but using this technique
we can avoid creating all these temporary objects and receive a large speed boost.
<p>
This object is also capable of using BLAS and LAPACK libraries such as ATLAS or the Intel
MKL when available. To enable BLAS support all you have to do is #define
DLIB_USE_BLAS and then make sure you link your application with your
BLAS library. Similarly, to enable LAPACK support just #define DLIB_USE_LAPACK and
link to your LAPACK library. Finally, the use of BLAS and LAPACK is transparent to
the user, that is, the dlib matrix object uses BLAS and LAPACK internally to optimize
various operations while still allowing the user to use a simple MATLAB like syntax.
</p>
<p>
Note that the cmake files that come with dlib know how to link a project with ATLAS or
the Intel MKL if you are building on a linux system. The cmake files may also
work in a few other cases as well but I haven't tested any others. But in any
case, by no means are you required to use the dlib cmake files.
</p>
<p>
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>
<example>matrix_ex.cpp.html</example>
<example>matrix_expressions_ex.cpp.html</example>
</examples>
<extensions>
<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.
</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>
<extension>
<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.
</description>
</extension>
<extension>
<name>matrix_sub_expressions</name>
<spec_file>dlib/matrix/matrix_subexp_abstract.h</spec_file>
<description>
This extension contains a number of functions for dealing with sub-matrices.
</description>
</extension>
</extensions>
</component>
<!-- ************************************************************************* -->
<component>
<name>std_vector_c</name>
<file>dlib/stl_checked.h</file>
......
docs/docs/graph_tools.xml
View file @ cc0b205d
......@@ -303,7 +303,7 @@
<spec_file link="true">dlib/graph_utils/function_objects_abstract.h</spec_file>
<description>
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>
<examples>
<example>linear_manifold_regularizer_ex.cpp.html</example>
......
docs/docs/howto_contribute.xml
View file @ cc0b205d
......@@ -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
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
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>.
</p>
<p>
......
docs/docs/imaging.xml
View file @ cc0b205d
......@@ -975,7 +975,7 @@
<spec_file link="true">dlib/image_transforms/equalize_histogram_abstract.h</spec_file>
<description>
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>
</component>
......@@ -1295,7 +1295,7 @@
<spec_file link="true">dlib/image_transforms/interpolation_abstract.h</spec_file>
<description>
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>).
An example application of this routine is for image rotation. Indeed, it is how
<a href="#rotate_image">rotate_image</a> is implemented.
......@@ -1639,7 +1639,7 @@
<spec_file link="true">dlib/image_processing/box_overlap_testing_abstract.h</spec_file>
<description>
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>
</component>
......
docs/docs/index.xml
View file @ cc0b205d
......@@ -104,7 +104,7 @@
<li><b>Numerical Algorithms</b>
<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>
<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>,
......
docs/docs/linear_algebra.xml 0 → 100644
View file @ cc0b205d
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml-stylesheet type="text/xsl" href="stylesheet.xsl"?>
<doc>
<title>Linear Algebra</title>
<!-- ************************************************************************* -->
<body>
<br/><br/>
<p>
This page documents the core linear algebra tools included in dlib.
In particular, the three most important objects in this part of the library are the
<a href="#matrix">matrix</a>, <a href="#vector">vector</a>, and
<a href="#rectangle">rectangle</a>. All the other tools on this page
are functions for manipulating these three objects. A good example and introduction
can be found in
the <a href="matrix_ex.cpp.html">matrix example program</a>.
</p>
</body>
<!-- ************************************************************************* -->
<menu width="150">
<top>
<section>
<name>General Matrix Tools</name>
<item>matrix</item>
<item nolink="true">
<name>Basic_Math_Operators</name>
<sub>
<item>
<name>exp</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#exp</link>
</item>
<item>
<name>log10</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#log10</link>
</item>
<item>
<name>log</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#log</link>
</item>
<item>
<name>sqrt</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sqrt</link>
</item>
<item>
<name>pow</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#pow</link>
</item>
<item>
<name>squared</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#squared</link>
</item>
<item>
<name>cubed</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cubed</link>
</item>
<item>
<name>sigmoid</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sigmoid</link>
</item>
<item>
<name>abs</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#abs</link>
</item>
<item>
<name>reciprocal</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#reciprocal</link>
</item>
<item>
<name>reciprocal_max</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#reciprocal_max</link>
</item>
<item>
<name>normalize</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#normalize</link>
</item>
<item>
<name>round</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#round</link>
</item>
<item>
<name>ceil</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#ceil</link>
</item>
<item>
<name>floor</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#floor</link>
</item>
<item>
<name>round_zeros</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#round_zeros</link>
</item>
<item>
<name>conj</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#conj</link>
</item>
<item>
<name>norm</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#norm</link>
</item>
<item>
<name>imag</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#imag</link>
</item>
<item>
<name>real</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#real</link>
</item>
<item>
<name>complex_matrix</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#complex_matrix</link>
</item>
<item>
<name>sin</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sin</link>
</item>
<item>
<name>cos</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cos</link>
</item>
<item>
<name>tan</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#tan</link>
</item>
<item>
<name>asin</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#asin</link>
</item>
<item>
<name>acos</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#acos</link>
</item>
<item>
<name>atan</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#atan</link>
</item>
<item>
<name>sinh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#sinh</link>
</item>
<item>
<name>cosh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#cosh</link>
</item>
<item>
<name>tanh</name>
<link>dlib/matrix/matrix_math_functions_abstract.h.html#tanh</link>
</item>
</sub>
</item>
<item nolink="true">
<name>Linear_Algebra</name>
<sub>
<item>
<name>inv</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv</link>
</item>
<item>
<name>pinv</name>
<link>dlib/matrix/matrix_la_abstract.h.html#pinv</link>
</item>
<item>
<name>svd</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd</link>
</item>
<item>
<name>svd2</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd2</link>
</item>
<item>
<name>svd3</name>
<link>dlib/matrix/matrix_la_abstract.h.html#svd3</link>
</item>
<item>
<name>det</name>
<link>dlib/matrix/matrix_la_abstract.h.html#det</link>
</item>
<item>
<name>trace</name>
<link>dlib/matrix/matrix_la_abstract.h.html#trace</link>
</item>
<item>
<name>dot</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#dot</link>
</item>
<item>
<name>length</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#length</link>
</item>
<item>
<name>length_squared</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#length_squared</link>
</item>
<item>
<name>trans</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#trans</link>
</item>
<item>
<name>diag</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#diag</link>
</item>
<item>
<name>diagm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#diagm</link>
</item>
<item>
<name>lowerm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#lowerm</link>
</item>
<item>
<name>upperm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#upperm</link>
</item>
<item>
<name>chol</name>
<link>dlib/matrix/matrix_la_abstract.h.html#chol</link>
</item>
<item>
<name>inv_lower_triangular</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv_lower_triangular</link>
</item>
<item>
<name>inv_upper_triangular</name>
<link>dlib/matrix/matrix_la_abstract.h.html#inv_upper_triangular</link>
</item>
<item>
<name>lu_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#lu_decomposition</link>
</item>
<item>
<name>qr_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#qr_decomposition</link>
</item>
<item>
<name>cholesky_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#cholesky_decomposition</link>
</item>
<item>
<name>eigenvalue_decomposition</name>
<link>dlib/matrix/matrix_la_abstract.h.html#eigenvalue_decomposition</link>
</item>
<item>
<name>real_eigenvalues</name>
<link>dlib/matrix/matrix_la_abstract.h.html#real_eigenvalues</link>
</item>
</sub>
</item>
<item nolink="true">
<name>Conversions</name>
<sub>
<item>
<name>matrix_cast</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#matrix_cast</link>
</item>
<item>
<name>array_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#array_to_matrix</link>
</item>
<item>
<name>vector_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#vector_to_matrix</link>
</item>
<item>
<name>pointer_to_column_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointer_to_column_vector</link>
</item>
<item>
<name>pointer_to_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointer_to_matrix</link>
</item>
<item>
<name>pixel_to_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pixel_to_vector</link>
</item>
<item>
<name>vector_to_pixel</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#vector_to_pixel</link>
</item>
</sub>
</item>
<item nolink="true">
<name>Sub_Matrix_Expressions</name>
<sub>
<item>
<name>range</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#range</link>
</item>
<item>
<name>subm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#subm</link>
</item>
<item>
<name>rowm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#rowm</link>
</item>
<item>
<name>colm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#colm</link>
</item>
<item>
<name>set_subm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_subm</link>
</item>
<item>
<name>set_colm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_colm</link>
</item>
<item>
<name>set_rowm</name>
<link>dlib/matrix/matrix_subexp_abstract.h.html#set_rowm</link>
</item>
</sub>
</item>
<item nolink="true">
<name>Statistics</name>
<sub>
<item>
<name>sum</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum</link>
</item>
<item>
<name>sum_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum_rows</link>
</item>
<item>
<name>sum_cols</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sum_cols</link>
</item>
<item>
<name>prod</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#prod</link>
</item>
<item>
<name>mean</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#mean</link>
</item>
<item>
<name>max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#max</link>
</item>
<item>
<name>min</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#min</link>
</item>
<item>
<name>find_min_and_max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#find_min_and_max</link>
</item>
<item>
<name>index_of_min</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#index_of_min</link>
</item>
<item>
<name>index_of_max</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#index_of_max</link>
</item>
<item>
<name>variance</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#variance</link>
</item>
<item>
<name>stddev</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#stddev</link>
</item>
<item>
<name>covariance</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#covariance</link>
</item>
<item>
<name>randm</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#randm</link>
</item>
</sub>
</item>
<item nolink="true">
<name>Other_Utilities</name>
<sub>
<item>
<name>is_col_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_col_vector</link>
</item>
<item>
<name>is_row_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_row_vector</link>
</item>
<item>
<name>is_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#is_vector</link>
</item>
<item>
<name>const_temp_matrix</name>
<link>dlib/matrix/matrix_abstract.h.html#const_temp_matrix</link>
</item>
<item>
<name>symmetric_matrix_cache</name>
<link>dlib/matrix/symmetric_matrix_cache_abstract.h.html</link>
</item>
<item>
<name>conv</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv</link>
</item>
<item>
<name>conv_same</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv_same</link>
</item>
<item>
<name>conv_valid</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#conv_valid</link>
</item>
<item>
<name>xcorr</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr</link>
</item>
<item>
<name>xcorr_same</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr_same</link>
</item>
<item>
<name>xcorr_valid</name>
<link>dlib/matrix/matrix_conv_abstract.h.html#xcorr_valid</link>
</item>
<item>
<name>flip</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#flip</link>
</item>
<item>
<name>flipud</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#flipud</link>
</item>
<item>
<name>fliplr</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#fliplr</link>
</item>
<item>
<name>make_symmetric</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#make_symmetric</link>
</item>
<item>
<name>ones_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#ones_matrix</link>
</item>
<item>
<name>zeros_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#zeros_matrix</link>
</item>
<item>
<name>uniform_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#uniform_matrix</link>
</item>
<item>
<name>identity_matrix</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#identity_matrix</link>
</item>
<item>
<name>rotate</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#rotate</link>
</item>
<item>
<name>reshape_to_column_vector</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#reshape_to_column_vector</link>
</item>
<item>
<name>reshape</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#reshape</link>
</item>
<item>
<name>removerc</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#removerc</link>
</item>
<item>
<name>remove_row</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#remove_row</link>
</item>
<item>
<name>remove_col</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#remove_col</link>
</item>
<item>
<name>set_all_elements</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#set_all_elements</link>
</item>
<item>
<name>hash</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#hash</link>
</item>
<item>
<name>tmp</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#tmp</link>
</item>
<item>
<name>equal</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#equal</link>
</item>
<item>
<name>pointwise_multiply</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#pointwise_multiply</link>
</item>
<item>
<name>join_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#join_rows</link>
</item>
<item>
<name>join_cols</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#join_cols</link>
</item>
<item>
<name>tensor_product</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#tensor_product</link>
</item>
<item>
<name>scale_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#scale_columns</link>
</item>
<item>
<name>scale_rows</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#scale_rows</link>
</item>
<item>
<name>sort_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#sort_columns</link>
</item>
<item>
<name>rsort_columns</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#rsort_columns</link>
</item>
<item>
<name>clamp</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#clamp</link>
</item>
<item>
<name>lowerbound</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#lowerbound</link>
</item>
<item>
<name>upperbound</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#upperbound</link>
</item>
<item>
<name>linspace</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#linspace</link>
</item>
<item>
<name>logspace</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#logspace</link>
</item>
<item>
<name>cartesian_product</name>
<link>dlib/matrix/matrix_utilities_abstract.h.html#cartesian_product</link>
</item>
</sub>
</item>
</section>
<section>
<name>2D/3D Geometry</name>
<item>border_enumerator</item>
<item>rectangle</item>
<item>vector</item>
<item>point</item>
<item>rotate_point</item>
<item>point_rotator</item>
<item>point_transform</item>
<item>point_transform_affine</item>
<item>rotation_matrix</item>
<item>get_rect</item>
<item>centered_rect</item>
<item>center</item>
<item>dcenter</item>
<item>shrink_rect</item>
<item>grow_rect</item>
<item>translate_rect</item>
<item>resize_rect</item>
<item>resize_rect_width</item>
<item>resize_rect_height</item>
<item>move_rect</item>
<item>nearest_point</item>
<item>distance_to_rect_edge</item>
</section>
</top>
</menu>
<!-- ************************************************************************* -->
<!-- ************************************************************************* -->
<!-- ************************************************************************* -->
<components>
<!-- ************************************************************************* -->
<component>
<name>matrix</name>
<file>dlib/matrix.h</file>
<spec_file link="true">dlib/matrix/matrix_abstract.h</spec_file>
<description>
This is a 2D matrix object that enables you to write code that deals with
matrices using a simple syntax similar to what can be written in MATLAB. It is implemented using
the <a href="matrix_expressions_ex.cpp.html">expression templates</a> technique which allows it to eliminate the
temporary matrix objects that would normally be returned from expressions
such as M = A+B+C+D; Normally each invocation of the + operator would
construct and return a temporary matrix object but using this technique
we can avoid creating all these temporary objects and receive a large speed boost.
<p>
This object is also capable of using BLAS and LAPACK libraries such as ATLAS or the Intel
MKL when available. To enable BLAS support all you have to do is #define
DLIB_USE_BLAS and then make sure you link your application with your
BLAS library. Similarly, to enable LAPACK support just #define DLIB_USE_LAPACK and
link to your LAPACK library. Finally, the use of BLAS and LAPACK is transparent to
the user, that is, the dlib matrix object uses BLAS and LAPACK internally to optimize
various operations while still allowing the user to use a simple MATLAB like syntax.
</p>
<p>
Note that the cmake files that come with dlib know how to link a project with ATLAS or
the Intel MKL if you are building on a linux system. The cmake files may also
work in a few other cases as well but I haven't tested any others. But in any
case, by no means are you required to use the dlib cmake files.
</p>
<p>
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>
<example>matrix_ex.cpp.html</example>
<example>matrix_expressions_ex.cpp.html</example>
</examples>
<extensions>
<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.
</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>
<extension>
<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.
</description>
</extension>
<extension>
<name>matrix_sub_expressions</name>
<spec_file>dlib/matrix/matrix_subexp_abstract.h</spec_file>
<description>
This extension contains a number of functions for dealing with sub-matrices.
</description>
</extension>
</extensions>
</component>
<!-- ************************************************************************* -->
<component>
<name>border_enumerator</name>
<file>dlib/geometry.h</file>
<spec_file>dlib/geometry/border_enumerator_abstract.h</spec_file>
<description>
This object is an <a href="containers.html#enumerable">enumerator</a>
over the border <a href="#point">points</a> of a
<a href="#rectangle">rectangle</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>nearest_point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and a
<a href="#point">point</a> and returns the point in the given
rectangle that is nearest to the given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>distance_to_rect_edge</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and a
<a href="#point">point</a> and returns the Manhattan distance between
the rectangle's edge and the point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>move_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and moves
it so that it's upper left corner occupies the given location.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect_height</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given height but otherwise with the
same edge points as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect_width</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given width but otherwise with the
same edge points as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>resize_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and
returns a new rectangle with the given size but with the same upper
left corner as the original rectangle.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>translate_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> and moves
it by a given number of units along the x and y axis relative to
where it was before the move.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>center</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
Returns the center point of a <a href="#rectangle">rectangle</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>dcenter</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
Returns the center point of a <a href="#rectangle">rectangle</a>. This
is a version of <a href="#center">center()</a> which returns a double version
of the point rather than one which uses integers to represent the
result. Therefore, it is slightly more accurate.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>centered_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
There are various overloads of this function but the basic idea is
that it returns a <a href="#rectangle">rectangle</a> with a given
width and height and centered about a given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>shrink_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> object,
shrinks its borders by a given amount, and returns the result.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>grow_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This function takes a <a href="#rectangle">rectangle</a> object,
grows its borders by a given amount, and returns the result.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotate_point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is a function that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about a given point.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_rotator</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about the origin.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_transform</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that rotates a 2D <a href="#vector">vector</a> or
<a href="#point">point</a> object about the origin and then adds a
displacement vector.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point_transform_affine</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is an object that applies an affine transformation to a <a href="#vector">vector</a> or
<a href="#point">point</a>.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rotation_matrix</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This is a method for creating 2D rotation matrices.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>get_rect</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This is a simple template function that returns a rectangle
representing the size of a 2D container (e.g. <a href="containers.html#matrix">matrix</a> or
<a href="containers.html#array2d">array2d</a>).
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>rectangle</name>
<file>dlib/geometry.h</file>
<spec_file>dlib/geometry/rectangle_abstract.h</spec_file>
<description>
This object represents a rectangular region inside a Cartesian
coordinate system. It allows you to easily represent and manipulate
rectangles.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>vector</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This object represents a two or three dimensional vector.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>point</name>
<file>dlib/geometry.h</file>
<spec_file link="true">dlib/geometry/vector_abstract.h</spec_file>
<description>
This object represents a point inside a Cartesian coordinate system.
Note that a point is simply a typedef for a <a href="#vector">vector</a>
that is 2D and uses longs to represent coordinate values.
</description>
</component>
<!-- ************************************************************************* -->
</components>
<!-- ************************************************************************* -->
</doc>
docs/docs/main_menu.xml
View file @ cc0b205d
......@@ -25,6 +25,11 @@
<link>ml.html</link>
<chm_sub>ml.xml</chm_sub>
</item>
<item>
<name>Linear Algebra</name>
<link>linear_algebra.html</link>
<chm_sub>linear_algebra.xml</chm_sub>
</item>
<item>
<name>Bayesian Nets</name>
<link>bayes.html</link>
......
docs/docs/metaprogramming.xml
View file @ cc0b205d
......@@ -392,7 +392,7 @@
<spec_file link="true">dlib/is_kind.h</spec_file>
<description>
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.
</description>
......
docs/docs/ml.xml
View file @ cc0b205d
......@@ -32,7 +32,7 @@
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
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>.
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
......
docs/docs/term_index.xml
View file @ cc0b205d
......@@ -15,18 +15,20 @@
<term file="dlib/algs.h.html" name="stack_based_memory_block"/>
<term file="algorithms.html" name="move_rect"/>
<term file="algorithms.html" name="translate_rect"/>
<term file="algorithms.html" name="resize_rect"/>
<term file="algorithms.html" name="resize_rect_width"/>
<term file="algorithms.html" name="resize_rect_height"/>
<term file="algorithms.html" name="centered_rect"/>
<term file="algorithms.html" name="center"/>
<term file="algorithms.html" name="nearest_point"/>
<term file="algorithms.html" name="distance_to_rect_edge"/>
<term file="algorithms.html" name="shrink_rect"/>
<term file="algorithms.html" name="grow_rect"/>
<term file="algorithms.html" name="dcenter"/>
<term file="linear_algebra.html" name="matrix"/>
<term file="linear_algebra.html" name="move_rect"/>
<term file="linear_algebra.html" name="translate_rect"/>
<term file="linear_algebra.html" name="resize_rect"/>
<term file="linear_algebra.html" name="resize_rect_width"/>
<term file="linear_algebra.html" name="resize_rect_height"/>
<term file="linear_algebra.html" name="centered_rect"/>
<term file="linear_algebra.html" name="center"/>
<term file="linear_algebra.html" name="nearest_point"/>
<term file="linear_algebra.html" name="distance_to_rect_edge"/>
<term file="linear_algebra.html" name="shrink_rect"/>
<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="rls_filter"/>
......@@ -150,8 +152,8 @@
<term file="algorithms.html" name="randomly_sample_image_features"/>
<term file="algorithms.html" name="disjoint_subsets"/>
<term link="algorithms.html#disjoint_subsets" name="union-find"/>
<term file="algorithms.html" name="rectangle"/>
<term file="algorithms.html" name="border_enumerator"/>
<term file="linear_algebra.html" name="rectangle"/>
<term file="linear_algebra.html" name="border_enumerator"/>
<term file="graph_tools.html" name="edge"/>
<term file="graph_tools.html" name="is_join_tree"/>
<term file="graph_tools.html" name="create_join_tree"/>
......@@ -182,13 +184,13 @@
<term file="graph_tools.html" name="is_clique"/>
<term file="graph_tools.html" name="is_maximal_clique"/>
<term file="algorithms.html" name="square_root"/>
<term file="algorithms.html" name="vector"/>
<term file="algorithms.html" name="point"/>
<term file="algorithms.html" name="rotate_point"/>
<term file="algorithms.html" name="point_rotator"/>
<term file="algorithms.html" name="point_transform"/>
<term file="algorithms.html" name="point_transform_affine"/>
<term file="algorithms.html" name="rotation_matrix"/>
<term file="linear_algebra.html" name="vector"/>
<term file="linear_algebra.html" name="point"/>
<term file="linear_algebra.html" name="rotate_point"/>
<term file="linear_algebra.html" name="point_rotator"/>
<term file="linear_algebra.html" name="point_transform"/>
<term file="linear_algebra.html" name="point_transform_affine"/>
<term file="linear_algebra.html" name="rotation_matrix"/>
<term file="algorithms.html" name="running_stats"/>
<term file="algorithms.html" name="running_scalar_covariance"/>
<term file="algorithms.html" name="mean_sign_agreement"/>
......@@ -369,7 +371,6 @@
<term file="containers.html" name="directed_graph"/>
<term file="containers.html" name="array"/>
<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="map_pair"/>
<term file="containers.html" name="map"/>
......@@ -825,7 +826,7 @@
<term name="get_rect">
<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 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