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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 43x 43x 43x 9x 9x 43x 9x 9x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 160x 160x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 89x 18x 18x 89x 18x 18x 89x 4x 4x 49x 49x 49x 49x 49x 49x 49x 49x 49x 89x 2x 2x 89x 2x 2x 45x 89x 2x 2x 43x 89x 34x 34x 24x 24x 89x 9x 9x 19x 19x 19x 89x 8x 8x 11x 11x 11x 11x 89x 8x 8x 8x 3x 3x 3x 3x 3x 3x 3x 3x 89x 10x 10x 10x 10x 3x 89x 43x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2024 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 isFunction = require( '@stdlib/assert/is-function' );
var isndarrayLikeWithDataType = require( '@stdlib/assert/is-ndarray-like-with-data-type' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isNegativeInteger = require( '@stdlib/assert/is-negative-integer' ).isPrimitive;
var isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
var isReadOnly = require( '@stdlib/ndarray/base/assert/is-read-only' );
var hasEqualValues = require( '@stdlib/array/base/assert/has-equal-values-indexed' );
var min = require( '@stdlib/math/base/special/fast/min' );
var without = require( '@stdlib/array/base/without' );
var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var nditerStacks = require( '@stdlib/ndarray/iter/stacks' );
var numel = require( '@stdlib/ndarray/base/numel' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Returns a function which interchanges two vectors.
*
* @param {Function} base - "base" function which interchanges two vectors
* @param {(String|null)} dtype - array data type
* @throws {TypeError} first argument must be a function
* @throws {TypeError} second argument must be a data type
* @returns {Function} function wrapper
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var array = require( '@stdlib/ndarray/array' );
* var dswap = require( '@stdlib/blas/base/dswap' ).ndarray;
*
* var swap = factory( dswap, 'float64' );
*
* var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
* var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
*
* swap( x, y );
*
* var xbuf = x.data;
* // returns <Float64Array>[ 2.0, 6.0, -1.0, -4.0, 8.0 ]
*
* var ybuf = y.data;
* // returns <Float64Array>[ 4.0, 2.0, -3.0, 5.0, -1.0 ]
*/
function factory( base, dtype ) {
var isValid;
if ( !isFunction( base ) ) {
throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', base ) );
}
if ( !isDataType( dtype ) && dtype !== null ) {
throw new TypeError( format( 'invalid argument. Second argument must be a data type. Value: `%s`.', dtype ) );
}
isValid = ( dtype ) ? isValidWrapper : isndarrayLike;
return swap;
/**
* Tests if an input value is an ndarray-like object having a specified data type.
*
* @private
* @param {*} value - value to test
* @returns {boolean} boolean indicating if an input value is an ndarray-like object having a specified data type
*/
function isValidWrapper( value ) {
return isndarrayLikeWithDataType( value, dtype );
}
/**
* Interchanges two vectors.
*
* @private
* @param {ndarrayLike} x - first input array
* @param {ndarrayLike} y - second input array
* @param {NegativeInteger} [dim] - dimension along which to interchange elements
* @throws {TypeError} first argument must be an ndarray
* @throws {TypeError} first argument must have at least one dimension
* @throws {TypeError} second argument must be an ndarray
* @throws {TypeError} second argument must have at least one dimension
* @throws {Error} both input arrays must have the same shape
* @throws {RangeError} third argument is out-of-bounds
* @throws {Error} cannot write to read-only array
* @returns {ndarrayLike} `y`
*/
function swap( x, y ) {
var dim;
var xsh;
var ysh;
var xit;
var yit;
var xc;
var yc;
var vx;
var vy;
var dm;
var S;
var N;
var i;
if ( !isValid( x ) ) {
throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object having a supported data type. Value: `%s`.', x ) );
}
if ( !isValid( y ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be an ndarray-like object having a supported data type. Value: `%s`.', y ) );
}
if ( isReadOnly( x ) || isReadOnly( y ) ) {
throw new Error( 'invalid argument. Cannot write to read-only array.' );
}
// Convert the input arrays to "base" ndarrays:
xc = ndarraylike2ndarray( x );
yc = ndarraylike2ndarray( y );
// Resolve the input array shapes:
xsh = xc.shape;
ysh = yc.shape;
// Validate that we've been provided non-zero-dimensional arrays...
if ( xsh.length < 1 ) {
throw new TypeError( format( 'invalid argument. First argument must have at least one dimension.' ) );
}
if ( ysh.length < 1 ) {
throw new TypeError( format( 'invalid argument. Second argument must have at least one dimension.' ) );
}
// Validate that the arrays have the same shape...
if ( !hasEqualValues( xsh, ysh ) ) {
throw new Error( 'invalid arguments. The first and second arguments must have the same shape.' );
}
// Validate that the dimension argument is a negative integer...
if ( arguments.length > 2 ) {
dim = arguments[ 2 ];
if ( !isNegativeInteger( dim ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a negative integer. Value: `%s`.', dim ) );
}
} else {
dim = -1;
}
// Validate that a provided dimension index is within bounds...
dm = min( xsh.length, ysh.length ) - 1;
dim = normalizeIndex( dim, dm );
if ( dim === -1 ) {
throw new RangeError( format( 'invalid argument. Third argument must be a value on the interval: [%d,%d]. Value: `%d`.', -dm, -1, arguments[ 2 ] ) );
}
// Resolve the size of the interchange dimension:
S = xsh[ dim ];
// If we are only provided one-dimensional input arrays, we can skip iterating over stacks...
if ( xsh.length === 1 ) {
base( S, xc.data, xc.strides[0], xc.offset, yc.data, yc.strides[0], yc.offset ); // eslint-disable-line max-len
return y;
}
// Resolve the number of stacks:
N = numel( without( xsh, dim ) );
// Create iterators for iterating over stacks of vectors:
xit = nditerStacks( xc, [ dim ] );
yit = nditerStacks( yc, [ dim ] );
// Interchange each pair of vectors...
for ( i = 0; i < N; i++ ) {
vx = xit.next().value;
vy = yit.next().value;
base( S, vx.data, vx.strides[0], vx.offset, vy.data, vy.strides[0], vy.offset ); // eslint-disable-line max-len
}
return y;
}
}
// EXPORTS //
module.exports = factory;
|