class Complex + Numeric
クラスの継承リスト: Complex < Numeric < Comparable < Object < Kernel < BasicObject
要約
複素数を扱うクラスです。
Complex オブジェクトを作成するには、Kernel.#Complex、 Complex.rect、Complex.polar、Numeric#to_c、 String#to_c のいずれかを使用します。
Complex(1) # => (1+0i) Complex(2, 3) # => (2+3i) Complex.polar(2, 3) # => (-1.9799849932008908+0.2822400161197344i) Complex(0.3) # => (0.3+0i) Complex('0.3-0.5i') # => (0.3-0.5i) Complex('2/3+3/4i') # => ((2/3)+(3/4)*i) Complex('1@2') # => (-0.4161468365471424+0.9092974268256817i) 3.to_c # => (3+0i) 0.3.to_c # => (0.3+0i) '0.3-0.5i'.to_c # => (0.3-0.5i) '2/3+3/4i'.to_c # => ((2/3)+(3/4)*i) '1@2'.to_c # => (-0.4161468365471424+0.9092974268256817i)
Complex オブジェクトは有理数の形式も実数の形式も扱う事ができます。
Complex(1, 1) / 2 # => ((1/2)+(1/2)*i) Complex(1, 1) / 2.0 # => (0.5+0.5i)
特異メソッド
polar(r, theta = 0) -> Complex
-
絶対値が r、偏角が theta である Complex クラスのオブジェクトを生成します。
- [PARAM] r:
- 生成する複素数の絶対値。
- [PARAM] theta:
- 生成する複素数の偏角。単位はラジアンです。省略した場合は 0 です。
例:
Complex.polar(2.0) # => (2.0+0.0i) Complex.polar(2.0, 0) # => (2.0+0.0i) Complex.polar(2.0, Math::PI) # => (-2.0+2.4492127076447545e-16i)
rect(r, i = 0) -> Complex
rectangular(r, i = 0) -> Complex
-
実部が r、虚部が i である Complex クラスのオブジェクトを生成します。
- [PARAM] r:
- 生成する複素数の実部。
- [PARAM] i:
- 生成する複素数の虚部。省略した場合は 0 です。
例:
Complex.rect(1) # => (1+0i) Complex.rect(1, 2) # => (1+2i) Complex.rectangular(1, 2) # => (1+2i)
[SEE_ALSO] Kernel.#Complex
インスタンスメソッド
self * other -> Complex
-
積を計算します。
- [PARAM] other:
- 自身に掛ける数
例:
Complex(1, 2) * 2 # => (2+4i) Complex(1, 2) * Complex(2, 3) # => (-4+4i) Complex(1, 2) * Rational(1, 2) # => ((1/2)+(1/1)*i)
self ** other -> Complex
-
冪(べき)乗を計算します。
- [PARAM] other:
- 自身を other 乗する数
例:
Complex('i') ** 2 # => (-1+0i)
self + other -> Complex
-
和を計算します。
- [PARAM] other:
- 自身に足す数
例:
Complex(1, 2) + Complex(2, 3) # => (3+5i)
+ -> self
-
単項演算子の + です。 self を返します。
self - other -> Complex
-
差を計算します。
- [PARAM] other:
- 自身から引く数
例:
Complex(1, 2) - Complex(2, 3) # => (-1-1i)
- -> Complex
-
自身の符号を反転させたものを返します。
例:
-Complex(1) # => (-1+0i) -Complex(-1, 1) # => (1-1i)
- -> Numeric
-
単項演算子の - です。 self の符号を反転させたものを返します。
このメソッドは、二項演算子 - で 0 - self によって定義されています。
self / other -> Complex
quo(other) -> Complex
-
商を計算します。
- [PARAM] other:
- 自身を割る数
例:
Complex(10.0) / 3 # => (3.3333333333333335+(0/1)*i) Complex(10) / 3 # => ((10/3)+(0/1)*i)
self <=> other -> -1 | 0 | 1 | nil
-
自身が other より大きい場合に 1 を、等しい場合に 0 を、小さい場合には -1 をそれぞれ返します。 自身と other が比較できない場合には nil を返します。
Numeric のサブクラスは、上の動作を満たすよう このメソッドを適切に再定義しなければなりません。
- [PARAM] other:
- 自身と比較したい数値を指定します。
1 <=> 0 #=> 1 1 <=> 1 #=> 0 1 <=> 2 #=> -1 1 <=> "0" #=> nil
self == other -> bool
-
数値として等しいか判定します。
- [PARAM] other:
- 自身と比較する数値
例:
Complex(2, 1) == Complex(1) # => false Complex(1, 0) == Complex(1) # => true Complex(1, 0) == 1 # => true
abs -> Float
magnitude -> Float
-
自身の絶対値を返します。
以下の計算の結果を Float オブジェクトで返します。
sqrt(self.real ** 2 + self.imag **2)
例:
Complex(1, 2).abs # => 2.23606797749979 Complex(3, 4).abs # => 5.0 Complex('1/2', '1/2').abs # => 0.7071067811865476
[SEE_ALSO] Complex#abs2
abs -> Numeric
-
自身が 0 以上ならば self を、そうでない場合は -self を返します。
abs2 -> Numeric
-
自身の絶対値の 2 乗を返します。
以下の計算の結果を返します。
self.real ** 2 + self.imag **2
例:
Complex(1, 1).abs2 # => 2 Complex(1.0, 1.0).abs2 # => 2.0 Complex('1/2', '1/2').abs2 # => (1/2)
[SEE_ALSO] Complex#abs
abs2 -> Numeric
-
自身の絶対値の 2 乗を返します。
例:
2.abs2 # => 4 -2.abs2 # => 4 2.0.abs2 # => 4 -2.0.abs2 # => 4
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
arg -> Float
angle -> Float
phase -> Float
-
自身の偏角を[-π,π]の範囲で返します。
例:
Complex.polar(3, Math::PI/2).arg # => 1.5707963267948966
非正の実軸付近での挙動に注意してください。以下の例のように虚部が 0.0 と -0.0 では値が変わります。
Complex(-1, 0).arg #=> 3.141592653589793 Complex(-1, -0).arg #=> 3.141592653589793 Complex(-1, -0.0).arg #=> -3.141592653589793 Complex(0, 0.0).arg #=> 0.0 Complex(0, -0.0).arg #=> -0.0 Complex(-0.0, 0).arg #=> 3.141592653589793 Complex(-0.0, -0.0).arg #=> -3.141592653589793
arg -> 0 | Math::PI
angle -> 0 | Math::PI
phase -> 0 | Math::PI
-
自身の偏角(正の数なら 0、負の数なら Math::PI)を返します。
例:
1.arg # => 0 -1.arg # => 3.141592653589793
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
ceil -> Integer
-
自身と等しいかより大きな整数のうち最小のものを返します。
1.ceil #=> 1 1.2.ceil #=> 2 (-1.2).ceil #=> -1 (-1.5).ceil #=> -1
[SEE_ALSO] Numeric#floor, Numeric#round, Numeric#truncate
coerce(other) -> [Complex, Complex]
-
other を Complex に変換して [self, 変換後の other] の配列を返します。
- [EXCEPTION] TypeError:
- 変換できないオブジェクトを指定した場合に発生します。
例:
Complex(1).coerce(2) # => [(2+0i), (1+0i)]
coerce(other) -> [Numeric]
-
自身と other が同じクラスになるよう、自身か other を変換し [other, self] という配列にして返します。
デフォルトでは self と other を Float に変換して [other, self] という配列にして返します。 Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。 以下は Rational の coerce のソースです。other が自身の知らない数値クラスであった場合、 super を呼んでいることに注意して下さい。
# lib/rational.rb より def coerce(other) if other.kind_of?(Float) return other, self.to_f elsif other.kind_of?(Integer) return Rational.new!(other, 1), self else super end end
数値クラスの算術演算子は通常自分と演算できないクラスをオペランドとして受け 取ると coerce を使って自分とオペランドを変換した上で演算を行います。 以下は Rational の + メソッドを一部省略したものです。 引数が自身の知らない数値クラスである場合、引数の coerce により自身を変換してから + 演算子を呼んでいます。
# lib/rational.rb より def + (a) if a.kind_of?(Rational) # 長いので省略 elsif a.kind_of?(Integer) # 長いので省略 elsif a.kind_of?(Float) Float(self) + a else x, y = a.coerce(self) x + y end end
- [PARAM] other:
- オペランドを数値で指定します。
conjugate -> Complex
conj -> Complex
-
自身の共役複素数を返します。
例:
Complex(1, 2).conj # => (1-2i)
conj -> Numeric
conjugate -> Numeric
-
自身の共役複素数(実数の場合は常に自身)を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
[SEE_ALSO] Complex#conj
denominator -> Integer
-
分母を返します。
以下のように、実部と虚部の分母の最小公倍数を整数で返します。
1 2 3+4i <- numerator(分子) - + -i -> ---- 2 3 6 <- denominator(分母)
例:
Complex('1/2+2/3i').denominator # => 6 Complex(3).numerator # => 1
[SEE_ALSO] Complex#numerator
denominator -> Integer
-
自身を Rational に変換した時の分母を返します。
- [RETURN]
- 分母を返します。
[SEE_ALSO] Numeric#numerator
div(other) -> Integer
-
self を other で割った整数の商 q を返します。
ここで、商 q と余り r は、それぞれ
- self == other * q + r
と
- other > 0 のとき: 0 <= r < other
- other < 0 のとき: other < r <= 0
- q は整数
をみたす数です。 商に対応する余りは Numeric#modulo で求められます。 div はメソッド / の呼び出しとして定義されています。
- [PARAM] other:
- 自身を割る数を指定します。
p 3.div(2) # => 1 p (-3).div(2) # => -2 p (-3.0).div(2) # => -2
divmod(other) -> [Numeric]
-
self を other で割った商 q と余り r を、 [q, r] という 2 要素の配列にして返します。 商 q は常に整数ですが、余り r は整数であるとは限りません。
ここで、商 q と余り r は、
- self == other * q + r
と
- other > 0 のとき: 0 <= r < other
- other < 0 のとき: other < r <= 0
- q は整数
をみたす数です。 divmod が返す商は Numeric#div と同じです。 また余りは、Numeric#modulo と同じです。 このメソッドは、メソッド / と % によって定義されています。
- [PARAM] other:
- 自身を割る数を指定します。
11.divmod(3) #=> [3, 2] (11.5).divmod(3.5) #=> [3, 1.0] 11.divmod(-3) #=> [-4, -1] 11.divmod(3.5) #=> [3, 0.5] (-11).divmod(3.5) #=> [-4, 3.0]
[SEE_ALSO] Numeric#div, Numeric#modulo
eql?(other) -> bool
-
自身と other の実部と虚部のクラスが等しく、それぞれが数値として等しい場 合に true を返します。そうでない場合に false を返します。
- [PARAM] other:
- 自身と比較する数値
eql?(other) -> bool
-
自身と other のクラスが等しくかつ == メソッドで比較して等しい場合に true を返します。 そうでない場合に false を返します。
Numeric のサブクラスは、eql? で比較して等しい数値同士が同じハッシュ値を返すように hash メソッドを適切に定義する必要があります。
- [PARAM] other:
- 自身と比較したい数値を指定します。
p 1.eql?(1) #=> true p 1.eql?(1.0) #=> false p 1 == 1.0 #=> true
[SEE_ALSO] Object#equal?, Object#eql?, Object#==, Object#===
fdiv(other) -> Complex
-
自身の実部と虚部をそれぞれ実数として other で割った商を返します。
- [PARAM] other:
- 自身を割る数
例:
Complex(11, 22).fdiv(3) # => (3.6666666666666665+7.333333333333333i) Complex(11, 22).quo(3) # => ((11/3)+(22/3)*i)
[SEE_ALSO] Complex#quo
quo(other) -> Float
fdiv(other) -> Float
-
self を other で割った実数の商を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
- [PARAM] other:
- 自身を割る数を指定します。
p 1.quo(3) # => 0.3333333333333333 require 'rational' p 1.quo(3) # => Rational(1, 3)
floor -> Integer
-
自身と等しいかより小さな整数のうち最大のものを返します。
1.floor #=> 1 1.2.floor #=> 1 (-1.2).floor #=> -2 (-1.5).floor #=> -2
[SEE_ALSO] Numeric#ceil, Numeric#round, Numeric#truncate
hash -> Integer
-
自身のハッシュ値を返します。
i -> Complex
-
Complex(0, self) を返します。
ただし、Complex オブジェクトでは利用できません。
例:
10.i # => (0+10i) -10.i # => (0-10i) (0.1).i # => (0+0.1i) Rational(1, 2).i # => (0+(1/2)*i)
imag -> Numeric
imaginary -> Numeric
-
自身の虚部を返します。
例:
Complex(3, 2).imag # => 2
imag -> 0
imaginary -> 0
-
常に 0 を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
[SEE_ALSO] Numeric#real、Complex#imag
inspect -> String
-
自身を人間が読みやすい形の文字列表現にして返します。
"(1+1i)", "(1-1i)" のような文字列を返します。
integer? -> bool
-
self が整数の時、真を返します。そうでない場合に false を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
marshal_dump -> Array
-
Complex#marshal_load で復元可能な配列を返します。
[SEE_ALSO] Complex#marshal_load
marshal_load -> Complex
-
Complex#marshal_dump で得られた配列を基に、Complex オブジェ クトを復元します。
[SEE_ALSO] Complex#marshal_dump
modulo(other) -> Numeric
-
self を other で割った余り r を返します。
ここで、商 q と余り r は、
- self == other * q + r
と
- other > 0 のとき 0 <= r < other
- other < 0 のとき other < r <= 0
- q は整数
をみたす数です。 余り r は、other と同じ符号になります。 商 q は、Numeric#div (あるいは 「/」)で求められます。 modulo はメソッド % の呼び出しとして定義されています。
- [PARAM] other:
- 自身を割る数を指定します。
p 13.modulo(4) #=> 1 p (11.5).modulo(3.5) #=> 1.0 p 13.modulo(-4) #=> -3 p (-13).modulo(4) #=> 3 p (-13).modulo(-4) #=> -1 p (-11).modulo(3.5) #=> 3.0
[SEE_ALSO] Numeric#divmod, Numeric#remainder
nonzero? -> self | nil
-
自身がゼロの時 nil を返し、非ゼロの時 self を返します。
p 10.nonzero? #=> 10 p 0.nonzero? #=> nil p 0.0.nonzero? #=> nil require 'rational' p Rational(0, 2).nonzero? #=> nil
numerator -> Complex
-
分子を返します。
例:
Complex('1/2+2/3i').numerator # => (3+4i) Complex(3).numerator # => (3+0i)
[SEE_ALSO] Complex#denominator
numerator -> Integer
-
自身を Rational に変換した時の分子を返します。
- [RETURN]
- 分子を返します。
[SEE_ALSO] Numeric#denominator
polar -> [Numeric, Numeric]
-
自身の絶対値と偏角を配列にして返します。
例:
Complex.polar(1, 2).polar # => [1, 2]
polar -> [Numeric, Numeric]
-
自身の絶対値と偏角を配列にして返します。正の数なら [self, 0]、負の数な ら [-self, Math::PI] を返します。
例:
1.0.polar # => [1.0, 0] 2.0.polar # => [2.0, 0] -1.0.polar # => [1.0, 3.141592653589793] -2.0.polar # => [2.0, 3.141592653589793]
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
to_r -> Rational
rationalize -> Rational
rationalize(eps) -> Rational
-
自身を Rational に変換します。
- [PARAM] eps:
- 許容する誤差。常に無視されます。
- [EXCEPTION] RangeError:
- 虚部が 0 ではない場合に発生します。
例:
Complex(3).to_r # => (3/1) Complex(3, 2).to_r # => RangeError
real -> Numeric
-
自身の実部を返します。
例:
Complex(3, 2).real # => 3
real -> Numeric
-
自身を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
[SEE_ALSO] Numeric#imag、Complex#real
real? -> false
-
常に false を返します。
[SEE_ALSO] Numeric#real?
real? -> bool
-
自身が Complex かそのサブクラスのインスタンスでない場合に true を返します。そうでない場合に false を返します。
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
rect -> [Numeric, Numeric]
rectangular -> [Numeric, Numeric]
-
実部と虚部を配列にして返します。
例:
Complex(3).rect # => [3, 0] Complex(3.5).rect # => [3.5, 0] Complex(3, 2).rect # => [3, 2]
rect -> [Numeric, Numeric]
rectangular -> [Numeric, Numeric]
-
[self, 0] を返します。
例:
1.rect # => [1, 0] -1.rect # => [-1, 0] 1.0.rect # => [1.0, 0] -1.0.rect # => [-1.0, 0]
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
remainder(other) -> Numeric
-
self を other で割った余り r を返します。
ここで、商 q と余り r は、
- self == other * q + r
と
- self > 0 のとき 0 <= r < |other|
- self < 0 のとき -|other| < r <= 0
- q は整数
をみたす数です。r の符号は self と同じになります。 商 q を直接返すメソッドはありません。self.quo(other).truncate がそれに相当します。
- [PARAM] other:
- 自身を割る数を指定します。
p 13.remainder(4) #=> 1 p (11.5).remainder(3.5) #=> 1.0 p 13.remainder(-4) #=> 1 p (-13).remainder(4) #=> -1 p (-13).remainder(-4) #=> -1 p (-11).remainder(3.5) #=> -0.5
[SEE_ALSO] Numeric#divmod, Numeric#modulo
round -> Integer
-
自身ともっとも近い整数を返します。
中央値 0.5, -0.5 はそれぞれ 1,-1 に切り上げされます。いわゆる四捨五入ですが、偶数丸めではありません。
1.round #=> 1 1.2.round #=> 1 (-1.2).round #=> -1 (-1.5).round #=> -2
[SEE_ALSO] Numeric#ceil, Numeric#floor, Numeric#truncate
step(limit, step = 1) {|n| ... } -> self
step(limit, step = 1) -> Enumerator
-
self からはじめ step を足しながら limit を越える 前までブロックを繰り返します。step は負の数も指定できます。また、limit や step には Float なども 指定できます。
- [PARAM] limit:
- ループの上限あるいは下限を数値で指定します。step に負の数が指定された場合は、 下限として解釈されます。
- [PARAM] step:
- 各ステップの大きさを数値で指定します。負の数を指定することもできます。
- [EXCEPTION] ArgumentError:
- step に 0 を指定した場合に発生します。
2.step(5){|n| p n} 2 3 4 5 1.1.step(1.5, 0.1) {|n| p n} => 1.1 1.2 1.3 1.4 1.5 10.step(6, -1){|n| p n} 10 9 8 7 6
注:浮動小数点数の 0.1 は 2進数では正確な表現ができない(2進数で 0.1は 0.00011001100....となる)ので、以下のようなループでは誤差が 生じて意図した回数ループしないことがある。step はこの誤差を考慮し て実装されている。
i = 1.1 while i <= 1.5 p i i += 0.1 end => 1.1 1.2 1.3 1.4 <- 1.5 が表示されない
[SEE_ALSO] Integer#downto
to_c -> Complex
-
自身を複素数 (Complex) に変換します。Complex(self, 0) を返します。
例:
1.to_c # => (1+0i) -1.to_c # => (-1+0i) 1.0.to_c # => (1.0+0i) Rational(1, 2).to_c # => ((1/2)+0i)
Numeric のサブクラスは、このメソッドを適切に再定義しなければなりません。
to_f -> Float
-
自身を Float に変換します。
- [EXCEPTION] RangeError:
- 虚部が 0 ではない場合に発生します。
例:
Complex(3).to_f # => 3.0 Complex(3.5).to_f # => 3.5 Complex(3, 2).to_f # => RangeError
to_i -> Integer
-
自身を整数に変換します。
- [EXCEPTION] RangeError:
- 虚部が 0 ではない場合に発生します。
例:
Complex(3).to_i # => 3 Complex(3).to_i # => 3 Complex(3.5).to_i # => 3 Complex(3, 2).to_i # => RangeError
to_int -> Integer
-
self.to_i と同じです。
to_s -> String
-
自身を "実部 + 虚部i" 形式の文字列にして返します。
truncate -> Integer
-
自身と 0 との間にある整数で、自身にもっとも近い整数を返します。
1.truncate #=> 1 1.2.truncate #=> 1 (-1.2).truncate #=> -1 (-1.5).truncate #=> -1
[SEE_ALSO] Numeric#ceil, Numeric#floor, Numeric#round
zero? -> bool
-
自身がゼロの時、真を返します。そうでない場合は false を返します。
p 10.zero? #=> false p 0.zero? #=> true p 0.0.zero? #=> true
定数
I -> Complex
-
虚数単位です。(0+1i) を返します。
- Ruby 1.9.3 リファレンスマニュアル
- はじめに
- コマンド
- Rubyの起動
- 環境変数
- Ruby言語仕様
- 組み込みライブラリ
- クラス
- Array
- BasicObject
- Bignum
- Binding
- Class
- Complex
- Data
- Dir
- Encoding
- Encoding::
Converter - Enumerator
- FalseClass
- Fiber
- File
- File::Stat
- Fixnum
- Float
- Hash
- IO
- Integer
- MatchData
- Method
- Module
- Mutex
- NilClass
- Numeric
- Object
- Proc
- Process::Status
- Random
- Range
- Rational
- Regexp
- String
- Struct
- Struct::Tms
- Symbol
- Thread
- ThreadGroup
- Time
- TrueClass
- UnboundMethod
- モジュール
- オブジェクト
- 例外クラス
- 組み込み関数
(Kernelモジュール関数) - 組み込み定数
(Kernel定数) - 組み込み特殊変数
- クラス
- 標準添付ライブラリ
- pack テンプレート文字列
- sprintf フォーマット
- Ruby用語集
- Rubyで使われる記号の意味
- 疑似BNFによるRubyの文法
- バージョン情報 / このリファレンスについて