Class Complex
In: lib/complex.rb
lib/mathn.rb
Parent: Numeric

The complex number class. See complex.rb for an overview.

Methods

%   *   **   +   -   /   <=>   ==   abs   abs2   angle   arg   coerce   conj   conjugate   denominator   hash   inspect   new   new!   numerator   polar   polar   to_s  

Constants

I = Complex(0,1)   I is the imaginary number. It exists at point (0,1) on the complex plane.
Unify = true

External Aliases

image -> imag

Attributes

image  [R]  The imaginary part of a complex number.
real  [R]  The real part of a complex number.

Public Class methods

new!(a, b=0)

Creates a Complex number a+bi.

polar(r, theta)

Creates a Complex number in terms of r (radius) and theta (angle).

Public Instance methods

%(other)

Remainder after division by a real or complex number.

*(other)

Multiplication with real or complex number.

**(other)

Raise this complex number to the given (real or complex) power.

+(other)

Addition with real or complex number.

-(other)

Subtraction with real or complex number.

/(other)

Division by real or complex number.

<=>(other)

Compares the absolute values of the two numbers.

==(other)

Test for numerical equality (a == a + 0i).

abs()

Absolute value (aka modulus): distance from the zero point on the complex plane.

abs2()

Square of the absolute value.

angle()

Alias for arg

arg()

Argument (angle from (1,0) on the complex plane).

coerce(other)

Attempts to coerce other to a Complex number.

conj()

Alias for conjugate

conjugate()

Complex conjugate (z + z.conjugate = 2 * z.real).

hash()

Returns a hash code for the complex number.

inspect()

Returns "Complex(real, image)".

polar()

Returns the absolute value and the argument.

to_s()

Standard string representation of the complex number.

[Validate]

ruby-doc.org is a service of James Britt and Neurogami, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.