From b11d5938bcf11141135e45fd4349da95e57de7b3 Mon Sep 17 00:00:00 2001 From: Utkarsh patwa Date: Wed, 4 Nov 2026 23:20:35 +0530 Subject: [PATCH 1/2] feat: add C implementation for `blas/ext/base/ndarray/dcircshift` Signed-off-by: Utkarsh patwa --- .../ext/base/ndarray/dcircshift/README.md | 169 +++++++++++ .../dcircshift/benchmark/benchmark.native.js | 111 ++++++++ .../ndarray/dcircshift/benchmark/c/Makefile | 146 ++++++++++ .../dcircshift/benchmark/c/benchmark.length.c | 189 +++++++++++++ .../ext/base/ndarray/dcircshift/binding.gyp | 265 ++++++++++++++++++ .../ndarray/dcircshift/examples/c/Makefile | 146 ++++++++++ .../ndarray/dcircshift/examples/c/example.c | 88 ++++++ .../ext/base/ndarray/dcircshift/include.gypi | 53 ++++ .../stdlib/blas/ext/base/ndarray/dcircshift.h | 40 +++ .../ext/base/ndarray/dcircshift/lib/index.js | 16 +- .../ext/base/ndarray/dcircshift/lib/native.js | 76 +++++ .../ext/base/ndarray/dcircshift/manifest.json | 109 +++++++ .../ext/base/ndarray/dcircshift/package.json | 4 + .../ext/base/ndarray/dcircshift/src/Makefile | 70 +++++ .../ext/base/ndarray/dcircshift/src/addon.c | 64 +++++ .../ext/base/ndarray/dcircshift/src/main.c | 50 ++++ .../ext/base/ndarray/dcircshift/test/test.js | 233 ++------------- .../base/ndarray/dcircshift/test/test.main.js | 252 +++++++++++++++++ .../ndarray/dcircshift/test/test.native.js | 261 +++++++++++++++++ 19 files changed, 2137 insertions(+), 205 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/include/stdlib/blas/ext/base/ndarray/dcircshift.h create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/main.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.native.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/README.md index 7ef4ebf48777..2771a2f4d4f8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/README.md @@ -108,6 +108,175 @@ console.log( ndarray2array( x ) ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/ndarray/dcircshift.h" +``` + +#### stdlib_blas_ext_dcircshift( arrays ) + +Circularly shifts the elements of a one-dimensional double-precision floating-point ndarray by a specified number of positions. + +```c +#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 + +// Create an input ndarray: +double dataX[] = { 1.0, 2.0, 3.0, 4.0, 5.0 }; +int64_t shapeX[] = { 5 }; +int64_t stridesX[] = { STDLIB_NDARRAY_FLOAT64_BYTES_PER_ELEMENT }; +int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR }; + +struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, 1, shapeX, stridesX, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Create an ndarray containing the number of positions to shift: +const int64_t kdata[] = { 2 }; +int64_t kstrides[] = { 0 }; + +struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT64, (uint8_t *)kdata, 0, NULL, kstrides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + +// Perform computation: +const struct ndarray *arrays[] = { x, k }; +stdlib_blas_ext_dcircshift( arrays ); + +// Free allocated memory: +stdlib_ndarray_free( x ); +stdlib_ndarray_free( k ); +``` + +The function accepts the following arguments: + +- **arrays**: `[in] struct ndarray**` list containing the following ndarrays: + + - `[inout] struct ndarray*` a one-dimensional input ndarray. + - `[in] struct ndarray*` a zero-dimensional ndarray specifying the number of positions to shift. + +```c +void stdlib_blas_ext_dcircshift( const struct ndarray *arrays[] ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/ndarray/dcircshift.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 +#include +#include + +int main( void ) { + // Create a data buffer for the input vector: + double dataX[] = { 1.0, 2.0, 3.0, 4.0, 5.0 }; + + // Specify the number of array dimensions: + const int64_t ndimsX = 1; + + // Specify the array shape: + int64_t shapeX[] = { 5 }; + + // Specify the array strides: + int64_t stridesX[] = { STDLIB_NDARRAY_FLOAT64_BYTES_PER_ELEMENT }; + + // 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 an input ndarray: + struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, ndimsX, shapeX, stridesX, offset, order, imode, nsubmodes, submodes ); + + // Create a data buffer for an ndarray containing the number of positions to shift: + const int64_t kdata[] = { 2 }; + + // Specify the array strides for a zero-dimensional ndarray: + int64_t kstrides[] = { 0 }; + + // Create an ndarray containing the shift amount: + struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT64, (uint8_t *)kdata, 0, NULL, kstrides, 0, order, imode, nsubmodes, submodes ); + + if ( x == NULL || k == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { x, k }; + + // Perform computation: + stdlib_blas_ext_dcircshift( arrays ); + + // Print the result: + for ( int i = 0; i < 5; i++ ) { + printf( "x[ %i ] = %lf\n", i, dataX[ i ] ); + } + + // Free allocated memory: + stdlib_ndarray_free( x ); + stdlib_ndarray_free( k ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.native.js new file mode 100644 index 000000000000..2283adaaf1d8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.native.js @@ -0,0 +1,111 @@ +/** +* @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/uniform' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dcircshift = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( dcircshift instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - ndarray length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( [ len ], -100.0, 100.0, options ); + var k = scalar2ndarray( 2, { + 'dtype': 'int64' + }); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = dcircshift( [ x, k ] ); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( typeof out !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s::native:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/Makefile new file mode 100644 index 000000000000..0756dc7da20a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/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/dcircshift/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..a17cf97f9004 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/c/benchmark.length.c @@ -0,0 +1,189 @@ +/** +* @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/dcircshift.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 +#include +#include +#include +#include +#include + +#define NAME "dcircshift" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* 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 double random_uniform( const double min, const double max ) { + double v = (double)rand() / ( (double)RAND_MAX + 1.0 ); + return min + ( v*(max-min) ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark( int iterations, int len ) { + int64_t stridesX[ 1 ]; + int64_t shapeX[ 1 ]; + int64_t stridesK[ 1 ]; + int8_t submodes[ 1 ]; + struct ndarray *x; + struct ndarray *k; + const struct ndarray *arrays[ 2 ]; + double elapsed; + double *dataX; + int64_t kdata[ 1 ]; + double t; + int i; + + shapeX[ 0 ] = len; + stridesX[ 0 ] = STDLIB_NDARRAY_FLOAT64_BYTES_PER_ELEMENT; + submodes[ 0 ] = STDLIB_NDARRAY_INDEX_ERROR; + + dataX = (double *)malloc( len * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + dataX[ i ] = random_uniform( -10.0, 10.0 ); + } + + // cppcheck-suppress invalidPointerCast + x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, 1, shapeX, stridesX, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + + kdata[ 0 ] = 2; + stridesK[ 0 ] = 0; + + // cppcheck-suppress invalidPointerCast + k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT64, (uint8_t *)kdata, 0, NULL, stridesK, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes ); + + arrays[ 0 ] = x; + arrays[ 1 ] = k; + + t = tic(); + for ( i = 0; i < iterations; i++ ) { + stdlib_blas_ext_dcircshift( arrays ); + if ( dataX[ 0 ] != dataX[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( dataX[ 0 ] != dataX[ 0 ] ) { + printf( "should not return NaN\n" ); + } + stdlib_ndarray_free( x ); + stdlib_ndarray_free( k ); + free( dataX ); + arrays[ 0 ] = NULL; + arrays[ 1 ] = NULL; + + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + 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++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark( iter, len ); + 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/dcircshift/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/binding.gyp new file mode 100644 index 000000000000..60dce9d0b31a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/binding.gyp @@ -0,0 +1,265 @@ +# @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', + + # Fortran compiler (to override -Dfortran_compiler=): + 'fortran_compiler%': 'gfortran', + + # Fortran compiler flags: + 'fflags': [ + # Specify the Fortran standard to which a program is expected to conform: + '-std=f95', + + # Indicate that the layout is free-form source code: + '-ffree-form', + + # Aggressive optimization: + '-O3', + + # Enable commonly used warning options: + '-Wall', + + # Warn if source code contains problematic language features: + '-Wextra', + + # Warn if a procedure is called without an explicit interface: + '-Wimplicit-interface', + + # Do not transform names of entities specified in Fortran source files by appending underscores (i.e., don't mangle names, thus allowing easier usage in C wrappers): + '-fno-underscoring', + + # Warn if source code contains Fortran 95 extensions and C-language constructs: + '-pedantic', + + # Compile but do not link (output is an object file): + '-c', + ], + + # 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 + + # Define custom build actions for particular inputs: + 'rules': [ + { + # Define a rule for processing Fortran files: + 'extension': 'f', + + # Define the pathnames to be used as inputs when performing processing: + 'inputs': [ + # Full path of the current input: + '<(RULE_INPUT_PATH)' + ], + + # Define the outputs produced during processing: + 'outputs': [ + # Store an output object file in a directory for placing intermediate results (only accessible within a single target): + '<(INTERMEDIATE_DIR)/<(RULE_INPUT_ROOT).<(obj)' + ], + + # Define the rule for compiling Fortran based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + + # Rule to compile Fortran on Windows: + { + 'rule_name': 'compile_fortran_windows', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Windows...', + + 'process_outputs_as_sources': 0, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + }, + + # Rule to compile Fortran on non-Windows: + { + 'rule_name': 'compile_fortran_linux', + 'message': 'Compiling Fortran file <(RULE_INPUT_PATH) on Linux...', + + 'process_outputs_as_sources': 1, + + # Define the command-line invocation: + 'action': [ + '<(fortran_compiler)', + '<@(fflags)', + '-fPIC', # generate platform-independent code + '<@(_inputs)', + '-o', + '<@(_outputs)', + ], + } + ], # end condition (OS=="win") + ], # end conditions + }, # end rule (extension=="f") + ], # end rules + }, # 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/dcircshift/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/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/dcircshift/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/examples/c/example.c new file mode 100644 index 000000000000..c1f66d74ff07 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/examples/c/example.c @@ -0,0 +1,88 @@ +/** +* @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/dcircshift.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 +#include +#include + +int main( void ) { + // Create a data buffer for the input vector: + double dataX[] = { 1.0, 2.0, 3.0, 4.0, 5.0 }; + + // Specify the number of array dimensions: + const int64_t ndimsX = 1; + + // Specify the array shape: + int64_t shapeX[] = { 5 }; + + // Specify the array strides: + int64_t stridesX[] = { STDLIB_NDARRAY_FLOAT64_BYTES_PER_ELEMENT }; + + // 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 an input ndarray: + // cppcheck-suppress invalidPointerCast + struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, (uint8_t *)dataX, ndimsX, shapeX, stridesX, offset, order, imode, nsubmodes, submodes ); + + // Create a data buffer for an ndarray containing the number of positions to shift: + const int64_t kdata[] = { 2 }; + + // Specify the array strides for a zero-dimensional ndarray: + int64_t kstrides[] = { 0 }; + + // Create an ndarray containing the shift amount: + // cppcheck-suppress invalidPointerCast + struct ndarray *k = stdlib_ndarray_allocate( STDLIB_NDARRAY_INT64, (uint8_t *)kdata, 0, NULL, kstrides, 0, order, imode, nsubmodes, submodes ); + + if ( x == NULL || k == NULL ) { + fprintf( stderr, "Error allocating memory.\n" ); + exit( 1 ); + } + + // Define a list of ndarrays: + const struct ndarray *arrays[] = { x, k }; + + // Perform computation: + stdlib_blas_ext_dcircshift( arrays ); + + // Print the result: + for ( int i = 0; i < 5; i++ ) { + printf( "x[ %i ] = %lf\n", i, dataX[ i ] ); + } + + // Free allocated memory: + stdlib_ndarray_free( x ); + stdlib_ndarray_free( k ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/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 {ndarray} input ndarray +* +* @example +* var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); +* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +* +* var x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); +* +* var k = scalar2ndarray( 2, { +* 'dtype': 'generic' +* }); +* +* var out = dcircshift( [ x, k ] ); +* // returns [ 4.0, 5.0, 1.0, 2.0, 3.0 ] +*/ +function dcircshift( arrays ) { + var x = arrays[ 0 ]; + var k = arrays[ 1 ]; + + if ( getDType( k ) !== 'int64' ) { + k = scalar2ndarray( ndarraylike2scalar( k ), { + 'dtype': 'int64' + }); + } + addon( getData( x ), serialize( x ), getData( k ), serialize( k ) ); + return x; +} + + +// EXPORTS // + +module.exports = dcircshift; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/manifest.json new file mode 100644 index 000000000000..ef2198cd9758 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/manifest.json @@ -0,0 +1,109 @@ +{ + "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/dcircshift", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/base/napi/addon-arguments", + "@stdlib/napi/export", + "@stdlib/napi/argv" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/dcircshift", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/dtypes", + "@stdlib/ndarray/index-modes", + "@stdlib/ndarray/orders", + "@stdlib/ndarray/base/bytes-per-element" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/dcircshift", + "@stdlib/ndarray/ctor", + "@stdlib/ndarray/dtypes", + "@stdlib/ndarray/index-modes", + "@stdlib/ndarray/orders", + "@stdlib/ndarray/base/bytes-per-element" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/blas/ext/base/dcircshift", + "@stdlib/ndarray/ctor" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/package.json b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/package.json index 55a39b208a72..d5dd23687bcd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/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/dcircshift/src/Makefile b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/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/dcircshift/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/addon.c new file mode 100644 index 000000000000..5d2695d1ff56 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/addon.c @@ -0,0 +1,64 @@ +/** +* @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/dcircshift.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, 4 ); + + // Process provided arguments: + struct ndarray *arrays[ 2 ]; + napi_value err; + napi_status status = stdlib_ndarray_napi_addon_arguments( env, argv, 4, 2, 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[ 2 ] = { + arrays[ 0 ], + arrays[ 1 ] + }; + // Perform computation: + stdlib_blas_ext_dcircshift( arr ); + + // Free allocated memory: + stdlib_ndarray_free( arrays[ 0 ] ); + stdlib_ndarray_free( arrays[ 1 ] ); + arrays[ 0 ] = NULL; + arrays[ 1 ] = NULL; + + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/main.c new file mode 100644 index 000000000000..be047ac27ee8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/src/main.c @@ -0,0 +1,50 @@ +/** +* @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/dcircshift.h" +#include "stdlib/blas/ext/base/dcircshift.h" +#include "stdlib/ndarray/ctor.h" +#include "stdlib/blas/base/shared.h" +#include + +/** +* Circularly shifts the elements of a one-dimensional double-precision floating-point ndarray by a specified number of positions. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* - a zero-dimensional ndarray specifying the number of positions to shift. +* +* @param arrays list containing ndarrays +*/ +void stdlib_blas_ext_dcircshift( const struct ndarray *arrays[] ) { + const struct ndarray *x = arrays[ 0 ]; + int64_t k; + + const CBLAS_INT N = stdlib_ndarray_dimension( x, 0 ); + const CBLAS_INT strideX = stdlib_ndarray_stride_elements( x, 0 ); + const CBLAS_INT offsetX = stdlib_ndarray_offset_elements( x ); + + double *dataX = (double *)stdlib_ndarray_data( x ); + + stdlib_ndarray_get_int64( arrays[ 1 ], NULL, &k ); + + API_SUFFIX(stdlib_strided_dcircshift_ndarray)( N, (CBLAS_INT)k, dataX, strideX, offsetX ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.js index 5711faff38e4..5aade4a9caae 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.js @@ -21,13 +21,18 @@ // MODULES // var tape = require( 'tape' ); -var Float64Array = require( '@stdlib/array/float64' ); -var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); -var getData = require( '@stdlib/ndarray/data-buffer' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); var dcircshift = require( './../lib' ); +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + // TESTS // tape( 'main export is a function', function test( t ) { @@ -36,217 +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( dcircshift.length, 1, 'has expected arity' ); - t.end(); -}); - -tape( 'the function circularly shifts elements of a one-dimensional ndarray (right shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function circularly shifts elements of a one-dimensional ndarray (left shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( -2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns the input ndarray unchanged when the number of elements to shift is zero', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 0, { - 'dtype': 'generic' +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var dcircshift = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire }); - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); - + t.strictEqual( dcircshift, mock, 'returns expected value' ); t.end(); -}); - -tape( 'the function returns the input ndarray unchanged when the input ndarray is empty', function test( t ) { - var actual; - var x; - var k; - x = ndarray( 'float64', new Float64Array( [] ), [ 0 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [] ), 'returns expected value' ); + function tryRequire() { + return mock; + } - t.end(); + function mock() { + // Mock... + } }); -tape( 'the function returns the input ndarray unchanged when the input ndarray contains a single element', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 7.0 ] ), [ 1 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 3, { - 'dtype': 'generic' - }); +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var dcircshift; + var main; - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 7.0 ] ), 'returns expected value' ); + main = require( './../lib/main.js' ); - t.end(); -}); - -tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (right shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 5, { - 'dtype': 'generic' + dcircshift = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire }); - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); - + t.strictEqual( dcircshift, main, 'returns expected value' ); t.end(); -}); - -tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (left shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( -5, { - 'dtype': 'generic' - }); - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports shifting elements in multiple cycles (right shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( 7, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports shifting elements in multiple cycles (left shift)', function test( t ) { - var actual; - var x; - var k; - - x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); - k = scalar2ndarray( -7, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports an input ndarray having a negative stride', function test( t ) { - var actual; - var xbuf; - var x; - var k; - - xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); - x = ndarray( 'float64', xbuf, [ 5 ], [ -1 ], 4, 'row-major' ); - k = scalar2ndarray( 2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports an input ndarray having a non-zero offset', function test( t ) { - var actual; - var xbuf; - var x; - var k; - - xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); - x = ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 1, 'row-major' ); - k = scalar2ndarray( 2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports an input ndarray having a negative stride and non-zero offset', function test( t ) { - var actual; - var xbuf; - var x; - var k; - - xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); - x = ndarray( 'float64', xbuf, [ 5 ], [ -2 ], 9, 'row-major' ); - k = scalar2ndarray( 2, { - 'dtype': 'generic' - }); - - actual = dcircshift( [ x, k ] ); - t.strictEqual( actual, x, 'returns expected value' ); - t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 5.0, 2.0, 7.0, 4.0, 9.0, 6.0, 1.0, 8.0, 3.0 ] ), 'returns expected value' ); - - t.end(); + function tryRequire() { + return new Error( 'Cannot find module' ); + } }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.main.js new file mode 100644 index 000000000000..4f2148d6e501 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.main.js @@ -0,0 +1,252 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var dcircshift = require( './../lib/main.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcircshift, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dcircshift.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of elements to shift is zero', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 0, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray is empty', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [] ), [ 0 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray contains a single element', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 7.0 ] ), [ 1 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 3, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 7.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 5, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -5, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (right shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 7, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (left shift)', function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -7, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ -1 ], 4, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 1, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride and non-zero offset', function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ -2 ], 9, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 5.0, 2.0, 7.0, 4.0, 9.0, 6.0, 1.0, 8.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.native.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.native.js new file mode 100644 index 000000000000..9096a8b2e922 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/test/test.native.js @@ -0,0 +1,261 @@ +/** +* @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 Float64Array = require( '@stdlib/array/float64' ); +var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); +var getData = require( '@stdlib/ndarray/data-buffer' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dcircshift = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( dcircshift instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcircshift, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', opts, function test( t ) { + t.strictEqual( dcircshift.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (right shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function circularly shifts elements of a one-dimensional ndarray (left shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of elements to shift is zero', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 0, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray is empty', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [] ), [ 0 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the input ndarray contains a single element', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 7.0 ] ), [ 1 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 3, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 7.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (right shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 5, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the input ndarray unchanged when the number of positions to shift equals the number of elements in the input ndarray (left shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -5, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (right shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( 7, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports shifting elements in multiple cycles (left shift)', opts, function test( t ) { + var actual; + var x; + var k; + + x = ndarray( 'float64', new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ), [ 5 ], [ 1 ], 0, 'row-major' ); + k = scalar2ndarray( -7, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride', opts, function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ -1 ], 4, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 3.0, 4.0, 5.0, 1.0, 2.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a non-zero offset', opts, function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 1, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 4.0, 5.0, 1.0, 2.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an input ndarray having a negative stride and non-zero offset', opts, function test( t ) { + var actual; + var xbuf; + var x; + var k; + + xbuf = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] ); + x = ndarray( 'float64', xbuf, [ 5 ], [ -2 ], 9, 'row-major' ); + k = scalar2ndarray( 2, { + 'dtype': 'generic' + }); + + actual = dcircshift( [ x, k ] ); + t.strictEqual( actual, x, 'returns expected value' ); + t.deepEqual( getData( actual ), new Float64Array( [ 0.0, 5.0, 2.0, 7.0, 4.0, 9.0, 6.0, 1.0, 8.0, 3.0 ] ), 'returns expected value' ); + + t.end(); +}); From d9df6b0fb4063549f39e29809ce6ddc2b64d1a6c Mon Sep 17 00:00:00 2001 From: Utkarsh patwa Date: Thu, 5 Nov 2026 00:03:29 +0530 Subject: [PATCH 2/2] benchmark: require main.js instead of lib to benchmark JavaScript implementation Signed-off-by: Utkarsh patwa --- .../blas/ext/base/ndarray/dcircshift/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.js index a29f1e2fb7ab..267fcf7a22d1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/dcircshift/benchmark/benchmark.js @@ -27,7 +27,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 dcircshift = require( './../lib' ); +var dcircshift = require( './../lib/main.js' ); // VARIABLES //