diff options
Diffstat (limited to 'doc/html/boost/CV/constrained_value.html')
-rw-r--r-- | doc/html/boost/CV/constrained_value.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/html/boost/CV/constrained_value.html b/doc/html/boost/CV/constrained_value.html index e111393cda..ef7c642874 100644 --- a/doc/html/boost/CV/constrained_value.html +++ b/doc/html/boost/CV/constrained_value.html @@ -39,53 +39,53 @@ <span class="keyword">typedef</span> <span class="identifier">value_policies</span><span class="special">::</span><span class="identifier">value_type</span> <a name="boost.CV.constrained_value.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="constrained_value.html#boost.CV.constrained_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="constrained_value.html#idp729244112-bb"><span class="identifier">constrained_value</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="constrained_value.html" title="Class template constrained_value">constrained_value</a> <span class="special">&</span> <a class="link" href="constrained_value.html#idp729245088-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="constrained_value.html#idp494904896-bb"><span class="identifier">constrained_value</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="constrained_value.html" title="Class template constrained_value">constrained_value</a> <span class="special">&</span> <a class="link" href="constrained_value.html#idp494905872-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="constrained_value.html#idp729241968-bb">public member functions</a></span> - <a class="link" href="constrained_value.html#idp729242528-bb"><span class="keyword">operator</span> <span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="constrained_value.html#idp494902752-bb">public member functions</a></span> + <a class="link" href="constrained_value.html#idp494903312-bb"><span class="keyword">operator</span> <span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="constrained_value.html#idp729246640-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">max</span> <a class="link" href="constrained_value.html#idp729247200-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">min</span> <a class="link" href="constrained_value.html#idp729248656-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="constrained_value.html#idp494907424-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">max</span> <a class="link" href="constrained_value.html#idp494907984-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">min</span> <a class="link" href="constrained_value.html#idp494909440-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="constrained_value.html#idp729250272-bb">private member functions</a></span> - <span class="keyword">void</span> <a class="link" href="constrained_value.html#idp729250848-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="constrained_value.html#idp494911056-bb">private member functions</a></span> + <span class="keyword">void</span> <a class="link" href="constrained_value.html#idp494911632-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="identifier">value_type</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp309928048"></a><h2>Description</h2> +<a name="idp215018320"></a><h2>Description</h2> <p>This template provides a quick way to generate an integer type with a constrained range. The type provides for the ability to specify the min, max, and and error handling policy.</p> <p><span class="bold"><strong>value policies</strong></span> A class that provides the range limits via the min and max functions as well as a function on_error that determines how errors are handled. A common strategy would be to assert or throw and exception. The on_error is passed both the current value and the new value that is in error. </p> <div class="refsect2"> -<a name="idp309930032"></a><h3> +<a name="idp215020304"></a><h3> <a name="boost.CV.constrained_valueconstruct-copy-destruct"></a><code class="computeroutput">constrained_value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp729244112-bb"></a><span class="identifier">constrained_value</span><span class="special">(</span><span class="identifier">value_type</span> value<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="constrained_value.html" title="Class template constrained_value">constrained_value</a> <span class="special">&</span> <a name="idp729245088-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">value_type</span> v<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp494904896-bb"></a><span class="identifier">constrained_value</span><span class="special">(</span><span class="identifier">value_type</span> value<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="constrained_value.html" title="Class template constrained_value">constrained_value</a> <span class="special">&</span> <a name="idp494905872-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">value_type</span> v<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp309942912"></a><h3> -<a name="idp729241968-bb"></a><code class="computeroutput">constrained_value</code> public member functions</h3> +<a name="idp215033312"></a><h3> +<a name="idp494902752-bb"></a><code class="computeroutput">constrained_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp729242528-bb"></a><span class="keyword">operator</span> <span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Coerce into the representation type. </li></ol></div> +<pre class="literallayout"><a name="idp494903312-bb"></a><span class="keyword">operator</span> <span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Coerce into the representation type. </li></ol></div> </div> <div class="refsect2"> -<a name="idp309950272"></a><h3> -<a name="idp729246640-bb"></a><code class="computeroutput">constrained_value</code> public static functions</h3> +<a name="idp215040672"></a><h3> +<a name="idp494907424-bb"></a><code class="computeroutput">constrained_value</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">max</span> <a name="idp729247200-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Return the max allowed value (traits method) </li> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">max</span> <a name="idp494907984-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Return the max allowed value (traits method) </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">min</span> <a name="idp729248656-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Return the min allowed value (traits method) </li> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">value_type</span> <span class="identifier">min</span> <a name="idp494909440-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Return the min allowed value (traits method) </li> </ol></div> </div> <div class="refsect2"> -<a name="idp309964176"></a><h3> -<a name="idp729250272-bb"></a><code class="computeroutput">constrained_value</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp729250848-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">value_type</span> value<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<a name="idp215054576"></a><h3> +<a name="idp494911056-bb"></a><code class="computeroutput">constrained_value</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp494911632-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="identifier">value_type</span> value<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> |