summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/luacas/tex/algebra/luacas-logarithm.lua
blob: 07a9db84d12b417182d82e65186efc2954f08c43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
--- @class Logarithm
--- An expression for the logarithm of an expression with respect to another.
--- Currently, logarithms are not being evaluated since we are just doing symbolic computation.
--- @field base Expression
--- @field expression Expression
Logarithm = {}
__Logarithm = {}

----------------------------
-- Instance functionality --
----------------------------

--- Creates a new logarithm expression with the given symbol and expression.
--- @param base Expression
--- @param expression Expression
--- @
function Logarithm:new(base, expression)
    local o = {}
    local __o = Copy(__ExpressionOperations)

    o.base = Copy(base)
    o.expression = Copy(expression)

    __o.__index = Logarithm
    __o.__tostring = function(a)
        return 'log(' .. tostring(base) .. ', ' .. tostring(expression) .. ')'
    end
    __o.__eq = function(a, b)
        -- This shouldn't be needed, since __eq should only fire if both metamethods have the same function, but for some reason Lua always runs this anyway
        if not b:type() == Logarithm then
            return false
        end
        return a.base == b.base and a.expression == b.expression
    end
    o = setmetatable(o, __o)

    return o
end

--- @return Expression
function Logarithm:evaluate()

    if (self.base:isconstant() and (self.base <= Integer.zero() or self.base == Integer.one())) or
        (self.expression:isconstant() and self.expression <= Integer.zero()) then
        error("Arithmetic error: division by zero")
    end

    if not self.base:isconstant() or not self.expression:isconstant() then
        return self
    end

    local power = Integer.one()
    local base = self.base
    if base:type() == Integer then
        local pp, b, p = base:isperfectpower()
        if pp then
            base = b
            power = p
        end
    end

    if base:type() == Rational then
        local ppn, bn, pn = base.numerator:isperfectpower()
        local ppd, bd, pd = base.denominator:isperfectpower()
        if base.numerator == Integer.one() then
            ppn = true
            bn = Integer.one()
            pn = pd
        end
        if ppn and ppd and pn == pd then
            base = bn / bd
            power = pn
        end
    end

    local result = Integer.one()
    local expression = self.expression
    local sign = Integer.one()
    if base < Integer.one() then
        base = Integer.one() / base
        sign = -sign
    end


    local current = base
    while current < expression do
        current = current * base
        result = result + Integer.one()
    end
    if current == expression then
        return sign * result / power
    else
        while current > expression do
            current = current / base
            result = result - Integer.one()
        end
        if current == expression then
            return sign * result / power
        end
    end

    return self
end

--- @return Expression
function Logarithm:autosimplify()

    local base = self.base:autosimplify()
    local expression = self.expression:autosimplify()

    local evaluated = Logarithm(base, expression):evaluate()
    if evaluated:type() ~= Logarithm then
        return evaluated
    end

    -- Uses the property that log(b, 1) = 0
    if expression == Integer.one() then
        return Integer.zero()
    end

    -- Uses the property that log(b, b) = 1
    if expression == base then
        return Integer.one()
    end

    -- Uses the propery that log(b, x^y) = y * log(b, x)
    if expression.operation == BinaryOperation.POW then
        return BinaryOperation.MULEXP({expression.expressions[2], Logarithm(base, expression.expressions[1])}):autosimplify()
    end

    if expression:type() == Rational and expression.numerator == Integer.one() then
        return (-Logarithm(base, expression.denominator)):autosimplify()
    end

    -- Our expression cannot be simplified
    return Logarithm(base, expression)
end

--- @return Expression
function Logarithm:expand()
    return Logarithm(self.base:expand(), self.expression:expand()):autosimplify()
end

--- @return table<number, Expression>
function Logarithm:subexpressions()
    return {self.base, self.expression}
end

--- @param subexpressions table<number, Expression>
--- @return Logarithm
function Logarithm:setsubexpressions(subexpressions)
    return Logarithm(subexpressions[1], subexpressions[2])
end

--- @param other Expression
--- @return boolean
function Logarithm:order(other)
    return FunctionExpression("log", {self.base, self.expression}):order(other)
end

--- @return string
function Logarithm:tolatex()
    if self.base == E then
        return '\\ln\\mathopen{}\\left(' .. self.expression:tolatex() .. '\\right)'
    end
    return '\\log_' .. self.base:tolatex() .. '\\mathopen{}\\left(' .. self.expression:tolatex() .. '\\right)'
end

-----------------
-- Inheritance --
-----------------
__Logarithm.__index = CompoundExpression
__Logarithm.__call = Logarithm.new
Logarithm = setmetatable(Logarithm, __Logarithm)

----------------------
-- Static constants --
----------------------

LOG = function(base, expression)
    return Logarithm(base, expression)
end

LN = function(expression)
    return Logarithm(E, expression)
end