Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 1x 73x 42x 42x 145x 145x 72x 1x 30x 20x 29x 9x 9x 64x 64x 64x 64x 73x 184x 184x 184x 184x 41x 41x 184x 23x 23x 73x 8x 8x 15x 15x 73x 27x 27x 15x 73x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2023 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';
// MODULES //
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
var broadcastShapes = require( '@stdlib/ndarray/base/broadcast-shapes' );
var maybeBroadcastArray = require( '@stdlib/ndarray/maybe-broadcast-array' );
var getShape = require( '@stdlib/ndarray/shape' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Broadcasts an ndarrays to a common shape.
*
* ## Notes
*
* - If a provided ndarray has a shape matching the common shape, the function returns the provided ndarray.
* - If a provided ndarray has a different (broadcast compatible) shape than the common shape, the function returns a new **read-only** ndarray view of the provided ndarray's data. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to a view may affect multiple elements. If you need to write to an input ndarray, copy the input ndarray before broadcasting.
*
* @param {...ndarray} arrays - ndarray arguments
* @throws {TypeError} first argument must be an ndarray or an array of ndarrays
* @throws {TypeError} must provide valid ndarray arguments
* @throws {Error} input arrays must be broadcast compatible
* @returns {Array<ndarray>} broadcasted arrays
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
* // returns <ndarray>
*
* var shx = x1.shape;
* // returns [ 2, 2 ]
*
* var y1 = zeros( [ 3, 2, 2 ] );
* // returns <ndarray>
*
* var shy = y1.shape;
* // returns [ 3, 2, 2 ]
*
* var out = maybeBroadcastArrays( [ x1, y1 ] );
* // returns <ndarray>
*
* var x2 = out[ 0 ];
* // returns <ndarray>
*
* var y2 = out[ 1 ];
* // returns <ndarray>
*
* shx = x2.shape;
* // returns [ 3, 2, 2 ]
*
* shy = y2.shape;
* // returns [ 3, 2, 2 ]
*
* var v = x2.get( 0, 0, 0 );
* // returns 1
*
* v = x2.get( 0, 0, 1 );
* // returns 2
*
* v = x2.get( 1, 0, 0 );
* // returns 1
*
* v = x2.get( 1, 1, 0 );
* // returns 3
*
* v = x2.get( 2, 0, 0 );
* // returns 1
*
* v = x2.get( 2, 1, 1 );
* // returns 4
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = zeros( [ 2, 2 ] );
* // returns <ndarray>
*
* var y = zeros( [ 4, 2 ] );
* // returns <ndarray>
*
* var out = maybeBroadcastArrays( [ x, y ] );
* // throws <Error>
*/
function maybeBroadcastArrays( arrays ) {
var shapes;
var nargs;
var list;
var out;
var sh;
var N;
var i;
nargs = arguments.length;
if ( nargs === 0 ) {
list = [];
} else if ( nargs > 1 ) {
list = [];
for ( i = 0; i < arguments.length; i++ ) {
list.push( arguments[ i ] );
}
} else if ( isndarrayLike( arrays ) ) {
list = [ arrays ];
} else if ( isArrayLikeObject( arrays ) ) {
list = arrays;
} else {
throw new TypeError( format( 'invalid argument. First argument must be either an ndarray or an array of ndarrays. Value: `%s`.', arrays ) );
}
N = list.length;
// Resolve the list of shapes...
shapes = [];
for ( i = 0; i < N; i++ ) {
// Delegate input argument validation to `getShape`...
try {
shapes.push( getShape( list[ i ] ) );
} catch ( err ) { // eslint-disable-line no-unused-vars
throw new TypeError( format( 'invalid argument. An ndarray argument must be an ndarray. Value: `%s`.', list[ i ] ) );
}
}
// Broadcast the shapes to a common shape:
sh = broadcastShapes( shapes );
if ( sh === null ) {
throw new Error( 'invalid arguments. Input arrays must be broadcast compatible.' );
}
// Broadcast each array to the common shape...
out = [];
for ( i = 0; i < N; i++ ) {
out.push( maybeBroadcastArray( list[ i ], sh ) );
}
return out;
}
// EXPORTS //
module.exports = maybeBroadcastArrays;
|