From 3b4514d1272ea9e4863381e3d0febd02ba8d230f Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Sun, 15 Dec 2024 09:10:50 +0530 Subject: [PATCH] feat: add `math/base/special/negalucasf` PR-URL: #3375 Ref: #649 --------- Signed-off-by: Philipp Burckhardt Co-authored-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Co-authored-by: Philipp Burckhardt --- .../math/base/special/negalucasf/README.md | 273 ++++++++++++++++ .../special/negalucasf/benchmark/benchmark.js | 298 ++++++++++++++++++ .../negalucasf/benchmark/benchmark.native.js | 61 ++++ .../special/negalucasf/benchmark/c/Makefile | 127 ++++++++ .../negalucasf/benchmark/c/benchmark.c | 151 +++++++++ .../negalucasf/benchmark/c/native/Makefile | 146 +++++++++ .../negalucasf/benchmark/c/native/benchmark.c | 136 ++++++++ .../negalucasf/benchmark/julia/REQUIRE | 2 + .../negalucasf/benchmark/julia/benchmark.jl | 156 +++++++++ .../math/base/special/negalucasf/binding.gyp | 170 ++++++++++ .../docs/img/equation_negalucas_lucas.svg | 31 ++ ...equation_negalucas_recurrence_relation.svg | 33 ++ .../docs/img/equation_negalucas_sequence.svg | 78 +++++ .../base/special/negalucasf/docs/repl.txt | 51 +++ .../special/negalucasf/docs/types/index.d.ts | 74 +++++ .../special/negalucasf/docs/types/test.ts | 44 +++ .../special/negalucasf/examples/c/Makefile | 146 +++++++++ .../special/negalucasf/examples/c/example.c | 31 ++ .../base/special/negalucasf/examples/index.js | 29 ++ .../math/base/special/negalucasf/include.gypi | 53 ++++ .../stdlib/math/base/special/negalucasf.h | 40 +++ .../math/base/special/negalucasf/lib/index.js | 58 ++++ .../math/base/special/negalucasf/lib/main.js | 97 ++++++ .../base/special/negalucasf/lib/native.js | 70 ++++ .../special/negalucasf/lib/negalucas.json | 1 + .../base/special/negalucasf/manifest.json | 72 +++++ .../math/base/special/negalucasf/package.json | 70 ++++ .../math/base/special/negalucasf/src/Makefile | 70 ++++ .../math/base/special/negalucasf/src/addon.c | 23 ++ .../math/base/special/negalucasf/src/main.c | 81 +++++ .../math/base/special/negalucasf/test/test.js | 106 +++++++ .../special/negalucasf/test/test.native.js | 94 ++++++ 32 files changed, 2872 insertions(+) create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/README.md create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/REQUIRE create mode 100755 lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/benchmark.jl create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/binding.gyp create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_lucas.svg create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_recurrence_relation.svg create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_sequence.svg create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/examples/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/include.gypi create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/include/stdlib/math/base/special/negalucasf.h create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/lib/index.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/lib/native.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/lib/negalucas.json create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/package.json create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/src/Makefile create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/src/addon.c create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.js create mode 100644 lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.native.js diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/README.md b/lib/node_modules/@stdlib/math/base/special/negalucasf/README.md new file mode 100644 index 000000000000..0997c6e8ffbe --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/README.md @@ -0,0 +1,273 @@ + + +# negaLucas + +> Compute the nth [negaLucas number][lucas-number] in single-precision floating-point format. + +
+ +The [negaLucas numbers][lucas-number] are the integer sequence + + + +```math +2, -1, 3, -4, 7, -11, 18, -29, 47, -76, 123, -199, 322, \ldots +``` + + + + + +The sequence is defined by the recurrence relation + + + +```math +L_{n-2} = L_{n} - L_{n-1} +``` + + + + + +which yields + + + +```math +L_{-n} = (-1)^{n} L_n +``` + + + + + +with seed values `L_0 = 2` and `L_{-1} = -1`. + +
+ + + +
+ +## Usage + +```javascript +var negalucasf = require( '@stdlib/math/base/special/negalucasf' ); +``` + +#### negalucasf( n ) + +Computes the nth [negaLucas number][lucas-number] in single-precision floating-point format. + +```javascript +var v = negalucasf( 0 ); +// returns 2 + +v = negalucasf( -1 ); +// returns -1 + +v = negalucasf( -2 ); +// returns 3 + +v = negalucasf( -3 ); +// returns -4 + +v = negalucasf( -34 ); +// returns 12752043 +``` + +If `n < -34`, the function returns `NaN`, as larger [negaLucas numbers][lucas-number] cannot be safely represented in [single-precision floating-point format][ieee754]. + +```javascript +var v = negalucasf( -35 ); +// returns NaN +``` + +If not provided a nonpositive integer value, the function returns `NaN`. + +```javascript +var v = negalucasf( -3.14 ); +// returns NaN + +v = negalucasf( 1 ); +// returns NaN +``` + +If provided `NaN`, the function returns `NaN`. + +```javascript +var v = negalucasf( NaN ); +// returns NaN +``` + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var negalucasf = require( '@stdlib/math/base/special/negalucasf' ); + +var v; +var i; + +for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + console.log( v ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/special/negalucasf.h" +``` + +#### stdlib_base_negalucasf( n ) + +Computes the nth [negaLucas number][lucas-number] in single-precision floating-point format. + +```c +float out = stdlib_base_negalucasf( 0 ); +// returns 0.0f + +out = stdlib_base_negalucasf( -1 ); +// returns -1.0f +``` + +The function accepts the following arguments: + +- **n**: `[in] int32_t` input value. + +```c +float stdlib_base_negalucasf( const int32_t n ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/special/negalucasf.h" +#include +#include + +int main( void ) { + int32_t i; + float v; + + for ( i = 0; i > -35; i-- ) { + v = stdlib_base_negalucasf( i ); + printf( "negalucasf(%d) = %f\n", i, v ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[lucas-number]: https://en.wikipedia.org/wiki/Lucas_number + +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.js new file mode 100644 index 000000000000..fddeb4b180fc --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.js @@ -0,0 +1,298 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 bench = require( '@stdlib/bench' ); +var randu = require( '@stdlib/random/array/discrete-uniform' ); +var roundf = require( '@stdlib/math/base/special/roundf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var PHI = require( '@stdlib/constants/float32/phi' ); +var pkg = require( './../package.json' ).name; +var NEGALUCAS = require( './../lib/negalucas.json' ); +var negalucasf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::analytic', function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -34, 0 ); + + function negalucasf( n ) { + var an = absf( n ); + return pow( -1.0, an ) * roundf( pow( PHI, an ) ); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::table', function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = NEGALUCAS[ absf( x[ i % x.length ] ) ]; + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::naive_recursion', function benchmark( b ) { + var x; + var y; + var i; + + function negalucasf( n ) { + if ( n === 0 ) { + return 2; + } + if ( n === -1 ) { + return -1; + } + return negalucasf( n+2 ) - negalucasf( n+1 ); + } + + x = randu( 100, -20, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::recursion_memoized', function benchmark( b ) { + var arr; + var N; + var x; + var y; + var i; + + arr = new Array( 35 ); + arr[ 0 ] = 2; + arr[ 1 ] = -1; + N = 1; + + function negalucasf( n ) { + var an = absf( n ); + if ( an <= N ) { + return arr[ an ]; + } + arr[ an ] = negalucasf( n+2 ) - negalucasf( n+1 ); + return arr[ an ]; + } + + x = randu( 100, -20, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::naive_iterative', function benchmark( b ) { + var x; + var y; + var i; + + function negalucasf( n ) { + var arr; + var an; + var i; + + an = absf( n ); + + arr = new Array( an+1 ); + arr[ 0 ] = 2; + arr[ 1 ] = -1; + for ( i = 2; i <= an; i++ ) { + arr[ i ] = arr[ i-2 ] - arr[ i-1 ]; + } + return arr[ an ]; + } + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::iterative', function benchmark( b ) { + var x; + var y; + var i; + + function negalucasf( n ) { + var an; + var a; + var b; + var c; + var i; + + an = absf( n ); + + a = 2; + b = -1; + for ( i = 2; i <= an; i++ ) { + c = a - b; + a = b; + b = c; + } + return b; + } + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::iterative_memoized', function benchmark( b ) { + var arr; + var N; + var x; + var y; + var i; + + arr = new Array( 35 ); + arr[ 0 ] = 2; + arr[ 1 ] = -1; + N = 2; + + function negalucasf( n ) { + var an; + var i; + + an = absf( n ); + if ( an > N ) { + for ( i = N; i <= an; i++ ) { + arr[ i ] = arr[ i-2 ] - arr[ i-1 ]; + } + N = an; + } + return arr[ an ]; + } + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.native.js new file mode 100644 index 000000000000..4dd3c3b28093 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/benchmark.native.js @@ -0,0 +1,61 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 randu = require( '@stdlib/random/array/discrete-uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var negalucasf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( negalucasf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -34, 0 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = negalucasf( x[ i % x.length ] ); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/Makefile b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/Makefile new file mode 100644 index 000000000000..e85bfcccdd04 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/Makefile @@ -0,0 +1,127 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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 C targets: +c_targets := benchmark.out + + +# RULES # + +#/ +# Compiles C source files. +# +# @param {string} [C_COMPILER] - C compiler +# @param {string} [CFLAGS] - C compiler flags +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler +# @param {string} CFLAGS - C compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) -o $@ $< -lm + +#/ +# 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/math/base/special/negalucasf/benchmark/c/benchmark.c b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/benchmark.c new file mode 100644 index 000000000000..df23e52ac174 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/benchmark.c @@ -0,0 +1,151 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 +#include +#include +#include +#include + +#define NAME "negalucas::naive_recursion" +#define ITERATIONS 100 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param elapsed elapsed time in seconds +*/ +static void print_results( 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.0f ); +} + +/** +* Computes the nth negaLucas number. +* +* @param n negaLucas number to compute +* @return negaLucas number +*/ +int negalucasf( int n ) { + if ( n == 0 ) { + return 2; + } + if ( n == -1 ) { + return -1; + } + return negalucasf( n+2 ) - negalucasf( n+1 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + double t; + int x[ 100 ]; + int y; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = (int)floorf( 20.0f * rand_float() ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = negalucasf( -x[ i % 100 ] ); + if ( y == -7 ) { + printf( "should not return -7\n" ); + break; + } + } + elapsed = tic() - t; + if ( y == -7 ) { + printf( "should not return -7\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/Makefile new file mode 100644 index 000000000000..f69e9da2b4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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.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/math/base/special/negalucasf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..1dc21363cc82 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/c/native/benchmark.c @@ -0,0 +1,136 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/negalucasf.h" +#include +#include +#include +#include +#include + +#define NAME "negalucasf" +#define ITERATIONS 100 +#define REPEATS 3 + +/** +* Prints the TAP version. +*/ +void print_version() { + 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 elapsed elapsed time in seconds +*/ +static void print_results( 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.0f ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + double elapsed; + int32_t x[ 100 ]; + double t; + float y; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = (int32_t)( 34.0f * rand_float() ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_negalucasf( x[ i % 100 ] ); + if ( y != y ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( y != y ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int i; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + for ( i = 0; i < REPEATS; i++ ) { + printf( "# c::native::%s\n", NAME ); + elapsed = benchmark(); + print_results( elapsed ); + printf( "ok %d benchmark finished\n", i+1 ); + } + print_summary( REPEATS, REPEATS ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/REQUIRE b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/REQUIRE new file mode 100644 index 000000000000..98645e192e41 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/REQUIRE @@ -0,0 +1,2 @@ +julia 1.5 +BenchmarkTools 0.5.0 diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/benchmark.jl b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/benchmark.jl new file mode 100755 index 000000000000..1f6a31e62aaf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/benchmark/julia/benchmark.jl @@ -0,0 +1,156 @@ +#!/usr/bin/env julia +# +# @license Apache-2.0 +# +# Copyright (c) 2024 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. + +import BenchmarkTools +using Printf + +# Benchmark variables: +name = "negalucasf::naive_recursion"; +repeats = 3; + +""" + print_version() + +Prints the TAP version. + +# Examples + +``` julia +julia> print_version() +``` +""" +function print_version() + @printf( "TAP version 13\n" ); +end + +""" + print_summary( total, passing ) + +Print the benchmark summary. + +# Arguments + +* `total`: total number of tests +* `passing`: number of passing tests + +# Examples + +``` julia +julia> print_summary( 3, 3 ) +``` +""" +function print_summary( total, 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" ); +end + +""" + print_results( iterations, elapsed ) + +Print benchmark results. + +# Arguments + +* `iterations`: number of iterations +* `elapsed`: elapsed time (in seconds) + +# Examples + +``` julia +julia> print_results( 1000000, 0.131009101868 ) +``` +""" +function print_results( iterations, elapsed ) + rate = iterations / elapsed + + @printf( " ---\n" ); + @printf( " iterations: %d\n", iterations ); + @printf( " elapsed: %0.9f\n", elapsed ); + @printf( " rate: %0.9f\n", rate ); + @printf( " ...\n" ); +end + +""" + benchmark() + +Run a benchmark. + +# Notes + +* Benchmark results are returned as a two-element array: [ iterations, elapsed ]. +* The number of iterations is not the true number of iterations. Instead, an 'iteration' is defined as a 'sample', which is a computed estimate for a single evaluation. +* The elapsed time is in seconds. + +# Examples + +``` julia +julia> out = benchmark(); +``` +""" +function benchmark() + # Define a NegaLucas recurrence relation: + function nlucas( n ) + if n == 0 + return 2; + end + if n == -1 + return -1; + end + return nlucas( n+2 ) - nlucas( n+1 ); + end + + # Benchmark: + t = BenchmarkTools.@benchmark $nlucas( -floor( 20.0*rand() ) ) samples=1e6 + + # Compute the total "elapsed" time and convert from nanoseconds to seconds: + s = sum( t.times ) / 1.0e9; + + # Determine the number of "iterations": + iter = length( t.times ); + + # Return the results: + [ iter, s ]; +end + +""" + main() + +Run benchmarks. + +# Examples + +``` julia +julia> main(); +``` +""" +function main() + print_version(); + for i in 1:repeats + @printf( "# julia::%s\n", name ); + results = benchmark(); + print_results( results[ 1 ], results[ 2 ] ); + @printf( "ok %d benchmark finished\n", i ); + end + print_summary( repeats, repeats ); +end + +main(); diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/binding.gyp b/lib/node_modules/@stdlib/math/base/special/negalucasf/binding.gyp new file mode 100644 index 000000000000..ec3992233442 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/binding.gyp @@ -0,0 +1,170 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/math/base/special/negalucasf/docs/img/equation_negalucas_lucas.svg b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_lucas.svg new file mode 100644 index 000000000000..dedd0be11581 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_lucas.svg @@ -0,0 +1,31 @@ + +upper L Subscript negative n Baseline equals left-parenthesis negative 1 right-parenthesis Superscript n Baseline upper L Subscript n + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_recurrence_relation.svg b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_recurrence_relation.svg new file mode 100644 index 000000000000..a3196618027e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_recurrence_relation.svg @@ -0,0 +1,33 @@ + +upper L Subscript n minus 2 Baseline equals upper L Subscript n Baseline minus upper L Subscript n minus 1 + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_sequence.svg b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_sequence.svg new file mode 100644 index 000000000000..4c67ad281502 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/img/equation_negalucas_sequence.svg @@ -0,0 +1,78 @@ + +2 comma negative 1 comma 3 comma negative 4 comma 7 comma negative 11 comma 18 comma negative 29 comma 47 comma negative 76 comma 123 comma negative 199 comma 322 comma ellipsis + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/repl.txt new file mode 100644 index 000000000000..cee205699efd --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/repl.txt @@ -0,0 +1,51 @@ + +{{alias}}( n ) + Computes the nth negaLucas number in + single-precision floating-point format. + + The negaLucas numbers follow the recurrence relation + + L_{n-2} = L_{n} - L_{n-1} + + with seed values L_0 = 2 and L_{-1} = -1. + + If `|n|` is greater than `34`, the function returns `NaN` as larger + negaLucas numbers cannot be accurately represented due to limitations of + single-precision floating-point format. + + If not provided a non-positive integer value, the function returns `NaN`. + + If provided `NaN`, the function returns `NaN`. + + Parameters + ---------- + n: integer + Input value. + + Returns + ------- + y: integer + NegaLucas number. + + Examples + -------- + > var y = {{alias}}( 0 ) + 2 + > y = {{alias}}( -1 ) + -1 + > y = {{alias}}( -2 ) + 3 + > y = {{alias}}( -3 ) + -4 + > y = {{alias}}( -4 ) + 7 + > y = {{alias}}( -35 ) + NaN + > y = {{alias}}( -36 ) + NaN + > y = {{alias}}( NaN ) + NaN + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts new file mode 100644 index 000000000000..b6328720137f --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/index.d.ts @@ -0,0 +1,74 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +// TypeScript Version: 4.1 + +/** +* Computes the nth negaLucas number in single-precision floating-point format. +* +* ## Notes +* +* - The negaLucas numbers follow the recurrence relation `L_{n-2} = L_{n} - L_{n-1}` with seed values `L_0 = 2` and `L_{-1} = -1`. +* - If `|n|` is greater than `34`, the function returns `NaN` as larger negaLucas numbers cannot be accurately represented due to limitations of single-precision floating-point format. +* - If not provided a non-positive integer value, the function returns `NaN`. +* +* @param n - the negaLucas number to compute +* @returns negaLucas number +* +* @example +* var y = negalucasf( 0 ); +* // returns 2 +* +* @example +* var y = negalucasf( -1 ); +* // returns -1 +* +* @example +* var y = negalucasf( -2 ); +* // returns 3 +* +* @example +* var y = negalucasf( -3 ); +* // returns -4 +* +* @example +* var y = negalucasf( -4 ); +* // returns 7 +* +* @example +* var y = negalucasf( -5 ); +* // returns -11 +* +* @example +* var y = negalucasf( -6 ); +* // returns 18 +* +* @example +* var y = negalucasf( NaN ); +* // returns NaN +* +* @example +* var y = negalucasf( -3.14 ); +* // returns NaN +*/ +declare function negalucasf( n: number ): number; + + +// EXPORTS // + +export = negalucasf; diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/test.ts b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/test.ts new file mode 100644 index 000000000000..2f220d1fe11b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/docs/types/test.ts @@ -0,0 +1,44 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +import negalucasf = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + negalucasf( -8 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + negalucasf( true ); // $ExpectError + negalucasf( false ); // $ExpectError + negalucasf( null ); // $ExpectError + negalucasf( undefined ); // $ExpectError + negalucasf( '5' ); // $ExpectError + negalucasf( [] ); // $ExpectError + negalucasf( {} ); // $ExpectError + negalucasf( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + negalucasf(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/Makefile b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/Makefile new file mode 100644 index 000000000000..6aed70daf167 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/math/base/special/negalucasf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/example.c new file mode 100644 index 000000000000..73be3c7ce026 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/c/example.c @@ -0,0 +1,31 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/negalucasf.h" +#include +#include + +int main( void ) { + int32_t i; + float v; + + for ( i = 0; i > -35; i-- ) { + v = stdlib_base_negalucasf( i ); + printf( "negalucasf(%d) = %f\n", i, v ); + } +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/index.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/index.js new file mode 100644 index 000000000000..b02c23087f5e --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/examples/index.js @@ -0,0 +1,29 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +var negalucasf = require( './../lib' ); + +var v; +var i; + +for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + console.log( v ); +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/include.gypi b/lib/node_modules/@stdlib/math/base/special/negalucasf/include.gypi new file mode 100644 index 000000000000..575cb043c0bf --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/include.gypi @@ -0,0 +1,53 @@ +# @license Apache-2.0 +# +# Copyright (c) 2024 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': [ + ' + +/* +* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. +*/ +#ifdef __cplusplus +extern "C" { +#endif + +/** +* Computes the nth negaLucas number in single-precision floating-point format. +*/ +float stdlib_base_negalucasf( const int32_t n ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_SPECIAL_NEGALUCASF_H diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/index.js new file mode 100644 index 000000000000..95374eebc178 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/index.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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'; + +/** +* Compute the nth negaLucas number in single-precision floating-point format. +* +* @module @stdlib/math/base/special/negalucasf +* +* @example +* var negalucasf = require( '@stdlib/math/base/special/negalucasf' ); +* +* var y = negalucasf( 0 ); +* // returns 2 +* +* y = negalucasf( -1 ); +* // returns -1 +* +* y = negalucasf( -2 ); +* // returns 3 +* +* y = negalucasf( -3 ); +* // returns -4 +* +* y = negalucasf( -4 ); +* // returns 7 +* +* y = negalucasf( -5 ); +* // returns -11 +* +* y = negalucasf( -6 ); +* // returns 18 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js new file mode 100644 index 000000000000..a1133f4ca17d --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js @@ -0,0 +1,97 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isIntegerf = require( '@stdlib/math/base/assert/is-integerf' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var NEGALUCAS = require( './negalucas.json' ); + + +// VARIABLES // + +var MAX_LUCAS = 34; + + +// MAIN // + +/** +* Computes the nth negalucas number in single-precision floating-point format. +* +* @param {NonPositiveInteger} n - the negalucas number to compute +* @returns {integer} negalucas number +* +* @example +* var y = negalucasf( 0 ); +* // returns 2 +* +* @example +* var y = negalucasf( -1 ); +* // returns -1 +* +* @example +* var y = negalucasf( -2 ); +* // returns 3 +* +* @example +* var y = negalucasf( -3 ); +* // returns -4 +* +* @example +* var y = negalucasf( -4 ); +* // returns 7 +* +* @example +* var y = negalucasf( -5 ); +* // returns -11 +* +* @example +* var y = negalucasf( -6 ); +* // returns 18 +* +* @example +* var y = negalucasf( NaN ); +* // returns NaN +* +* @example +* var y = negalucasf( -3.14 ); +* // returns NaN +*/ +function negalucasf( n ) { + var an; + if ( + isnanf( n ) || + isIntegerf( n ) === false || + n > 0 + ) { + return NaN; + } + an = absf( n ); + if ( an > MAX_LUCAS ) { + return NaN; + } + return NEGALUCAS[ an ]; +} + + +// EXPORTS // + +module.exports = negalucasf; diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/native.js new file mode 100644 index 000000000000..143c80c741b7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/native.js @@ -0,0 +1,70 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 // + +/** +* Compute the nth negalucas number in single-precision floating-point format. +* +* @private +* @param {NonPositiveInteger} n - the negalucas number to compute +* @returns {integer} negalucas number +* +* @example +* var y = negalucasf( 0 ); +* // returns 2 +* +* @example +* y = negalucasf( -1 ); +* // returns -1 +* +* @example +* y = negalucasf( -2 ); +* // returns 3 +* +* @example +* y = negalucasf( -3 ); +* // returns -4 +* +* @example +* y = negalucasf( -4 ); +* // returns 7 +* +* @example +* y = negalucasf( -5 ); +* // returns -11 +* +* @example +* y = negalucasf( -6 ); +* // returns 18 +*/ +function negalucasf( n ) { + return addon( n ); +} + + +// EXPORTS // + +module.exports = negalucasf; diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/negalucas.json b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/negalucas.json new file mode 100644 index 000000000000..425123e76132 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/lib/negalucas.json @@ -0,0 +1 @@ +[2,-1,3,-4,7,-11,18,-29,47,-76,123,-199,322,-521,843,-1364,2207,-3571,5778,-9349,15127,-24476,39603,-64079,103682,-167761,271443,-439204,710647,-1149851,1860498,-3010349,4870847,-7881196,12752043] diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json b/lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json new file mode 100644 index 000000000000..f7f6db691413 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json @@ -0,0 +1,72 @@ +{ + "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/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/napi/unary", + "@stdlib/math/base/special/labs" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/labs" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/labs" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/package.json b/lib/node_modules/@stdlib/math/base/special/negalucasf/package.json new file mode 100644 index 000000000000..7aadfe12f17b --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/math/base/special/negalucasf", + "version": "0.0.0", + "description": "Compute the nth negaLucas number in single-precision floating-point format.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "special functions", + "special", + "function", + "lucas", + "negalucas", + "fibonacci", + "fib", + "fibo", + "nlucas", + "number" + ] +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/src/Makefile b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/Makefile new file mode 100644 index 000000000000..bcf18aa46655 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2024 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/math/base/special/negalucasf/src/addon.c b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/addon.c new file mode 100644 index 000000000000..118acdff5088 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/addon.c @@ -0,0 +1,23 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/negalucasf.h" +#include "stdlib/math/base/napi/unary.h" + +// cppcheck-suppress shadowFunction +STDLIB_MATH_BASE_NAPI_MODULE_I_F( stdlib_base_negalucasf ) diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c new file mode 100644 index 000000000000..b9973ac26433 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c @@ -0,0 +1,81 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/negalucasf.h" +#include "stdlib/math/base/special/labs.h" +#define STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS 34 + +static const int32_t negalucasf_value[ 35 ] = { + 2, + -1, + 3, + -4, + 7, + -11, + 18, + -29, + 47, + -76, + 123, + -199, + 322, + -521, + 843, + -1364, + 2207, + -3571, + 5778, + -9349, + 15127, + -24476, + 39603, + -64079, + 103682, + -167761, + 271443, + -439204, + 710647, + -1149851, + 1860498, + -3010349, + 4870847, + -7881196, + 12752043 +}; + +/** +* Computes the nth negaLucas number. +* +* @param n input value +* @return output value +* +* @example +* float out = stdlib_base_negalucasf( -1 ); +* // returns -1 +* +* @example +* float out = stdlib_base_negalucasf( 1 ); +* // returns NaN +*/ +float stdlib_base_negalucasf( const int32_t n ) { + int32_t an = stdlib_base_labs( n ); + if ( n > 0 || an > STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS ) { + return 0.0f / 0.0f; // NaN + } + return negalucasf_value[ an ]; +} diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.js new file mode 100644 index 000000000000..7cdd29f460e9 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var NINF = require( '@stdlib/constants/float64/ninf' ); +var lucas = require( '@stdlib/math/base/special/lucas' ); +var negalucasf = require( './../lib' ); + + +// FIXTURES // + +var NEGALUCAS = require( './../lib/negalucas.json' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof negalucasf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided a positive number, the function returns `NaN`', function test( t ) { + var v; + var i; + + t.strictEqual( isnanf( negalucasf( 3.14 ) ), true, 'returns NaN' ); + + for ( i = 1; i < 100; i++ ) { + v = negalucasf( i ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided ' + i ); + } + t.end(); +}); + +tape( 'if provided negative infinity, the function returns `NaN`', function test( t ) { + var v = negalucasf( NINF ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided -infinity' ); + t.end(); +}); + +tape( 'if provided `NaN`, the function returns `NaN`', function test( t ) { + var v = negalucasf( NaN ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided a NaN' ); + t.end(); +}); + +tape( 'if provided a non-integer, the function returns `NaN`', function test( t ) { + var v = negalucasf( -3.14 ); + t.strictEqual( isnanf( v ), true, 'returns NaN' ); + t.end(); +}); + +tape( 'the function returns the nth negaLucas number', function test( t ) { + var v; + var i; + for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + t.strictEqual( v, NEGALUCAS[ absf(i) ], 'returns the '+i+'th negaLucas number' ); + } + t.end(); +}); + +tape( 'the function returns the nth negaLucas number (Lucas relationship)', function test( t ) { + var v; + var f; + var i; + for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + f = pow( -1.0, absf(i) ) * lucas( absf(i) ); + t.strictEqual( v, f, 'returns the '+i+'th negaLucas number' ); + } + t.end(); +}); + +tape( 'if provided nonpositive integers less than `-34`, the function returns `NaN`', function test( t ) { + var i; + var v; + for ( i = -35; i > -500; i-- ) { + v = negalucasf( i ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided ' + i ); + } + t.end(); +}); diff --git a/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.native.js b/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.native.js new file mode 100644 index 000000000000..711f1db75ea7 --- /dev/null +++ b/lib/node_modules/@stdlib/math/base/special/negalucasf/test/test.native.js @@ -0,0 +1,94 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var absf = require( '@stdlib/math/base/special/absf' ); +var lucas = require( '@stdlib/math/base/special/lucas' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// FIXTURES // + +var NEGALUCAS = require( './../lib/negalucas.json' ); + + +// VARIABLES // + +var negalucasf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( negalucasf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof negalucasf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'if provided a positive number, the function returns `NaN`', opts, function test( t ) { + var v; + var i; + + for ( i = 1; i < 100; i++ ) { + v = negalucasf( i ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided ' + i ); + } + t.end(); +}); + +tape( 'the function returns the nth negaLucas number', opts, function test( t ) { + var v; + var i; + for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + t.strictEqual( v, NEGALUCAS[ absf( i ) ], 'returns the '+i+'th negaLucas number' ); + } + t.end(); +}); + +tape( 'the function returns the nth negaLucas number (Lucas relationship)', opts, function test( t ) { + var v; + var f; + var i; + for ( i = 0; i > -35; i-- ) { + v = negalucasf( i ); + f = pow( -1.0, absf(i) ) * lucas( absf(i) ); + t.strictEqual( v, f, 'returns the '+i+'th negaLucas number' ); + } + t.end(); +}); + +tape( 'if provided nonpositive integers less than `-34`, the function returns `NaN`', opts, function test( t ) { + var i; + var v; + for ( i = -35; i > -500; i-- ) { + v = negalucasf( i ); + t.strictEqual( isnanf( v ), true, 'returns NaN when provided ' + i ); + } + t.end(); +});