triana.types

Class Const

java.lang.Object

java.lang.Number

triana.types.Const

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, Arithmetic

public class Const
extends java.lang.Number
implements Arithmetic, java.lang.Comparable

Const is a wrapper for basic base number types e.g. int, float, long, short and double. It stores a single real or complex number of one of those types.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Const() Creates a new Const with default 0 value
Const(double num) Creates a new real Const for double input.
Const(double r, double i) Creates a new complex Const for double input.
Const(java.lang.Number number) Creates a new complex Const from a number input.
Const(java.lang.String str) Creates a new Const from the specified string, which should be of the format "1.0", or "1.0 + 1.0i" for complex numbers.

Method Summary

Methods

Modifier and Type	Method and Description
Arithmetic	add(java.lang.Object obj) Adds this object and the given number
int	compareTo(java.lang.Object num) Compares this object with the specified object for order.
Arithmetic	divide(java.lang.Object obj) Divides this object by the given object
double	doubleValue() Returns the value of the specified number as a double.
boolean	equals(java.lang.Object num) Returns true if the specified Object has the same value as the Const (the Object must be an instance of number).
float	floatValue() Returns the value of the specified number as a float.
double	getImag()
double	getReal()
int	intValue() Returns the value of the specified number as an int.
boolean	isCompatible(java.lang.Object obj) Tests that the given object is a Const.
boolean	isComplex()
long	longValue() Returns the value of the specified number as a long.
Arithmetic	multiply(java.lang.Object obj) Multiplies this objectand the give number
void	setComplex(double r, double i) Set the real part and imaginary parts to the given double inputs.
void	setImag(double i) Set the imaginary part to the given double.
void	setReal(double r) Set the real part to the given double.
Arithmetic	subtract(java.lang.Object obj) Subtracts the number from this object
java.lang.String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Const

public Const()

Creates a new Const with default 0 value

Const

public Const(double num)

Creates a new real Const for double input.

Parameters:

num - the double value.

Const

public Const(java.lang.Number number)

Creates a new complex Const from a number input.

Parameters:

number - the number value.

Const

public Const(java.lang.String str)
      throws java.lang.NumberFormatException

Creates a new Const from the specified string, which should be of the format "1.0", or "1.0 + 1.0i" for complex numbers.

Parameters:

str - the const string

Throws:

java.lang.NumberFormatException

Const

public Const(double r,
     double i)

Creates a new complex Const for double input.

Parameters:

r - the real double value.

i - the imaginary double value.

Method Detail

isComplex

public boolean isComplex()

Returns:

boolean True if the imaginary part is non-zero, false otherwise

getReal

public double getReal()

Returns:

the real part of the Const

getImag

public double getImag()

Returns:

the imaginary part of the Const

setReal

public void setReal(double r)

Set the real part to the given double.

setImag

public void setImag(double i)

Set the imaginary part to the given double.

setComplex

public void setComplex(double r,
              double i)

Set the real part and imaginary parts to the given double inputs.

isCompatible

public boolean isCompatible(java.lang.Object obj)

Tests that the given object is a Const. No test needed on the contents.

Specified by:

isCompatible in interface Arithmetic

Parameters:

obj - The data object to be compared with the current one

Returns:

boolean True if the object can be combined with the current one

equals

public boolean equals(java.lang.Object num)

Returns true if the specified Object has the same value as the Const (the Object must be an instance of number).

Specified by:

equals in interface Arithmetic

Overrides:

equals in class java.lang.Object

Parameters:

num - The object to be tested

Returns:

True if the given Object is a Const whose contents equal those of the current one

compareTo

public int compareTo(java.lang.Object num)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable

add

public Arithmetic add(java.lang.Object obj)
               throws java.lang.ClassCastException

Adds this object and the given number

Specified by:

add in interface Arithmetic

Parameters:

obj - the object containing the number for the arithmetic

Returns:

the result of the addition

Throws:

java.lang.ClassCastException - if addition with the specified object is not valid

subtract

public Arithmetic subtract(java.lang.Object obj)
                    throws java.lang.ClassCastException

Subtracts the number from this object

Specified by:

subtract in interface Arithmetic

Parameters:

obj - the object containing the number for the arithmetic

Returns:

the result of the subtraction

Throws:

java.lang.ClassCastException - if subtraction with the specified object is not valid

multiply

public Arithmetic multiply(java.lang.Object obj)
                    throws java.lang.ClassCastException

Multiplies this objectand the give number

Specified by:

multiply in interface Arithmetic

Parameters:

obj - the object containing the number for the arithmetic

Returns:

the result of the multiplication

Throws:

java.lang.ClassCastException - if multiplication with the specified object is not valid

divide

public Arithmetic divide(java.lang.Object obj)
                  throws java.lang.ClassCastException

Divides this object by the given object

Specified by:

divide in interface Arithmetic

Parameters:

obj - the object containing the number for the arithmetic

Returns:

the result of the division

Throws:

java.lang.ClassCastException - if division with the specified object is not valid

intValue

public int intValue()

Returns the value of the specified number as an int. This may involve rounding or truncation.

Specified by:

intValue in class java.lang.Number

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public long longValue()

Returns the value of the specified number as a long. This may involve rounding or truncation.

Specified by:

longValue in class java.lang.Number

Returns:

the numeric value represented by this object after conversion to type long.

floatValue

public float floatValue()

Returns the value of the specified number as a float. This may involve rounding.

Specified by:

floatValue in class java.lang.Number

Returns:

the numeric value represented by this object after conversion to type float.

doubleValue

public double doubleValue()

Returns the value of the specified number as a double. This may involve rounding.

Specified by:

doubleValue in class java.lang.Number

Returns:

the numeric value represented by this object after conversion to type double.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.