All files dcartesianproduct.native.js

100% Statements 72/72
100% Branches 6/6
100% Functions 1/1
100% Lines 72/72

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 732x 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 2x 2x 35x 35x 10x 10x 35x 1x 1x 24x 24x 35x 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 resolveOrder = require( '@stdlib/blas/base/layout-resolve-enum' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
* Computes the Cartesian product for two double-precision floating-point strided arrays.
*
* @param {string} order - storage layout
* @param {NonNegativeInteger} M - number of indexed elements of `x`
* @param {NonNegativeInteger} N - number of indexed elements of `y`
* @param {Float64Array} x - input array
* @param {integer} strideX - stride length for `x`
* @param {Float64Array} y - input array
* @param {integer} strideY - stride length for `y`
* @param {Float64Array} out - output array
* @param {integer} LDO - stride length for the leading dimension of `out`
* @throws {TypeError} first argument must be a valid order
* @throws {RangeError} ninth argument must be greater than or equal to max(1,N)
* @returns {Float64Array} output array
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var x = new Float64Array( [ 1.0, 2.0 ] );
* var y = new Float64Array( [ 3.0, 4.0 ] );
* var out = new Float64Array( 8 );
*
* dcartesianProduct( 'row-major', x.length, y.length, x, 1, y, 1, out, 2 );
* // out => <Float64Array>[ 1.0, 3.0, 1.0, 4.0, 2.0, 3.0, 2.0, 4.0 ]
*/
function dcartesianProduct( order, M, N, x, strideX, y, strideY, out, LDO ) {
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( LDO < max( 1, N ) ) {
		throw new RangeError( format( 'invalid argument. Ninth argument must be greater than or equal to max(1,%d). Value: `%d`.', N, LDO ) );
	}
	addon( resolveOrder( order ), M, N, x, strideX, y, strideY, out, LDO );
	return out;
}
 
 
// EXPORTS //
 
module.exports = dcartesianProduct;