README.md (2532B)
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 # Utils 22 23 > Standard library basic mathematical utilities. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var utils = require( '@stdlib/math/base/utils' ); 31 ``` 32 33 #### utils 34 35 Standard library basic mathematical utilities. 36 37 ```javascript 38 var o = utils; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*difference*" > --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`absdiff( x, y )`][@stdlib/math/base/utils/absolute-difference]</span><span class="delimiter">: </span><span class="description">compute the absolute difference of two real numbers.</span> 47 - <span class="signature">[`epsdiff( x, y[, scale] )`][@stdlib/math/base/utils/float64-epsilon-difference]</span><span class="delimiter">: </span><span class="description">compute the relative difference of two real numbers in units of double-precision floating-point epsilon.</span> 48 - <span class="signature">[`reldiff( x, y[, scale] )`][@stdlib/math/base/utils/relative-difference]</span><span class="delimiter">: </span><span class="description">compute the relative difference of two real numbers.</span> 49 50 </div> 51 52 <!-- </toc> --> 53 54 </section> 55 56 <!-- /.usage --> 57 58 <section class="examples"> 59 60 ## Examples 61 62 <!-- TODO: better examples --> 63 64 <!-- eslint no-undef: "error" --> 65 66 ```javascript 67 var objectKeys = require( '@stdlib/utils/keys' ); 68 var utils = require( '@stdlib/math/base/utils' ); 69 70 console.log( objectKeys( utils ) ); 71 ``` 72 73 </section> 74 75 <!-- /.examples --> 76 77 <section class="links"> 78 79 <!-- <toc-links> --> 80 81 [@stdlib/math/base/utils/absolute-difference]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/utils/absolute-difference 82 83 [@stdlib/math/base/utils/float64-epsilon-difference]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/utils/float64-epsilon-difference 84 85 [@stdlib/math/base/utils/relative-difference]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/utils/relative-difference 86 87 <!-- </toc-links> --> 88 89 </section> 90 91 <!-- /.links -->