bigintAbsolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
-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)
-bigintModular inverse.
-bigintModular exponentiation a**b mod n
-bigintFinds the smallest positive element that is congruent to a in modulo n
-ObjectA triple (g, x, y), such that ax + by = g = gcd(a, b).
-bigint
+### abs(a) ⇒ bigint
Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
**Kind**: global function
@@ -109,13 +88,26 @@ Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
| --- | --- |
| 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.
+### 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 |
| --- | --- |
@@ -124,7 +116,7 @@ Take positive integers a, b as input, and return a triple (g, x, y), such that a
-## gcd(a, b) ⇒ bigint
+### gcd(a, b) ⇒ bigint
Greatest-common divisor of two integers based on the iterative binary algorithm.
**Kind**: global function
@@ -137,7 +129,7 @@ Greatest-common divisor of two integers based on the iterative binary algorithm.
-## lcm(a, b) ⇒ bigint
+### lcm(a, b) ⇒ bigint
The least common multiple computed as abs(a*b)/gcd(a,b)
**Kind**: global function
@@ -148,13 +140,39 @@ The least common multiple computed as abs(a*b)/gcd(a,b)
| 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
+### modInv(a, n) ⇒ bigint
Modular inverse.
**Kind**: global function
-**Returns**: bigint - the inverse modulo n
+**Returns**: bigint - the inverse modulo n or NaN if it does not exist
| Param | Type | Description |
| --- | --- | --- |
@@ -163,21 +181,21 @@ Modular inverse.
-## modPow(a, b, n) ⇒ bigint
-Modular exponentiation a**b mod n
+### modPow(b, e, n) ⇒ bigint
+Modular exponentiation b**e mod n. Currently using the right-to-left binary method
**Kind**: global function
-**Returns**: bigint - a**b mod n
+**Returns**: bigint - b**e mod n
| Param | Type | Description |
| --- | --- | --- |
-| a | number \| bigint | base |
-| b | number \| bigint | exponent |
+| b | number \| bigint | base |
+| e | number \| bigint | exponent |
| n | number \| bigint | modulo |
-## toZn(a, n) ⇒ bigint
+### toZn(a, n) ⇒ bigint
Finds the smallest positive element that is congruent to a in modulo n
**Kind**: global function
@@ -190,7 +208,7 @@ Finds the smallest positive element that is congruent to a in modulo n
-## egcdReturn : Object
+### egcdReturn : Object
A triple (g, x, y), such that ax + by = g = gcd(a, b).
**Kind**: global typedef
@@ -202,5 +220,3 @@ A triple (g, x, y), such that ax + by = g = gcd(a, b).
| x | bigint |
| y | bigint |
-
-* * *
\ No newline at end of file
diff --git a/build/build.dts.js b/build/build.dts.js
new file mode 100644
index 0000000..bedea02
--- /dev/null
+++ b/build/build.dts.js
@@ -0,0 +1,25 @@
+const fs = require('fs')
+const ts = require('typescript')
+const path = require('path')
+const pkgJson = require('../package.json')
+
+const rootDir = path.join(__dirname, '..')
+const jsFile = path.join(rootDir, pkgJson.browser)
+const dtsFile = path.join(rootDir, pkgJson.types)
+
+const compilerOptions = {
+ declaration: true,
+ noEmit: false,
+ emitDeclarationOnly: true,
+ allowJs: true
+}
+
+const host = ts.createCompilerHost(compilerOptions)
+
+host.writeFile = (fileName, contents) => {
+ fs.writeFileSync(dtsFile, contents)
+}
+
+// Prepare and emit the d.ts files
+const program = ts.createProgram([jsFile], compilerOptions, host)
+program.emit()
diff --git a/build/build.rollup.js b/build/build.rollup.js
deleted file mode 100644
index 8b7c4bc..0000000
--- a/build/build.rollup.js
+++ /dev/null
@@ -1,102 +0,0 @@
-'use strict';
-
-const rollup = require('rollup');
-const minify = require('rollup-plugin-babel-minify');
-const fs = require('fs');
-const path = require('path');
-const pkgJson = require('../package.json');
-
-const rootDir = path.join(__dirname, '..');
-const srcDir = path.join(rootDir, 'src');
-const dstDir = path.join(rootDir, 'dist');
-
-const buildOptions = [
- { // Browser
- input: {
- input: path.join(srcDir, 'main.js')
- },
- output: {
- file: path.join(dstDir, `${pkgJson.name}-${pkgJson.version}.browser.js`),
- format: 'iife',
- name: camelise(pkgJson.name)
- }
- },
- { // Browser minified
- input: {
- input: path.join(srcDir, 'main.js'),
- plugins: [
- minify({
- 'comments': false
- })
- ],
- },
- output: {
- file: path.join(dstDir, `${pkgJson.name}-${pkgJson.version}.browser.min.js`),
- format: 'iife',
- name: camelise(pkgJson.name)
- }
- },
- { // Browser esm
- input: {
- input: path.join(srcDir, 'main.js')
- },
- output: {
- file: path.join(dstDir, `${pkgJson.name}-${pkgJson.version}.browser.mod.js`),
- format: 'esm'
- }
- },
- { // Browser esm minified
- input: {
- input: path.join(srcDir, 'main.js'),
- plugins: [
- minify({
- 'comments': false
- })
- ],
- },
- output: {
- file: path.join(dstDir, `${pkgJson.name}-${pkgJson.version}.browser.mod.min.js`),
- format: 'esm'
- }
- },
- { // Node
- input: {
- input: path.join(srcDir, 'main.js'),
- },
- output: {
- file: path.join(dstDir, `${pkgJson.name}-${pkgJson.version}.node.js`),
- format: 'cjs'
- }
- }
-];
-
-for (const options of buildOptions) {
- build(options);
-}
-
-
-/* --- HELPLER FUNCTIONS --- */
-
-async function build(options) {
- // create a bundle
- const bundle = await rollup.rollup(options.input);
-
- // generate code
- await bundle.generate(options.output);
-
- // or write the bundle to disk
- await bundle.write(options.output);
-
- // copy the latest build as pkg_name-latest
- fs.copyFileSync(
- options.output.file,
- options.output.file.replace(`${pkgJson.name}-${pkgJson.version}.`, `${pkgJson.name}-latest.`)
- );
-}
-
-function camelise(str) {
- return str.replace(/-([a-z])/g,
- function (m, w) {
- return w.toUpperCase();
- });
-}
\ No newline at end of file
diff --git a/build/rollup.config.js b/build/rollup.config.js
new file mode 100644
index 0000000..018fa2c
--- /dev/null
+++ b/build/rollup.config.js
@@ -0,0 +1,82 @@
+'use strict'
+
+const resolve = require('@rollup/plugin-node-resolve')
+const replace = require('@rollup/plugin-replace')
+const { terser } = require('rollup-plugin-terser')
+
+const path = require('path')
+const pkgJson = require('../package.json')
+
+const rootDir = path.join(__dirname, '..')
+const srcDir = path.join(rootDir, pkgJson.directories.src)
+const dstDir = path.join(rootDir, pkgJson.directories.lib)
+
+function camelise (str) {
+ console.log('camelise', str)
+ return str.replace(/-([a-z])/g,
+ function (m, w) {
+ return w.toUpperCase()
+ })
+}
+
+const pkgName = pkgJson.name
+const pkgCamelisedName = camelise(pkgName)
+
+const input = path.join(srcDir, 'js', 'index.js')
+
+module.exports = [
+ { // ESM native module
+ input: input,
+ output: [
+ {
+ file: path.join(dstDir, 'index.browser.mod.js'),
+ format: 'esm'
+ }
+ ],
+ plugins: [
+ replace({
+ 'process.browser': true
+ })
+ ]
+ // external: ['bigint-crypto-utils']
+ },
+ { // Browser bundles
+ input: input,
+ output: [
+ {
+ file: path.join(dstDir, 'index.browser.bundle.js'),
+ format: 'iife',
+ name: pkgCamelisedName
+ },
+ {
+ file: path.join(dstDir, 'index.browser.bundle.mod.js'),
+ format: 'es'
+ }
+ ],
+ plugins: [
+ replace({
+ 'process.browser': true
+ }),
+ resolve({
+ browser: true
+ }),
+ terser({
+ mangle: false,
+ compress: false
+ })
+ ]
+ },
+ { // Node
+ input: input,
+ plugins: [
+ replace({
+ 'process.browser': false
+ })
+ ],
+ output: {
+ file: path.join(dstDir, 'index.node.js'),
+ format: 'cjs'
+ }
+ // external: ['bigint-crypto-utils']
+ }
+]
diff --git a/build/rollup.tests.config.js b/build/rollup.tests.config.js
new file mode 100644
index 0000000..b5da420
--- /dev/null
+++ b/build/rollup.tests.config.js
@@ -0,0 +1,62 @@
+'use strict'
+
+const resolve = require('@rollup/plugin-node-resolve')
+const replace = require('@rollup/plugin-replace')
+const commonjs = require('@rollup/plugin-commonjs')
+const multi = require('@rollup/plugin-multi-entry')
+
+const fs = require('fs')
+const path = require('path')
+const pkgJson = require('../package.json')
+const pkgJsonLock = require('../package-lock.json')
+const mochaVersion = pkgJsonLock.dependencies.mocha.version
+const chaiVersion = pkgJsonLock.dependencies.chai.version
+const pkgName = pkgJson.name
+
+const rootDir = path.join(__dirname, '..')
+
+// Let's first create the appropriate html file loading mocha, chai and a bundle of the tests
+const templatePath = path.join(rootDir, pkgJson.directories.src, 'browser', 'tests-template.html')
+const dstDir = path.join(rootDir, pkgJson.directories.test, 'browser')
+const dstFileName = path.join(dstDir, 'index.html')
+
+const template = fs.readFileSync(templatePath, 'utf-8')
+const bundleFile = path.join(rootDir, pkgJson.directories.lib, 'index.browser.bundle.mod.js')
+const testsJs = `
+ `
+
+fs.writeFileSync(dstFileName,
+ template.replace(/{{TESTS}}/g, testsJs).replace(/{{PKG_NAME}}/g, pkgName).replace(/{{MOCHA_VERSION}}/g, mochaVersion).replace(/{{CHAI_VERSION}}/g, chaiVersion)
+)
+
+const input = path.join(rootDir, pkgJson.directories.test, '*.js')
+console.log(input)
+
+module.exports = [
+ {
+ input: input,
+ plugins: [
+ multi({ exports: false }),
+ replace({
+ 'const _pkg = require(\'../lib/index.node\')': '',
+ 'const chai = require(\'chai\')': '',
+ delimiters: ['', ''],
+ 'process.browser': true
+ }),
+ resolve({
+ browser: true
+ }),
+ commonjs()
+ ],
+ output: {
+ file: path.join(rootDir, pkgJson.directories.test, 'browser', 'tests.js'),
+ format: 'esm'
+ },
+ external: [pkgName]
+ }
+]
diff --git a/dist/bigint-mod-arith-latest.browser.js b/dist/bigint-mod-arith-latest.browser.js
deleted file mode 100644
index 51de4da..0000000
--- a/dist/bigint-mod-arith-latest.browser.js
+++ /dev/null
@@ -1,178 +0,0 @@
-var bigintModArith = (function (exports) {
- 'use strict';
-
- const _ZERO = BigInt(0);
- const _ONE = BigInt(1);
- const _TWO = BigInt(2);
-
- /**
- * Absolute value. abs(a)==a if a>=0. abs(a)==-a if a<0
- *
- * @param {number|bigint} a
- *
- * @returns {bigint} the absolute value of a
- */
- function abs(a) {
- a = BigInt(a);
- return (a >= _ZERO) ? a : -a;
- }
-
- /**
- * @typedef {Object} egcdReturn A triple (g, x, y), such that ax + by = g = gcd(a, b).
- * @property {bigint} g
- * @property {bigint} x
- * @property {bigint} y
- */
- /**
- * 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).
- *
- * @param {number|bigint} a
- * @param {number|bigint} b
- *
- * @returns {egcdReturn}
- */
- function eGcd(a, b) {
- a = BigInt(a);
- b = BigInt(b);
- let x = _ZERO;
- let y = _ONE;
- let u = _ONE;
- let v = _ZERO;
-
- while (a !== _ZERO) {
- let q = b / a;
- let r = b % a;
- let m = x - (u * q);
- let n = y - (v * q);
- b = a;
- a = r;
- x = u;
- y = v;
- u = m;
- v = n;
- }
- return {
- b: b,
- x: x,
- y: y
- };
- }
-
- /**
- * Greatest-common divisor of two integers based on the iterative binary algorithm.
- *
- * @param {number|bigint} a
- * @param {number|bigint} b
- *
- * @returns {bigint} The greatest common divisor of a and b
- */
- function gcd(a, b) {
- a = abs(a);
- b = abs(b);
- let shift = _ZERO;
- while (!((a | b) & _ONE)) {
- a >>= _ONE;
- b >>= _ONE;
- shift++;
- }
- while (!(a & _ONE)) a >>= _ONE;
- do {
- while (!(b & _ONE)) b >>= _ONE;
- if (a > b) {
- let x = a;
- a = b;
- b = x;
- }
- b -= a;
- } while (b);
-
- // rescale
- return a << shift;
- }
-
- /**
- * The least common multiple computed as abs(a*b)/gcd(a,b)
- * @param {number|bigint} a
- * @param {number|bigint} b
- *
- * @returns {bigint} The least common multiple of a and b
- */
- function lcm(a, b) {
- a = BigInt(a);
- b = BigInt(b);
- return abs(a * b) / gcd(a, b);
- }
-
- /**
- * Modular inverse.
- *
- * @param {number|bigint} a The number to find an inverse for
- * @param {number|bigint} n The modulo
- *
- * @returns {bigint} the inverse modulo n
- */
- function modInv(a, n) {
- let egcd = eGcd(a, n);
- if (egcd.b !== _ONE) {
- return null; // modular inverse does not exist
- } else {
- return toZn(egcd.x, n);
- }
- }
-
- /**
- * Modular exponentiation a**b mod n
- * @param {number|bigint} a base
- * @param {number|bigint} b exponent
- * @param {number|bigint} n modulo
- *
- * @returns {bigint} a**b mod n
- */
- function modPow(a, b, n) {
- // See Knuth, volume 2, section 4.6.3.
- n = BigInt(n);
- a = toZn(a, n);
- b = BigInt(b);
- if (b < _ZERO) {
- return modInv(modPow(a, abs(b), n), n);
- }
- let result = _ONE;
- let x = a;
- while (b > 0) {
- var leastSignificantBit = b % _TWO;
- b = b / _TWO;
- if (leastSignificantBit == _ONE) {
- result = result * x;
- result = result % n;
- }
- x = x * x;
- x = x % n;
- }
- return result;
- }
-
- /**
- * Finds the smallest positive element that is congruent to a in modulo n
- * @param {number|bigint} a An integer
- * @param {number|bigint} n The modulo
- *
- * @returns {bigint} The smallest positive representation of a in modulo n
- */
- function toZn(a, n) {
- n = BigInt(n);
- a = BigInt(a) % n;
- return (a < 0) ? a + n : a;
- }
-
- exports.abs = abs;
- exports.eGcd = eGcd;
- exports.gcd = gcd;
- exports.lcm = lcm;
- exports.modInv = modInv;
- exports.modPow = modPow;
- exports.toZn = toZn;
-
- return exports;
-
-}({}));
diff --git a/dist/bigint-mod-arith-latest.browser.min.js b/dist/bigint-mod-arith-latest.browser.min.js
deleted file mode 100644
index 31c795d..0000000
--- a/dist/bigint-mod-arith-latest.browser.min.js
+++ /dev/null
@@ -1 +0,0 @@
-var bigintModArith=function(a){'use strict';function c(b){return b=BigInt(b),b>=i?b:-b}function d(c,d){c=BigInt(c),d=BigInt(d);let e=i,f=j,g=j,h=i;for(;c!==i;){let a=d/c,b=d%c,i=e-g*a,j=f-h*a;d=c,c=b,e=g,f=h,g=i,h=j}return{b:d,x:e,y:f}}function e(d,e){d=c(d),e=c(e);let f=i;for(;!((d|e)&j);)d>>=j,e>>=j,f++;for(;!(d&j);)d>>=j;do{for(;!(e&j);)e>>=j;if(d>e){let a=d;d=e,e=a}e-=d}while(e);return d<