All files / unitspace/lib base.js

100% Statements 111/111
100% Branches 1/1
100% Functions 0/0
100% Lines 111/111

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 1121x 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 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 gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' );
var dunitspace = require( '@stdlib/blas/ext/base/ndarray/dunitspace' );
var sunitspace = require( '@stdlib/blas/ext/base/ndarray/sunitspace' );
var zunitspace = require( '@stdlib/blas/ext/base/ndarray/zunitspace' );
var cunitspace = require( '@stdlib/blas/ext/base/ndarray/cunitspace' );
var factory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
var DTYPES = require( './dtypes.js' );
 
 
// VARIABLES //
 
var table = {
	'types': [
		'float64',    // output
		'float32',    // output
		'complex128', // output
		'complex64'   // output
	],
	'fcns': [
		dunitspace,
		sunitspace,
		zunitspace,
		cunitspace
	],
	'default': gunitspace
};
var options = {
	'strictTraversalOrder': true
};
 
 
// MAIN //
 
/**
* Fills an ndarray with linearly spaced numeric elements which increment by 1 starting from a specified value along one or more ndarray dimensions.
*
* @private
* @name unitspace
* @type {Function}
* @param {ndarray} x - input ndarray
* @param {ndarray} start - starting value
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} first argument must have a supported data type
* @throws {TypeError} second argument must be 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} input ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var array = require( '@stdlib/ndarray/array' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 2, 1, 3 ];
*
* // Define the array strides:
* var sx = [ 3, 3, 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Create an ndarray containing the starting value:
* var start = array( new Float64Array( [ 1.0, 4.0 ] ), {
*     'shape': [ 2, 1 ]
* });
*
* // Perform operation:
* var out = unitspace( x, start, {
*     'dims': [ -1 ]
* });
* // returns <ndarray>[ [ [ 1.0, 2.0, 3.0 ] ], [ [ 4.0, 5.0, 6.0 ] ] ]
*/
var unitspace = factory( table, [ DTYPES.idtypes0 ], DTYPES.odtypes, options );
 
 
// EXPORTS //
 
module.exports = unitspace;