From 8877111088c7bd87268d1a57c13aea530a61b242 Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Sun, 10 Aug 2025 12:14:14 +0530 Subject: [PATCH 1/7] feat: add number/uint32/base/identity --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../number/uint32/base/identity/README.md | 214 ++++++++++++++++++ .../base/identity/benchmark/benchmark.js | 54 +++++ .../identity/benchmark/benchmark.native.js | 63 ++++++ .../base/identity/benchmark/c/native/Makefile | 146 ++++++++++++ .../identity/benchmark/c/native/benchmark.c | 137 +++++++++++ .../number/uint32/base/identity/binding.gyp | 170 ++++++++++++++ .../docs/img/equation_identity_function.svg | 18 ++ .../number/uint32/base/identity/docs/repl.txt | 28 +++ .../base/identity/docs/types/index.d.ts | 48 ++++ .../uint32/base/identity/docs/types/test.ts | 44 ++++ .../uint32/base/identity/examples/c/Makefile | 146 ++++++++++++ .../uint32/base/identity/examples/c/example.c | 32 +++ .../uint32/base/identity/examples/index.js | 35 +++ .../number/uint32/base/identity/include.gypi | 53 +++++ .../stdlib/number/uint32/base/identity.h | 40 ++++ .../number/uint32/base/identity/lib/index.js | 49 ++++ .../number/uint32/base/identity/lib/main.js | 50 ++++ .../number/uint32/base/identity/lib/native.js | 58 +++++ .../number/uint32/base/identity/manifest.json | 67 ++++++ .../number/uint32/base/identity/package.json | 65 ++++++ .../number/uint32/base/identity/src/Makefile | 70 ++++++ .../number/uint32/base/identity/src/addon.c | 22 ++ .../number/uint32/base/identity/src/main.c | 34 +++ .../number/uint32/base/identity/test/test.js | 39 ++++ .../uint32/base/identity/test/test.native.js | 48 ++++ 25 files changed, 1730 insertions(+) create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/README.md create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/Makefile create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/binding.gyp create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/docs/img/equation_identity_function.svg create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/include.gypi create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/include/stdlib/number/uint32/base/identity.h create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/lib/index.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/manifest.json create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/package.json create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/src/Makefile create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/src/addon.c create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/src/main.c create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/test/test.js create mode 100644 lib/node_modules/@stdlib/number/uint32/base/identity/test/test.native.js diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/README.md b/lib/node_modules/@stdlib/number/uint32/base/identity/README.md new file mode 100644 index 000000000000..6f5b85688cd6 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/README.md @@ -0,0 +1,214 @@ + + +# Identity Function + +> Evaluate the [identity function][identity-function] of an unsigned 32-bit integer. + +
+ +The [identity-function][identity-function] is defined as + + + +```math +f(x) = x +``` + + + + + +for all `x`. + +
+ + + +
+ +## Usage + +```javascript +var identity = require( '@stdlib/number/uint32/base/identity' ); +``` + +#### identity( x ) + +Evaluates the [identity function][identity-function] for an unsigned 32-bit integer. + +```javascript +var v = identity( 1 ); +// returns 1 + +v = identity( 2 ); +// returns 2 + +v = identity( 0 ); +// returns 0 + +v = identity( 4294967295 ); +// returns 4294967295 +``` + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var identity = require( '@stdlib/number/uint32/base/identity' ); + +var opts = { + 'dtype': 'uint32' +}; + +var x = discreteUniform( 100, 0, 50, opts ); + +var v; +var i; +for ( i = 0; i < x.length; i++ ) { + v = identity( x[ i ] ); + console.log( 'identity(%d) = %d', x[ i ], v ); +} +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/number/uint32/base/identity.h" +``` + +#### stdlib_base_uint32_identity( x ) + +Evaluates the identity function for an unsigned 32-bit integer. + +```c +#include + +uint32_t y = stdlib_base_uint32_identity( 2 ); +// returns 2 +``` + +The function accepts the following arguments: + +- **x**: `[in] uint32_t` input value. + +```c +uint32_t stdlib_base_uint32_identity( const uint32_t x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/number/uint32/base/identity.h" +#include +#include + +int main( void ) { + const uint32_t x[] = { 3, 5, 10, 12 }; + + uint32_t y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_uint32_identity( x[ i ] ); + printf( "f(%u) = %u\n", x[ i ], y ); + } +} +``` + +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[identity-function]: https://en.wikipedia.org/wiki/Identity_function + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.js b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.js new file mode 100644 index 000000000000..2ccfad708e5b --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.js @@ -0,0 +1,54 @@ +/** +* @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 bench = require( '@stdlib/bench' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var identity = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = discreteUniform( 100, 0, 50, { + 'dtype': 'uint32' + }); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = identity( x[ i%x.length ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js new file mode 100644 index 000000000000..51c2e509a917 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js @@ -0,0 +1,63 @@ +/** +* @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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var identity = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( identity instanceof Error ) +}; + + +// MAIN // + +bench( pkg, opts, function benchmark( b ) { + var x; + var y; + var i; + + x = discreteUniform( 100, 0, 50, { + 'dtype': 'uint32' + }); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = identity( x[ i%x.length ] ); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/Makefile b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/Makefile new file mode 100644 index 000000000000..a4bd7b38fd74 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/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.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/number/uint32/base/identity/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c new file mode 100644 index 000000000000..2dca5e2d5fda --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c @@ -0,0 +1,137 @@ +/** +* @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/number/uint32/base/identity.h" +#include +#include +#include +#include +#include +#include + +#define NAME "identity" +#define ITERATIONS 1000000 +#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 double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @return elapsed time in seconds +*/ +static double benchmark( void ) { + uint32_t x[ 100 ]; + double elapsed; + double y; + double t; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = (uint32_t)( 50.0*rand_double() ); + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + y = stdlib_base_uint32_identity( 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/number/uint32/base/identity/binding.gyp b/lib/node_modules/@stdlib/number/uint32/base/identity/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/binding.gyp @@ -0,0 +1,170 @@ +# @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/number/uint32/base/identity/docs/img/equation_identity_function.svg b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/img/equation_identity_function.svg new file mode 100644 index 000000000000..86516c97fe7a --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/img/equation_identity_function.svg @@ -0,0 +1,18 @@ + +f left-parenthesis x right-parenthesis equals x + + + \ No newline at end of file diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/docs/repl.txt b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/repl.txt new file mode 100644 index 000000000000..4fc2f7720d62 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/repl.txt @@ -0,0 +1,28 @@ + +{{alias}}( x ) + Evaluates the identity function for an unsigned 32-bit integer `x`. + + Parameters + ---------- + x: number + Input value. + + Returns + ------- + y: number + Input value. + + Examples + -------- + > var y = {{alias}}( 1 ) + 1 + > y = {{alias}}( 2 ) + 2 + > y = {{alias}}( 0 ) + 0 + > y = {{alias}}( 4294967295 ) + 4294967295 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/index.d.ts b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/index.d.ts new file mode 100644 index 000000000000..858baac65dd7 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/index.d.ts @@ -0,0 +1,48 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/** +* Evaluates the identity function for an unsigned 32-bit integer `x`. +* +* @param x - input value +* @returns input value +* +* @example +* var v = identity( 1 ); +* // returns 1 +* +* @example +* var v = identity( 2 ); +* // returns 2 +* +* @example +* var v = identity( 0 ); +* // returns 0 +* +* @example +* var v = identity( 4294967295 ); +* // returns 4294967295 +*/ +declare function identity( x: number ): number; + + +// EXPORTS // + +export = identity; diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/test.ts b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/test.ts new file mode 100644 index 000000000000..ba6faf709efc --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/docs/types/test.ts @@ -0,0 +1,44 @@ +/* +* @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. +*/ + +import identity = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + identity( 8 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + identity( true ); // $ExpectError + identity( false ); // $ExpectError + identity( null ); // $ExpectError + identity( undefined ); // $ExpectError + identity( '5' ); // $ExpectError + identity( [] ); // $ExpectError + identity( {} ); // $ExpectError + identity( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + identity(); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/Makefile b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/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/number/uint32/base/identity/examples/c/example.c b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/example.c new file mode 100644 index 000000000000..06c0a9b0b3de --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/c/example.c @@ -0,0 +1,32 @@ +/** +* @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/number/uint32/base/identity.h" +#include +#include + +int main( void ) { + const uint32_t x[] = { 3, 5, 10, 12 }; + + uint32_t y; + int i; + for ( i = 0; i < 4; i++ ) { + y = stdlib_base_uint32_identity( x[ i ] ); + printf( "f(%u) = %u\n", x[ i ], y ); + } +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js new file mode 100644 index 000000000000..b3bc1e8e4a56 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.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'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var identity = require( './../lib' ); + +var opts = { + 'dtype': 'uint32' +}; + +var x = discreteUniform( 100, 0, 50, opts ); + +var v; +var i; +for ( i = 0; i < x.length; i++ ) { + v = identity( x[ i ] ); + console.log( 'identity(%d) = %d', x[ i ], v ); +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/include.gypi b/lib/node_modules/@stdlib/number/uint32/base/identity/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/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': [ + ' + +/* +* 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 + +/** +* Evaluates the identity function for an unsigned 32-bit integer. +*/ +uint32_t stdlib_base_uint32_identity( const uint32_t x ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_NUMBER_UINT32_BASE_IDENTITY_H diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/index.js b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/index.js new file mode 100644 index 000000000000..a045b6e00ac5 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/index.js @@ -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. +*/ + +'use strict'; + +/** +* Evaluate the identity function for an unsigned 32-bit integer. +* +* @module @stdlib/number/uint32/base/identity +* +* @example +* var identity = require( '@stdlib/number/uint32/base/identity' ); +* +* var v = identity( 1 ); +* // returns 1 +* +* v = identity( 2 ); +* // returns 2 +* +* v = identity( 0 ); +* // returns 0 +* +* v = identity( 4294967295 ); +* // returns 4294967295 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js new file mode 100644 index 000000000000..359b82eb1409 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js @@ -0,0 +1,50 @@ +/** +* @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'; + +/** +* Evaluates the identity function for an unsigned 32-bit integer `x`. +* +* @param {integer} x - input value +* @returns {integer} input value +* +* @example +* var v = identity( 1 ); +* // returns 1 +* +* @example +* var v = identity( 2 ); +* // returns 2 +* +* @example +* var v = identity( 0 ); +* // returns 0 +* +* @example +* var v = identity( 4294967295 ); +* // returns 4294967295 +*/ +function identity( x ) { + return x; +} + + +// EXPORTS // + +module.exports = identity; diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js new file mode 100644 index 000000000000..44b91a5292ba --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js @@ -0,0 +1,58 @@ +/** +* @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 // + +/** +* Evaluates the identity function for an unsigned 32-bit integer `x`. +* +* @private +* @param {integer} x - input value +* @returns {integer} input value +* +* @example +* var v = identity( 1 ); +* // returns 1 +* +* @example +* var v = identity( 2 ); +* // returns 2 +* +* @example +* var v = identity( 0 ); +* // returns 0 +* +* @example +* var v = identity( 4294967295 ); +* // returns 4294967295 +*/ +function identity( x ) { + return addon( x ); +} + + +// EXPORTS // + +module.exports = identity; diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/manifest.json b/lib/node_modules/@stdlib/number/uint32/base/identity/manifest.json new file mode 100644 index 000000000000..6bfc690068b2 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/manifest.json @@ -0,0 +1,67 @@ +{ + "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" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [] + } + ] +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/package.json b/lib/node_modules/@stdlib/number/uint32/base/identity/package.json new file mode 100644 index 000000000000..7af04f53fe81 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/number/uint32/base/identity", + "version": "0.0.0", + "description": "Evaluate the identity function for an unsigned 32-bit integer.", + "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", + "identity", + "unsigned", + "uint32", + "integer" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/src/Makefile b/lib/node_modules/@stdlib/number/uint32/base/identity/src/Makefile new file mode 100644 index 000000000000..7733b6180cb4 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/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/number/uint32/base/identity/src/addon.c b/lib/node_modules/@stdlib/number/uint32/base/identity/src/addon.c new file mode 100644 index 000000000000..2c67b7681903 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/src/addon.c @@ -0,0 +1,22 @@ +/** +* @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/number/uint32/base/identity.h" +#include "stdlib/math/base/napi/unary.h" + +STDLIB_MATH_BASE_NAPI_MODULE_U_U( stdlib_base_uint32_identity ) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/src/main.c b/lib/node_modules/@stdlib/number/uint32/base/identity/src/main.c new file mode 100644 index 000000000000..dce8837243a4 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/src/main.c @@ -0,0 +1,34 @@ +/** +* @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/number/uint32/base/identity.h" +#include + +/** +* Evaluates the identity function for an unsigned 32-bit integer. +* +* @param x number +* @return input value +* +* @example +* uint32_t y = stdlib_base_uint32_identity( 3 ); +* // returns 3 +*/ +uint32_t stdlib_base_uint32_identity( const uint32_t x ) { + return x; +} diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.js b/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.js new file mode 100644 index 000000000000..a602adf14e6c --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.js @@ -0,0 +1,39 @@ +/** +* @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 tape = require( 'tape' ); +var identity = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof identity, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function evaluates the identity function when provided a number', function test( t ) { + t.equal( identity( 2 ), 2, 'returns expected value' ); + t.equal( identity( 3 ), 3, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.native.js b/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.native.js new file mode 100644 index 000000000000..4883a87af20c --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/test/test.native.js @@ -0,0 +1,48 @@ +/** +* @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' ); + + +// VARIABLES // + +var identity = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( identity instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof identity, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function evaluates the identity function when provided a number', opts, function test( t ) { + t.equal( identity( 2 ), 2, 'returns expected value' ); + t.equal( identity( 3 ), 3, 'returns expected value' ); + t.end(); +}); From 6f9db9521bf06cea8e76774c2739b9869cf042da Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 10 Aug 2025 00:35:48 -0700 Subject: [PATCH 2/7] bench: fix missing namespace Signed-off-by: Athan --- .../number/uint32/base/identity/benchmark/benchmark.native.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js index 51c2e509a917..e49ae59f7369 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/benchmark.native.js @@ -38,7 +38,7 @@ var opts = { // MAIN // -bench( pkg, opts, function benchmark( b ) { +bench( pkg+'::native', opts, function benchmark( b ) { var x; var y; var i; From 473a630ab84b0e4017cfcdab9d732a8e4038d5f0 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 10 Aug 2025 00:39:46 -0700 Subject: [PATCH 3/7] docs: update types Signed-off-by: Athan --- .../@stdlib/number/uint32/base/identity/lib/main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js index 359b82eb1409..7e87c26c7aef 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/main.js @@ -21,8 +21,8 @@ /** * Evaluates the identity function for an unsigned 32-bit integer `x`. * -* @param {integer} x - input value -* @returns {integer} input value +* @param {uinteger} x - input value +* @returns {uinteger} input value * * @example * var v = identity( 1 ); From 6ac393487765c3615b8494b945091ff6748b818f Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 10 Aug 2025 00:40:16 -0700 Subject: [PATCH 4/7] docs: update types Signed-off-by: Athan --- .../@stdlib/number/uint32/base/identity/lib/native.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js index 44b91a5292ba..a961bbd62139 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/lib/native.js @@ -29,8 +29,8 @@ var addon = require( './../src/addon.node' ); * Evaluates the identity function for an unsigned 32-bit integer `x`. * * @private -* @param {integer} x - input value -* @returns {integer} input value +* @param {uinteger} x - input value +* @returns {uinteger} input value * * @example * var v = identity( 1 ); From f54fc94067959dfd68a3f27dd93612694e4ffcd9 Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 10 Aug 2025 00:41:27 -0700 Subject: [PATCH 5/7] bench: fix type Signed-off-by: Athan --- .../number/uint32/base/identity/benchmark/c/native/benchmark.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c index 2dca5e2d5fda..87f298acf407 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c @@ -93,7 +93,7 @@ static double rand_double( void ) { static double benchmark( void ) { uint32_t x[ 100 ]; double elapsed; - double y; + uint32_t y; double t; int i; From 338162609dfee91f82345a49f66a3e5285d4c10c Mon Sep 17 00:00:00 2001 From: Athan Date: Sun, 10 Aug 2025 00:41:52 -0700 Subject: [PATCH 6/7] bench: update conditions Signed-off-by: Athan --- .../uint32/base/identity/benchmark/c/native/benchmark.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c index 87f298acf407..a9e12210a542 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/benchmark/c/native/benchmark.c @@ -104,14 +104,14 @@ static double benchmark( void ) { t = tic(); for ( i = 0; i < ITERATIONS; i++ ) { y = stdlib_base_uint32_identity( x[ i%100 ] ); - if ( y != y ) { - printf( "should not return NaN\n" ); + if ( y > 100 ) { + printf( "unexpected result\n" ); break; } } elapsed = tic() - t; - if ( y != y ) { - printf( "should not return NaN\n" ); + if ( y > 100 ) { + printf( "unexpected result\n" ); } return elapsed; } From e71ee205aa479a3cf9f18507e5496e851f41e5ef Mon Sep 17 00:00:00 2001 From: GUNJ JOSHI Date: Sun, 10 Aug 2025 13:22:34 +0530 Subject: [PATCH 7/7] docs: update js examples to use logEach --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/number/uint32/base/identity/README.md | 10 ++++------ .../number/uint32/base/identity/examples/index.js | 10 ++++------ 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/README.md b/lib/node_modules/@stdlib/number/uint32/base/identity/README.md index 6f5b85688cd6..5523fcc007e6 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/README.md +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/README.md @@ -83,20 +83,18 @@ v = identity( 4294967295 ); ```javascript var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var identity = require( '@stdlib/number/uint32/base/identity' ); var opts = { 'dtype': 'uint32' }; +// Create an array of random values: var x = discreteUniform( 100, 0, 50, opts ); -var v; -var i; -for ( i = 0; i < x.length; i++ ) { - v = identity( x[ i ] ); - console.log( 'identity(%d) = %d', x[ i ], v ); -} +// Perform element-wise operation: +logEachMap( 'identity(%d) = %d', x, identity ); ``` diff --git a/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js index b3bc1e8e4a56..82cb514c73f3 100644 --- a/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js +++ b/lib/node_modules/@stdlib/number/uint32/base/identity/examples/index.js @@ -19,17 +19,15 @@ 'use strict'; var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); var identity = require( './../lib' ); var opts = { 'dtype': 'uint32' }; +// Create an array of random values: var x = discreteUniform( 100, 0, 50, opts ); -var v; -var i; -for ( i = 0; i < x.length; i++ ) { - v = identity( x[ i ] ); - console.log( 'identity(%d) = %d', x[ i ], v ); -} +// Perform element-wise operation: +logEachMap( 'identity(%d) = %d', x, identity );