diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/README.md b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/README.md new file mode 100644 index 000000000000..61ae4bcfdd84 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/README.md @@ -0,0 +1,100 @@ + + +# High Word + +> Return an unsigned 32-bit integer corresponding to the high 32-bit word of a [64-bit unsigned integer][@stdlib/number/uint64/ctor]. + +
+ +## Usage + +```javascript +var getHighWord = require( '@stdlib/number/uint64/base/get-high-word' ); +``` + +#### getHighWord( x ) + +Returns an unsigned 32-bit `integer` corresponding to the high 32-bit word of a [64-bit unsigned integer][@stdlib/number/uint64/ctor]. + +```javascript +var Uint64 = require( '@stdlib/number/uint64/ctor' ); + +var a = new Uint64( 4294967296 ); +var w = getHighWord( a ); +// returns 1 +``` + +
+ + + +
+ +## Examples + + + +```javascript +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var getHighWord = require( '@stdlib/number/uint64/base/get-high-word' ); + +var a = new Uint64( 4294967296 ); +console.log( getHighWord( a ) ); +// => 1 + +a = new Uint64( 0xffffffff ); +console.log( getHighWord( a ) ); +// => 0 + +a = new Uint64( 0x123400005678 ); +console.log( getHighWord( a ) ); +// => 4660 + +a = new Uint64.of( 1234, 5678 ); +console.log( getHighWord( a ) ); +// => 1234 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[@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/number/uint64/base/get-high-word/benchmark/benchmark.js b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/benchmark/benchmark.js new file mode 100644 index 000000000000..301d6b3b77ce --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/benchmark/benchmark.js @@ -0,0 +1,66 @@ +/** +* @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 isnan = require( '@stdlib/assert/is-nan' ).isPrimitive; +var bench = require( '@stdlib/bench' ); +var MAX_SAFE_INTEGER = require( '@stdlib/constants/float64/max-safe-integer' ); +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var pkg = require( './../package.json' ).name; +var getHighWord = require( './../lib' ); + + +// VARIABLES // + +var rand = discreteUniform.factory( 0, MAX_SAFE_INTEGER ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var values; + var N; + var a; + var i; + var w; + + N = 100; + values = []; + for ( i = 0; i < N; i++ ) { + values.push( new Uint64( rand() ) ); + } + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + a = values[ i % N ]; + w = getHighWord( a ); + if ( isnan( w ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( w ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/repl.txt b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/repl.txt new file mode 100644 index 000000000000..2701a145c081 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/repl.txt @@ -0,0 +1,25 @@ + +{{alias}}( x ) + Returns an unsigned 32-bit integer corresponding to the high 32-bit word of + a 64-bit unsigned integer. + + Parameters + ---------- + x: Uint64 + Input value. + + Returns + ------- + out: integer + Higher order word (unsigned 32-bit integer). + + Examples + -------- + > var a = new {{alias:@stdlib/number/uint64/ctor}}( 4294967296 ) + [ 4294967296n ] + > var w = {{alias}}( a ) + 1 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/index.d.ts b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/index.d.ts new file mode 100644 index 000000000000..4cb51a84cfe6 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/index.d.ts @@ -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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Uint64 } from '@stdlib/types/number'; + +/** +* Returns an unsigned 32-bit integer corresponding to the high 32-bit word of a 64-bit unsigned integer. +* +* @param a - input value +* @returns higher order word (unsigned 32-bit integer) +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* +* var a = new Uint64( 4294967296 ); +* var w = getHighWord( a ); +* // returns 1 +*/ +declare function getHighWord( a: Uint64 ): number; + + +// EXPORTS // + +export = getHighWord; diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/test.ts b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/test.ts new file mode 100644 index 000000000000..428180fdf0ea --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/docs/types/test.ts @@ -0,0 +1,47 @@ +/* +* @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 Uint64 = require( '@stdlib/number/uint64/ctor' ); +import getHighWord = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const a = new Uint64( 5 ); + getHighWord( a ); // $ExpectType number +} + +// The compiler throws an error if the function is provided an argument that is not a 64-bit unsigned integer... +{ + getHighWord( 5 ); // $ExpectError + getHighWord( '5' ); // $ExpectError + getHighWord( true ); // $ExpectError + getHighWord( false ); // $ExpectError + getHighWord( [] ); // $ExpectError + getHighWord( {} ); // $ExpectError + getHighWord( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const a = new Uint64( 5 ); + getHighWord(); // $ExpectError + getHighWord( a, a ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/examples/index.js b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/examples/index.js new file mode 100644 index 000000000000..9b91768807cf --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/examples/index.js @@ -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. +*/ + +'use strict'; + +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var getHighWord = require( './../lib' ); + +var a = new Uint64( 4294967296 ); +console.log( getHighWord( a ) ); +// => 1 + +a = new Uint64( 0xffffffff ); +console.log( getHighWord( a ) ); +// => 0 + +a = new Uint64( 0x123400005678 ); +console.log( getHighWord( a ) ); +// => 4660 + +a = new Uint64.of( 1234, 5678 ); +console.log( getHighWord( a ) ); +// => 1234 diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/index.js b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/index.js new file mode 100644 index 000000000000..d3b63c5fe2b6 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/index.js @@ -0,0 +1,42 @@ +/** +* @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'; + +/** +* Return an unsigned 32-bit integer corresponding to the high 32-bit word of a 64-bit unsigned integer. +* +* @module @stdlib/number/uint64/base/get-high-word +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* var getHighWord = require( '@stdlib/number/uint64/base/get-high-word' ); +* +* var a = new Uint64( 4294967296 ); +* var w = getHighWord( a ); +* // returns 1 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/main.js b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/main.js new file mode 100644 index 000000000000..6d86c5434bd5 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/lib/main.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'; + +// MAIN // + +/** +* Returns an unsigned 32-bit integer corresponding to the high 32-bit word of a 64-bit unsigned integer. +* +* @param {Uint64} a - input value +* @returns {uinteger32} higher order word +* +* @example +* var Uint64 = require( '@stdlib/number/uint64/ctor' ); +* +* var a = new Uint64( 4294967296 ); +* var w = getHighWord( a ); +* // returns 1 +*/ +function getHighWord( a ) { + return a.hi; +} + + +// EXPORTS // + +module.exports = getHighWord; diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/package.json b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/package.json new file mode 100644 index 000000000000..8022d4b9e328 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/package.json @@ -0,0 +1,69 @@ +{ + "name": "@stdlib/number/uint64/base/get-high-word", + "version": "0.0.0", + "description": "Return an unsigned 32-bit integer corresponding to the high 32-bit word of a 64-bit unsigned 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", + "stdtypes", + "base", + "utilities", + "utility", + "utils", + "util", + "types", + "type", + "uint64", + "unsigned", + "64-bit", + "integer", + "int", + "high", + "word" + ] +} diff --git a/lib/node_modules/@stdlib/number/uint64/base/get-high-word/test/test.js b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/test/test.js new file mode 100644 index 000000000000..82056122d2b4 --- /dev/null +++ b/lib/node_modules/@stdlib/number/uint64/base/get-high-word/test/test.js @@ -0,0 +1,83 @@ +/** +* @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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; +var UINT32_MAX = require( '@stdlib/constants/uint32/max' ); +var Uint64 = require( '@stdlib/number/uint64/ctor' ); +var getHighWord = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof getHighWord, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an integer', function test( t ) { + var a; + var w; + + a = new Uint64( 4294967296 ); + w = getHighWord( a ); + + t.ok( isInteger( w ), 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns the high 32-bit word of a 64-bit unsigned integer', function test( t ) { + var values; + var a; + var v; + var w; + var i; + + values = [ + 0, + 1, + 2, + 3, + 4, + 5, + 10, + 99, + 100, + 999, + 1000, + 999999, + 1000000, + 999999999, + 1000000000, + UINT32_MAX + ]; + + for ( i = 0; i < values.length; i++ ) { + v = values[ i ]; + a = Uint64.of( v, 0 ); + w = getHighWord( a ); + t.strictEqual( w, v, 'returns expected value' ); + } + t.end(); +});