time-to-botec

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

main.js (1299B)


      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 orders = require( './../../../../orders' );
     24 
     25 
     26 // VARIABLES //
     27 
     28 var ORDERS = orders();
     29 var len = ORDERS.length;
     30 
     31 
     32 // MAIN //
     33 
     34 /**
     35 * Tests whether an input value is an ndarray order.
     36 *
     37 * @param {*} v - value to test
     38 * @returns {boolean} boolean indicating whether an input value is an ndarray order
     39 *
     40 * @example
     41 * var bool = isOrder( 'row-major' );
     42 * // returns true
     43 *
     44 * bool = isOrder( 'column-major' );
     45 * // returns true
     46 *
     47 * bool = isOrder( 'foo' );
     48 * // returns false
     49 */
     50 function isOrder( v ) {
     51 	var i;
     52 	for ( i = 0; i < len; i++ ) {
     53 		if ( v === ORDERS[ i ] ) {
     54 			return true;
     55 		}
     56 	}
     57 	return false;
     58 }
     59 
     60 
     61 // EXPORTS //
     62 
     63 module.exports = isOrder;