All files ndarray.js

100% Statements 281/281
100% Branches 21/21
100% Functions 4/4
100% Lines 281/281

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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 2823x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 153x 153x 153x 153x 43x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 116x 116x 116x 116x 116x 36x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 20x 20x 20x 20x 4x 4x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 99x 99x 99x 99x 16x 16x 83x 99x 58x 58x 18x 18x 18x 18x 58x 18x 18x 18x 18x 22x 58x 18x 18x 18x 18x 4x 4x 4x 4x 99x 4x 4x 99x 21x 21x 25x 25x 99x 3x 3x 3x 3x 3x  
/**
* @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.
*/
 
/* eslint-disable max-len */
 
'use strict';
 
// MODULES //
 
var isComplex128Array = require( '@stdlib/array/base/assert/is-complex128array' );
var isComplex64Array = require( '@stdlib/array/base/assert/is-complex64array' );
var isBooleanArray = require( '@stdlib/array/base/assert/is-booleanarray' );
var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
var reinterpret128 = require( '@stdlib/strided/base/reinterpret-complex128' );
var reinterpret64 = require( '@stdlib/strided/base/reinterpret-complex64' );
var reinterpretBoolean = require( '@stdlib/strided/base/reinterpret-boolean' );
var bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
 
 
// VARIABLES //
 
var METHOD_TABLE = {
	'float64': 'getFloat64',
	'float32': 'getFloat32',
	'float16': 'getFloat16',
	'int64': 'getBigInt64',
	'int32': 'getInt32',
	'int16': 'getInt16',
	'int8': 'getInt8',
	'uint64': 'getBigUint64',
	'uint32': 'getUint32',
	'uint16': 'getUint16',
	'uint8': 'getUint8'
};
 
 
// FUNCTIONS //
 
/**
* Copies elements from an input strided DataView to elements in a strided indexed array.
*
* @private
* @param {string} dtype - output array data type
* @param {NonNegativeInteger} N - number of indexed elements
* @param {DataView} view - input DataView
* @param {integer} strideView - `view` stride length (in bytes)
* @param {NonNegativeInteger} offsetView - starting `view` index (in bytes)
* @param {Object} out - output array object
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - starting `out` index
* @param {boolean} littleEndian - boolean indicating whether the data is stored in little-endian format
* @returns {void}
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var DataView = require( '@stdlib/array/dataview' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var view = new DataView( x.buffer );
*
* var y = new Float64Array( x.length );
*
* indexed( 'float64', x.length, view, 8, 0, arraylike2object( y ), 1, 0, true );
* // e.g., y => <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/
function indexed( dtype, N, view, strideView, offsetView, out, strideOut, offsetOut, littleEndian ) {
	var data;
	var io;
	var iv;
	var m;
	var i;
 
	m = METHOD_TABLE[ dtype ];
 
	data = out.data;
 
	io = offsetOut;
	iv = offsetView;
	for ( i = 0; i < N; i++ ) {
		data[ io ] = view[ m ]( iv, littleEndian );
		io += strideOut;
		iv += strideView;
	}
}
 
/**
* Copies elements from an input strided DataView to elements in a strided complex array.
*
* @private
* @param {string} dtype - output array data type
* @param {NonNegativeInteger} N - number of indexed elements
* @param {DataView} view - input DataView
* @param {integer} strideView - `view` stride length (in bytes)
* @param {NonNegativeInteger} offsetView - starting `view` index (in bytes)
* @param {Collection} out - output array object
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - starting `out` index
* @param {boolean} littleEndian - boolean indicating whether the data is stored in little-endian format
* @returns {void}
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var DataView = require( '@stdlib/array/dataview' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var view = new DataView( x.buffer );
*
* var y = new Float64Array( x.length );
*
* complex( 'float64', 2, view, 8, 0, arraylike2object( y ), 1, 0, true );
* // e.g., y => <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/
function complex( dtype, N, view, strideView, offsetView, out, strideOut, offsetOut, littleEndian ) {
	var nbytes;
	var data;
	var io;
	var iv;
	var m;
	var i;
 
	m = METHOD_TABLE[ dtype ];
	nbytes = bytesPerElement( dtype );
 
	data = out.data;
 
	// Adjust meta data to account for interleaved real and imaginary components:
	strideOut *= 2;
	offsetOut *= 2;
 
	io = offsetOut;
	iv = offsetView;
	for ( i = 0; i < N; i++ ) {
		data[ io ] = view[ m ]( iv, littleEndian );
		data[ io+1 ] = view[ m ]( iv+nbytes, littleEndian );
		io += strideOut;
		iv += strideView;
	}
}
 
/**
* Copies elements from an input strided DataView to elements in a strided accessor array.
*
* @private
* @param {string} dtype - output array data type
* @param {NonNegativeInteger} N - number of indexed elements
* @param {DataView} view - input DataView
* @param {integer} strideView - `view` stride length (in bytes)
* @param {NonNegativeInteger} offsetView - starting `view` index (in bytes)
* @param {Object} out - output array object
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - starting `out` index
* @param {boolean} littleEndian - boolean indicating whether the data is stored in little-endian format
* @returns {void}
*
* @example
* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
* var Float64Array = require( '@stdlib/array/float64' );
* var DataView = require( '@stdlib/array/dataview' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var view = new DataView( x.buffer );
*
* var y = new Float64Array( x.length );
*
* accessors( 'float64', x.length, view, 8, 0, arraylike2object( toAccessorArray( y ) ), 1, 0, true );
* // e.g., y => <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*/
function accessors( dtype, N, view, strideView, offsetView, out, strideOut, offsetOut, littleEndian ) {
	var data;
	var set;
	var io;
	var iv;
	var m;
	var i;
 
	m = METHOD_TABLE[ dtype ];
 
	data = out.data;
	set = out.accessors[ 1 ];
 
	io = offsetOut;
	iv = offsetView;
	for ( i = 0; i < N; i++ ) {
		set( data, io, view[ m ]( iv, littleEndian ) );
		io += strideOut;
		iv += strideView;
	}
	return view;
}
 
 
// MAIN //
 
/**
* Copies elements from an input strided DataView to elements in an output strided array.
*
* @param {NonNegativeInteger} N - number of indexed elements
* @param {DataView} view - input DataView
* @param {integer} strideView - `view` stride length (in bytes)
* @param {NonNegativeInteger} offsetView - starting `view` index (in bytes)
* @param {Collection} out - output array
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - starting `out` index
* @param {boolean} littleEndian - boolean indicating whether the data is stored in little-endian format
* @returns {Collection} output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var DataView = require( '@stdlib/array/dataview' );
*
* var x = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var view = new DataView( x.buffer );
*
* var y = new Float64Array( x.length );
* var out = readDataView( x.length, view, 8, 0, y, 1, 0, true );
* // e.g., returns <Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
*
* var bool = ( out === y );
* // returns true
*/
function readDataView( N, view, strideView, offsetView, out, strideOut, offsetOut, littleEndian ) {
	var obj;
	var dt;
	if ( N <= 0 ) {
		return out;
	}
	obj = arraylike2object( out );
	if ( obj.accessorProtocol ) {
		// If provided a complex number array, reinterpret as a real typed array of interleaved real and imaginary components...
		if ( isComplex128Array( out ) ) {
			obj.data = reinterpret128( out, 0 );
			complex( 'float64', N, view, strideView, offsetView, obj, strideOut, offsetOut, littleEndian );
			return out;
		}
		if ( isComplex64Array( out ) ) {
			obj.data = reinterpret64( out, 0 );
			complex( 'float32', N, view, strideView, offsetView, obj, strideOut, offsetOut, littleEndian );
			return out;
		}
		// If provided a boolean array, reinterpret as typed array of integers...
		if ( isBooleanArray( out ) ) {
			obj.data = reinterpretBoolean( out, 0 );
			indexed( 'uint8', N, view, strideView, offsetView, obj, strideOut, offsetOut, littleEndian );
			return out;
		}
		// If provided a "generic" accessor array, assume double-precision floating-point numbers...
		accessors( 'float64', N, view, strideView, offsetView, obj, strideOut, offsetOut, littleEndian );
		return out;
	}
	if ( obj.dtype === null || obj.dtype === 'generic' ) {
		// If provided a "generic" array, assume double-precision floating-point numbers...
		dt = 'float64';
	} else {
		dt = obj.dtype;
	}
	indexed( dt, N, view, strideView, offsetView, obj, strideOut, offsetOut, littleEndian );
	return out;
}
 
 
// EXPORTS //
 
module.exports = readDataView;