README.md (9991B)
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 # Assert 22 23 > Standard library basic mathematical assertion utilities. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var ns = require( '@stdlib/math/base/assert' ); 31 ``` 32 33 #### ns 34 35 Standard library basic mathematical assertion utilities. 36 37 ```javascript 38 var o = ns; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*"> --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`isEvenInt32( x )`][@stdlib/math/base/assert/int32-is-even]</span><span class="delimiter">: </span><span class="description">test if a 32-bit integer is even.</span> 47 - <span class="signature">[`isOddInt32( x )`][@stdlib/math/base/assert/int32-is-odd]</span><span class="delimiter">: </span><span class="description">test if a 32-bit integer is odd.</span> 48 - <span class="signature">[`isComposite( x )`][@stdlib/math/base/assert/is-composite]</span><span class="delimiter">: </span><span class="description">test if a number is a composite.</span> 49 - <span class="signature">[`isCoprime( a, b )`][@stdlib/math/base/assert/is-coprime]</span><span class="delimiter">: </span><span class="description">test if two numbers are coprime.</span> 50 - <span class="signature">[`isEven( x )`][@stdlib/math/base/assert/is-even]</span><span class="delimiter">: </span><span class="description">test if a finite numeric value is an even number.</span> 51 - <span class="signature">[`isFinite( x )`][@stdlib/math/base/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is finite.</span> 52 - <span class="signature">[`isFinitef( x )`][@stdlib/math/base/assert/is-finitef]</span><span class="delimiter">: </span><span class="description">test if a single-precision floating-point numeric value is finite.</span> 53 - <span class="signature">[`isInfinite( x )`][@stdlib/math/base/assert/is-infinite]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is infinite.</span> 54 - <span class="signature">[`isInfinitef( x )`][@stdlib/math/base/assert/is-infinitef]</span><span class="delimiter">: </span><span class="description">test if a single-precision floating-point numeric value is infinite.</span> 55 - <span class="signature">[`isInteger( x )`][@stdlib/math/base/assert/is-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is an integer.</span> 56 - <span class="signature">[`isnan( x )`][@stdlib/math/base/assert/is-nan]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is NaN.</span> 57 - <span class="signature">[`isnanf( x )`][@stdlib/math/base/assert/is-nanf]</span><span class="delimiter">: </span><span class="description">test if a single-precision floating-point numeric value is NaN.</span> 58 - <span class="signature">[`isNegativeInteger( x )`][@stdlib/math/base/assert/is-negative-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is a negative integer.</span> 59 - <span class="signature">[`isNegativeZero( x )`][@stdlib/math/base/assert/is-negative-zero]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is negative zero.</span> 60 - <span class="signature">[`isNegativeZerof( x )`][@stdlib/math/base/assert/is-negative-zerof]</span><span class="delimiter">: </span><span class="description">test if a single-precision floating-point numeric value is negative zero.</span> 61 - <span class="signature">[`isNonNegativeInteger( x )`][@stdlib/math/base/assert/is-nonnegative-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is a nonnegative integer.</span> 62 - <span class="signature">[`isNonPositiveInteger( x )`][@stdlib/math/base/assert/is-nonpositive-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is a nonpositive integer.</span> 63 - <span class="signature">[`isOdd( x )`][@stdlib/math/base/assert/is-odd]</span><span class="delimiter">: </span><span class="description">test if a finite numeric value is an odd number.</span> 64 - <span class="signature">[`isPositiveInteger( x )`][@stdlib/math/base/assert/is-positive-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is a positive integer.</span> 65 - <span class="signature">[`isPositiveZero( x )`][@stdlib/math/base/assert/is-positive-zero]</span><span class="delimiter">: </span><span class="description">test if a double-precision floating-point numeric value is positive zero.</span> 66 - <span class="signature">[`isPositiveZerof( x )`][@stdlib/math/base/assert/is-positive-zerof]</span><span class="delimiter">: </span><span class="description">test if a single-precision floating-point numeric value is positive zero.</span> 67 - <span class="signature">[`isPrime( x )`][@stdlib/math/base/assert/is-prime]</span><span class="delimiter">: </span><span class="description">test if a number is a prime.</span> 68 - <span class="signature">[`isProbability( x )`][@stdlib/math/base/assert/is-probability]</span><span class="delimiter">: </span><span class="description">test if a numeric value is a probability.</span> 69 - <span class="signature">[`isSafeInteger( x )`][@stdlib/math/base/assert/is-safe-integer]</span><span class="delimiter">: </span><span class="description">test if a finite double-precision floating-point number is a safe integer.</span> 70 - <span class="signature">[`isPow2Uint32( x )`][@stdlib/math/base/assert/uint32-is-pow2]</span><span class="delimiter">: </span><span class="description">test whether an unsigned integer is a power of 2.</span> 71 72 </div> 73 74 <!-- </toc> --> 75 76 </section> 77 78 <!-- /.usage --> 79 80 <section class="examples"> 81 82 ## Examples 83 84 <!-- TODO: better examples --> 85 86 <!-- eslint no-undef: "error" --> 87 88 ```javascript 89 var objectKeys = require( '@stdlib/utils/keys' ); 90 var ns = require( '@stdlib/math/base/assert' ); 91 92 console.log( objectKeys( ns ) ); 93 ``` 94 95 </section> 96 97 <!-- /.examples --> 98 99 <section class="links"> 100 101 <!-- <toc-links> --> 102 103 [@stdlib/math/base/assert/int32-is-even]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/int32-is-even 104 105 [@stdlib/math/base/assert/int32-is-odd]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/int32-is-odd 106 107 [@stdlib/math/base/assert/is-composite]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-composite 108 109 [@stdlib/math/base/assert/is-coprime]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-coprime 110 111 [@stdlib/math/base/assert/is-even]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-even 112 113 [@stdlib/math/base/assert/is-finite]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-finite 114 115 [@stdlib/math/base/assert/is-finitef]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-finitef 116 117 [@stdlib/math/base/assert/is-infinite]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-infinite 118 119 [@stdlib/math/base/assert/is-infinitef]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-infinitef 120 121 [@stdlib/math/base/assert/is-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-integer 122 123 [@stdlib/math/base/assert/is-nan]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-nan 124 125 [@stdlib/math/base/assert/is-nanf]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-nanf 126 127 [@stdlib/math/base/assert/is-negative-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-negative-integer 128 129 [@stdlib/math/base/assert/is-negative-zero]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-negative-zero 130 131 [@stdlib/math/base/assert/is-negative-zerof]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-negative-zerof 132 133 [@stdlib/math/base/assert/is-nonnegative-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-nonnegative-integer 134 135 [@stdlib/math/base/assert/is-nonpositive-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-nonpositive-integer 136 137 [@stdlib/math/base/assert/is-odd]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-odd 138 139 [@stdlib/math/base/assert/is-positive-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-positive-integer 140 141 [@stdlib/math/base/assert/is-positive-zero]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-positive-zero 142 143 [@stdlib/math/base/assert/is-positive-zerof]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-positive-zerof 144 145 [@stdlib/math/base/assert/is-prime]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-prime 146 147 [@stdlib/math/base/assert/is-probability]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-probability 148 149 [@stdlib/math/base/assert/is-safe-integer]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/is-safe-integer 150 151 [@stdlib/math/base/assert/uint32-is-pow2]: https://www.npmjs.com/package/@stdlib/math/tree/main/base/assert/uint32-is-pow2 152 153 <!-- </toc-links> --> 154 155 </section> 156 157 <!-- /.links -->