Skip to content

GitLab

Commit 4a4a8e97 authored by Davis King's avatar Davis King
Browse files

updated docs

parent 6e4c77cd
Hide whitespace changes
Inline Side-by-side
Showing with 73 additions and 11 deletions
docs/docs/algorithms.xml
View file @ 4a4a8e97
...@@ -42,9 +42,13 @@ ...@@ -42,9 +42,13 @@
<item>point</item> <item>point</item>
<item>rotate_point</item> <item>rotate_point</item>
<item>point_rotator</item> <item>point_rotator</item>
<item>point_transform</item>
<item>point_transform_affine</item>
<item>rotation_matrix</item>
<item>get_rect</item> <item>get_rect</item>
<item>centered_rect</item> <item>centered_rect</item>
<item>center</item> <item>center</item>
<item>dcenter</item>
<item>shrink_rect</item> <item>shrink_rect</item>
<item>grow_rect</item> <item>grow_rect</item>
<item>translate_rect</item> <item>translate_rect</item>
...@@ -938,6 +942,21 @@ ...@@ -938,6 +942,21 @@
</component> </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> <component>
...@@ -1004,6 +1023,45 @@ ...@@ -1004,6 +1023,45 @@
</component> </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> <component>
......
docs/docs/term_index.xml
View file @ 4a4a8e97
...@@ -15,17 +15,18 @@ ...@@ -15,17 +15,18 @@
<term file="dlib/algs.h.html" name="stack_based_memory_block"/> <term file="dlib/algs.h.html" name="stack_based_memory_block"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="move_rect"/> <term file="algorithms.html" name="move_rect"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="translate_rect"/> <term file="algorithms.html" name="translate_rect"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="resize_rect"/> <term file="algorithms.html" name="resize_rect"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="resize_rect_width"/> <term file="algorithms.html" name="resize_rect_width"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="resize_rect_height"/> <term file="algorithms.html" name="resize_rect_height"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="centered_rect"/> <term file="algorithms.html" name="centered_rect"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="center"/> <term file="algorithms.html" name="center"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="nearest_point"/> <term file="algorithms.html" name="nearest_point"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="distance_to_rect_edge"/> <term file="algorithms.html" name="distance_to_rect_edge"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="shrink_rect"/> <term file="algorithms.html" name="shrink_rect"/>
<term file="dlib/geometry/rectangle_abstract.h.html" name="grow_rect"/> <term file="algorithms.html" name="grow_rect"/>
<term file="algorithms.html" name="dcenter"/>
<term file="dlib/optimization/optimization_abstract.h.html" name="central_differences"/> <term file="dlib/optimization/optimization_abstract.h.html" name="central_differences"/>
...@@ -150,6 +151,9 @@ ...@@ -150,6 +151,9 @@
<term file="algorithms.html" name="point"/> <term file="algorithms.html" name="point"/>
<term file="algorithms.html" name="rotate_point"/> <term file="algorithms.html" name="rotate_point"/>
<term file="algorithms.html" name="point_rotator"/> <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="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"/>
......
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