|
<html><head><title>dlib C++ Library - any_decision_function_abstract.h</title></head><body bgcolor='white'><pre> |
|
<font color='#009900'>// Copyright (C) 2010 Davis E. King ([email protected]) |
|
</font><font color='#009900'>// License: Boost Software License See LICENSE.txt for the full license. |
|
</font><font color='#0000FF'>#undef</font> DLIB_AnY_DECISION_FUNCTION_ABSTRACT_H_ |
|
<font color='#0000FF'>#ifdef</font> DLIB_AnY_DECISION_FUNCTION_ABSTRACT_H_ |
|
|
|
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='any_abstract.h.html'>any_abstract.h</a>" |
|
<font color='#0000FF'>#include</font> "<a style='text-decoration:none' href='../algs.h.html'>../algs.h</a>" |
|
|
|
<font color='#0000FF'>namespace</font> dlib |
|
<b>{</b> |
|
|
|
<font color='#009900'>// ---------------------------------------------------------------------------------------- |
|
</font> |
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font> |
|
<font color='#0000FF'>typename</font> sample_type_, |
|
<font color='#0000FF'>typename</font> result_type_ <font color='#5555FF'>=</font> <font color='#0000FF'><u>double</u></font> |
|
<font color='#5555FF'>></font> |
|
<font color='#0000FF'>class</font> <b><a name='any_decision_function'></a>any_decision_function</b> |
|
<b>{</b> |
|
<font color='#009900'>/*! |
|
INITIAL VALUE |
|
- is_empty() == true |
|
- for all T: contains<T>() == false |
|
|
|
WHAT THIS OBJECT REPRESENTS |
|
This object is a version of dlib::any that is restricted to containing |
|
elements which are some kind of function object with an operator() with |
|
the following signature: |
|
result_type operator()(const sample_type&) const |
|
|
|
It is intended to be used to contain dlib::decision_function objects and |
|
other types which represent learned decision functions. It allows you |
|
to write code which contains and processes these decision functions |
|
without needing to know the specific types of decision functions used. |
|
!*/</font> |
|
|
|
<font color='#0000FF'>public</font>: |
|
|
|
<font color='#0000FF'>typedef</font> sample_type_ sample_type; |
|
<font color='#0000FF'>typedef</font> result_type_ result_type; |
|
<font color='#0000FF'>typedef</font> default_memory_manager mem_manager_type; |
|
|
|
<b><a name='any_decision_function'></a>any_decision_function</b><font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- this object is properly initialized |
|
!*/</font> |
|
|
|
<b><a name='any_decision_function'></a>any_decision_function</b> <font face='Lucida Console'>(</font> |
|
<font color='#0000FF'>const</font> any_decision_function<font color='#5555FF'>&</font> item |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- copies the state of item into *this. |
|
- Note that *this and item will contain independent copies of the |
|
contents of item. That is, this function performs a deep |
|
copy and therefore does not result in *this containing |
|
any kind of reference to item. |
|
!*/</font> |
|
|
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font> <font color='#0000FF'>typename</font> T <font color='#5555FF'>></font> |
|
<b><a name='any_decision_function'></a>any_decision_function</b> <font face='Lucida Console'>(</font> |
|
<font color='#0000FF'>const</font> T<font color='#5555FF'>&</font> item |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- #contains<T>() == true |
|
- #cast_to<T>() == item |
|
(i.e. a copy of item will be stored in *this) |
|
!*/</font> |
|
|
|
<font color='#0000FF'><u>void</u></font> <b><a name='clear'></a>clear</b> <font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- #*this will have its default value. I.e. #is_empty() == true |
|
!*/</font> |
|
|
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font><font color='#0000FF'>typename</font> T<font color='#5555FF'>></font> |
|
<font color='#0000FF'><u>bool</u></font> <b><a name='contains'></a>contains</b> <font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- if (this object currently contains an object of type T) then |
|
- returns true |
|
- else |
|
- returns false |
|
!*/</font> |
|
|
|
<font color='#0000FF'><u>bool</u></font> <b><a name='is_empty'></a>is_empty</b><font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- if (this object contains any kind of object) then |
|
- returns false |
|
- else |
|
- returns true |
|
!*/</font> |
|
|
|
result_type <b><a name='operator'></a>operator</b><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font> <font face='Lucida Console'>(</font> |
|
<font color='#0000FF'>const</font> sample_type<font color='#5555FF'>&</font> item |
|
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>; |
|
<font color='#009900'>/*! |
|
requires |
|
- is_empty() == false |
|
ensures |
|
- Let F denote the function object contained within *this. Then |
|
this function performs: |
|
return F(item) |
|
!*/</font> |
|
|
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font><font color='#0000FF'>typename</font> T<font color='#5555FF'>></font> |
|
T<font color='#5555FF'>&</font> <b><a name='cast_to'></a>cast_to</b><font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- if (contains<T>() == true) then |
|
- returns a non-const reference to the object contained within *this |
|
- else |
|
- throws bad_any_cast |
|
!*/</font> |
|
|
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font><font color='#0000FF'>typename</font> T<font color='#5555FF'>></font> |
|
<font color='#0000FF'>const</font> T<font color='#5555FF'>&</font> <b><a name='cast_to'></a>cast_to</b><font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font> <font color='#0000FF'>const</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- if (contains<T>() == true) then |
|
- returns a const reference to the object contained within *this |
|
- else |
|
- throws bad_any_cast |
|
!*/</font> |
|
|
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font><font color='#0000FF'>typename</font> T<font color='#5555FF'>></font> |
|
T<font color='#5555FF'>&</font> <b><a name='get'></a>get</b><font face='Lucida Console'>(</font> |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- #is_empty() == false |
|
- #contains<T>() == true |
|
- if (contains<T>() == true) |
|
- returns a non-const reference to the object contained in *this. |
|
- else |
|
- Constructs an object of type T inside *this |
|
- Any previous object stored in this any_decision_function object is destructed and its |
|
state is lost. |
|
- returns a non-const reference to the newly created T object. |
|
!*/</font> |
|
|
|
any_decision_function<font color='#5555FF'>&</font> <b><a name='operator'></a>operator</b><font color='#5555FF'>=</font> <font face='Lucida Console'>(</font> |
|
<font color='#0000FF'>const</font> any_decision_function<font color='#5555FF'>&</font> item |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- copies the state of item into *this. |
|
- Note that *this and item will contain independent copies of the |
|
contents of item. That is, this function performs a deep |
|
copy and therefore does not result in *this containing |
|
any kind of reference to item. |
|
!*/</font> |
|
|
|
<font color='#0000FF'><u>void</u></font> <b><a name='swap'></a>swap</b> <font face='Lucida Console'>(</font> |
|
any_decision_function<font color='#5555FF'>&</font> item |
|
<font face='Lucida Console'>)</font>; |
|
<font color='#009900'>/*! |
|
ensures |
|
- swaps *this and item |
|
!*/</font> |
|
|
|
<b>}</b>; |
|
|
|
<font color='#009900'>// ---------------------------------------------------------------------------------------- |
|
</font> |
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font> |
|
<font color='#0000FF'>typename</font> sample_type, |
|
<font color='#0000FF'>typename</font> result_type |
|
<font color='#5555FF'>></font> |
|
<font color='#0000FF'>inline</font> <font color='#0000FF'><u>void</u></font> <b><a name='swap'></a>swap</b> <font face='Lucida Console'>(</font> |
|
any_decision_function<font color='#5555FF'><</font>sample_type,result_type<font color='#5555FF'>></font><font color='#5555FF'>&</font> a, |
|
any_decision_function<font color='#5555FF'><</font>sample_type,result_type<font color='#5555FF'>></font><font color='#5555FF'>&</font> b |
|
<font face='Lucida Console'>)</font> <b>{</b> a.<font color='#BB00BB'>swap</font><font face='Lucida Console'>(</font>b<font face='Lucida Console'>)</font>; <b>}</b> |
|
<font color='#009900'>/*! |
|
provides a global swap function |
|
!*/</font> |
|
|
|
<font color='#009900'>// ---------------------------------------------------------------------------------------- |
|
</font> |
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font> |
|
<font color='#0000FF'>typename</font> T, |
|
<font color='#0000FF'>typename</font> sample_type, |
|
<font color='#0000FF'>typename</font> result_type |
|
<font color='#5555FF'>></font> |
|
T<font color='#5555FF'>&</font> <b><a name='any_cast'></a>any_cast</b><font face='Lucida Console'>(</font> |
|
any_decision_function<font color='#5555FF'><</font>sample_type,result_type<font color='#5555FF'>></font><font color='#5555FF'>&</font> a |
|
<font face='Lucida Console'>)</font> <b>{</b> <font color='#0000FF'>return</font> a.cast_to<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font>; <b>}</b> |
|
<font color='#009900'>/*! |
|
ensures |
|
- returns a.cast_to<T>() |
|
!*/</font> |
|
|
|
<font color='#009900'>// ---------------------------------------------------------------------------------------- |
|
</font> |
|
<font color='#0000FF'>template</font> <font color='#5555FF'><</font> |
|
<font color='#0000FF'>typename</font> T, |
|
<font color='#0000FF'>typename</font> sample_type, |
|
<font color='#0000FF'>typename</font> result_type |
|
<font color='#5555FF'>></font> |
|
<font color='#0000FF'>const</font> T<font color='#5555FF'>&</font> <b><a name='any_cast'></a>any_cast</b><font face='Lucida Console'>(</font> |
|
<font color='#0000FF'>const</font> any_decision_function<font color='#5555FF'><</font>sample_type,result_type<font color='#5555FF'>></font><font color='#5555FF'>&</font> a |
|
<font face='Lucida Console'>)</font> <b>{</b> <font color='#0000FF'>return</font> a.cast_to<font color='#5555FF'><</font>T<font color='#5555FF'>></font><font face='Lucida Console'>(</font><font face='Lucida Console'>)</font>; <b>}</b> |
|
<font color='#009900'>/*! |
|
ensures |
|
- returns a.cast_to<T>() |
|
!*/</font> |
|
|
|
<font color='#009900'>// ---------------------------------------------------------------------------------------- |
|
</font> |
|
<b>}</b> |
|
|
|
<font color='#0000FF'>#endif</font> <font color='#009900'>// DLIB_AnY_DECISION_FUNCTION_ABSTRACT_H_ |
|
</font> |
|
|
|
|
|
|
|
</pre></body></html> |
