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 | 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 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x 36x 19x 19x 19x 36x 10x 10x 10x 5x 5x 5x 5x 5x 5x 5x 10x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2026 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 getDType = require( '@stdlib/ndarray/base/dtype' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getOrder = require( '@stdlib/ndarray/base/order' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
// MAIN //
/**
* Removes singleton dimensions from an input ndarray if and only if it contains singleton dimensions.
*
* ## Notes
*
* - If the input ndarray does not contain any singleton dimensions, the function returns the input ndarray unchanged.
* - If the input ndarray contains singleton dimensions, the function returns a new ndarray instance without those dimensions.
*
* @param {ndarray} x - input array
* @param {boolean} writable - boolean indicating whether a returned array should be writable
* @returns {ndarray} squeezed ndarray view or input ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ 1, 2 ], [ 3, 4 ] ], {
* 'ndmin': 5
* });
* // returns <ndarray>[ [ [ [ [ 1, 2 ], [ 3, 4 ] ] ] ] ]
*
* var y = maybeRemoveSingletonDimensions( x, false );
* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
*/
function maybeRemoveSingletonDimensions( x, writable ) {
var strides;
var shape;
var sh;
var st;
var N;
var i;
sh = getShape( x, false );
st = getStrides( x, false );
N = sh.length;
strides = [];
shape = [];
// Check for singleton dimensions...
for ( i = 0; i < N; i++ ) {
if ( sh[ i ] !== 1 ) {
shape.push( sh[ i ] );
strides.push( st[ i ] );
}
}
// If we filtered out at least one singleton dimension, return a new view...
if ( shape.length < N ) {
return new x.constructor( getDType( x ), getData( x ), shape, strides, getOffset( x ), getOrder( x ), { // eslint-disable-line max-len
'readonly': !writable
});
}
// If no singleton dimensions were found, return the input array...
return x;
}
// EXPORTS //
module.exports = maybeRemoveSingletonDimensions;
|