diff --git a/lib/node_modules/@stdlib/blas/base/srotg/README.md b/lib/node_modules/@stdlib/blas/base/srotg/README.md index 7fa9b5bc1174..604b75f0eece 100644 --- a/lib/node_modules/@stdlib/blas/base/srotg/README.md +++ b/lib/node_modules/@stdlib/blas/base/srotg/README.md @@ -92,6 +92,137 @@ for ( i = 0; i < 100; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/base/srotg.h" +``` + +#### c_srotg( a, b, \*Out, strideOut ) + +Constructs a Givens plane rotation provided two single-precision floating-point values `a` and `b`. + +```c +float Out[4]; +c_srotg( 0.0, 2.0, Out, 1 ); +// Out => [ 2.0, 1.0, 0.0, 1.0 ] +``` + +The function accepts the following arguments: + +- **a**: `[in] float` rotational elimination parameter. +- **b**: `[in] float` rotational elimination parameter. +- **Out**: `[inout] float*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. + +```c +void c_srotg_assign( float a, float b, float* Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ); +``` + +#### c_srotg_assign(a, b, \*Out, strideOut, offsetOut ) + +Constructs a Givens plane rotation provided two single-precision floating-point values `a` and `b` and assigns results to an output array. + +```c +float Out[4]; +c_srotg_assign( 0.0, 2.0, Out, 1, 0 ); +// Out => [ 2.0, 1.0, 0.0, 1.0 ] +``` + +The function accepts the following arguments: + +- **a**: `[in] float` rotational elimination parameter. +- **b**: `[in] float` rotational elimination parameter. +- **Out**: `[inout] float*` output array. +- **strideOut**: `[in] CBLAS_INT` stride length for `Out`. +- **offsetOut**: `[in] CBLAS_INT` starting index for `Out`. + +Givens transformation. + +```c +void c_srotg_assign( float a, float b, float* Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/base/srotg.h" +#include + +int main( void ) { + // Specify rotational elimination parameter: + const float a = 0.0; + const float b = 2.0; + int i; + + // Create strided arrays: + float Out[4]; + + // Specify stride lengths: + const int strideOut = 1; + + // Apply plane rotation: + c_srotg( a, b, Out, strideOut ); + + // Print the result: + for ( i = 0; i < 4; i++ ) { + printf( "Out[%d] = %f\n", i, Out[i] ); + } + + // Apply plane rotation + c_srotg_assign( a, b, Out, strideOut, 0 ); + + // Print the result: + for ( i = 0; i < 4; i++ ) { + printf( "Out[%d] = %f\n", i, Out[i] ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.assign.native.js b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.assign.native.js new file mode 100644 index 000000000000..4728fb83f92a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.assign.native.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tryRequire = require( '@stdlib/utils/try-require' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var srotg = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( srotg instanceof Error ) +}; + + +// VARIABLES // + +var OPTS = { + 'dtype': 'float32' +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var out; + var x; + var y; + var i; + + x = uniform( 100, -5, 5, OPTS ); + y = uniform( 100, -5, 5, OPTS ); + out = uniform( 4, 0, 0, OPTS ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + srotg( x[ i%x.length ], y[ i%y.length ], out, 1, 0 ); + if ( typeof out !=='object' ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( isnanf( out[ i%4 ] ) ) { + b.fail( 'should return the output array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.js index 4f229c376eb9..552a8370c3c5 100644 --- a/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.js @@ -21,9 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); -var Float32Array = require( '@stdlib/array/float32' ); var pkg = require( './../package.json' ).name; var srotg = require( './../lib' ); @@ -43,8 +42,8 @@ bench( pkg, function benchmark( b ) { var y; var i; - x = discreteUniform( 100, -5, 5, OPTS ); - y = discreteUniform( 100, -5, 5, OPTS ); + x = uniform( 100, -5, 5, OPTS ); + y = uniform( 100, -5, 5, OPTS ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { @@ -68,9 +67,9 @@ bench( pkg+':assign', function benchmark( b ) { var z; var i; - x = discreteUniform( 100, -5, 5, OPTS ); - y = discreteUniform( 100, -5, 5, OPTS ); - out = new Float32Array( 4 ); + x = uniform( 100, -5, 5, OPTS ); + y = uniform( 100, -5, 5, OPTS ); + out = uniform( 4, 0, 0, OPTS ); b.tic(); for ( i = 0; i < b.iterations; i++ ) { diff --git a/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.native.js new file mode 100644 index 000000000000..e7269fc9dec1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/benchmark.native.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tryRequire = require( '@stdlib/utils/try-require' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var srotg = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( srotg instanceof Error ) +}; + + +// VARIABLES // + +var OPTS = { + 'dtype': 'float32' +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var out; + var x; + var y; + var i; + + x = uniform( 100, -5, 5, OPTS ); + y = uniform( 100, -5, 5, OPTS ); + out = uniform( 4, 0, 0, OPTS ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + srotg( x[ i%x.length ], y[ i%y.length ], out, 1 ); + if ( typeof out !=='object' ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( isnanf( out[ i%4 ] ) ) { + b.fail( 'should return the output array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/base/srotg/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..4bef7512e626 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/benchmark/c/benchmark.length.c @@ -0,0 +1,195 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/srotg.h" +#include +#include +#include +#include +#include + +#define NAME "srotg" +#define ITERATIONS 10000000 +#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 [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + float a[ len ]; + float b[ len ]; + float Out[4]; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + a[ i ] = ( rand_float()*200.0f ) - 100.0f; + b[ i ] = ( rand_float()*200.0f ) - 100.0f; + } + + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c_srotg( a[i % len ], b[i % len ], Out, 1 ); + if ( Out[ 0 ] != Out[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( Out[ 0 ] != Out[ 0 ] ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + float a[ len ]; + float b[ len ]; + float Out[4]; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + a[ i ] = ( rand_float()*200.0f ) - 100.0f; + b[ i ] = ( rand_float()*200.0f ) - 100.0f; + } + + t = tic(); + for ( i = 0; i < iterations; i++ ) { + c_srotg_assign( a[i % len ], b[i % len ], Out, 1, 0 ); + if ( Out[ 0 ] != Out[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( Out[ 0 ] != Out[ 0 ] ) { + printf( "should not return NaN\n" ); + } + 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 = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( 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/base/srotg/binding.gyp b/lib/node_modules/@stdlib/blas/base/srotg/binding.gyp new file mode 100644 index 000000000000..ed405c6a5a28 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/binding.gyp @@ -0,0 +1,171 @@ + +# @license Apache-2.0 +# +# Copyright (c) 2025 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/base/srotg/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/srotg/docs/repl.txt index f9dbbc249883..7cf952f4dc95 100644 --- a/lib/node_modules/@stdlib/blas/base/srotg/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/srotg/docs/repl.txt @@ -7,7 +7,7 @@ ---------- a: float Rotational elimination parameter. - + b: float Rotational elimination parameter. @@ -22,7 +22,7 @@ [ 2.0, 1.0, 0.0, 1.0 ] -{{alias}}.assign( a, b, out, stride, offset ) +{{alias}}.assign( a, b, out, strideOut, offsetOut ) Constructs a Givens plane rotation from two single-precision floating-point numbers and assigns the results to an output array. @@ -33,21 +33,21 @@ b: float Rotational elimination parameter. - + out: Float32Array Output array. - - stride: integer - Output array stride. - - offset: integer + + strideOut: integer + Output array stride length. + + offsetOut: integer Output array index offset. Returns ------- out: Float32Array Output array. - + Examples -------- > var out = new {{alias:@stdlib/array/float32}}( 4 ); @@ -55,6 +55,6 @@ [ 2.0, 1.0, 0.0, 1.0 ] > var bool = ( y === out ) true - + See Also -------- diff --git a/lib/node_modules/@stdlib/blas/base/srotg/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/srotg/docs/types/index.d.ts index 02046f8728b7..a858e5a57e7a 100644 --- a/lib/node_modules/@stdlib/blas/base/srotg/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/srotg/docs/types/index.d.ts @@ -45,8 +45,8 @@ interface Routine { * @param a - rotational elimination parameter * @param b - rotational elimination parameter * @param out - output array - * @param stride - index increment - * @param offset - starting index + * @param strideOut - stride length for `out` + * @param offset - starting index for `out` * @returns output array * * @example @@ -60,7 +60,7 @@ interface Routine { * var bool = ( y === out ); * // returns true */ - assign( a: number, b: number, out: Float32Array, stride: number, offset: number ): Float32Array; + assign( a: number, b: number, out: Float32Array, strideOut: number, offset: number ): Float32Array; } /** diff --git a/lib/node_modules/@stdlib/blas/base/srotg/examples/c/Makefile b/lib/node_modules/@stdlib/blas/base/srotg/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/base/srotg/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/srotg/examples/c/example.c new file mode 100644 index 000000000000..e719457246c9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/examples/c/example.c @@ -0,0 +1,49 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/srotg.h" +#include + +int main( void ) { + // Specify rotational elimination parameter: + const float a = 0.0; + const float b = 2.0; + int i; + + // Create strided arrays: + float Out[4]; + + // Specify stride lengths: + const int strideOut = 1; + + // Apply plane rotation: + c_srotg( a, b, Out, strideOut ); + + // Print the result: + for ( i = 0; i < 4; i++ ) { + printf( "Out[%d] = %f\n", i, Out[i] ); + } + + // Apply plane rotation + c_srotg_assign( a, b, Out, strideOut, 0 ); + + // Print the result: + for ( i = 0; i < 4; i++ ) { + printf( "Out[%d] = %f\n", i, Out[i] ); + } +} diff --git a/lib/node_modules/@stdlib/blas/base/srotg/include.gypi b/lib/node_modules/@stdlib/blas/base/srotg/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2025 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': [ + '[ 2.0, 1.0, 0.0, 1.0 ] */ -function srotg( a, b, out, stride, offset ) { +function srotg( a, b, out, strideOut, offsetOut ) { var scale; var sign; var aa; @@ -82,10 +82,10 @@ function srotg( a, b, out, stride, offset ) { } a = r; b = z; - out[ offset ] = a; - out[ offset + stride ] = b; - out[ offset + ( 2 * stride ) ] = c; - out[ offset + ( 3 * stride ) ] = s; + out[ offsetOut ] = a; + out[ offsetOut + strideOut ] = b; + out[ offsetOut + ( 2 * strideOut ) ] = c; + out[ offsetOut + ( 3 * strideOut ) ] = s; return out; } diff --git a/lib/node_modules/@stdlib/blas/base/srotg/lib/assign.native.js b/lib/node_modules/@stdlib/blas/base/srotg/lib/assign.native.js new file mode 100644 index 000000000000..62f7b7531e39 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/lib/assign.native.js @@ -0,0 +1,52 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Constructs a Givens plane rotation using alternative indexing semantics. +* +* @param {number} a - rotational elimination parameter +* @param {number} b - rotational elimination parameter +* @param {Float32Array} Out - output array +* @param {integer} strideOut - stride length for `Out` +* @param {NonNegativeInteger} offsetOut - starting index for `Out` +* @returns {Float32Array} output array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var out = srotg( 0.0, 2.0, new Float32Array( 4 ), 1, 0 ); +* // returns [ 2.0, 1.0, 0.0, 1.0 ] +*/ +function srotg( a, b, Out, strideOut, offsetOut ) { + addon.assign( a, b, Out, strideOut, offsetOut ); + return Out; +} + + +// EXPORTS // + +module.exports = srotg; diff --git a/lib/node_modules/@stdlib/blas/base/srotg/lib/native.js b/lib/node_modules/@stdlib/blas/base/srotg/lib/native.js new file mode 100644 index 000000000000..5d2cb6d3f260 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/lib/native.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var srotg = require( './srotg.native.js' ); +var assign = require( './assign.native.js' ); + + +// MAIN // + +setReadOnly( srotg, 'assign', assign ); + + +// EXPORTS // + +module.exports = srotg; diff --git a/lib/node_modules/@stdlib/blas/base/srotg/lib/srotg.native.js b/lib/node_modules/@stdlib/blas/base/srotg/lib/srotg.native.js new file mode 100644 index 000000000000..3f672687fa39 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/lib/srotg.native.js @@ -0,0 +1,52 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Constructs a Givens plane rotation. +* +* @param {number} a - rotational elimination parameter +* @param {number} b - rotational elimination parameter +* @param {Float32Array} Out - output array +* @param {integer} strideOut - stride length for `Out` +* @returns {Float32Array} output array +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* +* var Out = new Float32Array( 4 ); +* srotg( 0, 2, Out); +* //Out => [ 2.0, 1.0, 0.0, 1.0 ] +*/ +function srotg( a, b, Out, strideOut ) { + addon( a, b, Out, strideOut ); + return Out; +} + + +// EXPORTS // + +module.exports = srotg; diff --git a/lib/node_modules/@stdlib/blas/base/srotg/manifest.json b/lib/node_modules/@stdlib/blas/base/srotg/manifest.json new file mode 100644 index 000000000000..d01a7b982404 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/manifest.json @@ -0,0 +1,99 @@ +{ + "options": { + "task": "build" + }, + "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", + "src": [ + "./src/srotg.c", + "./src/srotg_assign.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", + "@stdlib/napi/argv-strided-float32array", + "@stdlib/math/base/special/absf", + "@stdlib/math/base/special/sqrtf", + "@stdlib/math/base/special/abs2f", + "@stdlib/math/base/special/copysignf" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/srotg.c", + "./src/srotg_assign.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/absf", + "@stdlib/math/base/special/sqrtf", + "@stdlib/math/base/special/abs2f", + "@stdlib/constants/float64/eps", + "@stdlib/math/base/assert/is-nan", + "@stdlib/math/base/special/copysignf" + ] + }, + { + "task": "examples", + "src": [ + "./src/srotg.c", + "./src/srotg_assign.c" + ], + "include": [ + "./include" + ], + "libraries": [ + "-lm" + ], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/absf", + "@stdlib/math/base/special/sqrtf", + "@stdlib/math/base/special/abs2f", + "@stdlib/math/base/special/copysignf" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/srotg/package.json b/lib/node_modules/@stdlib/blas/base/srotg/package.json index b1ede45f37c6..18367c94c1b8 100644 --- a/lib/node_modules/@stdlib/blas/base/srotg/package.json +++ b/lib/node_modules/@stdlib/blas/base/srotg/package.json @@ -14,11 +14,14 @@ } ], "main": "./lib", + "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/base/srotg/src/Makefile b/lib/node_modules/@stdlib/blas/base/srotg/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/base/srotg/src/addon.c b/lib/node_modules/@stdlib/blas/base/srotg/src/addon.c new file mode 100644 index 000000000000..0c2beedacf60 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/src/addon.c @@ -0,0 +1,62 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/srotg.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_float.h" +#include "stdlib/napi/argv_strided_float32array.h" +#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 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut, argv, 3 ); + STDLIB_NAPI_ARGV_FLOAT( env, a, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, b, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, Out, 4, strideOut, argv, 2 ); + API_SUFFIX( c_srotg )( a, b, Out, strideOut ); + return NULL; +} +/** +* 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_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetOut, argv, 4 ); + STDLIB_NAPI_ARGV_FLOAT( env, a, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, b, argv, 1 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, Out, 4, strideOut, argv, 2 ); + API_SUFFIX( c_srotg_assign )( a, b, Out, strideOut, offsetOut ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "assign", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/base/srotg/src/srotg.c b/lib/node_modules/@stdlib/blas/base/srotg/src/srotg.c new file mode 100644 index 000000000000..e7930e9f84d4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/src/srotg.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/srotg.h" +#include "stdlib/blas/base/shared.h" + +/** +* Constructs a Givens plane rotation. +* +* @param a - rotational elimination parameter +* @param b - rotational elimination parameter +*/ +void API_SUFFIX( c_srotg )( float a, float b, float* Out, const CBLAS_INT strideOut ) { + API_SUFFIX( c_srotg_assign )( a, b, Out, strideOut, 0 ); + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/srotg/src/srotg_assign.c b/lib/node_modules/@stdlib/blas/base/srotg/src/srotg_assign.c new file mode 100644 index 000000000000..c60b132af919 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/src/srotg_assign.c @@ -0,0 +1,77 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/math/base/special/absf.h" +#include "stdlib/math/base/special/sqrtf.h" +#include "stdlib/math/base/special/abs2f.h" +#include "stdlib/math/base/special/copysignf.h" +#include "stdlib/blas/base/shared.h" + + +/** +* Constructs a Givens plane rotation using alternative indexing semantics. +* +* @param a - rotational elimination parameter +* @param b - rotational elimination parameter +* @param Out - output array +* @param strideOut - stride length for `Out` +* @param offsetOut - starting index for `Out` +*/ +void API_SUFFIX( c_srotg_assign )( float a, float b, float* Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut ) { + float scale; + float sign; + float aa; + float ab; + float r; + float c; + float s; + float z; + + aa = stdlib_base_absf( a ); + ab = stdlib_base_absf( b ); + if ( aa > ab ) { + sign = stdlib_base_copysignf( 1.0, a ); + } else { + sign = stdlib_base_copysignf( 1.0, b ); + } + scale = aa + ab; + if ( scale == 0.0 ) { + c = 1.0; + s = 0.0; + r = 0.0; + z = 0.0; + } else { + r = scale * stdlib_base_sqrtf( stdlib_base_abs2f( a/scale ) + stdlib_base_abs2f( b/scale ) ); + r = r * sign; + c = a / r; + s = b / r; + z = 1.0; + if ( aa > ab ) { + z = s; + } else if ( c != 0.0 ) { + z = 1.0 / c; + } + } + a = r; + b = z; + Out[ offsetOut ] = a; + Out[ offsetOut + strideOut ] = b; + Out[ offsetOut + ( 2 * strideOut ) ] = c; + Out[ offsetOut + ( 3 * strideOut ) ] = s; + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/srotg/test/test.assign.native.js b/lib/node_modules/@stdlib/blas/base/srotg/test/test.assign.native.js new file mode 100644 index 000000000000..361d214854b2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/test/test.assign.native.js @@ -0,0 +1,163 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tryRequire = require( '@stdlib/utils/try-require' ); +var Float32Array = require( '@stdlib/array/float32' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); + + +// VARIABLES // + +var srotg = tryRequire( resolve( __dirname, './../lib/native.js' ) ).assign; +var opts = { + 'skip': ( srotg instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof srotg, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( srotg.length, 5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function computes a Givens plane rotation', opts, function test( t ) { + var expected; + var values; + var out; + var i; + + expected = [ + [ 0.5, 1.6666666, 0.6, 0.8 ], + [ 0.5, 0.6, 0.8, 0.6 ], + [ 0.5, -1.6666666, -0.6, 0.8 ], + [ -0.5, -0.6, 0.8, -0.6 ], + [ -0.5, 1.6666666, 0.6, 0.8 ], + [ 0.0, 0.0, 1.0, 0.0 ], + [ 1.0, 1.0, 0.0, 1.0 ], + [ 1.0, 0.0, 1.0, 0.0 ] + ]; + values = [ + [ 0.3, 0.4 ], + [ 0.4, 0.3 ], + [ -0.3, 0.4 ], + [ -0.4, 0.3 ], + [ -0.3, -0.4 ], + [ 0.0, 0.0 ], + [ 0.0, 1.0 ], + [ 1.0, 0.0 ] + ]; + + for ( i = 0; i < values.length; i++ ) { + expected[i] = new Float32Array( expected[i] ); + out = new Float32Array( 4 ); + srotg( float64ToFloat32( values[i][0] ), float64ToFloat32( values[i][1] ), out, 1, 0 ); // eslint-disable-line max-len + t.deepEqual( out, expected[i], 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns an array of NaNs if provided a rotation elimination parameter equal to NaN', opts, function test( t ) { + var actual; + var i; + + actual = srotg( NaN, 1.0, new Float32Array( 4 ), 1, 0 ); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + + actual = srotg( 1.0, NaN, new Float32Array( 4 ), 1, 0 ); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + + actual = srotg( NaN, NaN, new Float32Array( 4 ), 1, 0 ); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function supports providing a positive stride', opts, function test( t ) { + var expected; + var actual; + var out; + + expected = new Float32Array( [ 0.5, 0.0, 1.6666666, 0.0, 0.6, 0.0, 0.8 ] ); + out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + actual = srotg( 0.3, 0.4, out, 2, 0 ); + t.strictEqual( actual, out, 'returns expected value' ); + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports providing a negative stride', opts, function test( t ) { + var expected; + var actual; + var out; + + expected = new Float32Array( [ 0.8, 0.0, 0.6, 0.0, 1.6666666, 0.0, 0.5 ] ); + out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + actual = srotg( 0.3, 0.4, out, -2, 6 ); + t.strictEqual( actual, out, 'returns expected value' ); + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports providing an offset', opts, function test( t ) { + var expected; + var actual; + var out; + + expected = new Float32Array( [ 0.0, 0.5, 1.6666666, 0.6, 0.8 ] ); + out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + actual = srotg( 0.3, 0.4, out, 1, 1 ); + t.strictEqual( actual, out, 'returns expected value' ); + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports providing both a stride and offset', opts, function test( t ) { + var expected; + var actual; + var out; + + expected = new Float32Array( [ 0.0, 0.0, 0.5, 0.0, 1.6666666, 0.0, 0.6, 0.0, 0.8 ] ); // eslint-disable-line max-len + out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + actual = srotg( 0.3, 0.4, out, 2, 2 ); + t.strictEqual( actual, out, 'returns expected value' ); + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/srotg/test/test.native.js b/lib/node_modules/@stdlib/blas/base/srotg/test/test.native.js new file mode 100644 index 000000000000..cc440f0f0838 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/srotg/test/test.native.js @@ -0,0 +1,121 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 tryRequire = require( '@stdlib/utils/try-require' ); +var Float32Array = require( '@stdlib/array/float32' ); +var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); + + +// VARIABLES // + +var srotg = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( srotg instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof srotg, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', opts, function test( t ) { + t.strictEqual( srotg.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'the function computes a Givens plane rotation', opts, function test( t ) { + var expected; + var values; + var out; + var i; + + expected = [ + [ 0.5, 1.6666666, 0.6, 0.8 ], + [ 0.5, 0.6, 0.8, 0.6 ], + [ 0.5, -1.6666666, -0.6, 0.8 ], + [ -0.5, -0.6, 0.8, -0.6 ], + [ -0.5, 1.6666666, 0.6, 0.8 ], + [ 0.0, 0.0, 1.0, 0.0 ], + [ 1.0, 1.0, 0.0, 1.0 ], + [ 1.0, 0.0, 1.0, 0.0 ] + ]; + values = [ + [ 0.3, 0.4 ], + [ 0.4, 0.3 ], + [ -0.3, 0.4 ], + [ -0.4, 0.3 ], + [ -0.3, -0.4 ], + [ 0.0, 0.0 ], + [ 0.0, 1.0 ], + [ 1.0, 0.0 ] + ]; + + for ( i = 0; i < values.length; i++ ) { + expected[i] = new Float32Array( expected[i] ); + out = new Float32Array( 4 ); + srotg( float64ToFloat32( values[i][0] ), float64ToFloat32( values[i][1] ), out, 1); // eslint-disable-line max-len + t.deepEqual( out, expected[i], 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns an array of NaNs if provided a rotation elimination parameter equal to NaN', opts, function test( t ) { + var actual; + var i; + + actual = srotg( NaN, 1.0, new Float32Array( 4 ), 1); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + + actual = srotg( 1.0, NaN, new Float32Array( 4 ), 1 ); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + + actual = srotg( NaN, NaN, new Float32Array( 4 ), 1 ); + for ( i = 0; i < actual.length; i++ ) { + t.strictEqual( isnanf( actual[i] ), true, 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function supports providing a positive stride', opts, function test( t ) { + var expected; + var actual; + var out; + + expected = new Float32Array( [ 0.5, 0.0, 1.6666666, 0.0, 0.6, 0.0, 0.8 ] ); + out = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] ); + + actual = srotg( 0.3, 0.4, out, 2 ); + t.strictEqual( actual, out, 'returns expected value' ); + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +});