org.rvpf.base.value

Class Complex

Object

Complex

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Complex.Cartesian, Complex.Polar

@Immutable
public abstract class Complex
extends Object
implements Serializable

Complex.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Complex.Cartesian Cartesian.
static class	Complex.Polar Polar.

Constructor Summary

Constructors

Constructor and Description
Complex()

Method Summary

Modifier and Type	Method and Description
abstract double	abs() Computes the absolute value of this complex number.
abstract Complex	acos() Computes the inverse cosine of this complex number.
abstract Complex	add(Complex complex) Adds an other complex number.
abstract double	angle() Returns the angle.
abstract double	argument() Computes the argument of this complex number.
abstract Complex	asin() Computes the inverse sine of this complex number.
abstract Complex	atan() Computes the inverse tangent of this complex number.
static Complex.Cartesian	cartesian(double real, double imaginary) Returns a complex number with cartesian representation.
abstract Complex	conjugate() Returns the conjugate of this complex number.
abstract Complex	cos() Computes the cosine of this complex number.
abstract Complex	cosh() Computes the hyperbolic cosine of this complex number.
abstract Complex	divide(Complex complex) Divides by an other complex number.
abstract boolean	equals(Object object)
abstract Complex	exp() Computes the exponential function of this complex number.
abstract int	hashCode()
abstract double	imaginary() Returns the imaginary part.
abstract boolean	isCartesian() Asks if this is a cartesian representation.
abstract boolean	isInfinite() Asks if this is an infinite number.
abstract boolean	isNaN() Asks if this is not a number (NaN).
abstract boolean	isPolar() Asks if this is a polar representation.
abstract Complex	log() Computes the natural logarithm of this complex number.
abstract double	magnitude() Returns the magnitude.
abstract Complex	multiply(Complex complex) Multiplies with an other complex number.
abstract Complex	negate() Negates this number.
static Complex.Polar	polar(double magnitude, double angle) Returns a complex number with polar representation.
abstract Complex	pow(Complex complex) Computes this complex number raised at the power of an other.
abstract double	real() Returns the real part.
abstract int	signum() Computes the signum function of this complex number.
abstract Complex	sin() Computes the sine of this complex number.
abstract Complex	sinh() Computes the hyperbolic sine of this complex number.
abstract Complex	sqrt() Computes the square root of this complex number.
abstract Complex	subtract(Complex complex) Subtracts an other complex number.
abstract Complex	tan() Computes the tangent of this complex number.
abstract Complex	tanh() Computes the hyperbolic tangent of this complex number.
abstract Complex.Cartesian	toCartesian() Returns a cartesian representation of this.
abstract String	toHexString() Returns an hexadecimal representation of this number.
abstract Complex.Polar	toPolar() Returns a polar representation of this.
abstract String	toString()
static Complex	valueOf(String string) Returns a complex number from the value of a string.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Complex

public Complex()

Method Detail

cartesian

@Nonnull
 @CheckReturnValue
public static Complex.Cartesian cartesian(double real,
                                                                        double imaginary)

Returns a complex number with cartesian representation.

Parameters:

real - The real part.

imaginary - The imaginary part.

Returns:

The complex number.

polar

@Nonnull
 @CheckReturnValue
public static Complex.Polar polar(double magnitude,
                                                                double angle)

Returns a complex number with polar representation.

Parameters:

magnitude - The magnitude (r).

angle - The angle (theta).

Returns:

The complex number.

valueOf

@Nonnull
 @CheckReturnValue
public static Complex valueOf(String string)

Returns a complex number from the value of a string.

Parameters:

string - The string.

Returns:

The complex number.

abs

@CheckReturnValue
public abstract double abs()

Computes the absolute value of this complex number.

Returns:

The result.

acos

@Nonnull
 @CheckReturnValue
public abstract Complex acos()

Computes the inverse cosine of this complex number.

Returns:

The result.

add

@Nonnull
 @CheckReturnValue
public abstract Complex add(@Nonnull
                                                          Complex complex)

Adds an other complex number.

Parameters:

complex - The other complex number.

Returns:

The result.

angle

@CheckReturnValue
public abstract double angle()

Returns the angle.

Returns:

The angle.

argument

@CheckReturnValue
public abstract double argument()

Computes the argument of this complex number.

Returns:

The result.

asin

@Nonnull
 @CheckReturnValue
public abstract Complex asin()

Computes the inverse sine of this complex number.

Returns:

The result.

atan

@Nonnull
 @CheckReturnValue
public abstract Complex atan()

Computes the inverse tangent of this complex number.

Returns:

The result.

conjugate

@Nonnull
 @CheckReturnValue
public abstract Complex conjugate()

Returns the conjugate of this complex number.

Returns:

The conjugate.

cos

@Nonnull
 @CheckReturnValue
public abstract Complex cos()

Computes the cosine of this complex number.

Returns:

The result.

cosh

@Nonnull
 @CheckReturnValue
public abstract Complex cosh()

Computes the hyperbolic cosine of this complex number.

Returns:

The result.

divide

@Nonnull
 @CheckReturnValue
public abstract Complex divide(@Nonnull
                                                             Complex complex)

Divides by an other complex number.

Parameters:

complex - The other complex number.

Returns:

The result.

equals

public abstract boolean equals(Object object)

Overrides:

equals in class Object

exp

@Nonnull
 @CheckReturnValue
public abstract Complex exp()

Computes the exponential function of this complex number.

Returns:

The result.

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

imaginary

@CheckReturnValue
public abstract double imaginary()

Returns the imaginary part.

Returns:

The imaginary part.

isCartesian

@CheckReturnValue
public abstract boolean isCartesian()

Asks if this is a cartesian representation.

Returns:

True if it is a cartesian representation.

isInfinite

@CheckReturnValue
public abstract boolean isInfinite()

Asks if this is an infinite number.

Returns:

True if it is infinite.

isNaN

@CheckReturnValue
public abstract boolean isNaN()

Asks if this is not a number (NaN).

Returns:

True if it is NaN.

isPolar

@CheckReturnValue
public abstract boolean isPolar()

Asks if this is a polar representation.

Returns:

True if it is a polar representation.

log

@Nonnull
 @CheckReturnValue
public abstract Complex log()

Computes the natural logarithm of this complex number.

Returns:

The result.

magnitude

@CheckReturnValue
public abstract double magnitude()

Returns the magnitude.

Returns:

The magnitude.

multiply

@Nonnull
 @CheckReturnValue
public abstract Complex multiply(@Nonnull
                                                               Complex complex)

Multiplies with an other complex number.

Parameters:

complex - The other complex number.

Returns:

The result.

negate

@Nonnull
 @CheckReturnValue
public abstract Complex negate()

Negates this number.

Returns:

The result.

pow

@Nonnull
 @CheckReturnValue
public abstract Complex pow(@Nonnull
                                                          Complex complex)

Computes this complex number raised at the power of an other.

Parameters:

complex - The other complex number.

Returns:

The result.

real

@CheckReturnValue
public abstract double real()

Returns the real part.

Returns:

The real part.

signum

@CheckReturnValue
public abstract int signum()

Computes the signum function of this complex number.

Returns:

The result.

sin

@Nonnull
 @CheckReturnValue
public abstract Complex sin()

Computes the sine of this complex number.

Returns:

The result.

sinh

@Nonnull
 @CheckReturnValue
public abstract Complex sinh()

Computes the hyperbolic sine of this complex number.

Returns:

The result.

sqrt

@Nonnull
 @CheckReturnValue
public abstract Complex sqrt()

Computes the square root of this complex number.

Returns:

The result.

subtract

@Nonnull
 @CheckReturnValue
public abstract Complex subtract(@Nonnull
                                                               Complex complex)

Subtracts an other complex number.

Parameters:

complex - The other complex number.

Returns:

The result.

tan

@Nonnull
 @CheckReturnValue
public abstract Complex tan()

Computes the tangent of this complex number.

Returns:

The result.

tanh

@Nonnull
 @CheckReturnValue
public abstract Complex tanh()

Computes the hyperbolic tangent of this complex number.

Returns:

The result.

toCartesian

@Nonnull
 @CheckReturnValue
public abstract Complex.Cartesian toCartesian()

Returns a cartesian representation of this.

Returns:

The cartesian representation.

toHexString

@Nonnull
 @CheckReturnValue
public abstract String toHexString()

Returns an hexadecimal representation of this number.

Returns:

The hexadecimal representation.

toPolar

@Nonnull
 @CheckReturnValue
public abstract Complex.Polar toPolar()

Returns a polar representation of this.

Returns:

The polar representation.

toString

public abstract String toString()

Overrides:

toString in class Object