Skip to content

stdlib-js/number-uint64-base-string2words

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

string2words

NPM version Build Status Coverage Status

Parse a string representation of a 64-bit unsigned integer into high and low 32-bit words.

Installation

npm install @stdlib/number-uint64-base-string2words

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

Usage

var string2words = require( '@stdlib/number-uint64-base-string2words' );

string2words( str, radix )

Parses a string representation of a 64-bit unsigned integer into high and low 32-bit words.

var w = string2words( '1234', 10 );
// returns [ 0, 1234 ]

The function returns an array containing two elements: a higher order word and a lower order word. The lower order word contains the less significant bits, while the higher order word contains the more significant bits.

string2words.assign( str, radix, out, stride, offset )

Parses a string representation of a 64-bit unsigned integer into high and low 32-bit words and assigns results to a provided output array.

var Uint32Array = require( '@stdlib/array-uint32' );

var out = new Uint32Array( 2 );
// returns <Uint32Array>[ 0, 0 ]

var w = string2words.assign( 'ffffffffffffffff', 16, out, 1, 0 );
// returns <Uint32Array>[ 4294967295, 4294967295 ]

var bool = ( w === out );
// returns true

Notes

  • The input string must be a valid representation of an unsigned 64-bit integer in the specified radix, containing no whitespace, sign symbols, or leading zeros.
  • If the provided string represents a value greater than 2^64-1 or the radix is not an integer on the interval [2, 36], the function throws a RangeError.

Examples

var string2words = require( '@stdlib/number-uint64-base-string2words' );

var w = string2words( '1234', 10 );
console.log( w );
// => [ 0, 1234 ]

w = string2words( 'abcd', 16 );
console.log( w );
// => [ 0, 43981 ]

w = string2words( '18446744073709551615', 10 );
console.log( w );
// => [ 4294967295, 4294967295 ]

w = string2words( '3w5e11264sgsf', 36 );
console.log( w );
// => [ 4294967295, 4294967295 ]

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2026. The Stdlib Authors.

About

Parse a string representation of a 64-bit unsigned integer into high and low 32-bit words.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors