diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/README.md index e4c7c965bb03..2e66eaf246ab 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/README.md @@ -50,7 +50,7 @@ var A = new Complex64Matrix( [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ] var B = new Complex64Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] ); var k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); var out = ctril( [ A, B, k ] ); @@ -108,7 +108,7 @@ var B = new Complex64Matrix( discreteUniform( 5*5*2, -50, 50, opts ).buffer, 0, console.log( ndarray2array( B ) ); var k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); var out = ctril( [ A, B, k ] ); @@ -119,6 +119,238 @@ console.log( ndarray2array( out ) ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ndarray/ctril.h" +``` + +#### stdlib_blas_ext_ctril( arrays ) + +Copies the lower triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`. + +```c +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/real.h" +#include "stdlib/complex/float32/imag.h" +#include +#include +#include + +// Create data buffers: +const stdlib_complex64_t dataA[] = { + stdlib_complex64( 1.0f, 1.0f ), stdlib_complex64( 2.0f, 2.0f ), + stdlib_complex64( 3.0f, 3.0f ), stdlib_complex64( 4.0f, 4.0f ) +}; +stdlib_complex64_t dataB[] = { + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ), + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ) +}; +int32_t dataK[] = { 0 }; + +// Specify the number of matrix dimensions: +const int64_t ndims = 2; + +// Specify the matrix shape: +int64_t shape[] = { 2, 2 }; + +// Specify the array strides (in bytes): +int64_t strides[] = { + 2 * STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT, + STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT +}; +int64_t kstrides[] = { 0 }; + +// Specify the byte offset: +const int64_t offset = 0; + +// Specify the array order: +const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR; + +// Specify the index mode: +const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR; + +// Specify the subscript index modes: +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; +const int64_t nsubmodes = 1; + +// Create ndarrays: +struct ndarray *A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataA, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + +struct ndarray *B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataB, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + +struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)dataK, 0, NULL, kstrides, offset, order, imode, nsubmodes, submodes ); +if ( A == NULL || B == NULL || k == NULL ) { + fprintf( stderr, "Error allocating memory. +" ); + exit( 1 ); +} + +// Define a list of ndarrays: +const struct ndarray *arrays[] = { A, B, k }; + +// Perform computation: +stdlib_blas_ext_ctril( arrays ); + +// Print the result: +for ( int i = 0; i < 4; i++ ) { + printf( "dataB[ %i ] = (%f, %f) +", i, stdlib_complex64_real( dataB[ i ] ), stdlib_complex64_imag( dataB[ i ] ) ); +} + +// Free allocated memory: +stdlib_ndarray_free( A ); +stdlib_ndarray_free( B ); +stdlib_ndarray_free( k ); +``` + +The function accepts the following arguments: + +- **arrays**: `[in] struct ndarray**` list containing the following ndarrays: + + - `[in] struct ndarray*` a two-dimensional input ndarray. + - `[inout] struct ndarray*` a two-dimensional output ndarray. + - `[in] struct ndarray*` a zero-dimensional ndarray specifying the diagonal above which to ignore. A value equal to zero refers to the main diagonal, greater than zero refers to a diagonal above the main diagonal, and less than zero refers to a diagonal below the main diagonal. + +```c +void stdlib_blas_ext_ctril( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +### Notes + +- Elements outside of the copied region are left unchanged. + +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/real.h" +#include "stdlib/complex/float32/imag.h" +#include +#include +#include + +int main( void ) { + // Create data buffers: + const stdlib_complex64_t dataA[] = { + stdlib_complex64( 1.0f, 1.0f ), stdlib_complex64( 2.0f, 2.0f ), + stdlib_complex64( 3.0f, 3.0f ), stdlib_complex64( 4.0f, 4.0f ) + }; + stdlib_complex64_t dataB[] = { + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ), + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ) + }; + int32_t dataK[] = { 0 }; + + // Specify the number of matrix dimensions: + const int64_t ndims = 2; + + // Specify the matrix shape: + int64_t shape[] = { 2, 2 }; + + // Specify the array strides (in bytes): + int64_t strides[] = { + 2 * STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT, + STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT + }; + int64_t kstrides[] = { 0 }; + + // Specify the byte offset: + const int64_t offset = 0; + + // Specify the array order: + const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR; + + // Specify the index mode: + const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR; + + // Specify the subscript index modes: + int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + const int64_t nsubmodes = 1; + + // Create ndarrays: + struct ndarray *A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataA, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + struct ndarray *B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataB, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)dataK, 0, NULL, kstrides, offset, order, imode, nsubmodes, submodes ); + if ( A == NULL || B == NULL || k == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { A, B, k }; + + // Perform computation: + stdlib_blas_ext_ctril( arrays ); + + // Print the result: + for ( int i = 0; i < 4; i++ ) { + printf( "dataB[ %i ] = (%f, %f)\n", i, stdlib_complex64_real( dataB[ i ] ), stdlib_complex64_imag( dataB[ i ] ) ); + } + + // Free allocated memory: + stdlib_ndarray_free( A ); + stdlib_ndarray_free( B ); + stdlib_ndarray_free( k ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.js index 3e31ac935cd9..fdc152f45ecf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.js @@ -29,7 +29,7 @@ var pow = require( '@stdlib/math/base/special/pow' ); var format = require( '@stdlib/string/format' ); var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); var pkg = require( './../package.json' ).name; -var ctril = require( './../lib' ); +var ctril = require( './../lib/main.js' ); // VARIABLES // @@ -61,7 +61,7 @@ function createBenchmark( N ) { B = new Complex64Matrix( bbuf.buffer, 0, N, N ); k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); return benchmark; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.native.js new file mode 100644 index 000000000000..a647a815ee40 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/benchmark.native.js @@ -0,0 +1,128 @@ +/** +* @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 resolve = require( 'path' ).resolve; +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var realf = require( '@stdlib/complex/float32/real' ); +var imagf = require( '@stdlib/complex/float32/imag' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Matrix = require( '@stdlib/ndarray/matrix/complex64' ); +var format = require( '@stdlib/string/format' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var ctril = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ctril instanceof Error ) +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - number of rows and columns +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var abuf; + var bbuf; + var A; + var B; + var k; + + abuf = uniform( N*N*2, -100.0, 100.0, { + 'dtype': 'float32' + }); + bbuf = uniform( N*N*2, -100.0, 100.0, { + 'dtype': 'float32' + }); + A = new Complex64Matrix( abuf.buffer, 0, N, N ); + B = new Complex64Matrix( bbuf.buffer, 0, N, N ); + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var value; + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = ctril( [ A, B, k ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + value = out.get( i%N, i%N ); + if ( isnanf( realf( value ) ) || isnanf( imagf( value ) ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var min; + var max; + var N; + var f; + var i; + + min = 1; // 10^min + max = 3; // 10^max + + for ( i = min; i <= max; i++ ) { + N = pow( 10, i ); + f = createBenchmark( N ); + bench( format( '%s::native:size=%d', pkg, N*N ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/Makefile new file mode 100644 index 000000000000..0756dc7da20a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..9751830cce2b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/benchmark/c/benchmark.length.c @@ -0,0 +1,224 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/real.h" +#include "stdlib/complex/float32/imag.h" +#include +#include +#include +#include +#include +#include + +#define NAME "ctril" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [min,max). +* +* @param min minimum value (inclusive) +* @param max maximum value (exclusive) +* @return random number +*/ +static float random_uniform( const float min, const float max ) { + float v = (float)rand() / ( (float)RAND_MAX + 1.0f ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param n number of matrix rows and columns +* @return elapsed time in seconds +*/ +static double benchmark( int iterations, int n ) { + const struct ndarray *arrays[ 3 ]; + enum STDLIB_NDARRAY_INDEX_MODE imode; + enum STDLIB_NDARRAY_ORDER order; + struct ndarray *A; + struct ndarray *B; + struct ndarray *k; + int64_t shape[ 2 ]; + int64_t strides[ 2 ]; + int64_t kstrides[ 1 ]; + int8_t submodes[ 2 ]; + int64_t nsubmodes; + stdlib_complex64_t *dataA; + stdlib_complex64_t *dataB; + int64_t offset; + int32_t kdata[ 1 ]; + double elapsed; + double t; + int64_t ndims; + int64_t len; + int i; + + ndims = 2; + shape[ 0 ] = n; + shape[ 1 ] = n; + strides[ 0 ] = (int64_t)n * STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT; + strides[ 1 ] = STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT; + kstrides[ 0 ] = 0; + offset = 0; + order = STDLIB_NDARRAY_ROW_MAJOR; + imode = STDLIB_NDARRAY_INDEX_ERROR; + submodes[ 0 ] = imode; + submodes[ 1 ] = imode; + nsubmodes = 1; + len = (int64_t)n * (int64_t)n; + + dataA = (stdlib_complex64_t *)malloc( (size_t)len * sizeof(stdlib_complex64_t) ); + dataB = (stdlib_complex64_t *)malloc( (size_t)len * sizeof(stdlib_complex64_t) ); + if ( dataA == NULL || dataB == NULL ) { + fprintf( stderr, "Error allocating matrix buffers.\n" ); + exit( 1 ); + } + for ( i = 0; i < len; i++ ) { + dataA[ i ] = stdlib_complex64( random_uniform( -100.0f, 100.0f ), random_uniform( -100.0f, 100.0f ) ); + dataB[ i ] = stdlib_complex64( 0.0f, 0.0f ); + } + kdata[ 0 ] = 0; + + // cppcheck-suppress invalidPointerCast + A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataA, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + + // cppcheck-suppress invalidPointerCast + B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataB, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + + // cppcheck-suppress invalidPointerCast + k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)kdata, 0, NULL, kstrides, offset, order, imode, nsubmodes, submodes ); + if ( A == NULL || B == NULL || k == NULL ) { + fprintf( stderr, "Error allocating ndarray metadata.\n" ); + exit( 1 ); + } + arrays[ 0 ] = A; + arrays[ 1 ] = B; + arrays[ 2 ] = k; + + t = tic(); + for ( i = 0; i < iterations; i++ ) { + stdlib_blas_ext_ctril( arrays ); + if ( isnan( stdlib_complex64_real( dataB[ 0 ] ) ) || isnan( stdlib_complex64_imag( dataB[ 0 ] ) ) ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( isnan( stdlib_complex64_real( dataB[ 0 ] ) ) || isnan( stdlib_complex64_imag( dataB[ 0 ] ) ) ) { + printf( "should not return NaN\n" ); + } + stdlib_ndarray_free( A ); + stdlib_ndarray_free( B ); + stdlib_ndarray_free( k ); + free( dataA ); + free( dataB ); + arrays[ 0 ] = NULL; + arrays[ 1 ] = NULL; + arrays[ 2 ] = NULL; + + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int n; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + n = (int)pow( 10.0, (double)i ); + iter = ITERATIONS / (int)pow( 10.0, (double)(2*(i-1)) ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:size=%d\n", NAME, n*n ); + elapsed = benchmark( iter, n ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/binding.gyp @@ -0,0 +1,170 @@ +# @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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/repl.txt index 65d99eaa5bfd..ef866ad11ba5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/repl.txt @@ -31,7 +31,7 @@ > var bbuf = [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]; > var B = new {{alias:@stdlib/ndarray/matrix/complex64}}( bbuf ); - > var k = {{alias:@stdlib/ndarray/from-scalar}}( 0, { 'dtype': 'generic' } ); + > var k = {{alias:@stdlib/ndarray/from-scalar}}( 0, { 'dtype': 'int32' } ); > {{alias}}( [ A, B, k ] ); > B diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/index.d.ts index 761a08d845c7..b4fc030f6d2d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/index.d.ts @@ -44,7 +44,7 @@ import { complex64ndarray, typedndarray } from '@stdlib/types/ndarray'; * var B = new Complex64Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] ); * * var k = scalar2ndarray( 0, { -* 'dtype': 'generic' +* 'dtype': 'int32' * }); * * var out = ctril( [ A, B, k ] ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/test.ts index 2811501d80b2..9408935897a9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/docs/types/test.ts @@ -34,7 +34,7 @@ import ctril = require( './index' ); 'dtype': 'complex64' }); const k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); ctril( [ A, B, k ] ); // $ExpectType complex64ndarray @@ -62,7 +62,7 @@ import ctril = require( './index' ); 'dtype': 'complex64' }); const k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); ctril(); // $ExpectError diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/example.c new file mode 100644 index 000000000000..09c63e64407a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/c/example.c @@ -0,0 +1,99 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/dtypes.h" +#include "stdlib/ndarray/index_modes.h" +#include "stdlib/ndarray/orders.h" +#include "stdlib/ndarray/base/bytes_per_element.h" +#include "stdlib/complex/float32/ctor.h" +#include "stdlib/complex/float32/real.h" +#include "stdlib/complex/float32/imag.h" +#include +#include +#include + +int main( void ) { + // Create data buffers: + const stdlib_complex64_t dataA[] = { + stdlib_complex64( 1.0f, 1.0f ), stdlib_complex64( 2.0f, 2.0f ), + stdlib_complex64( 3.0f, 3.0f ), stdlib_complex64( 4.0f, 4.0f ) + }; + stdlib_complex64_t dataB[] = { + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ), + stdlib_complex64( 0.0f, 0.0f ), stdlib_complex64( 0.0f, 0.0f ) + }; + int32_t dataK[] = { 0 }; + + // Specify the number of matrix dimensions: + const int64_t ndims = 2; + + // Specify the matrix shape: + int64_t shape[] = { 2, 2 }; + + // Specify the array strides (in bytes): + int64_t strides[] = { + 2 * STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT, + STDLIB_NDARRAY_COMPLEX64_BYTES_PER_ELEMENT + }; + int64_t kstrides[] = { 0 }; + + // Specify the byte offset: + const int64_t offset = 0; + + // Specify the array order: + const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR; + + // Specify the index mode: + const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR; + + // Specify the subscript index modes: + int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + const int64_t nsubmodes = 1; + + // Create ndarrays: + // cppcheck-suppress invalidPointerCast + struct ndarray *A = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataA, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + + // cppcheck-suppress invalidPointerCast + struct ndarray *B = stdlib_ndarray_allocate( STDLIB_NDARRAY_COMPLEX64, (uint8_t *)dataB, ndims, shape, strides, offset, order, imode, nsubmodes, submodes ); + + // cppcheck-suppress invalidPointerCast + struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT32, (uint8_t *)dataK, 0, NULL, kstrides, offset, order, imode, nsubmodes, submodes ); + if ( A == NULL || B == NULL || k == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { A, B, k }; + + // Perform computation: + stdlib_blas_ext_ctril( arrays ); + + // Print the result: + for ( int i = 0; i < 4; i++ ) { + printf( "dataB[ %i ] = (%f, %f)\n", i, stdlib_complex64_real( dataB[ i ] ), stdlib_complex64_imag( dataB[ i ] ) ); + } + + // Free allocated memory: + stdlib_ndarray_free( A ); + stdlib_ndarray_free( B ); + stdlib_ndarray_free( k ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/index.js index 43fc0a578a44..ddf9708d71ba 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/examples/index.js @@ -35,7 +35,7 @@ var B = new Complex64Matrix( discreteUniform( 5*5*2, -50, 50, opts ).buffer, 0, console.log( ndarray2array( B ) ); var k = scalar2ndarray( 0, { - 'dtype': 'generic' + 'dtype': 'int32' }); var out = ctril( [ A, B, k ] ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/include.gypi @@ -0,0 +1,53 @@ +# @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. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + '} arrays - array-like object containing ndarrays +* @returns {Object} output ndarray +* +* @example +* var Complex64Matrix = require( '@stdlib/ndarray/matrix/complex64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* +* var A = new Complex64Matrix( [ [ 1.0, 2.0, 3.0, 4.0 ], [ 5.0, 6.0, 7.0, 8.0 ] ] ); +* var B = new Complex64Matrix( [ [ 0.0, 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0, 0.0 ] ] ); +* +* var k = scalar2ndarray( 0, { +* 'dtype': 'int32' +* }); +* +* var out = ctril( [ A, B, k ] ); +* // returns [ [ [ 1.0, 2.0 ], [ 0.0, 0.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] ] +* +* var bool = ( out === B ); +* // returns true +*/ +function ctril( arrays ) { + var A = arrays[ 0 ]; + var B = arrays[ 1 ]; + var k = arrays[ 2 ]; + addon( reinterpret( getData( A ), 0 ), serialize( A ), reinterpret( getData( B ), 0 ), serialize( B ), getData( k ), serialize( k ) ); // eslint-disable-line max-len + return B; +} + + +// EXPORTS // + +module.exports = ctril; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/manifest.json new file mode 100644 index 000000000000..6a96a6ad2764 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/manifest.json @@ -0,0 +1,116 @@ +{ + "options": { + "task": "build", + "wasm": false + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/ctril", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/base/napi/addon-arguments", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/complex/float32/ctor" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/ctril", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/dtypes", + "@stdlib/ndarray/index-modes", + "@stdlib/ndarray/orders", + "@stdlib/ndarray/base/bytes-per-element", + "@stdlib/complex/float32/ctor", + "@stdlib/complex/float32/real", + "@stdlib/complex/float32/imag" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/ctril", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/dtypes", + "@stdlib/ndarray/index-modes", + "@stdlib/ndarray/orders", + "@stdlib/ndarray/base/bytes-per-element", + "@stdlib/complex/float32/ctor", + "@stdlib/complex/float32/real", + "@stdlib/complex/float32/imag" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/ctril", + "@stdlib/ndarray/ctor" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/package.json index 2f0fa8b9cf62..4bfe81b86612 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/package.json @@ -14,11 +14,15 @@ } ], "main": "./lib", + "browser": "./lib/main.js", + "gypfile": true, "directories": { "benchmark": "./benchmark", "doc": "./docs", "example": "./examples", + "include": "./include", "lib": "./lib", + "src": "./src", "test": "./test" }, "types": "./docs/types", diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/addon.c new file mode 100644 index 000000000000..4335563f7342 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/addon.c @@ -0,0 +1,67 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/ndarray/base/napi/addon_arguments.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 6 ); + + // Process provided arguments: + struct ndarray *arrays[ 3 ]; + napi_value err; + napi_status status = stdlib_ndarray_napi_addon_arguments( env, argv, 6, 3, arrays, &err ); + assert( status == napi_ok ); + if ( err != NULL ) { + status = napi_throw( env, err ); + assert( status == napi_ok ); + return NULL; + } + // Create a const-qualified view of the argument pointer list: + const struct ndarray *arr[ 3 ] = { + arrays[ 0 ], + arrays[ 1 ], + arrays[ 2 ] + }; + // Perform computation: + stdlib_blas_ext_ctril( arr ); + + // Free allocated memory: + stdlib_ndarray_free( arrays[ 0 ] ); + stdlib_ndarray_free( arrays[ 1 ] ); + stdlib_ndarray_free( arrays[ 2 ] ); + arrays[ 0 ] = NULL; + arrays[ 1 ] = NULL; + arrays[ 2 ] = NULL; + + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/main.c new file mode 100644 index 000000000000..f5561132cc13 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/src/main.c @@ -0,0 +1,57 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/ndarray/ctril.h" +#include "stdlib/blas/ext/base/ctril.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/blas/base/shared.h" + +/** +* Copies the lower triangular part of a single-precision complex floating-point matrix `A` to another matrix `B`. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a two-dimensional input ndarray corresponding to `A`. +* - a two-dimensional output ndarray corresponding to `B`. +* - a zero-dimensional ndarray specifying the diagonal above which to ignore. +* +* @param arrays list containing ndarrays +*/ +void stdlib_blas_ext_ctril( const struct ndarray *arrays[] ) { + const struct ndarray *A = arrays[ 0 ]; + const struct ndarray *B = arrays[ 1 ]; + + int32_t k; + stdlib_ndarray_get_int32( arrays[ 2 ], NULL, &k ); + + const CBLAS_INT M = stdlib_ndarray_dimension( A, 0 ); + const CBLAS_INT N = stdlib_ndarray_dimension( A, 1 ); + + const CBLAS_INT strideA1 = stdlib_ndarray_stride_elements( A, 0 ); + const CBLAS_INT strideA2 = stdlib_ndarray_stride_elements( A, 1 ); + const CBLAS_INT offsetA = stdlib_ndarray_offset_elements( A ); + const CBLAS_INT strideB1 = stdlib_ndarray_stride_elements( B, 0 ); + const CBLAS_INT strideB2 = stdlib_ndarray_stride_elements( B, 1 ); + const CBLAS_INT offsetB = stdlib_ndarray_offset_elements( B ); + + const stdlib_complex64_t *dataA = (const stdlib_complex64_t *)stdlib_ndarray_data( A ); + stdlib_complex64_t *dataB = (stdlib_complex64_t *)stdlib_ndarray_data( B ); + API_SUFFIX(stdlib_strided_ctril_ndarray)( M, N, k, dataA, strideA1, strideA2, offsetA, dataB, strideB1, strideB2, offsetB ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.js index fe27091c4853..0ccd8e71d327 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.js @@ -21,31 +21,16 @@ // MODULES // var tape = require( 'tape' ); -var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); -var Complex64Array = require( '@stdlib/array/complex64' ); -var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var getData = require( '@stdlib/ndarray/data-buffer' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); var ctril = require( './../lib' ); -// FUNCTIONS // +// VARIABLES // -/** -* Returns a two-dimensional ndarray. -* -* @private -* @param {Collection} buffer - underlying data buffer -* @param {NonNegativeInteger} M - number of rows -* @param {NonNegativeInteger} N - number of columns -* @param {integer} stride0 - stride of the first dimension -* @param {integer} stride1 - stride of the second dimension -* @param {NonNegativeInteger} offset - index offset -* @returns {ndarray} two-dimensional ndarray -*/ -function matrix( buffer, M, N, stride0, stride1, offset ) { - return new ndarray( 'complex64', buffer, [ M, N ], [ stride0, stride1 ], offset, 'row-major' ); -} +var opts = { + 'skip': IS_BROWSER +}; // TESTS // @@ -56,182 +41,37 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function has an arity of 1', function test( t ) { - t.strictEqual( ctril.length, 1, 'has expected arity' ); - t.end(); -}); - -tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k=0)', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - Bbuf = new Complex64Array( 9 ); - A = matrix( Abuf, 3, 3, 3, 1, 0 ); - B = matrix( Bbuf, 3, 3, 3, 1, 0 ); - - k = scalar2ndarray( 0, { - 'dtype': 'generic' - }); - v = ctril( [ A, B, k ] ); - - expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); - t.end(); -}); - -tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k>0)', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - Bbuf = new Complex64Array( 9 ); - A = matrix( Abuf, 3, 3, 3, 1, 0 ); - B = matrix( Bbuf, 3, 3, 3, 1, 0 ); - - k = scalar2ndarray( 1, { - 'dtype': 'generic' - }); - v = ctril( [ A, B, k ] ); - - expected = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); - t.end(); -}); - -tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k<0)', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - Bbuf = new Complex64Array( 9 ); - A = matrix( Abuf, 3, 3, 3, 1, 0 ); - B = matrix( Bbuf, 3, 3, 3, 1, 0 ); - - k = scalar2ndarray( -1, { - 'dtype': 'generic' +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var ctril = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire }); - v = ctril( [ A, B, k ] ); - expected = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 0.0, 0.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 0.0, 0.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.strictEqual( ctril, mock, 'returns expected value' ); t.end(); -}); -tape( 'the function copies the lower triangular part of a two-dimensional ndarray (column-major, k=0)', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 2.0, 2.0, 5.0, 5.0, 8.0, 8.0, 3.0, 3.0, 6.0, 6.0, 9.0, 9.0 ] ); - Bbuf = new Complex64Array( 9 ); - A = matrix( Abuf, 3, 3, 1, 3, 0 ); - B = matrix( Bbuf, 3, 3, 1, 3, 0 ); - - k = scalar2ndarray( 0, { - 'dtype': 'generic' - }); - v = ctril( [ A, B, k ] ); + function tryRequire() { + return mock; + } - expected = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 0.0, 0.0, 5.0, 5.0, 8.0, 8.0, 0.0, 0.0, 0.0, 0.0, 9.0, 9.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); - t.end(); + function mock() { + // Mock... + } }); -tape( 'the function supports non-square matrices (row-major)', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0 ] ); - Bbuf = new Complex64Array( 6 ); - A = matrix( Abuf, 2, 3, 3, 1, 0 ); - B = matrix( Bbuf, 2, 3, 3, 1, 0 ); - - k = scalar2ndarray( 0, { - 'dtype': 'generic' - }); - v = ctril( [ A, B, k ] ); +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var ctril; + var main; - expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); - t.end(); -}); + main = require( './../lib/main.js' ); -tape( 'the function supports ndarrays having non-zero offsets', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 99.0, 99.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] ); - Bbuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); - A = matrix( Abuf, 2, 2, 2, 1, 1 ); - B = matrix( Bbuf, 2, 2, 2, 1, 1 ); - - k = scalar2ndarray( 0, { - 'dtype': 'generic' + ctril = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire }); - v = ctril( [ A, B, k ] ); - expected = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 3.0, 3.0, 4.0, 4.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.strictEqual( ctril, main, 'returns expected value' ); t.end(); -}); -tape( 'the function leaves elements outside of the copied region unchanged', function test( t ) { - var expected; - var Abuf; - var Bbuf; - var A; - var B; - var k; - var v; - - Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - Bbuf = new Complex64Array( [ -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0 ] ); - A = matrix( Abuf, 3, 3, 3, 1, 0 ); - B = matrix( Bbuf, 3, 3, 3, 1, 0 ); - - k = scalar2ndarray( 0, { - 'dtype': 'generic' - }); - v = ctril( [ A, B, k ] ); - - expected = new Complex64Array( [ 1.0, 1.0, -1.0, -1.0, -1.0, -1.0, 4.0, 4.0, 5.0, 5.0, -1.0, -1.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); - t.strictEqual( v, B, 'returns expected value' ); - t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); - t.end(); + function tryRequire() { + return new Error( 'Cannot find module' ); + } }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.main.js new file mode 100644 index 000000000000..13eb847c94ae --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.main.js @@ -0,0 +1,237 @@ +/** +* @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 tape = require( 'tape' ); +var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var ctril = require( './../lib/main.js' ); + + +// FUNCTIONS // + +/** +* Returns a two-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} M - number of rows +* @param {NonNegativeInteger} N - number of columns +* @param {integer} stride0 - stride of the first dimension +* @param {integer} stride1 - stride of the second dimension +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} two-dimensional ndarray +*/ +function matrix( buffer, M, N, stride0, stride1, offset ) { + return new ndarray( 'complex64', buffer, [ M, N ], [ stride0, stride1 ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctril, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( ctril.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k=0)', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k>0)', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 1, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k<0)', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( -1, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 0.0, 0.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 0.0, 0.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (column-major, k=0)', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 2.0, 2.0, 5.0, 5.0, 8.0, 8.0, 3.0, 3.0, 6.0, 6.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 1, 3, 0 ); + B = matrix( Bbuf, 3, 3, 1, 3, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 0.0, 0.0, 5.0, 5.0, 8.0, 8.0, 0.0, 0.0, 0.0, 0.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports non-square matrices (row-major)', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0 ] ); + Bbuf = new Complex64Array( 6 ); + A = matrix( Abuf, 2, 3, 3, 1, 0 ); + B = matrix( Bbuf, 2, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports ndarrays having non-zero offsets', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 99.0, 99.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] ); + Bbuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = matrix( Abuf, 2, 2, 2, 1, 1 ); + B = matrix( Bbuf, 2, 2, 2, 1, 1 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 3.0, 3.0, 4.0, 4.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function leaves elements outside of the copied region unchanged', function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( [ -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0 ] ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, -1.0, -1.0, -1.0, -1.0, 4.0, 4.0, 5.0, 5.0, -1.0, -1.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.native.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.native.js new file mode 100644 index 000000000000..645d0beabbad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/ctril/test/test.native.js @@ -0,0 +1,246 @@ +/** +* @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 resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var isSameComplex64Array = require( '@stdlib/assert/is-same-complex64array' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var ctril = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( ctril instanceof Error ) +}; + + +// FUNCTIONS // + +/** +* Returns a two-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} M - number of rows +* @param {NonNegativeInteger} N - number of columns +* @param {integer} stride0 - stride of the first dimension +* @param {integer} stride1 - stride of the second dimension +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} two-dimensional ndarray +*/ +function matrix( buffer, M, N, stride0, stride1, offset ) { + return new ndarray( 'complex64', buffer, [ M, N ], [ stride0, stride1 ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctril, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', opts, function test( t ) { + t.strictEqual( ctril.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k=0)', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k>0)', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 1, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (row-major, k<0)', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( -1, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 0.0, 0.0, 0.0, 0.0, 7.0, 7.0, 8.0, 8.0, 0.0, 0.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function copies the lower triangular part of a two-dimensional ndarray (column-major, k=0)', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 2.0, 2.0, 5.0, 5.0, 8.0, 8.0, 3.0, 3.0, 6.0, 6.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( 9 ); + A = matrix( Abuf, 3, 3, 1, 3, 0 ); + B = matrix( Bbuf, 3, 3, 1, 3, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 4.0, 4.0, 7.0, 7.0, 0.0, 0.0, 5.0, 5.0, 8.0, 8.0, 0.0, 0.0, 0.0, 0.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports non-square matrices (row-major)', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0 ] ); + Bbuf = new Complex64Array( 6 ); + A = matrix( Abuf, 2, 3, 3, 1, 0 ); + B = matrix( Bbuf, 2, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 5.0, 5.0, 0.0, 0.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports ndarrays having non-zero offsets', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 99.0, 99.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0 ] ); + Bbuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + A = matrix( Abuf, 2, 2, 2, 1, 1 ); + B = matrix( Bbuf, 2, 2, 2, 1, 1 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 0.0, 0.0, 3.0, 3.0, 4.0, 4.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function leaves elements outside of the copied region unchanged', opts, function test( t ) { + var expected; + var Abuf; + var Bbuf; + var A; + var B; + var k; + var v; + + Abuf = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0, 4.0, 4.0, 5.0, 5.0, 6.0, 6.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + Bbuf = new Complex64Array( [ -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0, -1.0 ] ); + A = matrix( Abuf, 3, 3, 3, 1, 0 ); + B = matrix( Bbuf, 3, 3, 3, 1, 0 ); + + k = scalar2ndarray( 0, { + 'dtype': 'int32' + }); + v = ctril( [ A, B, k ] ); + + expected = new Complex64Array( [ 1.0, 1.0, -1.0, -1.0, -1.0, -1.0, 4.0, 4.0, 5.0, 5.0, -1.0, -1.0, 7.0, 7.0, 8.0, 8.0, 9.0, 9.0 ] ); + t.strictEqual( v, B, 'returns expected value' ); + t.strictEqual( isSameComplex64Array( getData( v ), expected ), true, 'returns expected value' ); + t.end(); +});