NextCloud/dlib
1
0
Fork 0
mirror of https://github.com/davisking/dlib.git synced 2024-11-01 10:14:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Davis King 2016-08-13 09:26:33 -04:00
parent cdb181920a
commit 3390697315
3 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/docs/api.xml
View File

@ -643,6 +643,8 @@
<item>auto_unlock_readonly</item>
<item>threaded_object</item>
<item>thread_pool</item>
<item>async</item>
<item>default_thread_pool</item>
<item>parallel_for</item>
<item>
<name>future</name>
@ -1124,6 +1126,30 @@
</examples>
</extension>
<extension>
<name>default_thread_pool</name>
<spec_file link="true">dlib/threads/async_abstract.h</spec_file>
<description>
This function returns a reference to a global <a href="#thread_pool">thread_pool</a>. If the DLIB_NUM_THREADS
environment variable is set to an integer then the thread pool will contain
DLIB_NUM_THREADS threads, otherwise it will contain
std::thread::hardware_concurrency() threads.
</description>
</extension>
<extension>
<name>async</name>
<spec_file link="true">dlib/threads/async_abstract.h</spec_file>
<description>
This function behaves just like std::async()
except that instead of spawning a new thread to process each task it submits
the task to a <a href="#thread_pool">dlib::thread_pool</a>. Therefore, dlib::async() is
guaranteed to use a bounded number of threads unlike std::async(). This also
means that calls to dlib::async() will block if there aren't any free threads
in the thread pool.
</description>
</extension>
<extension>
<name>parallel_for</name>
<spec_file>dlib/threads/parallel_for_extension_abstract.h</spec_file>

18
docs/docs/imaging.xml
View File

@ -38,6 +38,9 @@
<ul>The <a href="#hsi_pixel">hsi_pixel</a> is a 24bit pixel which represents a point in the Hue Saturation Intensity
(HSI) color space. </ul>
</li>
<li><b>LAB</b>
<ul>The <a href="#lab_pixel">lab_pixel</a> is a 24bit pixel which represents a point in the CIELab color space. </ul>
</li>
<li><b>Grayscale</b>
<ul>Any built in scalar type may be used as a grayscale pixel type. For example, unsigned char, int, double, etc.</ul>
</li>
@ -64,6 +67,7 @@
<item>bgr_pixel</item>
<item>rgb_alpha_pixel</item>
<item>hsi_pixel</item>
<item>lab_pixel</item>
<item>pixel_traits</item>
<item>get_pixel_intensity</item>
<item>assign_pixel</item>
@ -737,7 +741,19 @@
<file>dlib/pixel.h</file>
<spec_file link="true">dlib/pixel.h</spec_file>
<description>
This is a simple struct that represents an HSI colored graphical pixel.
This is a simple struct that represents a HSI colored graphical pixel.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>lab_pixel</name>
<file>dlib/pixel.h</file>
<spec_file link="true">dlib/pixel.h</spec_file>
<description>
This is a simple struct that represents a CIELab colored graphical pixel.
</description>
</component>

4
docs/docs/term_index.xml
View File

@ -918,6 +918,9 @@
<term file="api.html" name="thread_specific_data" include="dlib/threads.h"/>
<term file="api.html" name="threaded_object" include="dlib/threads.h"/>
<term file="api.html" name="thread_pool" include="dlib/threads.h"/>
<term file="api.html" name="async" include="dlib/threads.h"/>
<term file="api.html" name="default_thread_pool" include="dlib/threads.h"/>
<term link="api.html#default_thread_pool" name="DLIB_NUM_THREADS" />
<term file="api.html" name="parallel_for" include="dlib/threads.h"/>
<term link="api.html#parallel_for" name="parallel_for_blocked" include="dlib/threads.h"/>
<term link="api.html#parallel_for" name="parallel_for_verbose" include="dlib/threads.h"/>
@ -1364,6 +1367,7 @@
<term file="imaging.html" name="equalize_histogram" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="get_histogram" include="dlib/image_transforms.h"/>
<term file="imaging.html" name="hsi_pixel" include="dlib/pixel.h"/>
<term file="imaging.html" name="lab_pixel" include="dlib/pixel.h"/>
<term file="imaging.html" name="load_bmp" include="dlib/image_io.h"/>
<term file="imaging.html" name="load_png" include="dlib/image_io.h"/>
<term file="imaging.html" name="load_jpeg" include="dlib/image_io.h"/>