All files / linspace/lib base.js

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

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 1241x 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 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 glinspace = require( '@stdlib/blas/ext/base/ndarray/glinspace' );
var dlinspace = require( '@stdlib/blas/ext/base/ndarray/dlinspace' );
var slinspace = require( '@stdlib/blas/ext/base/ndarray/slinspace' );
var factory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
var DTYPES = require( './dtypes.js' );
 
 
// VARIABLES //
 
var table = {
	'types': [
		'float64', // input/output
		'float32'  // input/output
	],
	'fcns': [
		dlinspace,
		slinspace
	],
	'default': glinspace
};
var options = {
	'strictTraversalOrder': true
};
 
 
// MAIN //
 
/**
* Fills an ndarray with linearly spaced values over a specified interval along one or more ndarray dimensions.
*
* @private
* @name linspace
* @type {Function}
* @param {ndarray} x - input ndarray
* @param {ndarray} start - start of interval
* @param {ndarray} stop - end of interval
* @param {ndarray} endpoint - 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] - list of dimensions over which to perform operation
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument must be an ndarray-like object
* @throws {TypeError} third argument must be an ndarray-like object
* @throws {TypeError} fourth 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} output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var BooleanArray = require( '@stdlib/array/bool' );
* var array = require( '@stdlib/ndarray/array' );
* var ndarray2array = require( '@stdlib/ndarray/to-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 start of the interval:
* var start = array( new Float64Array( [ 1.0, 4.0 ] ), {
*     'shape': [ 2, 1 ]
* });
*
* // Create an ndarray containing the end of the interval:
* var end = array( new Float64Array( [ 3.0, 6.0 ] ), {
*     'shape': [ 2, 1 ]
* });
*
* // Create an ndarray specifying whether to include the end of the interval in the output:
* var endpoint = array( new BooleanArray( [ true, true ] ), {
*     'shape': [ 2, 1 ]
* });
*
* // Perform operation:
* var out = linspace( x, start, end, endpoint, {
*     'dims': [ -1 ]
* });
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ [ [ 1.0, 2.0, 3.0 ] ], [ [ 4.0, 5.0, 6.0 ] ] ]
*/
var linspace = factory( table, [ DTYPES.idtypes0, DTYPES.idtypes1, DTYPES.idtypes2 ], DTYPES.odtypes, options ); // eslint-disable-line max-len
 
 
// EXPORTS //
 
module.exports = linspace;