validate.js (1684B)
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 isPositive = require( '@stdlib/assert/is-positive-number' ).isPrimitive; 24 var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive; 25 var isnan = require( '@stdlib/assert/is-nan' ); 26 27 28 // MAIN // 29 30 /** 31 * Validates parameters. 32 * 33 * @private 34 * @param {PositiveNumber} r - number of successes until experiment is stopped 35 * @param {number} p - success probability 36 * @returns {(Error|null)} error or null 37 * 38 * @example 39 * var err = validate( 10, 0.5 ); 40 * if ( err ) { 41 * throw err; 42 * } 43 */ 44 function validate( r, p ) { 45 if ( !isPositive( r ) ) { 46 return new TypeError( 'invalid argument. First argument must be a positive number. Value: `' + r + '`.' ); 47 } 48 if ( !isNumber( p ) || isnan( p ) ) { 49 return new TypeError( 'invalid argument. Second argument must be a number primitive and not `NaN`. Value: `' + p + '`.' ); 50 } 51 if ( p <= 0.0 || p >= 1.0 ) { 52 return new RangeError( 'invalid argument. Second argument must be on the interval `(0,1)`. Value: `' + p + '`.' ); 53 } 54 return null; 55 } 56 57 58 // EXPORTS // 59 60 module.exports = validate;