All files / gcopy-within/lib main.js

77.65% Statements 73/94
100% Branches 1/1
0% Functions 0/1
77.65% Lines 73/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  
/**
* @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 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/gcopy-within' ).ndarray;
 
 
// MAIN //
 
/**
* Performs an in-place copy of elements within a one-dimensional ndarray.
*
* ## Notes
*
* -   The function expects the following ndarrays:
*
*     -   a one-dimensional input ndarray.
*     -   a zero-dimensional ndarray specifying a target index.
*     -   a zero-dimensional ndarray specifying a source start index (inclusive).
*     -   a zero-dimensional ndarray specifying a source end index (exclusive).
*     -   a one-dimensional workspace ndarray.
*
* -   If the `start` and `target` index ranges do not overlap, the `workspace` ndarray is unused and thus ignored.
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
* @returns {ndarray} input ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var opts = {
*     'dtype': 'generic'
* };
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], opts.dtype );
* var target = scalar2ndarray( 3, opts );
* var start = scalar2ndarray( 1, opts );
* var end = scalar2ndarray( 4, opts );
*
* var w = zeros( [ 6 ], opts );
*
* var out = gcopyWithin( [ x, target, start, end, w ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
*/
function gcopyWithin( arrays ) {
	var ws;
	var wo;
	var wd;
	var xs;
	var xo;
	var xd;
	var x;
	var w;

	x = arrays[ 0 ];
	w = arrays[ 4 ];
	xd = getData( x );
	xs = getStride( x, 0 );
	xo = getOffset( x );
	wd = getData( w );
	ws = getStride( w, 0 );
	wo = getOffset( w );
	strided( numelDimension( x, 0 ), ndarraylike2scalar( arrays[ 1 ] ), ndarraylike2scalar( arrays[ 2 ] ), ndarraylike2scalar( arrays[ 3 ] ), xd, xs, xo, wd, ws, wo ); // eslint-disable-line max-len
	return x;
}
 
 
// EXPORTS //
 
module.exports = gcopyWithin;