Python: 底を指定した対数計算が行われる自作クラスにおいて、かけ算とわり算を実装したい

Question

前提

DjangoとSympy, Mathjaxを併用して、ランダムな計算プリントを出力するシステムを作っています。そのシステム上で簡単な対数の計算を行えるようにしたいと思い試作を行っている最中です。初めはPythonの組み込みモジュールmathや、外部ライブラリのSympyをそのまま利用しようとしたのですが、いずれも指定した底を保ちながら計算するようにはなっていなかったため、クラスを自作することにしました。

実現したいこと

自作クラス同士の足し算と引き算、自作クラスと整数とのかけ算までは真数部分の計算を行うことで実装ができたのですが、以下の計算の実装にてこずっています。

• 底が異なるため、そのままの結果になる足し算と引き算

log_2(3) + log_3(5) = log_2(3) + log_3(5)
log_2(3) - log_3(5) = log_2(3) - log_3(5)

• 自作クラス同士のかけ算と割り算

log_2(3) * log_5(4) = log_2(3) * log_5(4)
log_2(3) / log_5(4) = log_2(3) / log_5(4)
log_2(3) / log_2(3) = 1

イメージとしては、計算ができるときは実行して、できないときはそのまま値を保有しておいて欲しいのですが、それを実装するための方法が思い浮かびません。自作クラスの修正案でもよいですし、前述のmath.logやsympy.logを使って底を保って計算する方法でも構いません。何かしらのご教示をいただけると幸いです。

該当のソースコード

import sympy as sy

class Log:    
    def __init__(self, base_numerator, antilog_numerator, base_denominator=1, antilog_denominator=1):
        base = sy.Rational(base_numerator, base_denominator)
        antilog = sy.Rational(antilog_numerator, antilog_denominator)
        if (base <= 0) or (antilog < 0):
            raise ValueError(f"base must be more than 0, and antilog must be 0 or more than 0.")
            
        self.base = base
        self.antilog = antilog
        self.other_log_part = 0  # = 0
    
    def __str__(self):
        return f"\log_{{{self.base}}} {self.antilog}"
    
    def __add__(self, other_num):
        if isinstance(other_num, Log):
            if self.base == other_num.base:
                return Log(self.base, self.antilog * other_num.antilog)
        else:
            new_antilog = self.base ** other_num
            return Log(self.base, self.antilog * new_antilog)
    
    def __radd__(self, other_num):
        new_antilog = self.base ** other_num
        return Log(self.base, new_antilog * self.antilog)
    
    def __sub__(self, other_num):
        if isinstance(other_num, Log):
            if self.base == other_num.base:
                return Log(self.base, self.antilog / other_num.antilog)
        else:
            new_antilog = self.base ** other_num
            return Log(self.base, self.antilog / new_antilog)
    
    def __rsub__(self, other_num):
        new_antilog = self.base ** other_num
        return Log(self.base, new_antilog / self.antilog)
    
    def __mul__(self, other_num):
        if not(isinstance(other_num, Log)):
            new_antilog = self.antilog ** other_num
            return Log(self.base, new_antilog)
    
    def __rmul__(self, other_num):
        new_antilog = self.antilog ** other_num
        return Log(self.base, new_antilog)

動作確認とその結果

num1 = Log(2, 3) 
num2 = Log(2, 5)
print(num1 + num2) # \log_{2} 15
print(num1 - num2) # \log_{2} 3/5
print(num1 + 2) # \log_{2} 12
print(2 + num1) # \log_{2} 12
print(num1 - 2) # \log_{2} 3/4
print(2 - num1) # \log_{2} 4/3
print(2 * num1) # \log_{2} 9
print(num1 * 2) # \log_{2} 9

補足情報（FW/ツールのバージョンなど）

python 3.8.12
sympy 1.9

Answer 1

sympyでは、log(3)+log(5)は明示的にlogcombineなどで変換しないとlog(15)になりません。

>>> log(3) + log(5)
log(3) + log(5)
>>> logcombine(log(3) + log(5))
log(15)

こちらの考え方に従えば、以下のように書くことはできます。

from collections import defaultdict
from sympy import *

class Log(Function):
    nargs = 2,
    @property
    def base(self):
        return self.args[0]
    @property
    def antilog(self):
        return self.args[1]

def LogCombine(expr):
    def f(rv):
        if rv.is_Add:
            logs = defaultdict(lambda: S.One)
            other = []
            for arg in rv.args:
                if isinstance(arg, Log):
                    logs[arg.base] *= arg.antilog
                else:
                    other.append(arg)
            for (base, antilog) in logs.items():
                if antilog.is_rational and antilog.numerator == 1:
                    other.append(-Log(base, antilog.denominator))
                else:
                    other.append(Log(base, antilog))
            return Add(*other)
        if rv.is_Mul and len(rv.args) == 2:
            if rv.args[0].is_rational and isinstance(rv.args[1], Log):
                return Log(rv.args[1].base, rv.args[1].antilog ** rv.args[0])
            if rv.args[1].is_rational and isinstance(rv.args[0], Log):
                return Log(rv.args[0].base, rv.args[0].antilog ** rv.args[1])
        return rv
    return bottom_up(expr, f)

実行例は以下の通りです。色々抜けているところはありますが、必要に応じて修正してください。

num1 = Log(2, 3)
num2 = Log(2, 5)
num3 = Log(3, 5)
num4 = Log(5, 4)
print(LogCombine(num1 + num2)) # Log(2, 15)
print(LogCombine(num1 - num2)) # Log(2, 3/5)
print(LogCombine(num1 + 2)) # Log(2, 3) + 2
print(LogCombine(2 + num1)) # Log(2, 3) + 2
print(LogCombine(num1 - 2)) # Log(2, 3) - 2
print(LogCombine(2 - num1)) # 2 - Log(2, 3)
print(LogCombine(2 * num1)) # Log(2, 9)
print(LogCombine(num1 * 2)) # Log(2, 9)
print(LogCombine(num1 + num3)) # Log(2, 3) + Log(3, 5)
print(LogCombine(num1 - num3)) # Log(2, 3) - Log(3, 5)
print(LogCombine(num1 * num4)) # Log(2, 3)*Log(5, 4)
print(LogCombine(num1 / num4)) # Log(2, 3)/Log(5, 4)
print(LogCombine(num1 / num1)) # 1

Comments

[kensoon]

コメントありがとうございます。結局自力では解決できず、場当たり的な解決法でとりあえずの実装をしていましたが、ご教示いただいた内容を元に書き直してみたいと思います。かなり煩雑な実装になっていたので本当に助かりました。

Answer 2

そのクラスで何をさせたいのかによると思うのですが、「できないときはそのまま値を保有しておいて欲しい」とは、どういう意味でしょう。

「x = Log(2, 3) * Log(3, 5)」としたときに、xに何を入れたいのですか？
もし、Log(2, 3) * Log(3, 5) という式そのものを入れたいとしたら実現不能です。
文字列"Log(2, 3) * Log(3, 5)"なら入れられますが、無意味ですよね。

その計算は結局はできないのですから、そのクラスに「計算できない」という状態を持てるようにしてそれを返すようにするのがいいのではないかと思います。
浮動小数演算のIEEE 754にも、NaN(Not a number)や±∞(無限大/小)があります。
そして、解が何になるのかは、 呼び出した側が決めることだと思います。

Comments

[kensoon]

コメントありがとうございます。

おっしゃられている通り、文字列だと結局計算できなくなるので意味がなくなります。ご提案いただいた方向含め、少し練り直してみようと思います。