pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Formatter.util.number</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.5.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> <script src="http://yui.yahooapis.com/combo?3.5.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title=""></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: </em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/cultures.deAT.html">cultures.deAT</a></li> <li><a href="../classes/cultures.deDE.html">cultures.deDE</a></li> <li><a href="../classes/cultures.enUS.html">cultures.enUS</a></li> <li><a href="../classes/flavors.java.html">flavors.java</a></li> <li><a href="../classes/flavors.java.Formatter.html">flavors.java.Formatter</a></li> <li><a href="../classes/flavors.java.Formatter.number.html">flavors.java.Formatter.number</a></li> <li><a href="../classes/flavors.java.Formatter.number.localize.html">flavors.java.Formatter.number.localize</a></li> <li><a href="../classes/flavors.java.Formatter.util.html">flavors.java.Formatter.util</a></li> <li><a href="../classes/flavors.java.Parser.html">flavors.java.Parser</a></li> <li><a href="../classes/flavors.java.Scanner.html">flavors.java.Scanner</a></li> <li><a href="../classes/flavors.java.Scanner.tokenCategories.html">flavors.java.Scanner.tokenCategories</a></li> <li><a href="../classes/Formatter.html">Formatter</a></li> <li><a href="../classes/Formatter.date.html">Formatter.date</a></li> <li><a href="../classes/Formatter.number.html">Formatter.number</a></li> <li><a href="../classes/Formatter.util.html">Formatter.util</a></li> <li><a href="../classes/Formatter.util.date.html">Formatter.util.date</a></li> <li><a href="../classes/Formatter.util.number.html">Formatter.util.number</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/cultures.html">cultures</a></li> <li><a href="../modules/flavors.html">flavors</a></li> <li><a href="../modules/pat.html">pat</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>Formatter.util.number Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_pat.js.html#l548"><code>../lib/pat.js:548</code></a> </div> Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Number utility functions.</p> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_isSigned">isSigned</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_isSymbolicNumber">isSymbolicNumber</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_round">round</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_signedInt">signedInt</a> <span class="flag static">static</span> </li> <li class="index-item method"> <a href="#method_twosComplement">twosComplement</a> <span class="flag static">static</span> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property"> <a href="#property_MAX_INT">MAX_INT</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_MAX_SIGNED_INT">MAX_SIGNED_INT</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_MIN_SIGNED_INT">MIN_SIGNED_INT</a> <span class="flag static">static</span> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_isSigned" class="method item"> <h3 class="name"><code>isSigned</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l579"><code>../lib/pat.js:579</code></a> </p> </div> <div class="description"> <p>Returns true if the given number is less than zero or negative zero.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Number</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: </div> </div> </div> <div id="method_isSymbolicNumber" class="method item"> <h3 class="name"><code>isSymbolicNumber</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l649"><code>../lib/pat.js:649</code></a> </p> </div> <div class="description"> <p>Returns true if the given argument represents a symbolic number (NaN, POSITIVE<em>INFINITY, NEGATIVE</em>INFINITY), false otherwise.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Number</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: </div> </div> </div> <div id="method_round" class="method item"> <h3 class="name"><code>round</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> <li class="arg"> <code class="optional">[precision=0]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l590"><code>../lib/pat.js:590</code></a> </p> </div> <div class="description"> <p>Returns the given argument rounded to the given precision.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Number</span> <div class="param-description"> <p>Number to be rounded</p> </div> </li> <li class="param"> <code class="param-name optional">[precision=0]</code> <span class="type">Number</span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>Number of precise fractional digits. A falsy value specifies fractional precision of 0.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_signedInt" class="method item"> <h3 class="name"><code>signedInt</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l604"><code>../lib/pat.js:604</code></a> </p> </div> <div class="description"> <p>Returns the given argument as a Number within the range [Formatter.util.number.MIN<em>SIGNED</em>INT, Formatter.util.number.MAX<em>SIGNED</em>INT].</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Number</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> <div id="method_twosComplement" class="method item"> <h3 class="name"><code>twosComplement</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>arg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Number</span> </span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l622"><code>../lib/pat.js:622</code></a> </p> </div> <div class="description"> <p>Returns a decimal integer representing two's complement of the given number.</p> <p>A JavaScript Number is a double-precision floating-point as specified by the IEEE 754 standard. All positive integers up to 2^53 are represented precisely, numbers beyond that threshold get their least significant bits clipped (((Math.pow(2,53) + 1) - Math.pow(2,53) results to 0, not 1).</p> <p>The argument is therefore interpreted as an integer within the range [-2^52, 2^52-1]. A floating point argument is truncated, an argument out of the expected range is set to the smallest or to the greatest precise value depending on whether the argument is smaller than -2^52 or greater than 2^52-1.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">arg</code> <span class="type">Number</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Number</span>: </div> </div> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property_MAX_INT" class="property item"> <h3 class="name"><code>MAX_INT</code></h3> <span class="type">Number</span> <span class="flag final">final</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l554"><code>../lib/pat.js:554</code></a> </p> </div> <div class="description"> <p>Greatest precise integer value in JavaScript.</p> </div> </div> <div id="property_MAX_SIGNED_INT" class="property item"> <h3 class="name"><code>MAX_SIGNED_INT</code></h3> <span class="type">Number</span> <span class="flag final">final</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l562"><code>../lib/pat.js:562</code></a> </p> </div> <div class="description"> <p>Greatest precise integer value in two's complement range.</p> </div> </div> <div id="property_MIN_SIGNED_INT" class="property item"> <h3 class="name"><code>MIN_SIGNED_INT</code></h3> <span class="type">Number</span> <span class="flag final">final</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_pat.js.html#l570"><code>../lib/pat.js:570</code></a> </p> </div> <div class="description"> <p>Smallest precise integer value in two's complement range.</p> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>