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 | 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) 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 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 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 resolveOrder = require( '@stdlib/ndarray/base/output-order' );
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 resolveDataType = require( './resolve_data_type.js' );
var normalizeArgument = require( './normalize_argument.js' );
var defaults = require( './defaults.js' );
var base = require( './base.js' );
// MAIN //
/**
* Returns a new ndarray filled with linearly spaced numeric elements which increment by 1 starting from a specified value along one or more ndarray dimensions.
*
* @param {(NonNegativeInteger|NonNegativeIntegerArray)} shape - array shape
* @param {(number|ComplexLike|ndarrayLike)} start - starting value
* @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=[options.mode]] - 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} second argument must have a supported data type
* @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 out = unitspace( [ 4 ], 1.0 );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0 ]
*/
function unitspace( shape, start ) {
var options;
var dtypes;
var type;
var opts;
var ncsh;
var arrs;
var arg;
var out;
var sh;
var dt;
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 ) );
}
arrs = [];
if ( isNumber( start ) ) {
type = ENUMS.NUMBER;
} else if ( isComplexLike( start ) ) {
type = ENUMS.COMPLEX;
} else if ( isndarrayLike( start ) ) {
type = 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 ) );
}
arrs.push( start );
} else {
throw new TypeError( format( 'invalid argument. Second argument must be either a number, complex number, or an ndarray. Value: `%s`.', start ) );
}
options = defaults();
if ( arguments.length > 2 ) {
opts = arguments[ 2 ];
if ( !isPlainObject( opts ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', 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;
}
}
// Resolve argument data types:
dtypes = resolveDataType( start, type );
options.dtype = options.dtype || dtypes[ 1 ];
dtypes[ 1 ] = options.dtype;
// Resolve the output array order:
options.order = options.order || resolveOrder( arrs );
// Resolve the complement of the operation dimensions:
ncsh = nonCoreShape( sh, options.dims );
// Normalize the provided `start` argument to an ndarray:
arg = normalizeArgument( start, type, dtypes, ncsh, options.order );
// Create an output ndarray:
out = empty( sh, options );
// Perform operation:
return base( out, arg, options );
}
// EXPORTS //
module.exports = unitspace;
|