time-to-botec/js/node_modules/@stdlib/ndarray/base/min-view-buffer-index/lib/index.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

/**
* Compute the minimum linear index in an underlying data buffer accessible to an array view.
*
* @module @stdlib/ndarray/base/min-view-buffer-index
*
* @example
* var minViewBufferIndex = require( '@stdlib/ndarray/base/min-view-buffer-index' );
*
* var shape = [ 10, 10 ];
* var strides = [ 10, 1 ];
* var offset = 10;
*
* var idx = minViewBufferIndex( shape, strides, offset );
* // returns 10
*
* @example
* var minViewBufferIndex = require( '@stdlib/ndarray/base/min-view-buffer-index' );
*
* var shape = [ 10, 10 ];
* var strides = [ -10, -1 ];
* var offset = 109;
*
* var idx = minViewBufferIndex( shape, strides, offset );
* // returns 10
*
* @example
* var minViewBufferIndex = require( '@stdlib/ndarray/base/min-view-buffer-index' );
*
* var shape = [ 10, 10 ];
* var strides = [ 1, 10 ];
* var offset = 10;
*
* var idx = minViewBufferIndex( shape, strides, offset );
* // returns 10
*
* @example
* var minViewBufferIndex = require( '@stdlib/ndarray/base/min-view-buffer-index' );
*
* var shape = [ 10, 10 ];
* var strides = [ -1, -10 ];
* var offset = 109;
*
* var idx = minViewBufferIndex( shape, strides, offset );
* // returns 10
*/

// MODULES //

var minViewBufferIndex = require( './main.js' );


// EXPORTS //

module.exports = minViewBufferIndex;