log2.js 2.3 KB

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