time-to-botec

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

index.js (1205B)

      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 * Until a test condition is true, invoke a function once for each element in a collection.
     23 *
     24 * @module @stdlib/utils/do-until-each
     25 *
     26 * @example
     27 * var doUntilEach = require( '@stdlib/utils/do-until-each' );
     28 *
     29 * function predicate( v, index, collection ) {
     30 *     return ( v !== v );
     31 * }
     32 *
     33 * function log( v, index, collection ) {
     34 *     console.log( '%s: %d', index, v );
     35 * }
     36 *
     37 * var arr = [ 1, 2, 3, 4, NaN, 5 ];
     38 *
     39 * doUntilEach( arr, log, predicate );
     40 */
     41 
     42 // MODULES //
     43 
     44 var doUntilEach = require( './do_until_each.js' );
     45 
     46 
     47 // EXPORTS //
     48 
     49 module.exports = doUntilEach;