time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1271B)

      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 performs an element-wise modulo operation of two or more iterators.
     23 *
     24 * @module @stdlib/math/iter/ops/mod
     25 *
     26 * @example
     27 * var array2iterator = require( '@stdlib/array/to-iterator' );
     28 * var iterMod = require( '@stdlib/math/iter/ops/mod' );
     29 *
     30 * var it1 = array2iterator( [ 3.0, 2.0 ] );
     31 * var it2 = array2iterator( [ 1.0, 4.0 ] );
     32 *
     33 * var iter = iterMod( it1, it2 );
     34 *
     35 * var v = iter.next().value;
     36 * // returns 0.0
     37 *
     38 * v = iter.next().value;
     39 * // returns 2.0
     40 *
     41 * var bool = iter.next().done;
     42 * // returns true
     43 */
     44 
     45 // MODULES //
     46 
     47 var iterMod = require( './main.js' );
     48 
     49 
     50 // EXPORTS //
     51 
     52 module.exports = iterMod;