index.js (6477B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /* 22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name isEvenInt32 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/math/base/assert/int32-is-even} 45 */ 46 setReadOnly( ns, 'isEvenInt32', require( './../../../base/assert/int32-is-even' ) ); 47 48 /** 49 * @name isOddInt32 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/math/base/assert/int32-is-odd} 54 */ 55 setReadOnly( ns, 'isOddInt32', require( './../../../base/assert/int32-is-odd' ) ); 56 57 /** 58 * @name isComposite 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/math/base/assert/is-composite} 63 */ 64 setReadOnly( ns, 'isComposite', require( './../../../base/assert/is-composite' ) ); 65 66 /** 67 * @name isCoprime 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/math/base/assert/is-coprime} 72 */ 73 setReadOnly( ns, 'isCoprime', require( './../../../base/assert/is-coprime' ) ); 74 75 /** 76 * @name isEven 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/math/base/assert/is-even} 81 */ 82 setReadOnly( ns, 'isEven', require( './../../../base/assert/is-even' ) ); 83 84 /** 85 * @name isFinite 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/math/base/assert/is-finite} 90 */ 91 setReadOnly( ns, 'isFinite', require( './../../../base/assert/is-finite' ) ); 92 93 /** 94 * @name isFinitef 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/math/base/assert/is-finitef} 99 */ 100 setReadOnly( ns, 'isFinitef', require( './../../../base/assert/is-finitef' ) ); 101 102 /** 103 * @name isInfinite 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/math/base/assert/is-infinite} 108 */ 109 setReadOnly( ns, 'isInfinite', require( './../../../base/assert/is-infinite' ) ); 110 111 /** 112 * @name isInfinitef 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/math/base/assert/is-infinitef} 117 */ 118 setReadOnly( ns, 'isInfinitef', require( './../../../base/assert/is-infinitef' ) ); 119 120 /** 121 * @name isInteger 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/math/base/assert/is-integer} 126 */ 127 setReadOnly( ns, 'isInteger', require( './../../../base/assert/is-integer' ) ); 128 129 /** 130 * @name isnan 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/math/base/assert/is-nan} 135 */ 136 setReadOnly( ns, 'isnan', require( './../../../base/assert/is-nan' ) ); 137 138 /** 139 * @name isnanf 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/math/base/assert/is-nanf} 144 */ 145 setReadOnly( ns, 'isnanf', require( './../../../base/assert/is-nanf' ) ); 146 147 /** 148 * @name isNegativeInteger 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/math/base/assert/is-negative-integer} 153 */ 154 setReadOnly( ns, 'isNegativeInteger', require( './../../../base/assert/is-negative-integer' ) ); 155 156 /** 157 * @name isNegativeZero 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/math/base/assert/is-negative-zero} 162 */ 163 setReadOnly( ns, 'isNegativeZero', require( './../../../base/assert/is-negative-zero' ) ); 164 165 /** 166 * @name isNegativeZerof 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/math/base/assert/is-negative-zerof} 171 */ 172 setReadOnly( ns, 'isNegativeZerof', require( './../../../base/assert/is-negative-zerof' ) ); 173 174 /** 175 * @name isNonNegativeInteger 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/math/base/assert/is-nonnegative-integer} 180 */ 181 setReadOnly( ns, 'isNonNegativeInteger', require( './../../../base/assert/is-nonnegative-integer' ) ); 182 183 /** 184 * @name isNonPositiveInteger 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/math/base/assert/is-nonpositive-integer} 189 */ 190 setReadOnly( ns, 'isNonPositiveInteger', require( './../../../base/assert/is-nonpositive-integer' ) ); 191 192 /** 193 * @name isOdd 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/math/base/assert/is-odd} 198 */ 199 setReadOnly( ns, 'isOdd', require( './../../../base/assert/is-odd' ) ); 200 201 /** 202 * @name isPositiveInteger 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/math/base/assert/is-positive-integer} 207 */ 208 setReadOnly( ns, 'isPositiveInteger', require( './../../../base/assert/is-positive-integer' ) ); 209 210 /** 211 * @name isPositiveZero 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/math/base/assert/is-positive-zero} 216 */ 217 setReadOnly( ns, 'isPositiveZero', require( './../../../base/assert/is-positive-zero' ) ); 218 219 /** 220 * @name isPositiveZerof 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/math/base/assert/is-positive-zerof} 225 */ 226 setReadOnly( ns, 'isPositiveZerof', require( './../../../base/assert/is-positive-zerof' ) ); 227 228 /** 229 * @name isPrime 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/math/base/assert/is-prime} 234 */ 235 setReadOnly( ns, 'isPrime', require( './../../../base/assert/is-prime' ) ); 236 237 /** 238 * @name isProbability 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/math/base/assert/is-probability} 243 */ 244 setReadOnly( ns, 'isProbability', require( './../../../base/assert/is-probability' ) ); 245 246 /** 247 * @name isSafeInteger 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/math/base/assert/is-safe-integer} 252 */ 253 setReadOnly( ns, 'isSafeInteger', require( './../../../base/assert/is-safe-integer' ) ); 254 255 /** 256 * @name isPow2Uint32 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/math/base/assert/uint32-is-pow2} 261 */ 262 setReadOnly( ns, 'isPow2Uint32', require( './../../../base/assert/uint32-is-pow2' ) ); 263 264 265 // EXPORTS // 266 267 module.exports = ns;