All files / reinterpret-complex128/lib main.js

73.17% Statements 60/82
100% Branches 1/1
0% Functions 0/1
73.17% Lines 60/82

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 831x 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 reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var getStrides = require( '@stdlib/ndarray/base/strides' );
var getOffset = require( '@stdlib/ndarray/base/offset' );
var getOrder = require( '@stdlib/ndarray/base/order' );
var getData = require( '@stdlib/ndarray/base/data-buffer' );
var gscal = require( '@stdlib/blas/base/gscal' );
 
 
// MAIN //
 
/**
* Reinterprets a double-precision complex floating-point ndarray as a real-valued double-precision floating-point ndarray containing interleaved real and imaginary components.
*
* ## 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
* @returns {ndarray} double-precision 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 = reinterpretComplex128( x );
* // returns <ndarray>[ [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ], [ [ 1.0, 0.0 ], [ 1.0, 0.0 ] ] ]
*/
function reinterpretComplex128( x ) {
	var strides;
	var shape;
	var ndims;

	shape = getShape( x, true );
	strides = getStrides( x, true );
	ndims = shape.length;

	gscal( ndims, 2, strides, 1 );

	// Append a trailing dimension where each element is the real and imaginary component for a corresponding element in the input ndarray...
	shape.push( 2 );

	// Augment the strides, assuming that real and imaginary components are adjacent in memory...
	if ( ndims === 0 ) {
		strides[ 0 ] = 1;
	} else {
		strides.push( 1 );
	}
	return ndarray( 'float64', reinterpret( getData( x ), 0 ), shape, strides, getOffset( x ) * 2, getOrder( x ) );
}
 
 
// EXPORTS //
 
module.exports = reinterpretComplex128;