log2.js 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. import { factory } from '../../utils/factory.js';
  2. import { deepMap } from '../../utils/collection.js';
  3. import { log2Number } from '../../plain/number/index.js';
  4. var name = 'log2';
  5. var dependencies = ['typed', 'config', 'Complex'];
  6. export var createLog2 = /* #__PURE__ */factory(name, dependencies, _ref => {
  7. var {
  8. typed,
  9. config,
  10. Complex
  11. } = _ref;
  12. /**
  13. * Calculate the 2-base of a value. This is the same as calculating `log(x, 2)`.
  14. *
  15. * For matrices, the function is evaluated element wise.
  16. *
  17. * Syntax:
  18. *
  19. * math.log2(x)
  20. *
  21. * Examples:
  22. *
  23. * math.log2(0.03125) // returns -5
  24. * math.log2(16) // returns 4
  25. * math.log2(16) / math.log2(2) // returns 4
  26. * math.pow(2, 4) // returns 16
  27. *
  28. * See also:
  29. *
  30. * exp, log, log1p, log10
  31. *
  32. * @param {number | BigNumber | Complex | Array | Matrix} x
  33. * Value for which to calculate the logarithm.
  34. * @return {number | BigNumber | Complex | Array | Matrix}
  35. * Returns the 2-base logarithm of `x`
  36. */
  37. return typed(name, {
  38. number: function number(x) {
  39. if (x >= 0 || config.predictable) {
  40. return log2Number(x);
  41. } else {
  42. // negative value -> complex value computation
  43. return _log2Complex(new Complex(x, 0));
  44. }
  45. },
  46. Complex: _log2Complex,
  47. BigNumber: function BigNumber(x) {
  48. if (!x.isNegative() || config.predictable) {
  49. return x.log(2);
  50. } else {
  51. // downgrade to number, return Complex valued result
  52. return _log2Complex(new Complex(x.toNumber(), 0));
  53. }
  54. },
  55. 'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
  56. });
  57. /**
  58. * Calculate log2 for a complex value
  59. * @param {Complex} x
  60. * @returns {Complex}
  61. * @private
  62. */
  63. function _log2Complex(x) {
  64. var newX = Math.sqrt(x.re * x.re + x.im * x.im);
  65. return new Complex(Math.log2 ? Math.log2(newX) : Math.log(newX) / Math.LN2, Math.atan2(x.im, x.re) / Math.LN2);
  66. }
  67. });