"numbers" --- 数の抽象基底クラス
********************************

**ソースコード:** Lib/numbers.py

======================================================================

The "numbers" module (**PEP 3141**) defines a hierarchy of numeric
*abstract base classes* which progressively define more operations.
None of the types defined in this module are intended to be
instantiated.

class numbers.Number

   数の階層の根。引数 *x* が、種類は何であれ、数であるということだけチ
   ェックしたい場合、"isinstance(x, Number)" が使えます。


数値塔
======

class numbers.Complex

   この型のサブクラスは複素数を表し、組み込みの "complex" 型を受け付け
   る演算を含みます。それらは: "complex" および "bool" への変換、
   "real", "imag", "+", "-", "*", "/", "**", "abs()", "conjugate()",
   "==", "!=" です。 "-" と "!=" 以外の全てのものは抽象メソッドや抽象
   プロパティです。

   real

      抽象プロパティ。この数の実部を取り出します。

   imag

      抽象プロパティ。この数の虚部を取り出します。

   abstractmethod conjugate()

      抽象プロパティ。複素共役を返します。たとえば、
      "(1+3j).conjugate() == (1-3j)" です。

class numbers.Real

   To "Complex", "Real" adds the operations that work on real numbers.

   簡潔に言うとそれらは: "float" への変換, "math.trunc()", "round()",
   "math.floor()", "math.ceil()", "divmod()", "//", "%", "<", "<=",
   ">" および ">=" です。

   Real はまた "complex()", "real", "imag" および "conjugate()" のデフ
   ォルトを提供します。

class numbers.Rational

   "Real" をサブタイプ化し "numerator" と "denominator" のプロパティを
   加えたものです。これは "float()" のデフォルトも提供します。

   The "numerator" and "denominator" values should be instances of
   "Integral" and should be in lowest terms with "denominator"
   positive.

   numerator

      Abstract.  The numerator of this rational number.

   denominator

      Abstract.  The denominator of this rational number.

class numbers.Integral

   "Rational" をサブタイプ化し "int" への変換が加わります。 "float()",
   "numerator", "denominator" のデフォルトを提供します。法 (訳注: 割る
   数、除数のこと) を持つ "pow()" に対する抽象メソッドと、ビット列演算
   "<<", ">>", "&", "^", "|", "~" を追加します。


Notes for type implementers
===========================

Implementers should be careful to make equal numbers equal and hash
them to the same values. This may be subtle if there are two different
extensions of the real numbers. See also 数値型のハッシュ化.


さらに数のABCを追加する
-----------------------

数に対する ABC が他にも多く存在しうることは、言うまでもありません。そ
れらの ABC を階層に追加する可能性が閉ざされるとしたら、その階層は貧相
な階層でしかありません。たとえば、 "MyFoo" を "Complex" と "Real" の間
に付け加えるには、次のようにします:

   class MyFoo(Complex): ...
   MyFoo.register(Real)


算術演算の実装
--------------

We want to implement the arithmetic operations so that mixed-mode
operations either call an implementation whose author knew about the
types of both arguments, or convert both to the nearest built in type
and do the operation there. For subtypes of "Integral", this means
that "__add__()" and "__radd__()" should be defined as:

   class MyIntegral(Integral):

       def __add__(self, other):
           if isinstance(other, MyIntegral):
               return do_my_adding_stuff(self, other)
           elif isinstance(other, OtherTypeIKnowAbout):
               return do_my_other_adding_stuff(self, other)
           else:
               return NotImplemented

       def __radd__(self, other):
           if isinstance(other, MyIntegral):
               return do_my_adding_stuff(other, self)
           elif isinstance(other, OtherTypeIKnowAbout):
               return do_my_other_adding_stuff(other, self)
           elif isinstance(other, Integral):
               return int(other) + int(self)
           elif isinstance(other, Real):
               return float(other) + float(self)
           elif isinstance(other, Complex):
               return complex(other) + complex(self)
           else:
               return NotImplemented

ここには5つの異なる "Complex" のサブクラス間の混在型の演算があります。
上のコードの中で "MyIntegral" と "OtherTypeIKnowAbout" に触れない部分
を "ボイラープレート" と呼ぶことにしましょう。 "a" を "Complex" のサブ
タイプである "A" のインスタンス ("a : A <: Complex")、同様に "b : B <:
Complex" として、 "a + b" を考えます:

1. If "A" defines an "__add__()" which accepts "b", all is well.

2. If "A" falls back to the boilerplate code, and it were to return a
   value from "__add__()", we'd miss the possibility that "B" defines
   a more intelligent "__radd__()", so the boilerplate should return
   "NotImplemented" from "__add__()". (Or "A" may not implement
   "__add__()" at all.)

3. Then "B"'s "__radd__()" gets a chance. If it accepts "a", all is
   well.

4. ここでボイラープレートに落ち込むならば、もう他に試すべきメソッドは
   ありませんので、デフォルト実装の出番です。

5. もし "B <: A" ならば、Python は "A.__add__" の前に "B.__radd__" を
   試します。これで良い理由は、 "A" についての知識を持って実装しており
   、 "Complex" に委ねる前にこれらのインスタンスを扱えるはずだからです
   。

If "A <: Complex" and "B <: Real" without sharing any other knowledge,
then the appropriate shared operation is the one involving the built
in "complex", and both "__radd__()" s land there, so "a+b == b+a".

ほとんどの演算はどのような型についても非常に良く似ていますので、与えら
れた演算子について順結合(forward)および逆結合(reverse)のメソッドを生成
する支援関数を定義することは役に立ちます。たとえば、
"fractions.Fraction" では次のようなものを利用しています:

   def _operator_fallbacks(monomorphic_operator, fallback_operator):
       def forward(a, b):
           if isinstance(b, (int, Fraction)):
               return monomorphic_operator(a, b)
           elif isinstance(b, float):
               return fallback_operator(float(a), b)
           elif isinstance(b, complex):
               return fallback_operator(complex(a), b)
           else:
               return NotImplemented
       forward.__name__ = '__' + fallback_operator.__name__ + '__'
       forward.__doc__ = monomorphic_operator.__doc__

       def reverse(b, a):
           if isinstance(a, Rational):
               # Includes ints.
               return monomorphic_operator(a, b)
           elif isinstance(a, Real):
               return fallback_operator(float(a), float(b))
           elif isinstance(a, Complex):
               return fallback_operator(complex(a), complex(b))
           else:
               return NotImplemented
       reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
       reverse.__doc__ = monomorphic_operator.__doc__

       return forward, reverse

   def _add(a, b):
       """a + b"""
       return Fraction(a.numerator * b.denominator +
                       b.numerator * a.denominator,
                       a.denominator * b.denominator)

   __add__, __radd__ = _operator_fallbacks(_add, operator.add)

   # ...
