index.js (9111B)
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 itercugmean 41 * @memberof ns 42 * @readonly 43 * @type {Function} 44 * @see {@link module:@stdlib/stats/iter/cugmean} 45 */ 46 setReadOnly( ns, 'itercugmean', require( './../../iter/cugmean' ) ); 47 48 /** 49 * @name itercuhmean 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/stats/iter/cuhmean} 54 */ 55 setReadOnly( ns, 'itercuhmean', require( './../../iter/cuhmean' ) ); 56 57 /** 58 * @name itercumax 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/stats/iter/cumax} 63 */ 64 setReadOnly( ns, 'itercumax', require( './../../iter/cumax' ) ); 65 66 /** 67 * @name itercumaxabs 68 * @memberof ns 69 * @readonly 70 * @type {Function} 71 * @see {@link module:@stdlib/stats/iter/cumaxabs} 72 */ 73 setReadOnly( ns, 'itercumaxabs', require( './../../iter/cumaxabs' ) ); 74 75 /** 76 * @name itercumean 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/stats/iter/cumean} 81 */ 82 setReadOnly( ns, 'itercumean', require( './../../iter/cumean' ) ); 83 84 /** 85 * @name itercumeanabs 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/stats/iter/cumeanabs} 90 */ 91 setReadOnly( ns, 'itercumeanabs', require( './../../iter/cumeanabs' ) ); 92 93 /** 94 * @name itercumeanabs2 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/stats/iter/cumeanabs2} 99 */ 100 setReadOnly( ns, 'itercumeanabs2', require( './../../iter/cumeanabs2' ) ); 101 102 /** 103 * @name itercumidrange 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/stats/iter/cumidrange} 108 */ 109 setReadOnly( ns, 'itercumidrange', require( './../../iter/cumidrange' ) ); 110 111 /** 112 * @name itercumin 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/stats/iter/cumin} 117 */ 118 setReadOnly( ns, 'itercumin', require( './../../iter/cumin' ) ); 119 120 /** 121 * @name itercuminabs 122 * @memberof ns 123 * @readonly 124 * @type {Function} 125 * @see {@link module:@stdlib/stats/iter/cuminabs} 126 */ 127 setReadOnly( ns, 'itercuminabs', require( './../../iter/cuminabs' ) ); 128 129 /** 130 * @name itercuprod 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/stats/iter/cuprod} 135 */ 136 setReadOnly( ns, 'itercuprod', require( './../../iter/cuprod' ) ); 137 138 /** 139 * @name itercurange 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/stats/iter/curange} 144 */ 145 setReadOnly( ns, 'itercurange', require( './../../iter/curange' ) ); 146 147 /** 148 * @name itercusum 149 * @memberof ns 150 * @readonly 151 * @type {Function} 152 * @see {@link module:@stdlib/stats/iter/cusum} 153 */ 154 setReadOnly( ns, 'itercusum', require( './../../iter/cusum' ) ); 155 156 /** 157 * @name itercusumabs 158 * @memberof ns 159 * @readonly 160 * @type {Function} 161 * @see {@link module:@stdlib/stats/iter/cusumabs} 162 */ 163 setReadOnly( ns, 'itercusumabs', require( './../../iter/cusumabs' ) ); 164 165 /** 166 * @name itercusumabs2 167 * @memberof ns 168 * @readonly 169 * @type {Function} 170 * @see {@link module:@stdlib/stats/iter/cusumabs2} 171 */ 172 setReadOnly( ns, 'itercusumabs2', require( './../../iter/cusumabs2' ) ); 173 174 /** 175 * @name itermax 176 * @memberof ns 177 * @readonly 178 * @type {Function} 179 * @see {@link module:@stdlib/stats/iter/max} 180 */ 181 setReadOnly( ns, 'itermax', require( './../../iter/max' ) ); 182 183 /** 184 * @name itermaxabs 185 * @memberof ns 186 * @readonly 187 * @type {Function} 188 * @see {@link module:@stdlib/stats/iter/maxabs} 189 */ 190 setReadOnly( ns, 'itermaxabs', require( './../../iter/maxabs' ) ); 191 192 /** 193 * @name itermean 194 * @memberof ns 195 * @readonly 196 * @type {Function} 197 * @see {@link module:@stdlib/stats/iter/mean} 198 */ 199 setReadOnly( ns, 'itermean', require( './../../iter/mean' ) ); 200 201 /** 202 * @name itermeanabs 203 * @memberof ns 204 * @readonly 205 * @type {Function} 206 * @see {@link module:@stdlib/stats/iter/meanabs} 207 */ 208 setReadOnly( ns, 'itermeanabs', require( './../../iter/meanabs' ) ); 209 210 /** 211 * @name itermeanabs2 212 * @memberof ns 213 * @readonly 214 * @type {Function} 215 * @see {@link module:@stdlib/stats/iter/meanabs2} 216 */ 217 setReadOnly( ns, 'itermeanabs2', require( './../../iter/meanabs2' ) ); 218 219 /** 220 * @name itermidrange 221 * @memberof ns 222 * @readonly 223 * @type {Function} 224 * @see {@link module:@stdlib/stats/iter/midrange} 225 */ 226 setReadOnly( ns, 'itermidrange', require( './../../iter/midrange' ) ); 227 228 /** 229 * @name itermin 230 * @memberof ns 231 * @readonly 232 * @type {Function} 233 * @see {@link module:@stdlib/stats/iter/min} 234 */ 235 setReadOnly( ns, 'itermin', require( './../../iter/min' ) ); 236 237 /** 238 * @name iterminabs 239 * @memberof ns 240 * @readonly 241 * @type {Function} 242 * @see {@link module:@stdlib/stats/iter/minabs} 243 */ 244 setReadOnly( ns, 'iterminabs', require( './../../iter/minabs' ) ); 245 246 /** 247 * @name itermmax 248 * @memberof ns 249 * @readonly 250 * @type {Function} 251 * @see {@link module:@stdlib/stats/iter/mmax} 252 */ 253 setReadOnly( ns, 'itermmax', require( './../../iter/mmax' ) ); 254 255 /** 256 * @name itermmaxabs 257 * @memberof ns 258 * @readonly 259 * @type {Function} 260 * @see {@link module:@stdlib/stats/iter/mmaxabs} 261 */ 262 setReadOnly( ns, 'itermmaxabs', require( './../../iter/mmaxabs' ) ); 263 264 /** 265 * @name itermmean 266 * @memberof ns 267 * @readonly 268 * @type {Function} 269 * @see {@link module:@stdlib/stats/iter/mmean} 270 */ 271 setReadOnly( ns, 'itermmean', require( './../../iter/mmean' ) ); 272 273 /** 274 * @name itermmeanabs 275 * @memberof ns 276 * @readonly 277 * @type {Function} 278 * @see {@link module:@stdlib/stats/iter/mmeanabs} 279 */ 280 setReadOnly( ns, 'itermmeanabs', require( './../../iter/mmeanabs' ) ); 281 282 /** 283 * @name itermmeanabs2 284 * @memberof ns 285 * @readonly 286 * @type {Function} 287 * @see {@link module:@stdlib/stats/iter/mmeanabs2} 288 */ 289 setReadOnly( ns, 'itermmeanabs2', require( './../../iter/mmeanabs2' ) ); 290 291 /** 292 * @name itermmidrange 293 * @memberof ns 294 * @readonly 295 * @type {Function} 296 * @see {@link module:@stdlib/stats/iter/mmidrange} 297 */ 298 setReadOnly( ns, 'itermmidrange', require( './../../iter/mmidrange' ) ); 299 300 /** 301 * @name itermmin 302 * @memberof ns 303 * @readonly 304 * @type {Function} 305 * @see {@link module:@stdlib/stats/iter/mmin} 306 */ 307 setReadOnly( ns, 'itermmin', require( './../../iter/mmin' ) ); 308 309 /** 310 * @name itermminabs 311 * @memberof ns 312 * @readonly 313 * @type {Function} 314 * @see {@link module:@stdlib/stats/iter/mminabs} 315 */ 316 setReadOnly( ns, 'itermminabs', require( './../../iter/mminabs' ) ); 317 318 /** 319 * @name itermprod 320 * @memberof ns 321 * @readonly 322 * @type {Function} 323 * @see {@link module:@stdlib/stats/iter/mprod} 324 */ 325 setReadOnly( ns, 'itermprod', require( './../../iter/mprod' ) ); 326 327 /** 328 * @name itermrange 329 * @memberof ns 330 * @readonly 331 * @type {Function} 332 * @see {@link module:@stdlib/stats/iter/mrange} 333 */ 334 setReadOnly( ns, 'itermrange', require( './../../iter/mrange' ) ); 335 336 /** 337 * @name itermsum 338 * @memberof ns 339 * @readonly 340 * @type {Function} 341 * @see {@link module:@stdlib/stats/iter/msum} 342 */ 343 setReadOnly( ns, 'itermsum', require( './../../iter/msum' ) ); 344 345 /** 346 * @name itermsumabs 347 * @memberof ns 348 * @readonly 349 * @type {Function} 350 * @see {@link module:@stdlib/stats/iter/msumabs} 351 */ 352 setReadOnly( ns, 'itermsumabs', require( './../../iter/msumabs' ) ); 353 354 /** 355 * @name itermsumabs2 356 * @memberof ns 357 * @readonly 358 * @type {Function} 359 * @see {@link module:@stdlib/stats/iter/msumabs2} 360 */ 361 setReadOnly( ns, 'itermsumabs2', require( './../../iter/msumabs2' ) ); 362 363 /** 364 * @name iterprod 365 * @memberof ns 366 * @readonly 367 * @type {Function} 368 * @see {@link module:@stdlib/stats/iter/prod} 369 */ 370 setReadOnly( ns, 'iterprod', require( './../../iter/prod' ) ); 371 372 /** 373 * @name iterrange 374 * @memberof ns 375 * @readonly 376 * @type {Function} 377 * @see {@link module:@stdlib/stats/iter/range} 378 */ 379 setReadOnly( ns, 'iterrange', require( './../../iter/range' ) ); 380 381 /** 382 * @name iterstdev 383 * @memberof ns 384 * @readonly 385 * @type {Function} 386 * @see {@link module:@stdlib/stats/iter/stdev} 387 */ 388 setReadOnly( ns, 'iterstdev', require( './../../iter/stdev' ) ); 389 390 /** 391 * @name itersum 392 * @memberof ns 393 * @readonly 394 * @type {Function} 395 * @see {@link module:@stdlib/stats/iter/sum} 396 */ 397 setReadOnly( ns, 'itersum', require( './../../iter/sum' ) ); 398 399 /** 400 * @name itersumabs 401 * @memberof ns 402 * @readonly 403 * @type {Function} 404 * @see {@link module:@stdlib/stats/iter/sumabs} 405 */ 406 setReadOnly( ns, 'itersumabs', require( './../../iter/sumabs' ) ); 407 408 /** 409 * @name itersumabs2 410 * @memberof ns 411 * @readonly 412 * @type {Function} 413 * @see {@link module:@stdlib/stats/iter/sumabs2} 414 */ 415 setReadOnly( ns, 'itersumabs2', require( './../../iter/sumabs2' ) ); 416 417 /** 418 * @name itervariance 419 * @memberof ns 420 * @readonly 421 * @type {Function} 422 * @see {@link module:@stdlib/stats/iter/variance} 423 */ 424 setReadOnly( ns, 'itervariance', require( './../../iter/variance' ) ); 425 426 427 // EXPORTS // 428 429 module.exports = ns;