Complex

java.lang.Object
- java.lang.Number
- - com.heirloomcomputing.epli.runtime.Complex

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Complex>
```
public final class Complex
extends java.lang.Number
implements java.lang.Comparable<Complex>
```
Complex - immutable Java class implementation of the PL/I Complex datatype

Author:

Princeton University Modified by Heirloom Computing to conform with Elastic PL/I runtime conventions for objects (add() instead of plus(); valueOf(), xxxValue() conversions, etc.). Several methods are not used by generated code (e.g., conjugate(), scale()) as there is no parallel in PL/I COMPLEX datatypes but are left in for completeness., Heirloom Computing, Inc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int BYTES
size in bytes if converted to a byte array

static Complex ZERO

Fields
Modifier and Type	Field and Description
`static int`	`BYTES` size in bytes if converted to a byte array
`static Complex`	`ZERO`

Constructor Summary

Constructors
Constructor and Description
`Complex()` Constructor - new Complex variable without a value is 0.0/0.0
`Complex(double real)` Constructor - construct a Complex number from a "real part"
`Complex(double real, double imag)` Constructor - construct a Complex number from a "real part" and "imaginary part"

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`abs()` abs() - return abs/modulus/magnitude
`Complex`	`add(Complex b)` add(b) - return a new Complex object whose value is (this + b)
`java.math.BigInteger`	`bigIntegerValue()` bigIntegerValue() - return a big integer from a Complex number
`boolean`	`booleanValue()` booleanValue() - return a (truncated) boolean from a Complex number
`byte`	`byteValue()` byteValue() - return a (truncated) byte from a Complex number
`int`	`compareTo(Complex x)` compareTo - compare two Complex numbers
`Complex`	`conjugate()` conjugate() - return a new Complex object whose value is the conjugate of this
`Complex`	`cos()` cos() - return a new Complex object whose value is the complex cosine of this
`Complex`	`divide(Complex b)` divide(b) - return a / b
`double`	`doubleValue()` doubleValue() - return a (truncated) double from a Complex number
`boolean`	`equals(java.lang.Object x)` equals - compare two Complex numbers for equality
`Complex`	`exp()` exp() - return a new Complex object whose value is the complex exponential of this
`FixedBin`	`fixedBinValue()` fixedBinValue() - return a (truncated) FixedBin from a Complex number
`float`	`floatValue()` floatValue() - return a (truncated) float from a Complex number
`void`	`fromBytes(byte[] bytes)` convert a byte array (from an I/O or Group assignment) to this Complex number (making it mutable for the moment)
`int`	`hashCode()`
`java.lang.Double`	`imag()` imag() - return the imaginary part of athis complex number
`double`	`imagValue()` imagValue() - same as imag() but return primitive double
`int`	`intValue()` intValue() - return a (truncated) integer from a Complex number
`long`	`longValue()` longValue() - return a (truncated) long from a Complex number
`static void`	`main(java.lang.String[] args)` main - unit test for Complex
`Complex`	`multiply(Complex b)` multiply(b) - return a new Complex object whose value is (this * b)
`Complex`	`negate()` negate() - return a new Complex object whose value is -this
`static Complex`	`parseComplex(java.lang.String value)` parseComplex() - similar to valueOf(String) except throws traditional NumberFormatException
`double`	`phase()` phase() - return angle/phase/argument, normalized to be between -pi and pi
`java.lang.Double`	`real()` real() - return the real part of this complex number
`double`	`realValue()` realValue() - same as real() but return primitive double
`Complex`	`reciprocal()` reciprical() - return a new Complex object whose value is the reciprocal of this
`Complex`	`scale(double alpha)` scale(a) - return a new object whose value is (this * alpha)
`short`	`shortValue()` shortValue() - return a (truncated) short from a Complex number
`Complex`	`sin()` sin() - return a new Complex object whose value is the complex sine of this
`Complex`	`subtract(Complex b)` subtract(b) - return a new Complex object whose value is (this - b)
`Complex`	`tan()` tan() - return a new Complex object whose value is the complex tangent of this
`byte[]`	`toBytes()` convert Complex to a byte array (for an I/O or Group assignment)
`java.lang.String`	`toString()` toString() - return a String representation of the invoking Complex object
`static Complex`	`valueOf(java.math.BigDecimal b)` valueOf() - construct a Complex number from a BigDecimal
`static Complex`	`valueOf(java.math.BigInteger b)` valueOf() - construct a Complex number from a BigInteger
`static Complex`	`valueOf(BitN bs)` valueOf() - construct a Complex number from a BitN
`static Complex`	`valueOf(java.lang.Boolean b)` valueOf() - construct a Complex number from a Boolean
`static Complex`	`valueOf(byte i)` valueOf() - construct a Complex number from a byte
`static Complex`	`valueOf(byte[] bytes)` valueOf() - construct a Complex number from a byte array (use instead of fromBytes() because Complex is immutable)
`static Complex`	`valueOf(double d)` valueOf() - construct a Complex number from a double or float
`static Complex`	`valueOf(double real, double imag)` valueOf() - construct a Complex number from a "real part" and "imaginary part"
`static Complex`	`valueOf(FixedBin f)` valueOf() - construct a Complex number from a FixedBin
`static Complex`	`valueOf(int i)` valueOf() - construct a Complex number from an int
`static Complex`	`valueOf(long i)` valueOf() - construct a Complex number from a long
`static Complex`	`valueOf(short i)` valueOf() - construct a Complex number from a short
`static Complex`	`valueOf(java.lang.String str)` valueOf() - construct a Complex number from a string [I]

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BYTES
```
public static final int BYTES
```
    size in bytes if converted to a byte array
    
    See Also:
    
    Constant Field Values
  - ZERO
```
public static final Complex ZERO
```
- Constructor Detail
  - Complex
```
public Complex()
```
    Constructor - new Complex variable without a value is 0.0/0.0
  - Complex
```
public Complex(double real,
               double imag)
```
    Constructor - construct a Complex number from a "real part" and "imaginary part"
    
    Parameters:
    
    real -
    
    imag -
  - Complex
```
public Complex(double real)
```
    Constructor - construct a Complex number from a "real part"
    
    Parameters:
    
    real -
- Method Detail
  - valueOf
```
public static Complex valueOf(double real,
                              double imag)
```
    valueOf() - construct a Complex number from a "real part" and "imaginary part"
    
    Parameters:
    
    real -
    
    imag -
    
    Returns:
    
    the Complex number making up both
  - valueOf
```
public static Complex valueOf(java.lang.String str)
```
    valueOf() - construct a Complex number from a string [I]
    
    Parameters:
    
    str - - a String in the same format as returned by toString()
    
    Returns:
    
    a new Complex number
  - parseComplex
```
public static Complex parseComplex(java.lang.String value)
```
    parseComplex() - similar to valueOf(String) except throws traditional NumberFormatException
    
    Parameters:
    
    value - - a String in the same format as returned by toString()
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(long i)
```
    valueOf() - construct a Complex number from a long
    
    Parameters:
    
    i - - a long representing the real part
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(int i)
```
    valueOf() - construct a Complex number from an int
    
    Parameters:
    
    i - - an int representing the real part
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(short i)
```
    valueOf() - construct a Complex number from a short
    
    Parameters:
    
    i - - a short representing the real part
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(byte i)
```
    valueOf() - construct a Complex number from a byte
    
    Parameters:
    
    i - - a byte representing the real part
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(double d)
```
    valueOf() - construct a Complex number from a double or float
    
    Parameters:
    
    d - - a double
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(FixedBin f)
```
    valueOf() - construct a Complex number from a FixedBin
    
    Parameters:
    
    f - - a FixedBin
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(java.math.BigDecimal b)
```
    valueOf() - construct a Complex number from a BigDecimal
    
    Parameters:
    
    b - - a BigDecimal
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(java.math.BigInteger b)
```
    valueOf() - construct a Complex number from a BigInteger
    
    Parameters:
    
    b - - a BigInteger
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(java.lang.Boolean b)
```
    valueOf() - construct a Complex number from a Boolean
    
    Parameters:
    
    b - - a Boolean
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(BitN bs)
```
    valueOf() - construct a Complex number from a BitN
    
    Parameters:
    
    bs - - a BitN
    
    Returns:
    
    a new Complex number
  - valueOf
```
public static Complex valueOf(byte[] bytes)
```
    valueOf() - construct a Complex number from a byte array (use instead of fromBytes() because Complex is immutable)
    
    Parameters:
    
    bytes - - a 16-byte byte array
    
    Returns:
    
    a new Complex number
    
    Throws:
    
    CONVERSION - CONDITION
  - real
```
public java.lang.Double real()
```
    real() - return the real part of this complex number
    
    Returns:
    
    the real part of this Complex number
  - imag
```
public java.lang.Double imag()
```
    imag() - return the imaginary part of athis complex number
    
    Returns:
    
    the imaginary part of this Complex number
  - toString
```
public java.lang.String toString()
```
    toString() - return a String representation of the invoking Complex object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String representation of this Complex number following the format "real-part +|- imaginary-part I"
  - intValue
```
public int intValue()
```
    intValue() - return a (truncated) integer from a Complex number
    
    Specified by:
    
    intValue in class java.lang.Number
    
    Returns:
    
    the real part as an int
  - shortValue
```
public short shortValue()
```
    shortValue() - return a (truncated) short from a Complex number
    
    Overrides:
    
    shortValue in class java.lang.Number
    
    Returns:
    
    the real part as an short
  - byteValue
```
public byte byteValue()
```
    byteValue() - return a (truncated) byte from a Complex number
    
    Overrides:
    
    byteValue in class java.lang.Number
    
    Returns:
    
    the real part as an byte
  - longValue
```
public long longValue()
```
    longValue() - return a (truncated) long from a Complex number
    
    Specified by:
    
    longValue in class java.lang.Number
    
    Returns:
    
    the real part as an long
  - bigIntegerValue
```
public java.math.BigInteger bigIntegerValue()
```
    bigIntegerValue() - return a big integer from a Complex number
    
    Returns:
    
    the real part as a big int
  - doubleValue
```
public double doubleValue()
```
    doubleValue() - return a (truncated) double from a Complex number
    
    Specified by:
    
    doubleValue in class java.lang.Number
    
    Returns:
    
    the real part as a double
  - floatValue
```
public float floatValue()
```
    floatValue() - return a (truncated) float from a Complex number
    
    Specified by:
    
    floatValue in class java.lang.Number
    
    Returns:
    
    the real part as a float
  - booleanValue
```
public boolean booleanValue()
```
    booleanValue() - return a (truncated) boolean from a Complex number
    
    Returns:
    
    the real part as a boolean in which false is 0.0 and true is anything else
  - realValue
```
public double realValue()
```
    realValue() - same as real() but return primitive double
    
    Returns:
    
    the real part as a float
  - imagValue
```
public double imagValue()
```
    imagValue() - same as imag() but return primitive double
    
    Returns:
    
    the real part as a float
  - fixedBinValue
```
public FixedBin fixedBinValue()
```
    fixedBinValue() - return a (truncated) FixedBin from a Complex number
    
    Returns:
    
    the real part as a FixedBin
  - abs
```
public double abs()
```
    abs() - return abs/modulus/magnitude
    
    Returns:
    
    the absolute value of a complex number
  - phase
```
public double phase()
```
    phase() - return angle/phase/argument, normalized to be between -pi and pi
    
    Returns:
    
    return the phase of a ocmplex number
  - negate
```
public Complex negate()
```
    negate() - return a new Complex object whose value is -this
    
    Returns:
    
    the negation of a Complex number
  - add
```
public Complex add(Complex b)
```
    add(b) - return a new Complex object whose value is (this + b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the sum of two Complex numbers
  - subtract
```
public Complex subtract(Complex b)
```
    subtract(b) - return a new Complex object whose value is (this - b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the difference of two Complex numbers
  - multiply
```
public Complex multiply(Complex b)
```
    multiply(b) - return a new Complex object whose value is (this * b)
    
    Parameters:
    
    b -
    
    Returns:
    
    the result of multiplying two Complex numbers
  - scale
```
public Complex scale(double alpha)
```
    scale(a) - return a new object whose value is (this * alpha)
    
    Parameters:
    
    alpha -
    
    Returns:
    
    the result of scaling a Complex number
  - conjugate
```
public Complex conjugate()
```
    conjugate() - return a new Complex object whose value is the conjugate of this
    
    Returns:
    
    a Complex number with the imaginary negated
  - reciprocal
```
public Complex reciprocal()
```
    reciprical() - return a new Complex object whose value is the reciprocal of this
    
    Returns:
    
    the Complex number that's the reciprical
  - divide
```
public Complex divide(Complex b)
```
    divide(b) - return a / b
    
    Parameters:
    
    b - Complex number as the divisor
    
    Returns:
    
    the Complex number dividend of this by the given divisor
  - exp
```
public Complex exp()
```
    exp() - return a new Complex object whose value is the complex exponential of this
    
    Returns:
    
    the exponential
  - sin
```
public Complex sin()
```
    sin() - return a new Complex object whose value is the complex sine of this
    
    Returns:
    
    the sine
  - cos
```
public Complex cos()
```
    cos() - return a new Complex object whose value is the complex cosine of this
    
    Returns:
    
    the co-sign
  - tan
```
public Complex tan()
```
    tan() - return a new Complex object whose value is the complex tangent of this
    
    Returns:
    
    the tangent
  - fromBytes
```
public void fromBytes(byte[] bytes)
```
    convert a byte array (from an I/O or Group assignment) to this Complex number (making it mutable for the moment)
    
    Parameters:
    
    bytes - - the byte array
    
    See Also:
    
    for the proper way to create new Complex numbers from bytes
  - toBytes
```
public byte[] toBytes()
```
    convert Complex to a byte array (for an I/O or Group assignment)
    
    Returns:
    
    the byte array made up of this Complex number
  - equals
```
public boolean equals(java.lang.Object x)
```
    equals - compare two Complex numbers for equality
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    x - - a Complex number to compare
    
    Returns:
    
    false if contents are not equal to this Complex number
    
    Throws:
    
    CONVERSION - condition if x is not Complex
  - compareTo
```
public int compareTo(Complex x)
```
    compareTo - compare two Complex numbers
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Complex>
    
    Parameters:
    
    x - - a Complex number to compare
    
    Returns:
    
    the value 0 if this Complex is equal to the argument Integer; a value less than 0 if this Complex is numerically less than the argument Complex; and a value greater than 0 if this Complex is numerically greater than the argument Complex (signed comparison).
    
    Throws:
    
    CONVERSION - condition if x is not Complex
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - main
```
public static void main(java.lang.String[] args)
```
    main - unit test for Complex
    
    Parameters:
    
    args - - the real & imaginary part of operand "a" and "b", respectively

Class Complex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTES

ZERO

Constructor Detail

Complex

Complex

Complex

Method Detail

valueOf

valueOf

parseComplex

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

valueOf

real

imag

toString

intValue

shortValue

byteValue

longValue

bigIntegerValue

doubleValue

floatValue

booleanValue

realValue

imagValue

fixedBinValue

abs

phase

negate

add

subtract

multiply

scale

conjugate

reciprocal

divide

exp

sin

cos

tan

fromBytes

toBytes

equals

compareTo

hashCode

main