time-to-botec

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

main.js (1520B)


      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 modes = require( './../../../../casting-modes' );
     24 
     25 
     26 // VARIABLES //
     27 
     28 var MODES = modes();
     29 var len = MODES.length;
     30 
     31 
     32 // MAIN //
     33 
     34 /**
     35 * Tests whether an input value is a supported ndarray casting mode.
     36 *
     37 * @param {*} v - value to test
     38 * @returns {boolean} boolean indicating whether an input value is a supported ndarray casting mode
     39 *
     40 * @example
     41 * var bool = isCastingMode( 'none' );
     42 * // returns true
     43 *
     44 * bool = isCastingMode( 'equiv' );
     45 * // returns true
     46 *
     47 * bool = isCastingMode( 'safe' );
     48 * // returns true
     49 *
     50 * bool = isCastingMode( 'same-kind' );
     51 * // returns true
     52 *
     53 * bool = isCastingMode( 'unsafe' );
     54 * // returns true
     55 *
     56 * bool = isCastingMode( 'foo' );
     57 * // returns false
     58 */
     59 function isCastingMode( v ) {
     60 	var i;
     61 	for ( i = 0; i < len; i++ ) {
     62 		if ( v === MODES[ i ] ) {
     63 			return true;
     64 		}
     65 	}
     66 	return false;
     67 }
     68 
     69 
     70 // EXPORTS //
     71 
     72 module.exports = isCastingMode;