invmod.js 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. import { factory } from '../../utils/factory.js';
  2. var name = 'invmod';
  3. var dependencies = ['typed', 'config', 'BigNumber', 'xgcd', 'equal', 'smaller', 'mod', 'add', 'isInteger'];
  4. export var createInvmod = /* #__PURE__ */factory(name, dependencies, _ref => {
  5. var {
  6. typed,
  7. config,
  8. BigNumber,
  9. xgcd,
  10. equal,
  11. smaller,
  12. mod,
  13. add,
  14. isInteger
  15. } = _ref;
  16. /**
  17. * Calculate the (modular) multiplicative inverse of a modulo b. Solution to the equation `ax ≣ 1 (mod b)`
  18. * See https://en.wikipedia.org/wiki/Modular_multiplicative_inverse.
  19. *
  20. * Syntax:
  21. *
  22. * math.invmod(a, b)
  23. *
  24. * Examples:
  25. *
  26. * math.invmod(8, 12) // returns NaN
  27. * math.invmod(7, 13) // returns 2
  28. * math.invmod(15151, 15122) // returns 10429
  29. *
  30. * See also:
  31. *
  32. * gcd, xgcd
  33. *
  34. * @param {number | BigNumber} a An integer number
  35. * @param {number | BigNumber} b An integer number
  36. * @return {number | BigNumber } Returns an integer number
  37. * where `invmod(a,b)*a ≣ 1 (mod b)`
  38. */
  39. return typed(name, {
  40. 'number, number': invmod,
  41. 'BigNumber, BigNumber': invmod
  42. });
  43. function invmod(a, b) {
  44. if (!isInteger(a) || !isInteger(b)) throw new Error('Parameters in function invmod must be integer numbers');
  45. a = mod(a, b);
  46. if (equal(b, 0)) throw new Error('Divisor must be non zero');
  47. var res = xgcd(a, b);
  48. res = res.valueOf();
  49. var [gcd, inv] = res;
  50. if (!equal(gcd, BigNumber(1))) return NaN;
  51. inv = mod(inv, b);
  52. if (smaller(inv, BigNumber(0))) inv = add(inv, b);
  53. return inv;
  54. }
  55. });