All files / glinspace/lib ndarray.js

55.88% Statements 57/102
100% Branches 1/1
0% Functions 0/1
55.88% Lines 57/102

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 1031x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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 arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var accessors = require( './accessors.js' );
 
 
// MAIN //
 
/**
* Fills a strided array with linearly spaced values over a specified interval.
*
* @param {PositiveInteger} N - number of indexed elements
* @param {number} start - start of interval
* @param {number} stop - end of interval
* @param {boolean} endpoint - boolean indicating whether to include the `stop` value when writing values to the input array
* @param {Collection} x - input array
* @param {integer} strideX - stride length
* @param {NonNegativeInteger} offsetX - starting index
* @returns {Collection} input array
*
* @example
* var x = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* glinspace( x.length, 0.0, 100.0, true, x, 1, 0 );
* // x => [ 0.0, 20.0, 40.0, 60.0, 80.0, 100.0 ]
*
* @example
* var x = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
*
* glinspace( x.length, 0.0, 100.0, false, x, 1, 0 );
* // x => [ 0.0, 20.0, 40.0, 60.0, 80.0 ]
*/
function glinspace( N, start, stop, endpoint, x, strideX, offsetX ) {
	var ix;
	var d;
	var o;
	var i;

	if ( N <= 0 ) {
		return x;
	}
	o = arraylike2object( x );
	if ( o.accessorProtocol ) {
		accessors( N, start, stop, endpoint, o, strideX, offsetX );
		return x;
	}
	ix = offsetX;

	// Set the first value:
	if ( N === 1 ) {
		if ( endpoint ) {
			x[ ix ] = stop;
		} else {
			x[ ix ] = start;
		}
		return x;
	}
	x[ ix ] = start;
	ix += strideX;

	// Calculate the increment:
	if ( endpoint ) {
		N -= 1;
	}
	d = ( stop-start ) / N;

	// Generate linearly spaced values:
	for ( i = 1; i < N; i++ ) {
		x[ ix ] = start + (d*i);
		ix += strideX;
	}
	// Check whether to include the `stop` value:
	if ( endpoint ) {
		x[ ix ] = stop;
	}
	return x;
}
 
 
// EXPORTS //
 
module.exports = glinspace;