time-to-botec

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

index.js (2926B)

      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 a strided array-like value.
     23 *
     24 * @module @stdlib/streams/node/from-strided-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 stridedArrayStream = require( '@stdlib/streams/node/from-strided-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 stream = stridedArrayStream( arr.length, arr, 1, 0 );
     43 *
     44 * stream.pipe( inspectStream( log ) );
     45 *
     46 * @example
     47 * var Float64Array = require( '@stdlib/array/float64' );
     48 * var randu = require( '@stdlib/random/base/randu' );
     49 * var stridedArrayStream = require( '@stdlib/streams/node/from-strided-array' );
     50 *
     51 * var arr = new Float64Array( 10 );
     52 * var i;
     53 * for ( i = 0; i < arr.length; i++ ) {
     54 *     arr[ i ] = randu();
     55 * }
     56 *
     57 * var opts = {
     58 *     'sep': ',',
     59 *     'objectMode': false,
     60 *     'encoding': 'utf8',
     61 *     'highWaterMark': 64
     62 * };
     63 *
     64 * var createStream = stridedArrayStream.factory( opts );
     65 *
     66 * // Create 10 identically configured streams...
     67 * var streams = [];
     68 * for ( i = 0; i < 10; i++ ) {
     69 *     streams.push( createStream( arr.length, arr, 1, 0 ) );
     70 * }
     71 *
     72 * @example
     73 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     74 * var Float64Array = require( '@stdlib/array/float64' );
     75 * var randu = require( '@stdlib/random/base/randu' );
     76 * var stridedArrayStream = require( '@stdlib/streams/node/from-strided-array' );
     77 *
     78 * function log( v ) {
     79 *    console.log( v );
     80 * }
     81 *
     82 * var arr = new Float64Array( 10 );
     83 * var i;
     84 * for ( i = 0; i < arr.length; i++ ) {
     85 *     arr[ i ] = randu();
     86 * }
     87 *
     88 * var stream = stridedArrayStream.objectMode( arr.length, arr, 1, 0 );
     89 *
     90 * stream.pipe( inspectStream.objectMode( log ) );
     91 */
     92 
     93 
     94 // MODULES //
     95 
     96 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     97 var stream = require( './main.js' );
     98 var objectMode = require( './object_mode.js' );
     99 var factory = require( './factory.js' );
    100 
    101 
    102 // MAIN //
    103 
    104 setReadOnly( stream, 'objectMode', objectMode );
    105 setReadOnly( stream, 'factory', factory );
    106 
    107 
    108 // EXPORTS //
    109 
    110 module.exports = stream;