bigintAbsolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
numberReturns the bitlength of a number
egcdReturnAn iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm. Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).
bigintGreatest-common divisor of two integers based on the iterative binary algorithm.
bigintThe least common multiple computed as abs(a*b)/gcd(a,b)
bigintMaximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
bigintMinimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
bigint | NaNModular inverse.
bigintModular exponentiation b**e mod n. Currently using the right-to-left binary method
bigintFinds the smallest positive element that is congruent to a in modulo n
Promise.<boolean>The test first tries if any of the first 250 small primes are a factor of the input number and then passes several iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)
Promise.<bigint>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI main process, and it can be much faster (if several cores or cpu are available). The node version can also use worker_threads if they are available (enabled by default with Node 11 and and can be enabled at runtime executing node --experimental-worker with node >=10.5.0).
bigintA probably-prime (Miller-Rabin), cryptographically-secure, random-number generator. The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be slower and may freeze thw window in browser's javascript. Please consider using prime() instead.
bigintReturns a cryptographically secure random integer between [min,max]. Both numbers must be >=0
Promise.<(Buffer|Uint8Array)>Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Buffer | Uint8ArraySecure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
Promise.<(Buffer|Uint8Array)>Secure random bytes for both node and browsers. Node version uses crypto.randomBytes() and browser one self.crypto.getRandomValues()
Buffer | Uint8ArraySecure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
ObjectA triple (g, x, y), such that ax + by = g = gcd(a, b).
bigint
Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
**Kind**: global function
**Returns**: bigint - the absolute value of a
| Param | Type |
| --- | --- |
| a | number \| bigint |
### bitLength(a) ⇒ number
Returns the bitlength of a number
**Kind**: global function
**Returns**: number - - the bit length
| Param | Type |
| --- | --- |
| a | number \| bigint |
### eGcd(a, b) ⇒ [egcdReturn](#egcdReturn)
An iterative implementation of the extended euclidean algorithm or extended greatest common divisor algorithm.
Take positive integers a, b as input, and return a triple (g, x, y), such that ax + by = g = gcd(a, b).
**Kind**: global function
**Returns**: [egcdReturn](#egcdReturn) - A triple (g, x, y), such that ax + by = g = gcd(a, b).
| Param | Type |
| --- | --- |
| a | number \| bigint |
| b | number \| bigint |
### gcd(a, b) ⇒ bigint
Greatest-common divisor of two integers based on the iterative binary algorithm.
**Kind**: global function
**Returns**: bigint - The greatest common divisor of a and b
| Param | Type |
| --- | --- |
| a | number \| bigint |
| b | number \| bigint |
### lcm(a, b) ⇒ bigint
The least common multiple computed as abs(a*b)/gcd(a,b)
**Kind**: global function
**Returns**: bigint - The least common multiple of a and b
| Param | Type |
| --- | --- |
| a | number \| bigint |
| b | number \| bigint |
### max(a, b) ⇒ bigint
Maximum. max(a,b)==a if a>=b. max(a,b)==b if a<=b
**Kind**: global function
**Returns**: bigint - maximum of numbers a and b
| Param | Type |
| --- | --- |
| a | number \| bigint |
| b | number \| bigint |
### min(a, b) ⇒ bigint
Minimum. min(a,b)==b if a>=b. min(a,b)==a if a<=b
**Kind**: global function
**Returns**: bigint - minimum of numbers a and b
| Param | Type |
| --- | --- |
| a | number \| bigint |
| b | number \| bigint |
### modInv(a, n) ⇒ bigint \| NaN
Modular inverse.
**Kind**: global function
**Returns**: bigint \| NaN - the inverse modulo n or NaN if it does not exist
| Param | Type | Description |
| --- | --- | --- |
| a | number \| bigint | The number to find an inverse for |
| n | number \| bigint | The modulo |
### modPow(b, e, n) ⇒ bigint
Modular exponentiation b**e mod n. Currently using the right-to-left binary method
**Kind**: global function
**Returns**: bigint - b**e mod n
| Param | Type | Description |
| --- | --- | --- |
| b | number \| bigint | base |
| e | number \| bigint | exponent |
| n | number \| bigint | modulo |
### toZn(a, n) ⇒ bigint
Finds the smallest positive element that is congruent to a in modulo n
**Kind**: global function
**Returns**: bigint - The smallest positive representation of a in modulo n
| Param | Type | Description |
| --- | --- | --- |
| a | number \| bigint | An integer |
| n | number \| bigint | The modulo |
### isProbablyPrime(w, [iterations], [disableWorkers]) ⇒ Promise.<boolean>
The test first tries if any of the first 250 small primes are a factor of the input number and then passes several
iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)
**Kind**: global function
**Returns**: Promise.<boolean> - A promise that resolves to a boolean that is either true (a probably prime number) or false (definitely composite)
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| w | number \| bigint | | An integer to be tested for primality |
| [iterations] | number | 16 | The number of iterations for the primality test. The value shall be consistent with Table C.1, C.2 or C.3 |
| [disableWorkers] | boolean | false | Disable the use of workers for the primality test |
### prime(bitLength, [iterations]) ⇒ Promise.<bigint>
A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
main process, and it can be much faster (if several cores or cpu are available).
The node version can also use worker_threads if they are available (enabled by default with Node 11 and
and can be enabled at runtime executing node --experimental-worker with node >=10.5.0).
**Kind**: global function
**Returns**: Promise.<bigint> - A promise that resolves to a bigint probable prime of bitLength bits.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| bitLength | number | | The required bit length for the generated prime |
| [iterations] | number | 16 | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
### primeSync(bitLength, [iterations]) ⇒ bigint
A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
The sync version is NOT RECOMMENDED since it won't use workers and thus it'll be slower and may freeze thw window in browser's javascript. Please consider using prime() instead.
**Kind**: global function
**Returns**: bigint - A bigint probable prime of bitLength bits.
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| bitLength | number | | The required bit length for the generated prime |
| [iterations] | number | 16 | The number of iterations for the Miller-Rabin Probabilistic Primality Test |
### randBetween(max, [min]) ⇒ bigint
Returns a cryptographically secure random integer between [min,max]. Both numbers must be >=0
**Kind**: global function
**Returns**: bigint - A cryptographically secure random bigint between [min,max]
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| max | bigint | | Returned value will be <= max |
| [min] | bigint | BigInt(1) | Returned value will be >= min |
### randBits(bitLength, [forceLength]) ⇒ Promise.<(Buffer\|Uint8Array)>
Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
**Kind**: global function
**Returns**: Promise.<(Buffer\|Uint8Array)> - A Promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| bitLength | number | | The desired number of random bits |
| [forceLength] | boolean | false | If we want to force the output to have a specific bit length. It basically forces the msb to be 1 |
### randBitsSync(bitLength, [forceLength]) ⇒ Buffer \| Uint8Array
Secure random bits for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
**Kind**: global function
**Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bits
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| bitLength | number | | The desired number of random bits |
| [forceLength] | boolean | false | If we want to force the output to have a specific bit length. It basically forces the msb to be 1 |
### randBytes(byteLength, [forceLength]) ⇒ Promise.<(Buffer\|Uint8Array)>
Secure random bytes for both node and browsers. Node version uses crypto.randomBytes() and browser one self.crypto.getRandomValues()
**Kind**: global function
**Returns**: Promise.<(Buffer\|Uint8Array)> - A promise that resolves to a Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| byteLength | number | | The desired number of random bytes |
| [forceLength] | boolean | false | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
### randBytesSync(byteLength, [forceLength]) ⇒ Buffer \| Uint8Array
Secure random bytes for both node and browsers. Node version uses crypto.randomFill() and browser one self.crypto.getRandomValues()
**Kind**: global function
**Returns**: Buffer \| Uint8Array - A Buffer/UInt8Array (Node.js/Browser) filled with cryptographically secure random bytes
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| byteLength | number | | The desired number of random bytes |
| [forceLength] | boolean | false | If we want to force the output to have a bit length of 8*byteLength. It basically forces the msb to be 1 |
### egcdReturn : Object
A triple (g, x, y), such that ax + by = g = gcd(a, b).
**Kind**: global typedef
**Properties**
| Name | Type |
| --- | --- |
| g | bigint |
| x | bigint |
| y | bigint |