README.md (5370B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Special Functions 22 23 > Standard library fast math special functions. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var fmath = require( '@stdlib/math/base/special/fast' ); 31 ``` 32 33 #### fmath 34 35 Standard library fast math special functions. 36 37 ```javascript 38 var fcns = fmath; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*"> --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`abs( x )`][@stdlib/math/base/special/fast/abs]</span><span class="delimiter">: </span><span class="description">compute an absolute value.</span> 47 - <span class="signature">[`acosh( x )`][@stdlib/math/base/special/fast/acosh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arccosine of a number.</span> 48 - <span class="signature">[`ampbm( x, y )`][@stdlib/math/base/special/fast/alpha-max-plus-beta-min]</span><span class="delimiter">: </span><span class="description">compute the hypotenuse using the alpha max plus beta min algorithm.</span> 49 - <span class="signature">[`asinh( x )`][@stdlib/math/base/special/fast/asinh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arcsine of a number.</span> 50 - <span class="signature">[`atanh( x )`][@stdlib/math/base/special/fast/atanh]</span><span class="delimiter">: </span><span class="description">compute the hyperbolic arctangent of a number.</span> 51 - <span class="signature">[`hypot( x, y )`][@stdlib/math/base/special/fast/hypot]</span><span class="delimiter">: </span><span class="description">compute the hypotenuse.</span> 52 - <span class="signature">[`max( x, y )`][@stdlib/math/base/special/fast/max]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span> 53 - <span class="signature">[`min( x, y )`][@stdlib/math/base/special/fast/min]</span><span class="delimiter">: </span><span class="description">return the minimum value.</span> 54 - <span class="signature">[`powint( base, exponent )`][@stdlib/math/base/special/fast/pow-int]</span><span class="delimiter">: </span><span class="description">exponential function.</span> 55 - <span class="signature">[`log2Uint32( x )`][@stdlib/math/base/special/fast/uint32-log2]</span><span class="delimiter">: </span><span class="description">compute an integer binary logarithm.</span> 56 - <span class="signature">[`sqrtUint32( x )`][@stdlib/math/base/special/fast/uint32-sqrt]</span><span class="delimiter">: </span><span class="description">compute an integer square root.</span> 57 58 </div> 59 60 <!-- </toc> --> 61 62 </section> 63 64 <!-- /.usage --> 65 66 <!-- Package notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> 67 68 <section class="notes"> 69 70 ## Notes 71 72 - Implementations **may** violate strict IEEE semantics. 73 - Implementations **may** assume arguments and results are **not** `NaN`. 74 - Implementations **may** assume arguments are **neither** positive or negative `infinity`. 75 - Implementations **may** ignore the sign of zero. 76 77 </section> 78 79 <!-- /.notes --> 80 81 <section class="examples"> 82 83 ## Examples 84 85 <!-- TODO: better examples --> 86 87 <!-- eslint no-undef: "error" --> 88 89 ```javascript 90 var objectKeys = require( '@stdlib/utils/keys' ); 91 var fmath = require( '@stdlib/math/base/special/fast' ); 92 93 console.log( objectKeys( fmath ) ); 94 ``` 95 96 </section> 97 98 <!-- /.examples --> 99 100 <section class="links"> 101 102 <!-- <toc-links> --> 103 104 [@stdlib/math/base/special/fast/abs]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/abs 105 106 [@stdlib/math/base/special/fast/acosh]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/acosh 107 108 [@stdlib/math/base/special/fast/alpha-max-plus-beta-min]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/alpha-max-plus-beta-min 109 110 [@stdlib/math/base/special/fast/asinh]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/asinh 111 112 [@stdlib/math/base/special/fast/atanh]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/atanh 113 114 [@stdlib/math/base/special/fast/hypot]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/hypot 115 116 [@stdlib/math/base/special/fast/max]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/max 117 118 [@stdlib/math/base/special/fast/min]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/min 119 120 [@stdlib/math/base/special/fast/pow-int]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/pow-int 121 122 [@stdlib/math/base/special/fast/uint32-log2]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/uint32-log2 123 124 [@stdlib/math/base/special/fast/uint32-sqrt]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/special/fast/uint32-sqrt 125 126 <!-- </toc-links> --> 127 128 </section> 129 130 <!-- /.links -->