feat(number): add number/uint64/ctor

lib/node_modules/@stdlib/number/uint64/ctor/README.md

@@ -0,0 +1,268 @@
+<!--
+
+@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.
+
+-->
+
+# Uint64
+
+> Unsigned 64-bit integer.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var Uint64 = require( '@stdlib/number/uint64/ctor' );
+```
+
+#### Uint64( value )
+
+Unsigned 64-bit integer constructor.
+
+```javascript
+var x = new Uint64( 5 );
+// returns <Uint64>
+```
+
+* * *
+
+## Properties
+
+#### Uint64.name
+
+Static property returning the constructor name.
+
+```javascript
+var str = Uint64.name;
+// returns 'Uint64'
+```
+
+#### Uint64.BYTES_PER_ELEMENT
+
+Size (in bytes) of the underlying value.
+
+```javascript
+var nbytes = Uint64.BYTES_PER_ELEMENT;
+// returns 8
+```
+
+#### Uint64.prototype.BYTES_PER_ELEMENT
+
+Size (in bytes) of the underlying value.
+
+```javascript
+var x = new Uint64( 5 );
+
+var nbytes = x.BYTES_PER_ELEMENT;
+// returns 8
+```
+
+#### Uint64.prototype.byteLength
+
+Size (in bytes) of the underlying value.
+
+```javascript
+var x = new Uint64( 5 );
+
+var nbytes = x.byteLength;
+// returns 8
+```
+
+#### Uint64.prototype.hi
+
+High 32-bit word of an unsigned 64-bit integer.
+
+```javascript
+var x = Uint64.from( [ 1234, 5678 ] );
+
+var w = x.hi;
+// returns 1234
+```
+
+#### Uint64.prototype.lo
+
+Low 32-bit word of an unsigned 64-bit integer.
+
+```javascript
+var x = Uint64.from( [ 1234, 5678 ] );
+
+var w = x.lo;
+// returns 5678
+```
+
+* * *
+
+## Methods
+
+### Static Methods
+
+#### Uint64.from( array )
+
+Creates a new unsigned 64-bit integer from an array-like object containing a high and low word.
+
+```javascript
+var x = Uint64.from( [ 1234, 5678 ] );
+// returns <Uint64>
+```
+
+#### Uint64.of( high, low )
+
+Creates a new unsigned 64-bit integer from a high and low word.
+
+```javascript
+var x = Uint64.of( 1234, 5678 );
+// returns <Uint64>
+```
+
+### Accessor Methods
+
+These methods do **not** mutate a `Uint64` instance and, instead, return an unsigned 64-bit integer representation.
+
+#### Uint64.prototype.toString()
+
+Returns a string representation of a `Uint64` instance.
+
+```javascript
+var x = new Uint64( 5 );
+var str = x.toString();
+// returns '5'
+```
+
+#### Uint64.prototype.toJSON()
+
+Returns a [JSON][json] representation of a `Uint64` instance. [`JSON.stringify()`][mdn-json-stringify] implicitly calls this method when stringifying a `Uint64` instance.
+
+```javascript
+var x = new Uint64( 5 );
+
+var o = x.toJSON();
+/*
+  {
+    "type": "Uint64",
+    "high": 0,
+    "low": 5
+  }
+*/
+```
+
+To [revive][mdn-json-parse] a `Uint64` instance from a [JSON][json] string, see [@stdlib/number/uint64/reviver][@stdlib/number/uint64/reviver].
+
+#### Uint64.prototype.valueOf()
+
+Converts a `Uint64` instance to a primitive value.
+
+```javascript
+var x = new Uint64( 5 );
+
+var v = x.valueOf();
+// e.g., returns <bigint>
+```
+
+</section>
+
+<!-- /.usage -->
+
+* * *
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   An unsigned 64-bit integer has a range of \[`0`, `2^64-1`\].
+
+</section>
+
+<!-- /.notes -->
+
+* * *
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Uint64 = require( '@stdlib/number/uint64/ctor' );
+
+var x = new Uint64( 1234 );
+
+console.log( 'type: %s', typeof x );
+// => 'type: object'
+
+console.log( 'str: %s', x );
+// => 'str: 1234'
+
+console.log( 'JSON: %s', JSON.stringify( x ) );
+// => 'JSON: {"type":"Uint64","words":[0,1234]}'
+```
+
+</section>
+
+<!-- /.examples -->
+
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[json]: http://www.json.org/
+
+[mdn-json-stringify]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
+
+[mdn-json-parse]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse
+
+[@stdlib/number/uint64/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint64/reviver
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/number/uint64/ctor/benchmark/benchmark.js

@@ -0,0 +1,95 @@
+/**
+* @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 randi = require( '@stdlib/random/base/randi' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var Uint64 = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s::constructor', pkg ), function benchmark( b ) {
+	var z;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		z = new Uint64( i );
+		if ( typeof z !== 'object' ) {
+			b.fail( 'should return a Uint64 instance' );
+		}
+	}
+	b.toc();
+	if ( !( z instanceof Uint64 ) ) {
+		b.fail( 'should return a Uint64 instance' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+// FIXME: add additional benchmarks
+
+bench( format( '%s:toString', pkg ), function benchmark( b ) {
+	var o;
+	var z;
+	var i;
+
+	z = new Uint64( randi() );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		o = z.toString();
+		if ( typeof o !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+	}
+	b.toc();
+	if ( typeof o !== 'string' ) {
+		b.fail( 'should return a string' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:toJSON', pkg ), function benchmark( b ) {
+	var o;
+	var z;
+	var i;
+
+	z = new Uint64( randi() );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		o = z.toJSON();
+		if ( typeof o !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( typeof o !== 'object' ) {
+		b.fail( 'should return an object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});