All files main.js

100% Statements 79/79
100% Branches 4/4
100% Functions 1/1
100% Lines 79/79

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 801x 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 12x 12x 12x 12x 12x 6x 6x 12x 3x 3x 3x 12x 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 getData = require( '@stdlib/ndarray/base/data-buffer' );
 
 
// MAIN //
 
/**
* Reinterprets a complex-valued floating-point ndarray as a real-valued floating-point ndarray having the same precision.
*
* ## Notes
*
* -   If provided an ndarray whose underlying data buffer is neither a `Complex128Array` nor a `Complex64Array`, the function returns the input ndarray unchanged.
* -   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
* @returns {ndarray} real-valued floating-point ndarray view
*
* @example
* var ones = require( '@stdlib/ndarray/base/ones' );
*
* var x = ones( 'complex128', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ <Complex128>[ 1.0, 0.0 ], <Complex128>[ 1.0, 0.0 ] ], [ <Complex128>[ 1.0, 0.0 ], <Complex128>[ 1.0, 0.0 ] ] ]
*
* var out = reinterpretComplex( x );
* // returns <ndarray>[ [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ], [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ] ]
*
* @example
* var ones = require( '@stdlib/ndarray/base/ones' );
*
* var x = ones( 'complex64', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ <Complex64>[ 1.0, 0.0 ], <Complex64>[ 1.0, 0.0 ] ], [ <Complex64>[ 1.0, 0.0 ], <Complex64>[ 1.0, 0.0 ] ] ]
*
* var out = reinterpretComplex( x );
* // returns <ndarray>[ [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ], [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ] ]
*/
function reinterpretComplex( x ) {
	var buf;
 
	buf = getData( x );
	if ( isComplex128Array( buf ) ) {
		return reinterpret128( x );
	}
	if ( isComplex64Array( buf ) ) {
		return reinterpret64( x );
	}
	return x;
}
 
 
// EXPORTS //
 
module.exports = reinterpretComplex;