time-to-botec

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

index.js (1466B)

      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 * Return an index given an index mode.
     23 *
     24 * @module @stdlib/ndarray/base/ind
     25 *
     26 * @example
     27 * var ind = require( '@stdlib/ndarray/base/ind' );
     28 *
     29 * var idx = ind( -1, 10, 'wrap' );
     30 * // returns 10
     31 *
     32 * idx = ind( 14, 10, 'wrap' );
     33 * // returns 3
     34 *
     35 * idx = ind( 6, 10, 'wrap' );
     36 * // returns 6
     37 *
     38 * @example
     39 * var ind = require( '@stdlib/ndarray/base/ind' );
     40 *
     41 * var idx = ind( -1, 10, 'clamp' );
     42 * // returns 0
     43 *
     44 * idx = ind( 14, 10, 'clamp' );
     45 * // returns 10
     46 *
     47 * idx = ind( 6, 10, 'clamp' );
     48 * // returns 6
     49 *
     50 * @example
     51 * var ind = require( '@stdlib/ndarray/base/ind' );
     52 *
     53 * var idx = ind( 1, 10, 'throw' );
     54 * // returns 1
     55 *
     56 * idx = ind( 14, 10, 'throw' );
     57 * // throws <RangeError>
     58 *
     59 * idx = ind( -1, 10, 'throw' );
     60 * // throws <RangeError>
     61 */
     62 
     63 // MODULES //
     64 
     65 var ind = require( './main.js' );
     66 
     67 
     68 // EXPORTS //
     69 
     70 module.exports = ind;