log.js 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", {
  3. value: true
  4. });
  5. exports.createLog = void 0;
  6. var _factory = require("../../utils/factory.js");
  7. var _index = require("../../plain/number/index.js");
  8. var name = 'log';
  9. var dependencies = ['config', 'typed', 'divideScalar', 'Complex'];
  10. var createLog = /* #__PURE__ */(0, _factory.factory)(name, dependencies, function (_ref) {
  11. var typed = _ref.typed,
  12. config = _ref.config,
  13. divideScalar = _ref.divideScalar,
  14. Complex = _ref.Complex;
  15. /**
  16. * Calculate the logarithm of a value.
  17. *
  18. * To avoid confusion with the matrix logarithm, this function does not
  19. * apply to matrices.
  20. *
  21. * Syntax:
  22. *
  23. * math.log(x)
  24. * math.log(x, base)
  25. *
  26. * Examples:
  27. *
  28. * math.log(3.5) // returns 1.252762968495368
  29. * math.exp(math.log(2.4)) // returns 2.4
  30. *
  31. * math.pow(10, 4) // returns 10000
  32. * math.log(10000, 10) // returns 4
  33. * math.log(10000) / math.log(10) // returns 4
  34. *
  35. * math.log(1024, 2) // returns 10
  36. * math.pow(2, 10) // returns 1024
  37. *
  38. * See also:
  39. *
  40. * exp, log2, log10, log1p
  41. *
  42. * @param {number | BigNumber | Complex} x
  43. * Value for which to calculate the logarithm.
  44. * @param {number | BigNumber | Complex} [base=e]
  45. * Optional base for the logarithm. If not provided, the natural
  46. * logarithm of `x` is calculated.
  47. * @return {number | BigNumber | Complex}
  48. * Returns the logarithm of `x`
  49. */
  50. return typed(name, {
  51. number: function number(x) {
  52. if (x >= 0 || config.predictable) {
  53. return (0, _index.logNumber)(x);
  54. } else {
  55. // negative value -> complex value computation
  56. return new Complex(x, 0).log();
  57. }
  58. },
  59. Complex: function Complex(x) {
  60. return x.log();
  61. },
  62. BigNumber: function BigNumber(x) {
  63. if (!x.isNegative() || config.predictable) {
  64. return x.ln();
  65. } else {
  66. // downgrade to number, return Complex valued result
  67. return new Complex(x.toNumber(), 0).log();
  68. }
  69. },
  70. 'any, any': typed.referToSelf(function (self) {
  71. return function (x, base) {
  72. // calculate logarithm for a specified base, log(x, base)
  73. return divideScalar(self(x), self(base));
  74. };
  75. })
  76. });
  77. });
  78. exports.createLog = createLog;