All files zcartesiansquare.native.js

100% Statements 77/77
100% Branches 10/10
100% Functions 1/1
100% Lines 77/77

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 782x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 30x 30x 30x 30x 30x 10x 10x 30x 1x 30x 1x 1x 18x 18x 18x 18x 30x 2x 2x 2x 2x 2x  
/**
* @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 isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
var max = require( '@stdlib/math/base/special/fast/max' );
var resolveOrder = require( '@stdlib/blas/base/layout-resolve-enum' );
var format = require( '@stdlib/string/format' );
var addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
* Computes the Cartesian square for a double-precision complex floating-point strided array.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} N - number of indexed elements
* @param {Complex128Array} x - input array
* @param {integer} strideX - stride length for `x`
* @param {Complex128Array} out - output array
* @param {integer} LDO - stride length between successive contiguous vectors of the matrix `out` (a.k.a., leading dimension of `out`)
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} sixth argument must be a valid stride length
* @returns {Complex128Array} output array
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
*
* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var out = new Complex128Array( 8 );
*
* zcartesianSquare( 'row-major', x.length, x, 1, out, 2 );
* // out => <Complex128Array>[ 1.0, 2.0, 1.0, 2.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0, 1.0, 2.0, 3.0, 4.0, 3.0, 4.0 ]
*/
function zcartesianSquare( order, N, x, strideX, out, LDO ) {
	var viewX;
	var viewO;
 
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( isColumnMajor( order ) && LDO < max( 1, N*N ) ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', N*N, LDO ) );
	} else if ( !isColumnMajor( order ) && LDO < 2 ) {
		throw new RangeError( format( 'invalid argument. Sixth argument must be greater than or equal to max(1,%d). Value: `%d`.', 2, LDO ) );
	}
	viewX = reinterpret( x, 0 );
	viewO = reinterpret( out, 0 );
	addon( resolveOrder( order ), N, viewX, strideX, viewO, LDO );
	return out;
}
 
 
// EXPORTS //
 
module.exports = zcartesianSquare;