time-to-botec

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

index.js (3049B)

      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 a readable stream from an array-like object which repeatedly iterates over a provided value's elements.
     23 *
     24 * @module @stdlib/streams/node/from-circular-array
     25 *
     26 * @example
     27 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     28 * var Float64Array = require( '@stdlib/array/float64' );
     29 * var randu = require( '@stdlib/random/base/randu' );
     30 * var circularArrayStream = require( '@stdlib/streams/node/from-circular-array' );
     31 *
     32 * function log( chunk ) {
     33 *    console.log( chunk.toString() );
     34 * }
     35 *
     36 * var arr = new Float64Array( 10 );
     37 * var i;
     38 * for ( i = 0; i < arr.length; i++ ) {
     39 *     arr[ i ] = randu();
     40 * }
     41 *
     42 * var opts = {
     43 *     'iter': arr.length * 2
     44 * };
     45 *
     46 * var stream = circularArrayStream( arr, opts );
     47 *
     48 * stream.pipe( inspectStream( log ) );
     49 *
     50 * @example
     51 * var Float64Array = require( '@stdlib/array/float64' );
     52 * var randu = require( '@stdlib/random/base/randu' );
     53 * var circularArrayStream = require( '@stdlib/streams/node/from-circular-array' );
     54 *
     55 * var arr = new Float64Array( 10 );
     56 * var i;
     57 * for ( i = 0; i < arr.length; i++ ) {
     58 *     arr[ i ] = randu();
     59 * }
     60 *
     61 * var opts = {
     62 *     'sep': ',',
     63 *     'objectMode': false,
     64 *     'encoding': 'utf8',
     65 *     'highWaterMark': 64
     66 * };
     67 *
     68 * var createStream = circularArrayStream.factory( opts );
     69 *
     70 * // Create 10 identically configured streams...
     71 * var streams = [];
     72 * for ( i = 0; i < 10; i++ ) {
     73 *     streams.push( createStream( arr ) );
     74 * }
     75 *
     76 * @example
     77 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     78 * var Float64Array = require( '@stdlib/array/float64' );
     79 * var randu = require( '@stdlib/random/base/randu' );
     80 * var circularArrayStream = require( '@stdlib/streams/node/from-circular-array' );
     81 *
     82 * function log( v ) {
     83 *    console.log( v );
     84 * }
     85 *
     86 * var arr = new Float64Array( 10 );
     87 * var i;
     88 * for ( i = 0; i < arr.length; i++ ) {
     89 *     arr[ i ] = randu();
     90 * }
     91 *
     92 * var opts = {
     93 *     'iter': arr.length * 2
     94 * };
     95 *
     96 * var stream = circularArrayStream.objectMode( arr, opts );
     97 *
     98 * stream.pipe( inspectStream.objectMode( log ) );
     99 */
    100 
    101 
    102 // MODULES //
    103 
    104 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
    105 var stream = require( './main.js' );
    106 var objectMode = require( './object_mode.js' );
    107 var factory = require( './factory.js' );
    108 
    109 
    110 // MAIN //
    111 
    112 setReadOnly( stream, 'objectMode', objectMode );
    113 setReadOnly( stream, 'factory', factory );
    114 
    115 
    116 // EXPORTS //
    117 
    118 module.exports = stream;