time-to-botec

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

index.js (1897B)

      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 * Compute the maximum linear index in an underlying data buffer accessible to an array view.
     23 *
     24 * @module @stdlib/ndarray/base/max-view-buffer-index
     25 *
     26 * @example
     27 * var maxViewBufferIndex = require( '@stdlib/ndarray/base/max-view-buffer-index' );
     28 *
     29 * var shape = [ 10, 10 ];
     30 * var strides = [ 10, 1 ];
     31 * var offset = 0;
     32 *
     33 * var idx = maxViewBufferIndex( shape, strides, offset );
     34 * // returns 99
     35 *
     36 * @example
     37 * var maxViewBufferIndex = require( '@stdlib/ndarray/base/max-view-buffer-index' );
     38 *
     39 * var shape = [ 10, 10 ];
     40 * var strides = [ -10, -1 ];
     41 * var offset = 99;
     42 *
     43 * var idx = maxViewBufferIndex( shape, strides, offset );
     44 * // returns 99
     45 *
     46 * @example
     47 * var maxViewBufferIndex = require( '@stdlib/ndarray/base/max-view-buffer-index' );
     48 *
     49 * var shape = [ 10, 10 ];
     50 * var strides = [ 1, 10 ];
     51 * var offset = 0;
     52 *
     53 * var idx = maxViewBufferIndex( shape, strides, offset );
     54 * // returns 99
     55 *
     56 * @example
     57 * var maxViewBufferIndex = require( '@stdlib/ndarray/base/max-view-buffer-index' );
     58 *
     59 * var shape = [ 10, 10 ];
     60 * var strides = [ -1, -10 ];
     61 * var offset = 99;
     62 *
     63 * var idx = maxViewBufferIndex( shape, strides, offset );
     64 * // returns 99
     65 */
     66 
     67 // MODULES //
     68 
     69 var maxViewBufferIndex = require( './main.js' );
     70 
     71 
     72 // EXPORTS //
     73 
     74 module.exports = maxViewBufferIndex;