Sophie

Sophie

distrib > Mageia > 1 > i586 > by-pkgid > 64656f00434e190abe8506174ca339ed > files > 716

ucommon-doc-4.3.1-1.mga1.i586.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: ucommon/numbers.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">ucommon</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00190.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>ucommon/numbers.h File Reference</h1>  </div>
</div>
<div class="contents">

<p>Support classes for manipulation of numbers as strings.  
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include &lt;ucommon/platform.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for numbers.h:</div>
<div class="dyncontent">
<div class="center"><img src="a00236.png" border="0" usemap="#ucommon_2numbers_8h" alt=""/></div>
<map name="ucommon_2numbers_8h" id="ucommon_2numbers_8h">
</map>
</div>
</div>
<p><a href="a00190_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html">Number</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A number manipulation class.  <a href="a00090.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html">ZNumber</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A number manipulation class that maintains a zero lead filled string.  <a href="a00175.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c6561760aa04325f8ff22f042fe070d"></a><!-- doxytag: member="numbers.h::number_t" ref="a6c6561760aa04325f8ff22f042fe070d" args="" -->
typedef <a class="el" href="a00090.html">Number</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#a6c6561760aa04325f8ff22f042fe070d">number_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A convenience type for number. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6168d5d5da44f957d29437b249236c53"></a><!-- doxytag: member="numbers.h::znumber_t" ref="a6168d5d5da44f957d29437b249236c53" args="" -->
typedef <a class="el" href="a00175.html">ZNumber</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00190.html#a6168d5d5da44f957d29437b249236c53">znumber_t</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A convenience type for znumber. <br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">const T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#a4f458ace8bb9c59901f92a6cbc450902">abs</a> (const T &amp;value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Template for absolute value of a type.  <a href="#a4f458ace8bb9c59901f92a6cbc450902"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">const T()&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#a19cce48e3a02fe4b47f5b3dfec520b54">max</a> (const T &amp;v1, const T &amp;v2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Template for max value of a type.  <a href="#a19cce48e3a02fe4b47f5b3dfec520b54"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">const T()&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00190.html#a251aa3e728ea0ae9b59e7423653a722d">min</a> (const T &amp;v1, const T &amp;v2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Template for min value of a type.  <a href="#a251aa3e728ea0ae9b59e7423653a722d"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Support classes for manipulation of numbers as strings. </p>
<p>This is used for things which parse numbers out of strings, such as in the date and time classes. Other useful math related functions, templates, and macros may also be found here. </p>

<p>Definition in file <a class="el" href="a00190_source.html">numbers.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a4f458ace8bb9c59901f92a6cbc450902"></a><!-- doxytag: member="numbers.h::abs" ref="a4f458ace8bb9c59901f92a6cbc450902" args="(const T &amp;value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T abs </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Template for absolute value of a type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>absolute value </dd></dl>

<p>Definition at line <a class="el" href="a00190_source.html#l00188">188</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a19cce48e3a02fe4b47f5b3dfec520b54"></a><!-- doxytag: member="numbers.h::max" ref="a19cce48e3a02fe4b47f5b3dfec520b54" args="(const T &amp;v1, const T &amp;v2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T() max </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>v1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>v2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Template for max value of a type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">v1</td><td>value to check </td></tr>
    <tr><td class="paramname">v2</td><td>value to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>v1 if &gt; v2, else v2 </dd></dl>

<p>Definition at line <a class="el" href="a00190_source.html#l00215">215</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>

</div>
</div>
<a class="anchor" id="a251aa3e728ea0ae9b59e7423653a722d"></a><!-- doxytag: member="numbers.h::min" ref="a251aa3e728ea0ae9b59e7423653a722d" args="(const T &amp;v1, const T &amp;v2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const T() min </td>
          <td>(</td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>v1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const T &amp;&#160;</td>
          <td class="paramname"><em>v2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Template for min value of a type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">v1</td><td>value to check </td></tr>
    <tr><td class="paramname">v2</td><td>value to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>v1 if &lt; v2, else v2 </dd></dl>

<p>Definition at line <a class="el" href="a00190_source.html#l00203">203</a> of file <a class="el" href="a00190_source.html">numbers.h</a>.</p>

</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00190.html">numbers.h</a>      </li>
      <li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>