time-to-botec

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

index.js (1235B)

      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 * Create an iterator from a strided array-like value.
     23 *
     24 * @module @stdlib/array/to-strided-iterator
     25 *
     26 * @example
     27 * var stridedarray2iterator = require( '@stdlib/array/to-strided-iterator' );
     28 *
     29 * var values = [ 1, 2, 3, 4, 5, 6, 7, 8 ];
     30 *
     31 * var N = 4;
     32 * var stride = -2;
     33 * var offset = 6;
     34 *
     35 * var iter = stridedarray2iterator( N, values, stride, offset );
     36 *
     37 * var v = iter.next().value;
     38 * // returns 7
     39 *
     40 * v = iter.next().value;
     41 * // returns 5
     42 *
     43 * v = iter.next().value;
     44 * // returns 3
     45 *
     46 * // ...
     47 */
     48 
     49 // MODULES //
     50 
     51 var iterator = require( './main.js' );
     52 
     53 
     54 // EXPORTS //
     55 
     56 module.exports = iterator;