index.js (16765B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2020 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 abs 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/math/strided/special/abs} 45 */ 46 setReadOnly( ns, 'abs', require( './../../../strided/special/abs' ) ); 47 48 /** 49 * @name absBy 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/math/strided/special/abs-by} 54 */ 55 setReadOnly( ns, 'absBy', require( './../../../strided/special/abs-by' ) ); 56 57 /** 58 * @name abs2 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/math/strided/special/abs2} 63 */ 64 setReadOnly( ns, 'abs2', require( './../../../strided/special/abs2' ) ); 65 66 /** 67 * @name abs2By 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/math/strided/special/abs2-by} 72 */ 73 setReadOnly( ns, 'abs2By', require( './../../../strided/special/abs2-by' ) ); 74 75 /** 76 * @name acosBy 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/math/strided/special/acos-by} 81 */ 82 setReadOnly( ns, 'acosBy', require( './../../../strided/special/acos-by' ) ); 83 84 /** 85 * @name acoshBy 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/math/strided/special/acosh-by} 90 */ 91 setReadOnly( ns, 'acoshBy', require( './../../../strided/special/acosh-by' ) ); 92 93 /** 94 * @name acotBy 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/math/strided/special/acot-by} 99 */ 100 setReadOnly( ns, 'acotBy', require( './../../../strided/special/acot-by' ) ); 101 102 /** 103 * @name acothBy 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/math/strided/special/acoth-by} 108 */ 109 setReadOnly( ns, 'acothBy', require( './../../../strided/special/acoth-by' ) ); 110 111 /** 112 * @name acovercosBy 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/math/strided/special/acovercos-by} 117 */ 118 setReadOnly( ns, 'acovercosBy', require( './../../../strided/special/acovercos-by' ) ); 119 120 /** 121 * @name acoversinBy 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/math/strided/special/acoversin-by} 126 */ 127 setReadOnly( ns, 'acoversinBy', require( './../../../strided/special/acoversin-by' ) ); 128 129 /** 130 * @name ahavercosBy 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/math/strided/special/ahavercos-by} 135 */ 136 setReadOnly( ns, 'ahavercosBy', require( './../../../strided/special/ahavercos-by' ) ); 137 138 /** 139 * @name ahaversinBy 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/math/strided/special/ahaversin-by} 144 */ 145 setReadOnly( ns, 'ahaversinBy', require( './../../../strided/special/ahaversin-by' ) ); 146 147 /** 148 * @name asinBy 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/math/strided/special/asin-by} 153 */ 154 setReadOnly( ns, 'asinBy', require( './../../../strided/special/asin-by' ) ); 155 156 /** 157 * @name asinhBy 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/math/strided/special/asinh-by} 162 */ 163 setReadOnly( ns, 'asinhBy', require( './../../../strided/special/asinh-by' ) ); 164 165 /** 166 * @name atanBy 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/math/strided/special/atan-by} 171 */ 172 setReadOnly( ns, 'atanBy', require( './../../../strided/special/atan-by' ) ); 173 174 /** 175 * @name atanhBy 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/math/strided/special/atanh-by} 180 */ 181 setReadOnly( ns, 'atanhBy', require( './../../../strided/special/atanh-by' ) ); 182 183 /** 184 * @name avercosBy 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/math/strided/special/avercos-by} 189 */ 190 setReadOnly( ns, 'avercosBy', require( './../../../strided/special/avercos-by' ) ); 191 192 /** 193 * @name aversinBy 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/math/strided/special/aversin-by} 198 */ 199 setReadOnly( ns, 'aversinBy', require( './../../../strided/special/aversin-by' ) ); 200 201 /** 202 * @name besselj0By 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/math/strided/special/besselj0-by} 207 */ 208 setReadOnly( ns, 'besselj0By', require( './../../../strided/special/besselj0-by' ) ); 209 210 /** 211 * @name besselj1By 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/math/strided/special/besselj1-by} 216 */ 217 setReadOnly( ns, 'besselj1By', require( './../../../strided/special/besselj1-by' ) ); 218 219 /** 220 * @name bessely0By 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/math/strided/special/bessely0-by} 225 */ 226 setReadOnly( ns, 'bessely0By', require( './../../../strided/special/bessely0-by' ) ); 227 228 /** 229 * @name bessely1By 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/math/strided/special/bessely1-by} 234 */ 235 setReadOnly( ns, 'bessely1By', require( './../../../strided/special/bessely1-by' ) ); 236 237 /** 238 * @name binetBy 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/math/strided/special/binet-by} 243 */ 244 setReadOnly( ns, 'binetBy', require( './../../../strided/special/binet-by' ) ); 245 246 /** 247 * @name cbrt 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/math/strided/special/cbrt} 252 */ 253 setReadOnly( ns, 'cbrt', require( './../../../strided/special/cbrt' ) ); 254 255 /** 256 * @name ceil 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/math/strided/special/ceil} 261 */ 262 setReadOnly( ns, 'ceil', require( './../../../strided/special/ceil' ) ); 263 264 /** 265 * @name dabs 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/math/strided/special/dabs} 270 */ 271 setReadOnly( ns, 'dabs', require( './../../../strided/special/dabs' ) ); 272 273 /** 274 * @name dabs2 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/math/strided/special/dabs2} 279 */ 280 setReadOnly( ns, 'dabs2', require( './../../../strided/special/dabs2' ) ); 281 282 /** 283 * @name dcbrt 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/math/strided/special/dcbrt} 288 */ 289 setReadOnly( ns, 'dcbrt', require( './../../../strided/special/dcbrt' ) ); 290 291 /** 292 * @name dceil 293 * @memberof ns 294 * @readonly 295 * @type {Function} 296 * @see {@link module:@stdlib/math/strided/special/dceil} 297 */ 298 setReadOnly( ns, 'dceil', require( './../../../strided/special/dceil' ) ); 299 300 /** 301 * @name ddeg2rad 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/math/strided/special/ddeg2rad} 306 */ 307 setReadOnly( ns, 'ddeg2rad', require( './../../../strided/special/ddeg2rad' ) ); 308 309 /** 310 * @name deg2rad 311 * @memberof ns 312 * @readonly 313 * @type {Function} 314 * @see {@link module:@stdlib/math/strided/special/deg2rad} 315 */ 316 setReadOnly( ns, 'deg2rad', require( './../../../strided/special/deg2rad' ) ); 317 318 /** 319 * @name dfloor 320 * @memberof ns 321 * @readonly 322 * @type {Function} 323 * @see {@link module:@stdlib/math/strided/special/dfloor} 324 */ 325 setReadOnly( ns, 'dfloor', require( './../../../strided/special/dfloor' ) ); 326 327 /** 328 * @name dinv 329 * @memberof ns 330 * @readonly 331 * @type {Function} 332 * @see {@link module:@stdlib/math/strided/special/dinv} 333 */ 334 setReadOnly( ns, 'dinv', require( './../../../strided/special/dinv' ) ); 335 336 /** 337 * @name dmskabs 338 * @memberof ns 339 * @readonly 340 * @type {Function} 341 * @see {@link module:@stdlib/math/strided/special/dmskabs} 342 */ 343 setReadOnly( ns, 'dmskabs', require( './../../../strided/special/dmskabs' ) ); 344 345 /** 346 * @name dmskabs2 347 * @memberof ns 348 * @readonly 349 * @type {Function} 350 * @see {@link module:@stdlib/math/strided/special/dmskabs2} 351 */ 352 setReadOnly( ns, 'dmskabs2', require( './../../../strided/special/dmskabs2' ) ); 353 354 /** 355 * @name dmskcbrt 356 * @memberof ns 357 * @readonly 358 * @type {Function} 359 * @see {@link module:@stdlib/math/strided/special/dmskcbrt} 360 */ 361 setReadOnly( ns, 'dmskcbrt', require( './../../../strided/special/dmskcbrt' ) ); 362 363 /** 364 * @name dmskceil 365 * @memberof ns 366 * @readonly 367 * @type {Function} 368 * @see {@link module:@stdlib/math/strided/special/dmskceil} 369 */ 370 setReadOnly( ns, 'dmskceil', require( './../../../strided/special/dmskceil' ) ); 371 372 /** 373 * @name dmskdeg2rad 374 * @memberof ns 375 * @readonly 376 * @type {Function} 377 * @see {@link module:@stdlib/math/strided/special/dmskdeg2rad} 378 */ 379 setReadOnly( ns, 'dmskdeg2rad', require( './../../../strided/special/dmskdeg2rad' ) ); 380 381 /** 382 * @name dmskfloor 383 * @memberof ns 384 * @readonly 385 * @type {Function} 386 * @see {@link module:@stdlib/math/strided/special/dmskfloor} 387 */ 388 setReadOnly( ns, 'dmskfloor', require( './../../../strided/special/dmskfloor' ) ); 389 390 /** 391 * @name dmskinv 392 * @memberof ns 393 * @readonly 394 * @type {Function} 395 * @see {@link module:@stdlib/math/strided/special/dmskinv} 396 */ 397 setReadOnly( ns, 'dmskinv', require( './../../../strided/special/dmskinv' ) ); 398 399 /** 400 * @name dmskramp 401 * @memberof ns 402 * @readonly 403 * @type {Function} 404 * @see {@link module:@stdlib/math/strided/special/dmskramp} 405 */ 406 setReadOnly( ns, 'dmskramp', require( './../../../strided/special/dmskramp' ) ); 407 408 /** 409 * @name dmskrsqrt 410 * @memberof ns 411 * @readonly 412 * @type {Function} 413 * @see {@link module:@stdlib/math/strided/special/dmskrsqrt} 414 */ 415 setReadOnly( ns, 'dmskrsqrt', require( './../../../strided/special/dmskrsqrt' ) ); 416 417 /** 418 * @name dmsksqrt 419 * @memberof ns 420 * @readonly 421 * @type {Function} 422 * @see {@link module:@stdlib/math/strided/special/dmsksqrt} 423 */ 424 setReadOnly( ns, 'dmsksqrt', require( './../../../strided/special/dmsksqrt' ) ); 425 426 /** 427 * @name dmsktrunc 428 * @memberof ns 429 * @readonly 430 * @type {Function} 431 * @see {@link module:@stdlib/math/strided/special/dmsktrunc} 432 */ 433 setReadOnly( ns, 'dmsktrunc', require( './../../../strided/special/dmsktrunc' ) ); 434 435 /** 436 * @name dramp 437 * @memberof ns 438 * @readonly 439 * @type {Function} 440 * @see {@link module:@stdlib/math/strided/special/dramp} 441 */ 442 setReadOnly( ns, 'dramp', require( './../../../strided/special/dramp' ) ); 443 444 /** 445 * @name drsqrt 446 * @memberof ns 447 * @readonly 448 * @type {Function} 449 * @see {@link module:@stdlib/math/strided/special/drsqrt} 450 */ 451 setReadOnly( ns, 'drsqrt', require( './../../../strided/special/drsqrt' ) ); 452 453 /** 454 * @name dsqrt 455 * @memberof ns 456 * @readonly 457 * @type {Function} 458 * @see {@link module:@stdlib/math/strided/special/dsqrt} 459 */ 460 setReadOnly( ns, 'dsqrt', require( './../../../strided/special/dsqrt' ) ); 461 462 /** 463 * @name dtrunc 464 * @memberof ns 465 * @readonly 466 * @type {Function} 467 * @see {@link module:@stdlib/math/strided/special/dtrunc} 468 */ 469 setReadOnly( ns, 'dtrunc', require( './../../../strided/special/dtrunc' ) ); 470 471 /** 472 * @name floor 473 * @memberof ns 474 * @readonly 475 * @type {Function} 476 * @see {@link module:@stdlib/math/strided/special/floor} 477 */ 478 setReadOnly( ns, 'floor', require( './../../../strided/special/floor' ) ); 479 480 /** 481 * @name inv 482 * @memberof ns 483 * @readonly 484 * @type {Function} 485 * @see {@link module:@stdlib/math/strided/special/inv} 486 */ 487 setReadOnly( ns, 'inv', require( './../../../strided/special/inv' ) ); 488 489 /** 490 * @name ramp 491 * @memberof ns 492 * @readonly 493 * @type {Function} 494 * @see {@link module:@stdlib/math/strided/special/ramp} 495 */ 496 setReadOnly( ns, 'ramp', require( './../../../strided/special/ramp' ) ); 497 498 /** 499 * @name rsqrt 500 * @memberof ns 501 * @readonly 502 * @type {Function} 503 * @see {@link module:@stdlib/math/strided/special/rsqrt} 504 */ 505 setReadOnly( ns, 'rsqrt', require( './../../../strided/special/rsqrt' ) ); 506 507 /** 508 * @name sabs 509 * @memberof ns 510 * @readonly 511 * @type {Function} 512 * @see {@link module:@stdlib/math/strided/special/sabs} 513 */ 514 setReadOnly( ns, 'sabs', require( './../../../strided/special/sabs' ) ); 515 516 /** 517 * @name sabs2 518 * @memberof ns 519 * @readonly 520 * @type {Function} 521 * @see {@link module:@stdlib/math/strided/special/sabs2} 522 */ 523 setReadOnly( ns, 'sabs2', require( './../../../strided/special/sabs2' ) ); 524 525 /** 526 * @name scbrt 527 * @memberof ns 528 * @readonly 529 * @type {Function} 530 * @see {@link module:@stdlib/math/strided/special/scbrt} 531 */ 532 setReadOnly( ns, 'scbrt', require( './../../../strided/special/scbrt' ) ); 533 534 /** 535 * @name sceil 536 * @memberof ns 537 * @readonly 538 * @type {Function} 539 * @see {@link module:@stdlib/math/strided/special/sceil} 540 */ 541 setReadOnly( ns, 'sceil', require( './../../../strided/special/sceil' ) ); 542 543 /** 544 * @name sdeg2rad 545 * @memberof ns 546 * @readonly 547 * @type {Function} 548 * @see {@link module:@stdlib/math/strided/special/sdeg2rad} 549 */ 550 setReadOnly( ns, 'sdeg2rad', require( './../../../strided/special/sdeg2rad' ) ); 551 552 /** 553 * @name sfloor 554 * @memberof ns 555 * @readonly 556 * @type {Function} 557 * @see {@link module:@stdlib/math/strided/special/sfloor} 558 */ 559 setReadOnly( ns, 'sfloor', require( './../../../strided/special/sfloor' ) ); 560 561 /** 562 * @name sinv 563 * @memberof ns 564 * @readonly 565 * @type {Function} 566 * @see {@link module:@stdlib/math/strided/special/sinv} 567 */ 568 setReadOnly( ns, 'sinv', require( './../../../strided/special/sinv' ) ); 569 570 /** 571 * @name smskabs 572 * @memberof ns 573 * @readonly 574 * @type {Function} 575 * @see {@link module:@stdlib/math/strided/special/smskabs} 576 */ 577 setReadOnly( ns, 'smskabs', require( './../../../strided/special/smskabs' ) ); 578 579 /** 580 * @name smskabs2 581 * @memberof ns 582 * @readonly 583 * @type {Function} 584 * @see {@link module:@stdlib/math/strided/special/smskabs2} 585 */ 586 setReadOnly( ns, 'smskabs2', require( './../../../strided/special/smskabs2' ) ); 587 588 /** 589 * @name smskcbrt 590 * @memberof ns 591 * @readonly 592 * @type {Function} 593 * @see {@link module:@stdlib/math/strided/special/smskcbrt} 594 */ 595 setReadOnly( ns, 'smskcbrt', require( './../../../strided/special/smskcbrt' ) ); 596 597 /** 598 * @name smskceil 599 * @memberof ns 600 * @readonly 601 * @type {Function} 602 * @see {@link module:@stdlib/math/strided/special/smskceil} 603 */ 604 setReadOnly( ns, 'smskceil', require( './../../../strided/special/smskceil' ) ); 605 606 /** 607 * @name smskdeg2rad 608 * @memberof ns 609 * @readonly 610 * @type {Function} 611 * @see {@link module:@stdlib/math/strided/special/smskdeg2rad} 612 */ 613 setReadOnly( ns, 'smskdeg2rad', require( './../../../strided/special/smskdeg2rad' ) ); 614 615 /** 616 * @name smskfloor 617 * @memberof ns 618 * @readonly 619 * @type {Function} 620 * @see {@link module:@stdlib/math/strided/special/smskfloor} 621 */ 622 setReadOnly( ns, 'smskfloor', require( './../../../strided/special/smskfloor' ) ); 623 624 /** 625 * @name smskinv 626 * @memberof ns 627 * @readonly 628 * @type {Function} 629 * @see {@link module:@stdlib/math/strided/special/smskinv} 630 */ 631 setReadOnly( ns, 'smskinv', require( './../../../strided/special/smskinv' ) ); 632 633 /** 634 * @name smskramp 635 * @memberof ns 636 * @readonly 637 * @type {Function} 638 * @see {@link module:@stdlib/math/strided/special/smskramp} 639 */ 640 setReadOnly( ns, 'smskramp', require( './../../../strided/special/smskramp' ) ); 641 642 /** 643 * @name smskrsqrt 644 * @memberof ns 645 * @readonly 646 * @type {Function} 647 * @see {@link module:@stdlib/math/strided/special/smskrsqrt} 648 */ 649 setReadOnly( ns, 'smskrsqrt', require( './../../../strided/special/smskrsqrt' ) ); 650 651 /** 652 * @name smsksqrt 653 * @memberof ns 654 * @readonly 655 * @type {Function} 656 * @see {@link module:@stdlib/math/strided/special/smsksqrt} 657 */ 658 setReadOnly( ns, 'smsksqrt', require( './../../../strided/special/smsksqrt' ) ); 659 660 /** 661 * @name smsktrunc 662 * @memberof ns 663 * @readonly 664 * @type {Function} 665 * @see {@link module:@stdlib/math/strided/special/smsktrunc} 666 */ 667 setReadOnly( ns, 'smsktrunc', require( './../../../strided/special/smsktrunc' ) ); 668 669 /** 670 * @name sqrt 671 * @memberof ns 672 * @readonly 673 * @type {Function} 674 * @see {@link module:@stdlib/math/strided/special/sqrt} 675 */ 676 setReadOnly( ns, 'sqrt', require( './../../../strided/special/sqrt' ) ); 677 678 /** 679 * @name sramp 680 * @memberof ns 681 * @readonly 682 * @type {Function} 683 * @see {@link module:@stdlib/math/strided/special/sramp} 684 */ 685 setReadOnly( ns, 'sramp', require( './../../../strided/special/sramp' ) ); 686 687 /** 688 * @name srsqrt 689 * @memberof ns 690 * @readonly 691 * @type {Function} 692 * @see {@link module:@stdlib/math/strided/special/srsqrt} 693 */ 694 setReadOnly( ns, 'srsqrt', require( './../../../strided/special/srsqrt' ) ); 695 696 /** 697 * @name ssqrt 698 * @memberof ns 699 * @readonly 700 * @type {Function} 701 * @see {@link module:@stdlib/math/strided/special/ssqrt} 702 */ 703 setReadOnly( ns, 'ssqrt', require( './../../../strided/special/ssqrt' ) ); 704 705 /** 706 * @name strunc 707 * @memberof ns 708 * @readonly 709 * @type {Function} 710 * @see {@link module:@stdlib/math/strided/special/strunc} 711 */ 712 setReadOnly( ns, 'strunc', require( './../../../strided/special/strunc' ) ); 713 714 /** 715 * @name trunc 716 * @memberof ns 717 * @readonly 718 * @type {Function} 719 * @see {@link module:@stdlib/math/strided/special/trunc} 720 */ 721 setReadOnly( ns, 'trunc', require( './../../../strided/special/trunc' ) ); 722 723 724 // EXPORTS // 725 726 module.exports = ns;