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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | 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 | /**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
var isEmptyCollection = require( '@stdlib/assert/is-empty-collection' );
var isIntegerArray = require( '@stdlib/assert/is-integer-array' ).primitives;
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
var isComplexLike = require( '@stdlib/assert/is-complex-like' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
var isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
var nonCoreShape = require( '@stdlib/ndarray/base/complement-shape' );
var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
var getDType = require( '@stdlib/ndarray/base/dtype' );
var empty = require( '@stdlib/ndarray/empty' );
var contains = require( '@stdlib/array/base/assert/contains' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
var DTYPES = require( './dtypes.js' );
var ENUMS = require( './type_enums.js' );
var resolveDataTypes = require( './resolve_data_types.js' );
var resolveOrder = require( './resolve_order.js' );
var normalizeArguments = require( './normalize_arguments.js' );
var defaults = require( './defaults.js' );
var base = require( './base.js' );
// MAIN //
/**
* Returns a new ndarray filled with linearly spaced values over a specified interval along one or more ndarray dimensions.
*
* @param {(NonNegativeInteger|NonNegativeIntegerArray)} shape - array shape
* @param {(number|ndarrayLike)} start - start of interval
* @param {(number|ndarrayLike)} stop - end of interval
* @param {(boolean|ndarrayLike)} [endpoint=true] - specifies whether to include the end of the interval when writing values to the output ndarray
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims=[-1]] - list of dimensions over which to perform operation
* @param {*} [options.dtype] - output ndarray data type
* @param {string} [options.order] - ndarray order
* @param {string} [options.mode="throw"] - specifies how to handle indices which exceed ndarray dimensions
* @param {ArrayLikeObject<string>} [options.submode=["throw"]] - specifies how to handle subscripts which exceed ndarray dimensions on a per dimension basis
* @throws {TypeError} first argument must be either a nonnegative integer or an array of nonnegative integers
* @throws {TypeError} second argument must be either a number, complex number, or an ndarray-like object
* @throws {TypeError} third argument must be either a number, complex number, or an ndarray-like object
* @throws {TypeError} fourth argument must be either a boolean or an ndarray-like object
* @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 ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var out = linspace( [ 2, 4 ], 0.0, 3.0 );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ 0.0, 1.0, 2.0, 3.0 ], [ 0.0, 1.0, 2.0, 3.0 ] ]
*/
function linspace( shape, start, stop ) {
var endpoint;
var options;
var dtypes;
var nargs;
var types;
var opts;
var args;
var ncsh;
var out;
var sh;
var dt;
var o;
if ( isNonNegativeInteger( shape ) ) {
sh = [ shape ];
} else if ( isNonNegativeIntegerArray( shape ) ) {
sh = shape; // Note: empty shape (i.e., a shape for a zero-dimensional ndarray) is not allowed
} else {
throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', shape ) );
}
types = [ 0, 0, 0 ]; // [ start, stop, endpoint ]
if ( isNumber( start ) ) {
types[ 0 ] = ENUMS.NUMBER;
} else if ( isComplexLike( start ) ) {
types[ 0 ] = ENUMS.COMPLEX;
} else if ( isndarrayLike( start ) ) {
types[ 0 ] = ENUMS.NDARRAY;
dt = resolveStr( getDType( start ) );
if ( !contains( DTYPES.idtypes0, dt ) ) {
throw new TypeError( format( 'invalid argument. Second argument must have one of the following data types: "%s". Data type: `%s`.', join( DTYPES.idtypes0, '", "' ), dt ) );
}
} else {
throw new TypeError( format( 'invalid argument. Second argument must be either a number, complex number, or an ndarray. Value: `%s`.', start ) );
}
if ( isNumber( stop ) ) {
types[ 1 ] = ENUMS.NUMBER;
} else if ( isComplexLike( stop ) ) {
types[ 1 ] = ENUMS.COMPLEX;
} else if ( isndarrayLike( stop ) ) {
types[ 1 ] = ENUMS.NDARRAY;
dt = resolveStr( getDType( stop ) );
if ( !contains( DTYPES.idtypes1, dt ) ) {
throw new TypeError( format( 'invalid argument. Third argument must have one of the following data types: "%s". Data type: `%s`.', join( DTYPES.idtypes1, '", "' ), dt ) );
}
} else {
throw new TypeError( format( 'invalid argument. Third argument must be either a number, complex number, or an ndarray. Value: `%s`.', stop ) );
}
nargs = arguments.length;
o = arguments[ 3 ];
options = defaults();
// Case: linspace( shape, start, stop )
if ( nargs < 4 ) {
endpoint = true;
types[ 2 ] = ENUMS.BOOLEAN;
}
// Case: linspace( shape, start, stop, ??? )
else if ( nargs === 4 ) {
// Case: linspace( shape, start, stop, endpoint_boolean )
if ( isBoolean( o ) ) {
endpoint = o;
types[ 2 ] = ENUMS.BOOLEAN;
}
// Case: linspace( shape, start, stop, endpoint_ndarray )
else if ( isndarrayLike( o ) ) {
endpoint = o;
dt = resolveStr( getDType( endpoint ) );
if ( !contains( DTYPES.idtypes2, dt ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must have one of the following data types: "%s". Data type: `%s`.', join( DTYPES.idtypes2, '", "' ), dt ) );
}
types[ 2 ] = ENUMS.NDARRAY;
}
// Case: linspace( shape, start, stop, options )
else {
endpoint = true;
types[ 2 ] = ENUMS.BOOLEAN;
opts = o;
if ( !isPlainObject( opts ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) );
}
}
}
// Case: linspace( shape, start, stop, endpoint, options )
else if ( nargs >= 5 ) {
endpoint = o;
if ( isBoolean( endpoint ) ) {
types[ 2 ] = ENUMS.BOOLEAN;
} else if ( isndarrayLike( endpoint ) ) {
types[ 2 ] = ENUMS.NDARRAY;
dt = resolveStr( getDType( endpoint ) );
if ( !contains( DTYPES.idtypes2, dt ) ) {
throw new TypeError( format( 'invalid argument. Fourth argument must have one of the following data types: "%s". Data type: `%s`.', join( DTYPES.idtypes2, '", "' ), dt ) );
}
} else {
throw new TypeError( format( 'invalid argument. Fourth argument must be either a boolean or an ndarray. Value: `%s`.', endpoint ) );
}
opts = arguments[ 4 ];
if ( !isPlainObject( opts ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) );
}
}
// Resolve options...
if ( opts ) {
if ( hasOwnProp( opts, 'dtype' ) ) {
dt = resolveStr( opts.dtype );
if ( !isDataType( opts.dtype ) || !contains( DTYPES.odtypes, dt ) ) { // eslint-disable-line max-len
throw new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', join( DTYPES.odtypes, '", "' ), opts.dtype ) );
}
options.dtype = dt;
}
if ( hasOwnProp( opts, 'order' ) ) {
if ( !isOrder( opts.order ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a supported order. Option: `%s`.', 'order', opts.order ) );
}
options.order = opts.order;
}
if ( hasOwnProp( opts, 'mode' ) ) {
// Defer to `empty` to validate below...
options.mode = opts.mode;
}
if ( hasOwnProp( opts, 'submode' ) ) {
// Defer to `empty` to validate below...
options.submode = opts.submode;
}
if ( hasOwnProp( opts, 'dims' ) ) {
if ( !isIntegerArray( opts.dims ) && !isEmptyCollection( opts.dims ) ) { // eslint-disable-line max-len
throw new TypeError( format( 'invalid option. `%s` option must be an array of integers. Option: `%s`.', 'dims', opts.dims ) );
}
options.dims = opts.dims;
}
}
args = [ start, stop, endpoint ];
// Resolve argument data types:
dtypes = resolveDataTypes( args.slice( 0, 2 ), types );
options.dtype = options.dtype || dtypes[ 3 ];
dtypes[ 3 ] = options.dtype;
// Resolve the output array order:
options.order = options.order || resolveOrder( args, types );
// Resolve the complement of the operation dimensions:
ncsh = nonCoreShape( sh, options.dims );
// Normalize provided arguments to ndarrays:
args = normalizeArguments( args, types, dtypes, ncsh, options.order );
// Create an output ndarray:
out = empty( sh, options );
// Perform operation:
return base( out, args[ 0 ], args[ 1 ], args[ 2 ], options );
}
// EXPORTS //
module.exports = linspace;
|