69 lines
1.4 KiB
JavaScript
69 lines
1.4 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2021 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';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Broadcast an ndarray to a specified shape.
|
||
|
|
*
|
||
|
|
* @module @stdlib/ndarray/base/broadcast-array
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var array = require( '@stdlib/ndarray/array' );
|
||
|
|
* var broadcastArray = require( '@stdlib/ndarray/base/broadcast-array' );
|
||
|
|
*
|
||
|
|
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
|
||
|
|
* // returns <ndarray>
|
||
|
|
*
|
||
|
|
* var shx = x.shape;
|
||
|
|
* // returns [ 2, 2 ]
|
||
|
|
*
|
||
|
|
* var y = broadcastArray( x, [ 3, 2, 2 ] );
|
||
|
|
* // returns <ndarray>
|
||
|
|
*
|
||
|
|
* var shy = y.shape;
|
||
|
|
* // returns [ 3, 2, 2 ]
|
||
|
|
*
|
||
|
|
* var v = y.get( 0, 0, 0 );
|
||
|
|
* // returns 1
|
||
|
|
*
|
||
|
|
* v = y.get( 0, 0, 1 );
|
||
|
|
* // returns 2
|
||
|
|
*
|
||
|
|
* v = y.get( 1, 0, 0 );
|
||
|
|
* // returns 1
|
||
|
|
*
|
||
|
|
* v = y.get( 1, 1, 0 );
|
||
|
|
* // returns 3
|
||
|
|
*
|
||
|
|
* v = y.get( 2, 0, 0 );
|
||
|
|
* // returns 1
|
||
|
|
*
|
||
|
|
* v = y.get( 2, 1, 1 );
|
||
|
|
* // returns 4
|
||
|
|
*/
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var main = require( './main.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = main;
|