All files / base/ndarray/slinspace/lib main.js

84.04% Statements 79/94
100% Branches 1/1
0% Functions 0/1
84.04% Lines 79/94

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 951x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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 ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' );
var getStride = require( '@stdlib/ndarray/base/stride' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var strided = require( '@stdlib/blas/ext/base/slinspace' ).ndarray;
 
 
// MAIN //
 
/**
* Fills a one-dimensional single-precision floating-point ndarray with linearly spaced values over a specified interval.
*
* ## Notes
*
* -   The function expects the following ndarrays in order:
*
*     -   a one-dimensional input ndarray.
*     -   a zero-dimensional ndarray specifying the start of the interval.
*     -   a zero-dimensional ndarray specifying the end of the interval.
*     -   a zero-dimensional ndarray specifying whether to include the end of the interval when writing values to the input ndarray.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {ndarray} input ndarray
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var xbuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var x = new ndarray( 'float32', xbuf, [ 6 ], [ 1 ], 0, 'row-major' );
*
* var start = scalar2ndarray( 0.0, {
*    'dtype': 'float32'
* });
*
* var stop = scalar2ndarray( 100.0, {
*    'dtype': 'float32'
* });
*
* var endpoint = scalar2ndarray( true, {
*     'dtype': 'bool'
* });
*
* var out = slinspace( [ x, start, stop, endpoint ] );
* // returns <ndarray>
*
* var arr = ndarray2array( out );
* // returns [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
*/
function slinspace( arrays ) {
	var endpoint;
	var start;
	var stop;
	var x;

	x = arrays[ 0 ];
	start = ndarraylike2scalar( arrays[ 1 ] );
	stop = ndarraylike2scalar( arrays[ 2 ] );
	endpoint = ndarraylike2scalar( arrays[ 3 ] );

	strided( numelDimension( x, 0 ), start, stop, endpoint, getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len

	return x;
}
 
 
// EXPORTS //
 
module.exports = slinspace;