Package org.drip.function.definition

Class CartesianComplexNumber

java.lang.Object
org.drip.function.definition.CartesianComplexNumber
public class CartesianComplexNumber
extends java.lang.Object
CartesianComplexNumber implements the functionality for dealing with the Cartesian Form of Complex Numbers.



Author:
Lakshmi Krishnamurthy

  • Constructor Details

    • CartesianComplexNumber

      public CartesianComplexNumber​(double real, double imaginary) throws java.lang.Exception
      CartesianComplexNumber constructor
      Parameters:
      real - Real Part
      imaginary - Imaginary Part
      Throws:
      java.lang.Exception - Thrown if the Inputs are invalid

  • Method Details

    • Add

      public static final CartesianComplexNumber Add​(CartesianComplexNumber complexNumber1, CartesianComplexNumber complexNumber2)
      Add the 2 Complex Numbers
      Parameters:
      complexNumber1 - The First Complex Number
      complexNumber2 - The Second Complex Number
      Returns:
      The Complex Number instance that is a sum of the two

    • Scale

      public static final CartesianComplexNumber Scale​(CartesianComplexNumber complexNumber, double scale)
      Scale the Complex Number with the factor
      Parameters:
      complexNumber - The Complex Number
      scale - The Scaling Factor
      Returns:
      The Scaled Complex Number

    • Subtract

      public static final CartesianComplexNumber Subtract​(CartesianComplexNumber complexNumber1, CartesianComplexNumber complexNumber2)
      Subtract the Second Complex Number from the First
      Parameters:
      complexNumber1 - The First Complex Number
      complexNumber2 - The Second Complex Number
      Returns:
      The "Difference" Complex Number

    • Multiply

      public static final CartesianComplexNumber Multiply​(CartesianComplexNumber complexNumber1, CartesianComplexNumber complexNumber2)
      Multiply the 2 Complex Numbers
      Parameters:
      complexNumber1 - The First Complex Number
      complexNumber2 - The Second Complex Number
      Returns:
      The Complex Number instance that is a product of the two

    • Divide

      public static final CartesianComplexNumber Divide​(CartesianComplexNumber numerator, CartesianComplexNumber denominator)
      Divide the Numerator Complex Number by the Denominator Complex Number
      Parameters:
      numerator - The Numerator Complex Number
      denominator - The Denominator Complex Number
      Returns:
      The "Divided" Complex Number

    • Square

      public static final CartesianComplexNumber Square​(CartesianComplexNumber complexNumber)
      Square the Complex Number
      Parameters:
      complexNumber - The Complex Number
      Returns:
      The Squared Complex Number Instance

    • SquareRoot

      public static final CartesianComplexNumber SquareRoot​(CartesianComplexNumber complexNumber)
      Compute the Square Root of the Complex Number
      Parameters:
      complexNumber - The Complex Number
      Returns:
      The Square Root Complex Number Instance

    • Exponentiate

      public static final CartesianComplexNumber Exponentiate​(CartesianComplexNumber complexNumber)
      Exponentiate the Complex Number
      Parameters:
      complexNumber - The Complex Number
      Returns:
      The Exponentiated Complex Number Instance

    • Logarithm

      public static final CartesianComplexNumber Logarithm​(CartesianComplexNumber complexNumber)
      Compute Logarithm of the Complex Number
      Parameters:
      complexNumber - The Complex Number
      Returns:
      The Complex Number Logarithm Instance

    • FromPolar

      public static final CartesianComplexNumber FromPolar​(double r, double theta)
      Construct the Complex Number from its Polar Representation
      Parameters:
      r - r
      theta - theta
      Returns:
      Complex Number from its Polar Representation

    • 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