All files base.js

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

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 124 125 126 127 128 1291x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 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 dtypes = require( '@stdlib/ndarray/dtypes' );
var gcopyWithin = require( '@stdlib/blas/ext/base/ndarray/gcopy-within' );
var dcopyWithin = require( '@stdlib/blas/ext/base/ndarray/dcopy-within' );
var scopyWithin = require( '@stdlib/blas/ext/base/ndarray/scopy-within' );
var zcopyWithin = require( '@stdlib/blas/ext/base/ndarray/zcopy-within' );
var ccopyWithin = require( '@stdlib/blas/ext/base/ndarray/ccopy-within' );
var factory = require( '@stdlib/ndarray/base/nullary-strided1d-dispatch-factory' );
 
 
// VARIABLES //
 
var idtypes0 = dtypes( 'integer_index_and_generic' ); // target/start/end ndarrays
var idtypes1 = dtypes( 'all' ); // workspace ndarray
var odtypes = dtypes( 'all' );
var table = {
	'types': [
		'float64',    // input/output
		'float32',    // input/output
		'complex128', // input/output
		'complex64'   // input/output
	],
	'fcns': [
		dcopyWithin,
		scopyWithin,
		zcopyWithin,
		ccopyWithin
	],
	'default': gcopyWithin
};
var options = {
	'strictTraversalOrder': true
};
 
 
// MAIN //
 
/**
* Performs an in-place copy of elements within an ndarray along an ndarray dimension.
*
* @private
* @name copyWithin
* @type {Function}
* @param {ndarray} x - input ndarray
* @param {ndarray} target - ndarray containing the target index
* @param {ndarray} start - ndarray containing the source start index (inclusive)
* @param {ndarray} end - ndarray containing the source end index (exclusive)
* @param {ndarray} workspace - workspace 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} index arguments must be ndarray-like objects
* @throws {TypeError} workspace 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 {Error} must provide valid options
* @returns {ndarray} input ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var zeros = require( '@stdlib/ndarray/zeros' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 6 ];
*
* // Define the array strides:
* var sx = [ 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Create ndarrays containing the target, start, and end indices:
* var opts = {
*     'dtype': 'int32'
* };
* var target = scalar2ndarray( 3, opts );
* var start = scalar2ndarray( 1, opts );
* var end = scalar2ndarray( 4, opts );
*
* // Create a workspace ndarray:
* var w = zeros( [ 6 ], {
*     'dtype': 'float64'
* });
*
* // Perform operation:
* var out = copyWithin( x, target, start, end, w, {
*     'dims': [ 0 ]
* });
* // returns <ndarray>[ 1.0, 2.0, 3.0, 2.0, 3.0, 4.0 ]
*
* var bool = ( out === x );
* // returns true
*/
var copyWithin = factory( table, [ idtypes0, idtypes0, idtypes0, idtypes1 ], odtypes, options ); // eslint-disable-line max-len
 
 
// EXPORTS //
 
module.exports = copyWithin;