index.js (1248B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2019 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 * Create an iterator which iteratively computes a cumulative maximum absolute value. 23 * 24 * @module @stdlib/stats/iter/cumaxabs 25 * 26 * @example 27 * var runif = require( '@stdlib/random/iter/uniform' ); 28 * var itercumaxabs = require( '@stdlib/stats/iter/cumaxabs' ); 29 * 30 * var rand = runif( -10.0, 10.0, { 31 * 'iter': 100 32 * }); 33 * 34 * var it = itercumaxabs( rand ); 35 * 36 * var v = it.next().value; 37 * // returns <number> 38 * 39 * v = it.next().value; 40 * // returns <number> 41 * 42 * v = it.next().value; 43 * // returns <number> 44 * 45 * // ... 46 */ 47 48 // MODULES // 49 50 var iterator = require( './main.js' ); 51 52 53 // EXPORTS // 54 55 module.exports = iterator;