time-to-botec

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

object_mode.js (3027B)

      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 // MODULES //
     22 
     23 var isObject = require( '@stdlib/assert/is-plain-object' );
     24 var copy = require( '@stdlib/utils/copy' );
     25 var RandomStream = require( './main.js' );
     26 
     27 
     28 // MAIN //
     29 
     30 /**
     31 * Returns an "objectMode" readable stream for generating pseudorandom numbers drawn from a Fréchet distribution.
     32 *
     33 * @param {PositiveNumber} [alpha] - shape parameter
     34 * @param {PositiveNumber} [s] - scale parameter
     35 * @param {number} [m] - location parameter
     36 * @param {Options} [options] - stream options
     37 * @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to `strings`
     38 * @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of objects to store in an internal buffer before ceasing to generate additional pseudorandom numbers
     39 * @param {NonNegativeInteger} [options.iter] - number of iterations
     40 * @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
     41 * @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed
     42 * @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state
     43 * @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state
     44 * @param {PositiveInteger} [options.siter] - number of iterations after which to emit the PRNG state
     45 * @throws {TypeError} `alpha` must be a positive number
     46 * @throws {TypeError} `s` must be a positive number
     47 * @throws {TypeError} `m` must be a number
     48 * @throws {TypeError} options argument must be an object
     49 * @throws {TypeError} must provide valid options
     50 * @throws {Error} must provide a valid state
     51 * @returns {RandomStream} Stream instance
     52 *
     53 * @example
     54 * var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
     55 *
     56 * function log( v ) {
     57 *    console.log( v );
     58 * }
     59 *
     60 * var opts = {
     61 *     'iter': 10
     62 * };
     63 *
     64 * var stream = objectMode( 2.0, 5.0, -1.0, opts );
     65 *
     66 * stream.pipe( inspectStream.objectMode( log ) );
     67 */
     68 function objectMode( alpha, s, m, options ) {
     69 	var opts;
     70 	if ( arguments.length > 3 ) {
     71 		opts = options;
     72 		if ( !isObject( opts ) ) {
     73 			throw new TypeError( 'invalid argument. Options must be an object. Value: `' + opts + '`.' );
     74 		}
     75 		opts = copy( options, 1 );
     76 	} else {
     77 		opts = {};
     78 	}
     79 	opts.objectMode = true;
     80 	return new RandomStream( alpha, s, m, opts );
     81 }
     82 
     83 
     84 // EXPORTS //
     85 
     86 module.exports = objectMode;