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 | 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 isComplex128Array = require( '@stdlib/array/base/assert/is-complex128array' );
var isComplex64Array = require( '@stdlib/array/base/assert/is-complex64array' );
var reinterpret128 = require( '@stdlib/ndarray/base/reinterpret-complex128' );
var reinterpret64 = require( '@stdlib/ndarray/base/reinterpret-complex64' );
var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
var getDType = require( '@stdlib/ndarray/base/dtype' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Reinterprets a complex-valued floating-point ndarray as a real-valued floating-point ndarray having the same precision.
*
* ## Notes
*
* - The returned ndarray is a view on the input ndarray data buffer.
* - The returned ndarray has an additional trailing dimension of size two whose elements correspond to the real and imaginary components, respectively, of each complex-valued element in the input ndarray.
* - The returned ndarray is a "base" ndarray, and, thus, the returned ndarray does not perform bounds checking or afford any of the guarantees of the non-base ndarray constructor. The primary intent of this function is to reinterpret an ndarray-like object within internal implementations and to do so with minimal overhead.
*
* @param {ndarray} x - input ndarray
* @throws {TypeError} must provide a complex-valued floating-point ndarray
* @returns {ndarray} real-valued floating-point ndarray view
*
* @example
* var zeroTo = require( '@stdlib/blas/ext/zero-to' );
*
* var x = zeroTo( [ 2, 2 ], {
* 'dtype': 'complex128'
* });
* // returns <ndarray>[ [ <Complex128>[ 0.0, 0.0 ], <Complex128>[ 1.0, 0.0 ] ], [ <Complex128>[ 0.0, 0.0 ], <Complex128>[ 1.0, 0.0 ] ] ]
*
* var out = reinterpretComplex( x );
* // returns <ndarray>[ [ [ 0.0, 0.0 ], [ 1.0, 0.0 ] ], [ [ 0.0, 0.0 ], [ 1.0, 0.0 ] ] ]
*
* @example
* var zeroTo = require( '@stdlib/blas/ext/zero-to' );
*
* var x = zeroTo( [ 2, 2 ], {
* 'dtype': 'complex64'
* });
* // returns <ndarray>[ [ <Complex64>[ 0.0, 0.0 ], <Complex64>[ 1.0, 0.0 ] ], [ <Complex64>[ 0.0, 0.0 ], <Complex64>[ 1.0, 0.0 ] ] ]
*
* var out = reinterpretComplex( x );
* // returns <ndarray>[ [ [ 0.0, 0.0 ], [ 1.0, 0.0 ] ], [ [ 0.0, 0.0 ], [ 1.0, 0.0 ] ] ]
*/
function reinterpretComplex( x ) {
var dtype;
var buf;
dtype = resolveStr( getDType( x ) );
buf = getData( x );
if ( dtype === 'complex128' && isComplex128Array( buf ) ) {
return reinterpret128( x );
}
if ( dtype === 'complex64' && isComplex64Array( buf ) ) {
return reinterpret64( x );
}
// Note: intentionally throw here to catch the scenario in which we add, e.g., a Complex32Array and need to explicitly add support here...
throw new TypeError( format( 'invalid argument. Must provide a complex-valued floating-point ndarray. Value: `%s`.', x ) );
}
// EXPORTS //
module.exports = reinterpretComplex;
|