diff --git a/CHANGELOG.md b/CHANGELOG.md index b86c10574..18e436096 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,28 @@ ### Packages +
+ +#### [@stdlib/math/base/assert/is-nonnegative-integerf](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/assert/is-nonnegative-integerf) + +
+ +
+ +##### Features + +- [`d125530`](https://github.com/stdlib-js/stdlib/commit/d125530c01e76a5f6f0b093f422e403dbc3a03e2) - add `math/base/assert/is-nonnegative-integerf` [(#2851)](https://github.com/stdlib-js/stdlib/pull/2851) + +
+ + + +
+ +
+ + +
#### [@stdlib/math/base/special/acotdf](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/acotdf) @@ -298,6 +320,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
+- [`d125530`](https://github.com/stdlib-js/stdlib/commit/d125530c01e76a5f6f0b093f422e403dbc3a03e2) - **feat:** add `math/base/assert/is-nonnegative-integerf` [(#2851)](https://github.com/stdlib-js/stdlib/pull/2851) _(by Gunj Joshi)_ - [`4dbd685`](https://github.com/stdlib-js/stdlib/commit/4dbd685129b1ee7a1f459b77e791314c0bef49e7) - **feat:** add `math/base/special/acovercosf` _(by Gunj Joshi)_ - [`4bddc16`](https://github.com/stdlib-js/stdlib/commit/4bddc16dfcdc4d18a95bbd08abc869f58d77396b) - **feat:** add `math/base/special/aversinf` [(#2852)](https://github.com/stdlib-js/stdlib/pull/2852) _(by Gunj Joshi)_ - [`ff629c7`](https://github.com/stdlib-js/stdlib/commit/ff629c760ef40d9245a87a56716ea7a12145f6b2) - **feat:** add `math/base/special/maxabsf` _(by Gunj Joshi, Philipp Burckhardt)_ diff --git a/base/assert/is-nonnegative-integerf/README.md b/base/assert/is-nonnegative-integerf/README.md new file mode 100644 index 000000000..fc56a847f --- /dev/null +++ b/base/assert/is-nonnegative-integerf/README.md @@ -0,0 +1,224 @@ + + +# isNonNegativeIntegerf + +> Test if a finite [single-precision floating-point number][ieee754] is a nonnegative integer. + +
+ +## Usage + +```javascript +var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' ); +``` + +#### isNonNegativeIntegerf( x ) + +Tests if a finite [single-precision floating-point number][ieee754] is a nonnegative `integer`. + +```javascript +var bool = isNonNegativeIntegerf( 1.0 ); +// returns true + +bool = isNonNegativeIntegerf( 0.0 ); +// returns true + +bool = isNonNegativeIntegerf( -10.0 ); +// returns false +``` + +
+ + + +
+ +## Notes + +- The function assumes a **finite** `number`. If provided positive `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows: + + ```javascript + function check( x ) { + return ( + x < Infinity && + isNonNegativeIntegerf( x ) + ); + } + + var bool = check( Infinity ); + // returns false + ``` + +- The function does **not** distinguish between positive and negative `zero`. + + ```javascript + var bool = isNonNegativeIntegerf( 0.0 ); + // returns true + + bool = isNonNegativeIntegerf( -0.0 ); + // returns true + ``` + +
+ + + +
+ +## Examples + + + +```javascript +var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' ); + +var bool = isNonNegativeIntegerf( 5.0 ); +// returns true + +bool = isNonNegativeIntegerf( 0.0 ); +// returns true + +bool = isNonNegativeIntegerf( -1.0 ); +// returns false + +bool = isNonNegativeIntegerf( 3.14 ); +// returns false + +bool = isNonNegativeIntegerf( NaN ); +// returns false +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/math/base/assert/is_nonnegative_integerf.h" +``` + +#### stdlib_base_is_nonnegative_integerf( x ) + +Tests if a finite [single-precision floating-point number][ieee754] is a nonnegative integer. + +```c +bool out = stdlib_base_is_nonnegative_integerf( 1.0f ); +// returns true + +out = stdlib_base_is_nonnegative_integerf( -10.0f ); +// returns false +``` + +The function accepts the following arguments: + +- **x**: `[in] float` input value. + +```c +bool stdlib_base_is_nonnegative_integerf( const float x ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/math/base/assert/is_nonnegative_integerf.h" +#include +#include +#include + +int main( void ) { + float x; + bool v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0f ) - 50.0f; + v = stdlib_base_is_nonnegative_integerf( x ); + printf( "x = %f, is_nonnegative_integerf(x) = %s\n", x, ( v ) ? "true" : "false" ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/base/assert/is-nonnegative-integerf/benchmark/benchmark.js b/base/assert/is-nonnegative-integerf/benchmark/benchmark.js new file mode 100644 index 000000000..673f63d18 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/benchmark/benchmark.js @@ -0,0 +1,52 @@ +/** +* @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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var pkg = require( './../package.json' ).name; +var isNonNegativeIntegerf = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -5.0e6, 5.0e6 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = isNonNegativeIntegerf( x[ i % x.length ] ); + if ( typeof y !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( y ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/base/assert/is-nonnegative-integerf/benchmark/benchmark.native.js b/base/assert/is-nonnegative-integerf/benchmark/benchmark.native.js new file mode 100644 index 000000000..47ce43e82 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var isNonNegativeIntegerf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( isNonNegativeIntegerf instanceof Error ) +}; + + +// MAIN // + +bench( pkg+'::native', opts, function benchmark( b ) { + var x; + var y; + var i; + + x = randu( 100, -5.0e6, 5.0e6 ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = isNonNegativeIntegerf( x[ i % x.length ] ); + if ( typeof y !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( y ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/base/assert/is-nonnegative-integerf/benchmark/c/native/Makefile b/base/assert/is-nonnegative-integerf/benchmark/c/native/Makefile new file mode 100644 index 000000000..f69e9da2b --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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/base/assert/is-nonnegative-integerf/benchmark/c/native/benchmark.c b/base/assert/is-nonnegative-integerf/benchmark/c/native/benchmark.c new file mode 100644 index 000000000..5340ab0e6 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/benchmark/c/native/benchmark.c @@ -0,0 +1,137 @@ +/** +* @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/assert/is_nonnegative_integerf.h" +#include +#include +#include +#include +#include +#include + +#define NAME "is-nonnegative-integerf" +#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 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; + double t; + float x[ 100 ]; + bool b; + int i; + + for ( i = 0; i < 100; i++ ) { + x[ i ] = ( 1000.0f * rand_float() ) - 500.0f; + } + + t = tic(); + for ( i = 0; i < ITERATIONS; i++ ) { + b = stdlib_base_is_nonnegative_integerf( x[ i % 100 ] ); + if ( b != true && b != false ) { + printf( "should return either true or false\n" ); + break; + } + } + elapsed = tic() - t; + if ( b != true && b != false ) { + printf( "should return either true or false\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/base/assert/is-nonnegative-integerf/binding.gyp b/base/assert/is-nonnegative-integerf/binding.gyp new file mode 100644 index 000000000..ec3992233 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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/base/assert/is-nonnegative-integerf/docs/repl.txt b/base/assert/is-nonnegative-integerf/docs/repl.txt new file mode 100644 index 000000000..7a4505bcd --- /dev/null +++ b/base/assert/is-nonnegative-integerf/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( x ) + Tests if a finite single-precision floating-point number is a nonnegative + integer. + + The function assumes a finite number. If provided positive infinity, the + function will return `true`, when, in fact, the result is undefined. + + The function does not distinguish between positive and negative zero. + + Parameters + ---------- + x: number + Value to test. + + Returns + ------- + bool: boolean + Boolean indicating whether the value is a nonnegative integer. + + Examples + -------- + > var bool = {{alias}}( 1.0 ) + true + > bool = {{alias}}( 0.0 ) + true + > bool = {{alias}}( -10.0 ) + false + + See Also + -------- + diff --git a/base/assert/is-nonnegative-integerf/docs/types/index.d.ts b/base/assert/is-nonnegative-integerf/docs/types/index.d.ts new file mode 100644 index 000000000..02aaaaed5 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/docs/types/index.d.ts @@ -0,0 +1,49 @@ +/* +* @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 + +/** +* Tests if a finite single-precision floating-point number is a nonnegative integer. +* +* ## Notes +* +* - The function assumes a finite number. If provided positive infinity, the function will return `true`, when, in fact, the result is undefined. +* - The function does not distinguish between positive and negative zero. +* +* @param x - value to test +* @returns boolean indicating whether the value is a nonnegative integer +* +* @example +* var bool = isNonNegativeIntegerf( 1.0 ); +* // returns true +* +* @example +* var bool = isNonNegativeIntegerf( 0.0 ); +* // returns true +* +* @example +* var bool = isNonNegativeIntegerf( -10.0 ); +* // returns false +*/ +declare function isNonNegativeIntegerf( x: number ): boolean; + + +// EXPORTS // + +export = isNonNegativeIntegerf; diff --git a/base/assert/is-nonnegative-integerf/docs/types/test.ts b/base/assert/is-nonnegative-integerf/docs/types/test.ts new file mode 100644 index 000000000..9be0d7a88 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/docs/types/test.ts @@ -0,0 +1,46 @@ +/* +* @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 isNonNegativeIntegerf = require( './index' ); + + +// TESTS // + +// The function returns a boolean... +{ + isNonNegativeIntegerf( 2 ); // $ExpectType boolean + isNonNegativeIntegerf( 3.12 ); // $ExpectType boolean + isNonNegativeIntegerf( -2 ); // $ExpectType boolean +} + +// The compiler throws an error if the function is provided a value other than a number... +{ + isNonNegativeIntegerf( true ); // $ExpectError + isNonNegativeIntegerf( false ); // $ExpectError + isNonNegativeIntegerf( null ); // $ExpectError + isNonNegativeIntegerf( undefined ); // $ExpectError + isNonNegativeIntegerf( [] ); // $ExpectError + isNonNegativeIntegerf( {} ); // $ExpectError + isNonNegativeIntegerf( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + isNonNegativeIntegerf(); // $ExpectError + isNonNegativeIntegerf( undefined, 123 ); // $ExpectError +} diff --git a/base/assert/is-nonnegative-integerf/examples/c/Makefile b/base/assert/is-nonnegative-integerf/examples/c/Makefile new file mode 100644 index 000000000..6aed70daf --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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/base/assert/is-nonnegative-integerf/examples/c/example.c b/base/assert/is-nonnegative-integerf/examples/c/example.c new file mode 100644 index 000000000..97dc068ff --- /dev/null +++ b/base/assert/is-nonnegative-integerf/examples/c/example.c @@ -0,0 +1,34 @@ +/** +* @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/assert/is_nonnegative_integerf.h" +#include +#include +#include + +int main( void ) { + float x; + bool v; + int i; + + for ( i = 0; i < 100; i++ ) { + x = ( ( (float)rand() / (float)RAND_MAX ) * 100.0f ) - 50.0f; + v = stdlib_base_is_nonnegative_integerf( x ); + printf( "x = %f, is_nonnegative_integerf(x) = %s\n", x, ( v ) ? "true" : "false" ); + } +} diff --git a/base/assert/is-nonnegative-integerf/examples/index.js b/base/assert/is-nonnegative-integerf/examples/index.js new file mode 100644 index 000000000..ff6c43fbd --- /dev/null +++ b/base/assert/is-nonnegative-integerf/examples/index.js @@ -0,0 +1,36 @@ +/** +* @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 isNonNegativeIntegerf = require( './../lib' ); + +console.log( isNonNegativeIntegerf( 5.0 ) ); +// => true + +console.log( isNonNegativeIntegerf( 0.0 ) ); +// => true + +console.log( isNonNegativeIntegerf( -1.0 ) ); +// => false + +console.log( isNonNegativeIntegerf( 3.14 ) ); +// => false + +console.log( isNonNegativeIntegerf( NaN ) ); +// => false diff --git a/base/assert/is-nonnegative-integerf/include.gypi b/base/assert/is-nonnegative-integerf/include.gypi new file mode 100644 index 000000000..575cb043c --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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 + +/** +* Tests if a finite single-precision floating-point number is a nonnegative integer. +*/ +bool stdlib_base_is_nonnegative_integerf( const float x ); + +#ifdef __cplusplus +} +#endif + +#endif // !STDLIB_MATH_BASE_ASSERT_IS_NONNEGATIVE_INTEGERF_H diff --git a/base/assert/is-nonnegative-integerf/lib/index.js b/base/assert/is-nonnegative-integerf/lib/index.js new file mode 100644 index 000000000..0f8ba3149 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/lib/index.js @@ -0,0 +1,46 @@ +/** +* @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'; + +/** +* Test if a finite single-precision floating-point number is a nonnegative integer. +* +* @module @stdlib/math/base/assert/is-nonnegative-integerf +* +* @example +* var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' ); +* +* var bool = isNonNegativeIntegerf( 1.0 ); +* // returns true +* +* bool = isNonNegativeIntegerf( 0.0 ); +* // returns true +* +* bool = isNonNegativeIntegerf( -10.0 ); +* // returns false +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/base/assert/is-nonnegative-integerf/lib/main.js b/base/assert/is-nonnegative-integerf/lib/main.js new file mode 100644 index 000000000..790fdfd5c --- /dev/null +++ b/base/assert/is-nonnegative-integerf/lib/main.js @@ -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. +*/ + +'use strict'; + +// MODULES // + +var floorf = require( './../../../../base/special/floorf' ); + + +// MAIN // + +/** +* Tests if a finite single-precision floating-point number is a nonnegative integer. +* +* @param {number} x - value to test +* @returns {boolean} boolean indicating whether the value is a nonnegative integer +* +* @example +* var bool = isNonNegativeIntegerf( 1.0 ); +* // returns true +* +* @example +* var bool = isNonNegativeIntegerf( 0.0 ); +* // returns true +* +* @example +* var bool = isNonNegativeIntegerf( -10.0 ); +* // returns false +*/ +function isNonNegativeIntegerf( x ) { + return ( floorf( x ) === x && x >= 0 ); +} + + +// EXPORTS // + +module.exports = isNonNegativeIntegerf; diff --git a/base/assert/is-nonnegative-integerf/lib/native.js b/base/assert/is-nonnegative-integerf/lib/native.js new file mode 100644 index 000000000..d17296909 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/lib/native.js @@ -0,0 +1,51 @@ +/** +* @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 Boolean = require( '@stdlib/boolean/ctor' ); +var addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Tests if a finite single-precision floating-point number is a nonnegative integer. +* +* @private +* @param {number} x - value to test +* @returns {boolean} boolean indicating whether the value is a nonnegative integer +* +* @example +* var bool = isNonNegativeIntegerf( 1.0 ); +* // returns true +* +* @example +* var bool = isNonNegativeIntegerf( -10.0 ); +* // returns false +*/ +function isNonNegativeIntegerf( x ) { + return Boolean( addon( x ) ); +} + + +// EXPORTS // + +module.exports = isNonNegativeIntegerf; diff --git a/base/assert/is-nonnegative-integerf/manifest.json b/base/assert/is-nonnegative-integerf/manifest.json new file mode 100644 index 000000000..1966e234a --- /dev/null +++ b/base/assert/is-nonnegative-integerf/manifest.json @@ -0,0 +1,71 @@ +{ + "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/special/floorf" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floorf" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/math/base/special/floorf" + ] + } + ] +} diff --git a/base/assert/is-nonnegative-integerf/package.json b/base/assert/is-nonnegative-integerf/package.json new file mode 100644 index 000000000..0e3bda0f0 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/package.json @@ -0,0 +1,78 @@ +{ + "name": "@stdlib/math/base/assert/is-nonnegative-integerf", + "version": "0.0.0", + "description": "Test if a finite single-precision floating-point number is a nonnegative 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", + "assertion", + "assert", + "utilities", + "utility", + "utils", + "util", + "math", + "mathematics", + "nonnegative", + "positive", + "integer", + "number", + "int", + "is", + "isinteger", + "isint", + "type", + "check", + "float", + "flt" + ] +} diff --git a/base/assert/is-nonnegative-integerf/src/Makefile b/base/assert/is-nonnegative-integerf/src/Makefile new file mode 100644 index 000000000..bcf18aa46 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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/base/assert/is-nonnegative-integerf/src/addon.c b/base/assert/is-nonnegative-integerf/src/addon.c new file mode 100644 index 000000000..ed3fcc657 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/src/addon.c @@ -0,0 +1,88 @@ +/** +* @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/assert/is_nonnegative_integerf.h" +#include +#include +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + napi_status status; + + // Get callback arguments: + size_t argc = 1; + napi_value argv[ 1 ]; + status = napi_get_cb_info( env, info, &argc, argv, NULL, NULL ); + assert( status == napi_ok ); + + // Check whether we were provided the correct number of arguments: + if ( argc < 1 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Insufficient arguments." ); + assert( status == napi_ok ); + return NULL; + } + if ( argc > 1 ) { + status = napi_throw_error( env, NULL, "invalid invocation. Too many arguments." ); + assert( status == napi_ok ); + return NULL; + } + + napi_valuetype vtype0; + status = napi_typeof( env, argv[ 0 ], &vtype0 ); + assert( status == napi_ok ); + if ( vtype0 != napi_number ) { + status = napi_throw_type_error( env, NULL, "invalid argument. First argument must be a number." ); + assert( status == napi_ok ); + return NULL; + } + + double x; + status = napi_get_value_double( env, argv[ 0 ], &x ); + assert( status == napi_ok ); + + bool result = stdlib_base_is_nonnegative_integerf( (float)x ); + + napi_value v; + status = napi_create_int32( env, (int32_t)result, &v ); + assert( status == napi_ok ); + + return v; +} + +/** +* Initializes a Node-API module. +* +* @param env environment under which the function is invoked +* @param exports exports object +* @return main export +*/ +static napi_value init( napi_env env, napi_value exports ) { + napi_value fcn; + napi_status status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, addon, NULL, &fcn ); + assert( status == napi_ok ); + return fcn; +} + +NAPI_MODULE( NODE_GYP_MODULE_NAME, init ) diff --git a/base/assert/is-nonnegative-integerf/src/main.c b/base/assert/is-nonnegative-integerf/src/main.c new file mode 100644 index 000000000..405850f38 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/src/main.c @@ -0,0 +1,36 @@ +/** +* @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/assert/is_nonnegative_integerf.h" +#include "stdlib/math/base/special/floorf.h" + +/** +* Tests if a finite single-precision floating-point number is a nonnegative integer. +* +* @param x input value +* @return output value +* +* @example +* #include +* +* bool out = stdlib_base_is_nonnegative_integerf( 3.0f ); +* // returns true +*/ +bool stdlib_base_is_nonnegative_integerf( const float x ) { + return ( x == stdlib_base_floorf( x ) && x >= 0.0f ); +} diff --git a/base/assert/is-nonnegative-integerf/test/test.js b/base/assert/is-nonnegative-integerf/test/test.js new file mode 100644 index 000000000..4424d106c --- /dev/null +++ b/base/assert/is-nonnegative-integerf/test/test.js @@ -0,0 +1,85 @@ +/** +* @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 truncf = require( './../../../../base/special/truncf' ); +var randu = require( '@stdlib/random/base/randu' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var NINF = require( '@stdlib/constants/float32/ninf' ); +var isNonNegativeIntegerf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof isNonNegativeIntegerf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `true` if provided a nonnegative integer', function test( t ) { + var i; + for ( i = 0; i < 101; i++ ) { + t.equal( isNonNegativeIntegerf( i ), true, 'returns expected value when provided '+i ); + } + t.end(); +}); + +tape( 'the function returns `false` if not provided a nonnegative integer', function test( t ) { + var i; + for ( i = -1; i > -101; i-- ) { + t.equal( isNonNegativeIntegerf( i ), false, 'returns expected value when provided '+i ); + } + t.end(); +}); + +tape( 'the function returns `false` if not provided an integer', function test( t ) { + var v; + var i; + for ( i = 0; i < 100; i++ ) { + v = ( randu() * 100.0 ) - 50.0; + if ( truncf( v ) !== v ) { + t.equal( isNonNegativeIntegerf( v ), false, 'returns expected value when provided '+v ); + } + } + t.end(); +}); + +tape( 'the function returns `false` if provided `NaN`', function test( t ) { + t.equal( isNonNegativeIntegerf( NaN ), false, 'returns expected value' ); + t.end(); +}); + +tape( 'WARNING: the function returns `true` if provided `+infinity`', function test( t ) { + t.equal( isNonNegativeIntegerf( PINF ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function does not distinguish between positive and negative zero and returns `true` if provided `-0`', function test( t ) { + t.equal( isNonNegativeIntegerf( -0.0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `false` if provided `-infinity`', function test( t ) { + t.equal( isNonNegativeIntegerf( NINF ), false, 'returns expected value' ); + t.end(); +}); diff --git a/base/assert/is-nonnegative-integerf/test/test.native.js b/base/assert/is-nonnegative-integerf/test/test.native.js new file mode 100644 index 000000000..bd99b8bb9 --- /dev/null +++ b/base/assert/is-nonnegative-integerf/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 truncf = require( './../../../../base/special/truncf' ); +var randu = require( '@stdlib/random/base/randu' ); +var PINF = require( '@stdlib/constants/float32/pinf' ); +var NINF = require( '@stdlib/constants/float32/ninf' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var isNonNegativeIntegerf = tryRequire( resolve( __dirname, './../lib/native.js' ) ); +var opts = { + 'skip': ( isNonNegativeIntegerf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof isNonNegativeIntegerf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `true` if provided a nonnegative integer', opts, function test( t ) { + var i; + for ( i = 0; i < 101; i++ ) { + t.equal( isNonNegativeIntegerf( i ), true, 'returns expected value when provided '+i ); + } + t.end(); +}); + +tape( 'the function returns `false` if not provided a nonnegative integer', opts, function test( t ) { + var i; + for ( i = -1; i > -101; i-- ) { + t.equal( isNonNegativeIntegerf( i ), false, 'returns expected value when provided '+i ); + } + t.end(); +}); + +tape( 'the function returns `false` if not provided an integer', opts, function test( t ) { + var v; + var i; + for ( i = 0; i < 100; i++ ) { + v = ( randu() * 100.0 ) - 50.0; + if ( truncf( v ) !== v ) { + t.equal( isNonNegativeIntegerf( v ), false, 'returns expected value when provided '+v ); + } + } + t.end(); +}); + +tape( 'the function returns `false` if provided `NaN`', opts, function test( t ) { + t.equal( isNonNegativeIntegerf( NaN ), false, 'returns expected value' ); + t.end(); +}); + +tape( 'WARNING: the function returns `true` if provided `+infinity`', opts, function test( t ) { + t.equal( isNonNegativeIntegerf( PINF ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function does not distinguish between positive and negative zero and returns `true` if provided `-0`', opts, function test( t ) { + t.equal( isNonNegativeIntegerf( -0.0 ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `false` if provided `-infinity`', opts, function test( t ) { + t.equal( isNonNegativeIntegerf( NINF ), false, 'returns expected value' ); + t.end(); +});