org.drip.quant.fourier

Class ComplexNumber

java.lang.Object

org.drip.quant.fourier.ComplexNumber

public class ComplexNumber
extends java.lang.Object

ComplexNumber implements the functionality for dealing with Complex Numbers.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
ComplexNumber(double dblReal, double dblImaginary) ComplexNumber constructor

Method Summary

Modifier and Type	Method and Description
double	abs() Retrieve the Absolute Value
static ComplexNumber	Add(ComplexNumber cn1, ComplexNumber cn2) Add the 2 Complex Numbers
double	argument() Retrieve the Argument
java.lang.String	display() Display the Real/Imaginary Contents
static ComplexNumber	Divide(ComplexNumber cnNumerator, ComplexNumber cnDenominator) Divide the Numerator Complex Number by the Denominator
static ComplexNumber	Exponentiate(ComplexNumber cn) Exponentiate the Complex Number
double	imaginary() Retrieve the Imaginary Part
static ComplexNumber	Logarithm(ComplexNumber cn) Compute Logarithm of the Complex Number
double	modulus() Retrieve the Modulus
static ComplexNumber	Multiply(ComplexNumber cn1, ComplexNumber cn2) Multiply the 2 Complex Numbers
double	real() Retrieve the Real Part
static ComplexNumber	Scale(ComplexNumber cn, double dblScale) Scale the Complex Number with the factor
static ComplexNumber	Square(ComplexNumber cn) Square the Complex Number
static ComplexNumber	SquareRoot(ComplexNumber cn) Compute the Square Root of the Complex Number
static ComplexNumber	Subtract(ComplexNumber cn1, ComplexNumber cn2) Subtract the Second Complex Number from the First

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComplexNumber

public ComplexNumber(double dblReal,
                     double dblImaginary)
              throws java.lang.Exception

ComplexNumber constructor

Parameters:

dblReal - Real Part

dblImaginary - Imaginary Part

Throws:

java.lang.Exception - Thrown if the Inputs are invalid

Method Detail

Add

public static final ComplexNumber Add(ComplexNumber cn1,
                                      ComplexNumber cn2)

Add the 2 Complex Numbers

Parameters:

cn1 - The First Complex Number

cn2 - The Second Complex Number

Returns:

The Complex Number instance that is a sum of the two

Scale

public static final ComplexNumber Scale(ComplexNumber cn,
                                        double dblScale)

Scale the Complex Number with the factor

Parameters:

cn - The Complex Number

dblScale - The Scaling Factor

Returns:

The Scaled Complex Number

Subtract

public static final ComplexNumber Subtract(ComplexNumber cn1,
                                           ComplexNumber cn2)

Subtract the Second Complex Number from the First

Parameters:

cn1 - The First Complex Number

cn2 - The Second Complex Number

Returns:

The "Difference" Complex Number

Multiply

public static final ComplexNumber Multiply(ComplexNumber cn1,
                                           ComplexNumber cn2)

Multiply the 2 Complex Numbers

Parameters:

cn1 - The First Complex Number

cn2 - The Second Complex Number

Returns:

The Complex Number instance that is a product of the two

Divide

public static final ComplexNumber Divide(ComplexNumber cnNumerator,
                                         ComplexNumber cnDenominator)

Divide the Numerator Complex Number by the Denominator

Parameters:

cnNumerator - The Numerator Complex Number

cnDenominator - The Denominator Complex Number

Returns:

The "Divided" Complex Number

Square

public static final ComplexNumber Square(ComplexNumber cn)

Square the Complex Number

Parameters:

cn - The Complex Number

Returns:

The Squared Complex Number Instance

SquareRoot

public static final ComplexNumber SquareRoot(ComplexNumber cn)

Compute the Square Root of the Complex Number

Parameters:

cn - The Complex Number

Returns:

The Square Root Complex Number Instance

Exponentiate

public static final ComplexNumber Exponentiate(ComplexNumber cn)

Exponentiate the Complex Number

Parameters:

cn - The Complex Number

Returns:

The Exponentiated Complex Number Instance

Logarithm

public static final ComplexNumber Logarithm(ComplexNumber cn)

Compute Logarithm of the Complex Number

Parameters:

cn - The Complex Number

Returns:

The Complex Number Logarithm Instance

real

public double real()

Retrieve the Real Part

Returns:

The Real Part

imaginary

public double imaginary()

Retrieve the Imaginary Part

Returns:

The Imaginary Part

modulus

public double modulus()

Retrieve the Modulus

Returns:

The Modulus

abs

public double abs()

Retrieve the Absolute Value

Returns:

The Absolute Value

argument

public double argument()

Retrieve the Argument

Returns:

The Argument

display

public java.lang.String display()

Display the Real/Imaginary Contents

Returns:

The Real/Imaginary Contents