index.js (10127B)
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 ArrayBuffer 41 * @memberof ns 42 * @readonly 43 * @constructor 44 * @see {@link module:@stdlib/array/buffer} 45 */ 46 setReadOnly( ns, 'ArrayBuffer', require( './../buffer' ) ); 47 48 /** 49 * @name Complex64Array 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/array/complex64} 54 */ 55 setReadOnly( ns, 'Complex64Array', require( './../complex64' ) ); 56 57 /** 58 * @name Complex128Array 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/array/complex128} 63 */ 64 setReadOnly( ns, 'Complex128Array', require( './../complex128' ) ); 65 66 /** 67 * @name convertArray 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/array/convert} 72 */ 73 setReadOnly( ns, 'convertArray', require( './../convert' ) ); 74 75 /** 76 * @name convertArraySame 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/array/convert-same} 81 */ 82 setReadOnly( ns, 'convertArraySame', require( './../convert-same' ) ); 83 84 /** 85 * @name arrayCtors 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/array/ctors} 90 */ 91 setReadOnly( ns, 'arrayCtors', require( './../ctors' ) ); 92 93 /** 94 * @name DataView 95 * @memberof ns 96 * @readonly 97 * @constructor 98 * @see {@link module:@stdlib/array/dataview} 99 */ 100 setReadOnly( ns, 'DataView', require( './../dataview' ) ); 101 102 /** 103 * @name datespace 104 * @memberof ns 105 * @readonly 106 * @constructor 107 * @see {@link module:@stdlib/array/datespace} 108 */ 109 setReadOnly( ns, 'datespace', require( './../datespace' ) ); 110 111 /** 112 * @name arrayDataType 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/array/dtype} 117 */ 118 setReadOnly( ns, 'arrayDataType', require( './../dtype' ) ); 119 120 /** 121 * @name arrayDataTypes 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/array/dtypes} 126 */ 127 setReadOnly( ns, 'arrayDataTypes', require( './../dtypes' ) ); 128 129 /** 130 * @name filledarray 131 * @memberof ns 132 * @readonly 133 * @constructor 134 * @see {@link module:@stdlib/array/filled} 135 */ 136 setReadOnly( ns, 'filledarray', require( './../filled' ) ); 137 138 /** 139 * @name Float32Array 140 * @memberof ns 141 * @readonly 142 * @constructor 143 * @see {@link module:@stdlib/array/float32} 144 */ 145 setReadOnly( ns, 'Float32Array', require( './../float32' ) ); 146 147 /** 148 * @name Float64Array 149 * @memberof ns 150 * @readonly 151 * @constructor 152 * @see {@link module:@stdlib/array/float64} 153 */ 154 setReadOnly( ns, 'Float64Array', require( './../float64' ) ); 155 156 /** 157 * @name iterator2array 158 * @memberof ns 159 * @readonly 160 * @constructor 161 * @see {@link module:@stdlib/array/from-iterator} 162 */ 163 setReadOnly( ns, 'iterator2array', require( './../from-iterator' ) ); 164 165 /** 166 * @name incrspace 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/array/incrspace} 171 */ 172 setReadOnly( ns, 'incrspace', require( './../incrspace' ) ); 173 174 /** 175 * @name Int8Array 176 * @memberof ns 177 * @readonly 178 * @constructor 179 * @see {@link module:@stdlib/array/int8} 180 */ 181 setReadOnly( ns, 'Int8Array', require( './../int8' ) ); 182 183 /** 184 * @name Int16Array 185 * @memberof ns 186 * @readonly 187 * @constructor 188 * @see {@link module:@stdlib/array/int16} 189 */ 190 setReadOnly( ns, 'Int16Array', require( './../int16' ) ); 191 192 /** 193 * @name Int32Array 194 * @memberof ns 195 * @readonly 196 * @constructor 197 * @see {@link module:@stdlib/array/int32} 198 */ 199 setReadOnly( ns, 'Int32Array', require( './../int32' ) ); 200 201 /** 202 * @name linspace 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/array/linspace} 207 */ 208 setReadOnly( ns, 'linspace', require( './../linspace' ) ); 209 210 /** 211 * @name logspace 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/array/logspace} 216 */ 217 setReadOnly( ns, 'logspace', require( './../logspace' ) ); 218 219 /** 220 * @name arrayMinDataType 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/array/min-dtype} 225 */ 226 setReadOnly( ns, 'arrayMinDataType', require( './../min-dtype' ) ); 227 228 /** 229 * @name arrayNextDataType 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/array/next-dtype} 234 */ 235 setReadOnly( ns, 'arrayNextDataType', require( './../next-dtype' ) ); 236 237 /** 238 * @name typedarraypool 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/array/pool} 243 */ 244 setReadOnly( ns, 'typedarraypool', require( './../pool' ) ); 245 246 /** 247 * @name arrayPromotionRules 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/array/promotion-rules} 252 */ 253 setReadOnly( ns, 'arrayPromotionRules', require( './../promotion-rules' ) ); 254 255 /** 256 * @name reviveTypedArray 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/array/reviver} 261 */ 262 setReadOnly( ns, 'reviveTypedArray', require( './../reviver' ) ); 263 264 /** 265 * @name arraySafeCasts 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/array/safe-casts} 270 */ 271 setReadOnly( ns, 'arraySafeCasts', require( './../safe-casts' ) ); 272 273 /** 274 * @name arraySameKindCasts 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/array/same-kind-casts} 279 */ 280 setReadOnly( ns, 'arraySameKindCasts', require( './../same-kind-casts' ) ); 281 282 /** 283 * @name arrayShape 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/array/shape} 288 */ 289 setReadOnly( ns, 'arrayShape', require( './../shape' ) ); 290 291 /** 292 * @name SharedArrayBuffer 293 * @memberof ns 294 * @readonly 295 * @constructor 296 * @see {@link module:@stdlib/array/shared-buffer} 297 */ 298 setReadOnly( ns, 'SharedArrayBuffer', require( './../shared-buffer' ) ); 299 300 /** 301 * @name circarray2iterator 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/array/to-circular-iterator} 306 */ 307 setReadOnly( ns, 'circarray2iterator', require( './../to-circular-iterator' ) ); 308 309 /** 310 * @name array2iterator 311 * @memberof ns 312 * @readonly 313 * @type {Function} 314 * @see {@link module:@stdlib/array/to-iterator} 315 */ 316 setReadOnly( ns, 'array2iterator', require( './../to-iterator' ) ); 317 318 /** 319 * @name array2iteratorRight 320 * @memberof ns 321 * @readonly 322 * @type {Function} 323 * @see {@link module:@stdlib/array/to-iterator-right} 324 */ 325 setReadOnly( ns, 'array2iteratorRight', require( './../to-iterator-right' ) ); 326 327 /** 328 * @name typedarray2json 329 * @memberof ns 330 * @readonly 331 * @type {Function} 332 * @see {@link module:@stdlib/array/to-json} 333 */ 334 setReadOnly( ns, 'typedarray2json', require( './../to-json' ) ); 335 336 /** 337 * @name sparsearray2iterator 338 * @memberof ns 339 * @readonly 340 * @type {Function} 341 * @see {@link module:@stdlib/array/to-sparse-iterator} 342 */ 343 setReadOnly( ns, 'sparsearray2iterator', require( './../to-sparse-iterator' ) ); 344 345 /** 346 * @name sparsearray2iteratorRight 347 * @memberof ns 348 * @readonly 349 * @type {Function} 350 * @see {@link module:@stdlib/array/to-sparse-iterator-right} 351 */ 352 setReadOnly( ns, 'sparsearray2iteratorRight', require( './../to-sparse-iterator-right' ) ); 353 354 /** 355 * @name stridedarray2iterator 356 * @memberof ns 357 * @readonly 358 * @type {Function} 359 * @see {@link module:@stdlib/array/to-strided-iterator} 360 */ 361 setReadOnly( ns, 'stridedarray2iterator', require( './../to-strided-iterator' ) ); 362 363 /** 364 * @name arrayview2iterator 365 * @memberof ns 366 * @readonly 367 * @type {Function} 368 * @see {@link module:@stdlib/array/to-view-iterator} 369 */ 370 setReadOnly( ns, 'arrayview2iterator', require( './../to-view-iterator' ) ); 371 372 /** 373 * @name arrayview2iteratorRight 374 * @memberof ns 375 * @readonly 376 * @type {Function} 377 * @see {@link module:@stdlib/array/to-view-iterator-right} 378 */ 379 setReadOnly( ns, 'arrayview2iteratorRight', require( './../to-view-iterator-right' ) ); 380 381 /** 382 * @name typedarray 383 * @memberof ns 384 * @readonly 385 * @type {Function} 386 * @see {@link module:@stdlib/array/typed} 387 */ 388 setReadOnly( ns, 'typedarray', require( './../typed' ) ); 389 390 /** 391 * @name typedarrayComplexCtors 392 * @memberof ns 393 * @readonly 394 * @type {Function} 395 * @see {@link module:@stdlib/array/typed-complex-ctors} 396 */ 397 setReadOnly( ns, 'typedarrayComplexCtors', require( './../typed-complex-ctors' ) ); 398 399 /** 400 * @name typedarrayComplexDataTypes 401 * @memberof ns 402 * @readonly 403 * @type {Function} 404 * @see {@link module:@stdlib/array/typed-complex-dtypes} 405 */ 406 setReadOnly( ns, 'typedarrayComplexDataTypes', require( './../typed-complex-dtypes' ) ); 407 408 /** 409 * @name typedarrayCtors 410 * @memberof ns 411 * @readonly 412 * @type {Function} 413 * @see {@link module:@stdlib/array/typed-ctors} 414 */ 415 setReadOnly( ns, 'typedarrayCtors', require( './../typed-ctors' ) ); 416 417 /** 418 * @name typedarrayDataTypes 419 * @memberof ns 420 * @readonly 421 * @type {Function} 422 * @see {@link module:@stdlib/array/typed-dtypes} 423 */ 424 setReadOnly( ns, 'typedarrayDataTypes', require( './../typed-dtypes' ) ); 425 426 /** 427 * @name Uint8Array 428 * @memberof ns 429 * @readonly 430 * @constructor 431 * @see {@link module:@stdlib/array/uint8} 432 */ 433 setReadOnly( ns, 'Uint8Array', require( './../uint8' ) ); 434 435 /** 436 * @name Uint8ClampedArray 437 * @memberof ns 438 * @readonly 439 * @constructor 440 * @see {@link module:@stdlib/array/uint8c} 441 */ 442 setReadOnly( ns, 'Uint8ClampedArray', require( './../uint8c' ) ); 443 444 /** 445 * @name Uint16Array 446 * @memberof ns 447 * @readonly 448 * @constructor 449 * @see {@link module:@stdlib/array/uint16} 450 */ 451 setReadOnly( ns, 'Uint16Array', require( './../uint16' ) ); 452 453 /** 454 * @name Uint32Array 455 * @memberof ns 456 * @readonly 457 * @constructor 458 * @see {@link module:@stdlib/array/uint32} 459 */ 460 setReadOnly( ns, 'Uint32Array', require( './../uint32' ) ); 461 462 /** 463 * @name constants 464 * @memberof ns 465 * @readonly 466 * @type {Namespace} 467 * @see {@link module:@stdlib/constants/array} 468 */ 469 setReadOnly( ns, 'constants', require( '@stdlib/constants/array' ) ); 470 471 472 // EXPORTS // 473 474 module.exports = ns;