@stdlib/ndarray-sub2ind/lib/index.js

Convert subscripts to a linear index.

/**
* @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';

/**
* Convert subscripts to a linear index.
*
* @module @stdlib/ndarray-sub2ind
*
* @example
* var sub2ind = require( '@stdlib/ndarray-sub2ind' );
*
* var i = sub2ind( [ 3, 3, 3 ], 1, 2, 2 );
* // returns 17
*/

// MODULES //

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


// EXPORTS //

module.exports = sub2ind;