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 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 279x 279x 279x 279x 279x 279x 279x 279x 279x 279x 60x 60x 219x 219x 219x 219x 279x 3x 3x 216x 216x 75x 75x 16x 16x 59x 59x 59x 59x 59x 12x 12x 59x 75x 141x 141x 141x 141x 141x 18x 18x 141x 189x 279x 75x 75x 72x 72x 279x 114x 114x 117x 117x 117x 117x 117x 117x 117x 117x 117x 279x 279x 2x 2x 2x 2x 2x | /**
* @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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isMostlySafeCast = require( '@stdlib/ndarray/base/assert/is-mostly-safe-data-type-cast' );
var getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var empty = require( '@stdlib/ndarray/empty' );
var assign = require( '@stdlib/ndarray/base/assign' );
var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
var sort = require( '@stdlib/blas/ext/sort' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Returns a new ndarray containing the elements of an input ndarray sorted along one or more ndarray dimensions.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|number|string)} [sortOrder=1.0] - sort order
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @param {*} [options.dtype] - output ndarray data type
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} sort order argument must be either an ndarray-like object, a numeric value, or a supported string
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension indices must not exceed input ndarray bounds
* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ -3.0, 4.0 ] ], [ [ -5.0, 6.0 ] ] ] );
* // returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ -3.0, 4.0 ] ], [ [ -5.0, 6.0 ] ] ]
*
* var out = toSorted( x );
* // returns <ndarray>[ [ [ -5.0, -3.0 ] ], [ [ 1.0, 2.0 ] ], [ [ 4.0, 6.0 ] ] ]
*/
function toSorted( x ) {
var sortOrder;
var options;
var nargs;
var xdt;
var ydt;
var y;
var o;
if ( !isndarrayLike( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
}
nargs = arguments.length;
o = arguments[ 1 ];
// Case: toSorted( x )
if ( nargs < 2 ) {
sortOrder = 1;
}
// Case: toSorted( x, ??? )
else if ( nargs === 2 ) {
// Case: toSorted( x, sortOrder_string || sortOrder_scalar || sortOrder_ndarray ) )
if ( isString( o ) || isNumber( o ) || isndarrayLike( o ) ) {
sortOrder = o;
}
// Case: toSorted( x, options )
else {
sortOrder = 1;
options = o;
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
}
}
// Case: toSorted( x, sortOrder, options )
else if ( nargs >= 3 ) {
sortOrder = o;
options = arguments[ 2 ];
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
}
xdt = getDType( x );
if ( options && hasOwnProp( options, 'dtype' ) ) {
ydt = options.dtype;
if ( !isMostlySafeCast( xdt, ydt ) ) {
throw new TypeError( format( 'invalid argument. First argument cannot be safely cast to the output data type. Data types: [%s, %s].', resolveStr( xdt ), resolveStr( ydt ) ) );
}
} else {
ydt = xdt;
}
// Create an output ndarray:
y = empty( getShape( x ), {
'dtype': ydt,
'order': getOrder( x )
});
// Copy elements from the input ndarray to the output ndarray:
assign( [ x, y ] );
return sort( y, sortOrder, options || {} );
}
// EXPORTS //
module.exports = toSorted;
|