class Complex

要約

複素数を表すクラスです。

実部・虚部を、実数を表す数値オブジェクトとして保持します。

Complex オブジェクトは以下の方法で生成できます。

• 虚数リテラルで記述する
• Kernel?.Complex、Complex.rect、Complex.polar を使う
• 他の数値クラスのオブジェクトから Numeric#to_c で変換する
• 文字列表現から String#to_c で変換する

p 1i # => (0+1i)
# 虚部は Integer オブジェクトで保持される

p 1.0i # => (0+1.0i)
# 虚部は Float オブジェクトで保持される

p 1ri   # => (0+(1/1)*i)
p 0.5ri # => (0+(1/2)*i)
# 虚部は Rational オブジェクトで保持される

p 1+2i # => (1+2i)
# `1+2i` という形式のリテラルがあるわけではなく、
# Integer のリテラル `1` と虚数リテラル `2i` と
# 減算演算子 `-` からなる演算子式

# 実部のみ与える
p Complex(1)          # => (1+0i)
p Complex(0.3)        # => (0.3+0i)

# 実部と虚部を与える
p Complex(2, 3)       # => (2+3i)

# 文字列表現を与える（実部・虚部に浮動小数点リテラル形式を使う）
p Complex("0.3-0.5i") # => (0.3-0.5i)

# 文字列表現を与える（実部・虚部に有理数リテラル形式を使う）
p Complex("2/3+3/4i") # => ((2/3)+(3/4)*i)

# 文字列表現を与える（絶対値と偏角による極形式）
p Complex("2@3.141592653589793") # => (-2+0.0i)

# 実部と虚部を与える
p Complex.rect(2, 3) # => (2+3i)
# `Complex(2, 3)` と変わらない

# 絶対値と偏角を与える
p Complex.polar(0.5, Math::PI / 2) # => (0.0+0.5i)

p 3.to_c    # => (3+0i)
p 0.3.to_c  # => (0.3+0i)
p 0.5r.to_c # => ((1/2)+0i)

p "0.3-0.5i".to_c    # => (0.3-0.5i)
p "2/3+3/4i".to_c    # => ((2/3)+(3/4)*i)
p "2@3.141592653589793".to_c # => (-2+0.0i)

複素数演算において、オペランドの実部・虚部のクラスは演算結果の実部・虚部のクラスに影響します。

a = 3.0 + 3i
# 実部が Float、虚部が Integer

p a / 2 # => (1.5+(3/2)*i)
# 実部は Float、虚部は Rational になる

実部・虚部ともに Integer もしくは Rational であるような Complex オブジェクト、および Integer オブジェクト、Rational オブジェクトの間の加減乗除算は丸め誤差なく行われます。

p ([1ri / 10] * 10).sum
# => (0+(1/1)*i)
# 演算誤差無し

# 参考：
p ([1.0i / 10] * 10).sum
# => (0+0.9999999999999999i)
# `1.0i / 10` の時点で誤差が生じている
# それを 10 個足し合わせることで、`to_s` でも分かる誤差になっている

目次

特異メソッド

• polar
• rect
• rectangular

インスタンスメソッド

• *
• **
• +
• -
• -@
• /
• <=>
• ==
• abs
• abs2
• angle
• arg
• coerce
• conj
• conjugate
• denominator
• fdiv
• finite?
• imag
• imaginary
• infinite?
• inspect
• magnitude
• numerator
• phase
• polar
• quo
• rationalize
• real
• real?
• rect
• rectangular
• to_c
• to_f
• to_i
• to_r
• to_s

privateメソッド

• marshal_dump

追加されるメソッド

• json_create
• to_json

定数

• I

継承しているメソッド

Numericから継承しているメソッド

• %
• +@
• ceil
• div
• divmod
• eql?
• floor
• i
• integer?
• modulo
• negative?
• nonzero?
• positive?
• remainder
• round
• step
• to_int
• truncate
• zero?

特異メソッド

polar(r, theta = 0) -> Complex[permalink][rdoc][edit]

(Numeric, ?Numeric) → Complex

絶対値が r、偏角が theta である Complex クラスのオブジェクトを生成します。

複素数の極形式（polar form）に基づくためこの名があります。

[PARAM] r:

生成する複素数の絶対値。

[PARAM] theta:

生成する複素数の偏角。単位はラジアンです。省略した場合は 0 です。

例

p Complex.polar(2.0)          # => (2.0+0.0i)
p Complex.polar(2.0, 0)       # => (2.0+0.0i)
p Complex.polar(2.0, Math::PI)  # => (-2.0+0.0i)

rect(real, imag = 0) -> ComplexRuby 1.9.3 から[permalink][rdoc][edit]

rectangular(real, imag = 0) -> Complex

(Numeric, ?Numeric) → Complex

実部が real、虚部が imag である Complex クラスのオブジェクトを生成します。

複素数の直交形式（rectangular form）に基づくためこの名があります。

[PARAM] real:

生成する複素数の実部。

[PARAM] imag:

生成する複素数の虚部。省略した場合は 0 です。

例

p Complex.rect(1)         # => (1+0i)
p Complex.rect(1, 2)      # => (1+2i)
p Complex.rectangular(1, 2) # => (1+2i)

[SEE_ALSO] Kernel?.Complex

インスタンスメソッド

self * other -> Complex[permalink][rdoc][edit]

(Numeric) → Complex

self に other を掛けた値（＝積）を返します。

Complex オブジェクトを左項とする算術演算子 * はこのメソッドの呼び出しになります。

[PARAM] other:

self に対する乗数

例

p Complex(1, 2) * 2            # => (2+4i)
p Complex(1, 2) * Complex(2, 3)  # => (-4+7i)
p Complex(1, 2) * Rational(1, 2) # => ((1/2)+(1/1)*i)

self ** other -> Complex[permalink][rdoc][edit]

(Numeric) → Complex

self の other 乗を返します。

Complex オブジェクトを左項とする算術演算子 ** はこのメソッドの呼び出しになります。

[PARAM] other:

self に対する冪指数（べきしすう）

例

p 1i ** 2 # => (-1+0i)

self + other -> Complex[permalink][rdoc][edit]

(Numeric) → Complex

self に other を足した値（＝和）を返します。

Complex オブジェクトを左項とする算術演算子 + はこのメソッドの呼び出しになります。

[PARAM] other:

self に加算する数値

例

p Complex(1, 2) + Complex(2, 3) # => (3+5i)

self - other -> Complex[permalink][rdoc][edit]

(Numeric) → Complex

self から other を引いた値（＝差）を返します。

Complex オブジェクトを左項とする算術演算子 - はこのメソッドの呼び出しになります。

[PARAM] other:

self から減算する数値

例

p Complex(1, 2) - Complex(2, 3) # => (-1-1i)

- self -> ComplexRuby 1.9.3 から[permalink][rdoc][edit]

() → Complex

0 から self を引いた値を返します。

Complex オブジェクトに対する単項演算子 - はこのメソッドの呼び出しになります。

例

p -Complex(1)     # => (-1+0i)
p -Complex(-1, 1) # => (1-1i)

self / other -> Complex[permalink][rdoc][edit]

quo(other) -> Complex

(Numeric) → Complex

self を other で割った値（＝商）を返します。

Complex オブジェクトを左項とする算術演算子 / はこのメソッドの呼び出しになります。

[PARAM] other:

self に対する除数

例

p Complex(1.0) / 2 # => (0.5+0i)
# 実部が Float、虚部が Integer

p Complex(1) / 2.0 # => (0.5+0.0i)
# 実部・虚部ともに Float

p Complex(3, 4) / 2 # => ((3/2)+2i)
# 実部が Rational、虚部が Integer

[SEE_ALSO] Numeric#quo

self <=> other -> -1 | 0 | 1 | nil[permalink][rdoc][edit]

(untyped) → Integer?

self と other が共に実数（＝虚部がゼロの数）のとき self.real <=> other.real の結果を返します。

そうでないときは nil を返します。

Complex オブジェクトを左項とする二項演算子 <=> はこのメソッドの呼び出しになります。

[PARAM] other:

比較対象

例

p Complex(2, 3)  <=> Complex(2, 3) # => nil
p Complex(2, 3)  <=> 1           # => nil
p Complex(2)     <=> 1           # => 1
p Complex(2)     <=> 2           # => 0
p Complex(2)     <=> 3           # => -1

self == other -> bool[permalink][rdoc][edit]

(untyped) → bool

self が数値として other と等しければ true を、そうでなければ false を返します。

other が数値でないときは false を返します。

Complex オブジェクトを左項とする比較演算子 == はこのメソッドの呼び出しになります。

[PARAM] other:

比較対象

例

p Complex(2, 1) == Complex(1) # => false
p Complex(1, 0) == Complex(1) # => true
p Complex(1, 0) == 1          # => true
p Complex(1, 0) == 1.0        # => true

abs -> Numeric[permalink][rdoc][edit]

magnitude -> NumericRuby 1.9.3 から

() → Numeric

self の絶対値（absolute value）を返します。

以下の計算の結果を Float オブジェクトで返します。

sqrt(self.real ** 2 + self.imag ** 2)

例

p Complex(1, 2).abs       # => 2.23606797749979
p Complex(3, 4).abs       # => 5.0
p Complex('1/2', '1/2').abs # => 0.7071067811865476

[SEE_ALSO] Complex#abs2

abs2 -> Numeric[permalink][rdoc][edit]

() → Numeric

self の絶対値の 2 乗を返します。

以下の計算の結果を返します。

self.real ** 2 + self.imag ** 2

例

p Complex(1, 1).abs2       # => 2
p Complex(1.0, 1.0).abs2   # => 2.0
p Complex('1/2', '1/2').abs2 # => (1/2)

[SEE_ALSO] Complex#abs

arg -> Float[permalink][rdoc][edit]

angle -> Float

phase -> FloatRuby 1.9.3 から

() → Float

self の偏角を [-π,π] の範囲で返します。

例

p Complex.polar(3, Math::PI/2).arg # => 1.5707963267948966

非正の実軸付近での挙動に注意してください。以下の例のように虚部が 0.0 と -0.0 では値が変わります。

例

p Complex(-1, 0).arg            # =>  3.141592653589793
p Complex(-1, -0).arg           # =>  3.141592653589793
p Complex(-1, -0.0).arg         # => -3.141592653589793

p Complex(0, 0.0).arg           # =>  0.0
p Complex(0, -0.0).arg          # => -0.0
p Complex(-0.0, 0).arg          # =>  3.141592653589793
p Complex(-0.0, -0.0).arg       # => -3.141592653589793

メソッド名の arg は argument（偏角）に由来しますが、「引数」の argument と紛らわしいためか、argument というエイリアスは用意されていません。

[SEE_ALSO] Numeric#arg

coerce(other) -> [Complex, Complex][permalink][rdoc][edit]

(Numeric) → [ Complex, Complex ]

other を Complex に変換して [変換後の other, self] の配列を返します。

[EXCEPTION] TypeError:

変換できないオブジェクトを指定した場合に発生します。

例

p Complex(1).coerce(2) # => [(2+0i), (1+0i)]

conjugate -> Complex[permalink][rdoc][edit]

conj -> Complex

() → Complex

self の共役複素数を返します。

例

p Complex(1, 2).conj # => (1-2i)

denominator -> Integer[permalink][rdoc][edit]

() → Integer

self の分母（denominator）を返します。

以下のように、実部と虚部の分母の最小公倍数を整数で返します。

1   2       3+4i  <-  numerator(分子)
- + -i  ->  ----
2   3        6    <-  denominator(分母)

例

p Complex('1/2+2/3i').denominator # => 6
p Complex(3).denominator          # => 1

[SEE_ALSO] Complex#numerator

fdiv(other) -> ComplexRuby 1.9.3 から[permalink][rdoc][edit]

(Numeric) → Complex

self を other で割った商を返します。実部と虚部が共に Float の値になります。

[PARAM] other:

self に対する除数

例

p Complex(11, 22).fdiv(3) # => (3.6666666666666665+7.333333333333333i)
p Complex(11, 22).quo(3)  # => ((11/3)+(22/3)*i)

[SEE_ALSO] Complex#quo

finite? -> boolRuby 2.4.0 から[permalink][rdoc][edit]

() → bool

実部と虚部の両方が有限値の場合に true を、そうでない場合に false を返します。

例

p (1 + 1i).finite?               # => true
p (Float::INFINITY + 1i).finite? # => false

[SEE_ALSO] Complex#infinite?

imag -> Numeric[permalink][rdoc][edit]

imaginary -> NumericRuby 1.9.3 から

() → Numeric

self の虚部を返します。

例

p Complex(3, 2).imag # => 2

[SEE_ALSO] Numeric#imag

infinite? -> nil | 1Ruby 2.4.0 から[permalink][rdoc][edit]

() → Integer?

実部と虚部のどちらも正または負の無限大ではない場合に nil を、そうでない場合に 1 を返します。

例

p (1+1i).infinite?                 # => nil
p (Float::INFINITY + 1i).infinite? # => 1

[SEE_ALSO] Complex#finite?

inspect -> String[permalink][rdoc][edit]

() → String

self を人間が読みやすい形の文字列表現にして返します。

例

p Complex(2).inspect                     # => "(2+0i)"
p Complex('-8/6').inspect                # => "((-4/3)+0i)"
p Complex('1/2i').inspect                # => "(0+(1/2)*i)"
p Complex(0, Float::INFINITY).inspect    # => "(0+Infinity*i)"
p Complex(Float::NAN, Float::NAN).inspect  # => "(NaN+NaN*i)"

numerator -> Complex[permalink][rdoc][edit]

() → Complex

self の分子（numerator）を返します。

例

p Complex('1/2+2/3i').numerator # => (3+4i)
p Complex(3).numerator        # => (3+0i)

[SEE_ALSO] Complex#denominator

polar -> [Numeric, Numeric][permalink][rdoc][edit]

() → [ Numeric, Float ]

self の絶対値と偏角を配列にして返します。

例

p Complex.polar(1, 2).polar # => [1.0, 2.0]

[SEE_ALSO] Numeric#polar

rationalize -> RationalRuby 1.9.3 から[permalink][rdoc][edit]

rationalize(eps) -> Rational

(?Numeric eps) → Rational

self の虚部が Integer か Rational のゼロであれば実部を Rational に変換して返します。許容誤差 eps を与えることもできます。

[PARAM] eps:

許容する誤差。

[EXCEPTION] RangeError:

虚部がゼロでなかったり Float のゼロである場合に発生します。

例

p Complex(0.1).rationalize            # => (1/10)
p Complex(Math::PI).rationalize(0.01) # => (22/7)

変換できない例

# 虚部がゼロでない
(1 + 2i).rationalize # ~> RangeError

# 虚部がゼロだが Float の 0.0 である
(1 + 0.0i).rationalize # ~> RangeError

[SEE_ALSO] Float#rationalize, Integer#rationalize, Rational#rationalize

real -> Numeric[permalink][rdoc][edit]

() → Numeric

self の実部を返します。

例

p Complex(3, 2).real # => 3

real? -> falseRuby 1.9.3 から[permalink][rdoc][edit]

() → false

常に false を返します。

例

p (2+3i).real? # => false
p (2+0i).real? # => false

[SEE_ALSO] Numeric#real?

rect -> [Numeric, Numeric]Ruby 1.9.3 から[permalink][rdoc][edit]

rectangular -> [Numeric, Numeric]

() → [ Numeric, Numeric ]

self の実部と虚部を配列にして返します。

メソッド名は、これが複素数の直交形式（rectangular form）の成分を得るものであることから。

例

p Complex(3).rect  # => [3, 0]
p Complex(3.5).rect  # => [3.5, 0]
p Complex(3, 2).rect # => [3, 2]

[SEE_ALSO] Numeric#rect

to_c -> selfRuby 1.9.1 から[permalink][rdoc][edit]

() → Complex

self を返します。

例

p Complex(2).to_c    # => (2+0i)
p Complex(-8, 6).to_c  # => (-8+6i)

to_f -> FloatRuby 1.9.3 から[permalink][rdoc][edit]

() → Float

self の虚部が Integer か Rational のゼロであれば実部を Float に変換して返します。

[EXCEPTION] RangeError:

虚部がゼロでなかったり Float のゼロである場合に発生します。

例

p (1 + 0i).to_f  # => 1.0
p (1 + 0ri).to_f # => 1.0

変換できない例

# 虚部がゼロでない
(1 + 2i).to_f # ~> RangeError

# 虚部がゼロだが Float の 0.0 である
(1 + 0.0i).to_f # ~> RangeError

to_i -> IntegerRuby 1.9.3 から[permalink][rdoc][edit]

() → Integer

self の虚部が Integer か Rational のゼロであれば実部を Integer に変換して返します。

[EXCEPTION] RangeError:

虚部がゼロでなかったり Float のゼロである場合に発生します。

例

p (1.9 + 0i).to_i  # => 1
p (1.9 + 0ri).to_i # => 1

変換できない例

# 虚部がゼロでない
(1 + 2i).to_i # ~> RangeError

# 虚部がゼロだが Float の 0.0 である
(1 + 0.0i).to_i # ~> RangeError

to_r -> RationalRuby 1.9.3 から[permalink][rdoc][edit]

() → Rational

self の虚部がゼロであれば実部を Rational に変換して返します。

[EXCEPTION] RangeError:

虚部がゼロでない場合に発生します。

例

p (0.75 + 0i).to_r   # => (3/4)
p (0.75 + 0ri).to_r  # => (3/4)
p (0.75 + 0.0i).to_r # => (3/4)

変換できない例

# 虚部がゼロでない
(1 + 2i).to_r # ~> RangeError

to_s -> String[permalink][rdoc][edit]

() → String

self を "実部 + 虚部i" 形式の文字列にして返します。

例

p Complex(2).to_s                     # => "2+0i"
p Complex('-8/6').to_s                # => "-4/3+0i"
p Complex('1/2i').to_s                # => "0+1/2i"
p Complex(0, Float::INFINITY).to_s    # => "0+Infinity*i"
p Complex(Float::NAN, Float::NAN).to_s  # => "NaN+NaN*i"

privateメソッド

marshal_dump -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]

Marshal?.load のためのメソッドです。 Complex::compatible#marshal_load で復元可能な配列を返します。

2.0 以降では Marshal?.load で 1.8 系の Complex オブジェクトを保存した文字列も復元できます。

[注意] Complex::compatible は通常の方法では参照できません。

追加されるメソッド

json_create(hash) -> ComplexRuby 2.1.0 から[permalink][rdoc][edit] [added by json/add/complex]

JSON のオブジェクトから Complex のオブジェクトを生成して返します。

[PARAM] hash:

実部をキー 'r'、虚部をキー 'i' に持つハッシュを指定します。

to_json(*args) -> StringRuby 2.1.0 から[permalink][rdoc][edit] [added by json/add/complex]

自身を JSON 形式の文字列に変換して返します。

内部的にはハッシュにデータをセットしてから JSON::Generator::GeneratorMethods::Hash#to_json を呼び出しています。

[PARAM] args:

引数はそのまま JSON::Generator::GeneratorMethods::Hash#to_json に渡されます。

例

require 'json/add/complex'
p (2+3i).to_json # => "{\"json_class\":\"Complex\",\"r\":2,\"i\":3}"

[SEE_ALSO] JSON::Generator::GeneratorMethods::Hash#to_json

定数

I -> Complex[permalink][rdoc][edit]

虚数単位です。(0+1i) を返します。