diff --git a/lib/node_modules/@stdlib/assert/is-uint64/README.md b/lib/node_modules/@stdlib/assert/is-uint64/README.md new file mode 100644 index 000000000000..552e1496d59c --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/README.md @@ -0,0 +1,98 @@ + + +# isUint64 + +> Test if a value is an [unsigned 64-bit integer][@stdlib/number/uint64/ctor]. + +
+ +## Usage + +```javascript +var isUint64 = require( '@stdlib/assert/is-uint64' ); +``` + +#### isUint64( value ) + +Tests if a value is an [unsigned 64-bit integer][@stdlib/number/uint64/ctor]. + +```javascript +var Uint64 = require( '@stdlib/number/uint64/ctor' ); + +var x = new Uint64( 1234 ); + +var bool = isUint64( x ); +// returns true +``` + +
+ + + +
+ +## Examples + + + +```javascript +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var isUint64 = require( '@stdlib/assert/is-uint64' ); + +console.log( isUint64( new Uint64( 1234 ) ) ); +// => true + +console.log( isUint64( new Complex128( 3.0, 1.0 ) ) ); +// => false + +console.log( isUint64( {} ) ); +// => false + +console.log( isUint64( null ) ); +// => false +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[@stdlib/number/uint64/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint64/ctor + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/assert/is-uint64/benchmark/benchmark.js b/lib/node_modules/@stdlib/assert/is-uint64/benchmark/benchmark.js new file mode 100644 index 000000000000..fa704fc5f253 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/benchmark/benchmark.js @@ -0,0 +1,88 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var isUint64 = require( './../lib' ); + + +// MAIN // + +bench( format( '%s::true', pkg ), function benchmark( b ) { + var values; + var bool; + var i; + + values = [ + new Uint64( 1234 ), + new Uint64( 5678 ), + new Uint64( 9012 ), + new Uint64( 3456 ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + bool = isUint64( values[ i%values.length ] ); + if ( typeof bool !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( bool ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( format( '%s::false', pkg ), function benchmark( b ) { + var values; + var bool; + var i; + + values = [ + '5', + 5, + NaN, + true, + false, + [], + {} + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + bool = isUint64( values[ i%values.length ] ); + if ( typeof bool !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( bool ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/assert/is-uint64/docs/repl.txt b/lib/node_modules/@stdlib/assert/is-uint64/docs/repl.txt new file mode 100644 index 000000000000..e04718b1e0bc --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/docs/repl.txt @@ -0,0 +1,28 @@ + +{{alias}}( value ) + Tests if a value is an unsigned 64-bit integer. + + Parameters + ---------- + value: any + Value to test. + + Returns + ------- + bool: boolean + Boolean indicating whether a value is an unsigned 64-bit integer. + + Examples + -------- + > var bool = {{alias}}( new {{alias:@stdlib/number/uint64/ctor}}( 1234 ) ) + true + > bool = {{alias}}( new {{alias:@stdlib/complex/float64/ctor}}( 3.0, 1.0 ) ) + false + > bool = {{alias}}( 3.14 ) + false + > bool = {{alias}}( {} ) + false + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/assert/is-uint64/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-uint64/docs/types/index.d.ts new file mode 100644 index 000000000000..1d653c51a272 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/docs/types/index.d.ts @@ -0,0 +1,44 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Uint64 } from '@stdlib/types/number'; + +/** +* Tests if a value is an unsigned 64-bit integer. +* +* @param value - value to test +* @returns boolean indicating if a value is an unsigned 64-bit integer +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* +* var x = new Uint64( 1234 ); +* +* var bool = isUint64( x ); +* // returns true +*/ +declare function isUint64( value: any ): value is Uint64; + + +// EXPORTS // + +export = isUint64; diff --git a/lib/node_modules/@stdlib/assert/is-uint64/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-uint64/docs/types/test.ts new file mode 100644 index 000000000000..4754f06c4c45 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/docs/types/test.ts @@ -0,0 +1,38 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import Complex128 = require( '@stdlib/complex/float64/ctor' ); +import Uint64 = require( '@stdlib/number/uint64/ctor' ); +import isUint64 = require( './index' ); + + +// TESTS // + +// The function returns a boolean... +{ + isUint64( new Uint64( 1234 ) ); // $ExpectType boolean + isUint64( new Complex128( 5.0, 3.0 ) ); // $ExpectType boolean + isUint64( {} ); // $ExpectType boolean + isUint64( 123 ); // $ExpectType boolean +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + isUint64(); // $ExpectError + isUint64( new Uint64( 1234 ), 123 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/assert/is-uint64/examples/index.js b/lib/node_modules/@stdlib/assert/is-uint64/examples/index.js new file mode 100644 index 000000000000..54866c52a46e --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/examples/index.js @@ -0,0 +1,35 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var isUint64 = require( './../lib' ); + +console.log( isUint64( new Uint64( 1234 ) ) ); +// => true + +console.log( isUint64( new Complex128( 3.0, 1.0 ) ) ); +// => false + +console.log( isUint64( {} ) ); +// => false + +console.log( isUint64( null ) ); +// => false diff --git a/lib/node_modules/@stdlib/assert/is-uint64/lib/index.js b/lib/node_modules/@stdlib/assert/is-uint64/lib/index.js new file mode 100644 index 000000000000..1c5f7e92885b --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/lib/index.js @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Test if a value is an unsigned 64-bit integer. +* +* @module @stdlib/assert/is-uint64 +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* var isUint64 = require( '@stdlib/assert/is-uint64' ); +* +* var x = new Uint64( 1234 ); +* +* var bool = isUint64( x ); +* // returns true +*/ + +// MODULES // + +var isUint64 = require( './main.js' ); + + +// EXPORTS // + +module.exports = isUint64; diff --git a/lib/node_modules/@stdlib/assert/is-uint64/lib/main.js b/lib/node_modules/@stdlib/assert/is-uint64/lib/main.js new file mode 100644 index 000000000000..0c5763baab01 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/lib/main.js @@ -0,0 +1,53 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var constructorName = require( '@stdlib/utils/constructor-name' ); + + +// MAIN // + +/** +* Tests if a value is an unsigned 64-bit integer. +* +* @param {*} value - value to test +* @returns {boolean} boolean indicating if a value is an unsigned 64-bit integer +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* +* var x = new Uint64( 1234 ); +* +* var bool = isUint64( x ); +* // returns true +*/ +function isUint64( value ) { + return ( + value instanceof Uint64 || + constructorName( value ) === 'Uint64' + ); +} + + +// EXPORTS // + +module.exports = isUint64; diff --git a/lib/node_modules/@stdlib/assert/is-uint64/package.json b/lib/node_modules/@stdlib/assert/is-uint64/package.json new file mode 100644 index 000000000000..186a68987097 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/package.json @@ -0,0 +1,73 @@ +{ + "name": "@stdlib/assert/is-uint64", + "version": "0.0.0", + "description": "Test if a value is an unsigned 64-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", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "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", + "stdassert", + "assertion", + "assert", + "utilities", + "utility", + "utils", + "util", + "is", + "isuint64", + "uint64", + "unsigned", + "64-bit", + "integer", + "type", + "check", + "test", + "validate", + "isvalid", + "valid" + ] +} diff --git a/lib/node_modules/@stdlib/assert/is-uint64/test/test.js b/lib/node_modules/@stdlib/assert/is-uint64/test/test.js new file mode 100644 index 000000000000..fea8d9fe40eb --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-uint64/test/test.js @@ -0,0 +1,63 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var isUint64 = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof isUint64, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `true` if provided an unsigned 64-bit integer', function test( t ) { + t.strictEqual( isUint64( new Uint64( 1234 ) ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns `false` if not provided an unsigned 64-bit integer', function test( t ) { + var values; + var i; + + values = [ + 5, + '5', + null, + void 0, + NaN, + true, + [], + {}, + new Complex128( 2.0, 2.0 ), + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( isUint64( values[i] ), false, 'returns false when provided '+values[i] ); + } + t.end(); +});