Commit dc907c33 authored by Davis King's avatar Davis King

updated docs

parent 138be05d
...@@ -38,6 +38,7 @@ ...@@ -38,6 +38,7 @@
<item>numeric_constants</item> <item>numeric_constants</item>
<item>put_in_range</item> <item>put_in_range</item>
<item>qsort_array</item> <item>qsort_array</item>
<item>split_array</item>
<item>integrate_function_adapt_simp</item> <item>integrate_function_adapt_simp</item>
<item>square_root</item> <item>square_root</item>
<item nolink="true"> <item nolink="true">
...@@ -668,6 +669,20 @@ ...@@ -668,6 +669,20 @@
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>split_array</name>
<file>dlib/array.h</file>
<spec_file link="true">dlib/array/array_tools_abstract.h</spec_file>
<description>
This function is used to efficiently split <a href="containers.html#array">array</a>
like objects into two parts. It uses the global swap() function instead
of copying to move elements around, so it works on arrays of non-copyable
types.
</description>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component> <component>
......
...@@ -202,6 +202,7 @@ ...@@ -202,6 +202,7 @@
<term file="algorithms.html" name="median" include="dlib/algs.h"/> <term file="algorithms.html" name="median" include="dlib/algs.h"/>
<term file="algorithms.html" name="qsort_array" include="dlib/sort.h"/> <term file="algorithms.html" name="qsort_array" include="dlib/sort.h"/>
<term file="algorithms.html" name="split_array" include="dlib/array.h"/>
<term file="algorithms.html" name="rand" include="dlib/rand.h"/> <term file="algorithms.html" name="rand" include="dlib/rand.h"/>
<term link="algorithms.html#rand" name="Mersenne Twister" include="dlib/rand.h"/> <term link="algorithms.html#rand" name="Mersenne Twister" include="dlib/rand.h"/>
<term file="graph_tools.html" name="graph_contains_undirected_cycle" include="dlib/graph_utils.h"/> <term file="graph_tools.html" name="graph_contains_undirected_cycle" include="dlib/graph_utils.h"/>
......
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