time-to-botec

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

index.js (1072B)

      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 * Convert subscripts to a linear index.
     23 *
     24 * @module @stdlib/ndarray/base/sub2ind
     25 *
     26 * @example
     27 * var sub2ind = require( '@stdlib/ndarray/base/sub2ind' );
     28 *
     29 * var shape = [ 3, 3, 3 ];
     30 * var strides = [ 9, 3, 1 ];
     31 * var offset = 0;
     32 * var mode = [ 'throw' ];
     33 *
     34 * var idx = sub2ind( shape, strides, offset, 1, 2, 2, mode );
     35 * // returns 17
     36 */
     37 
     38 // MODULES //
     39 
     40 var sub2ind = require( './main.js' );
     41 
     42 
     43 // EXPORTS //
     44 
     45 module.exports = sub2ind;