|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Number
org.apfloat.Apcomplex
Arbitrary precision complex number class. An apcomplex consists of
a real and imaginary part of type Apfloat
.
Note that although the Apcomplex class extends Number
,
the methods inherited from Number
return the value of
the real part of the complex number. Thus they are more meaningful
for the Apfloat
class and its subclasses.
Apfloat
,
Serialized FormField Summary | |
static long |
DEFAULT
Default precision. |
static Apcomplex |
I
Imaginary unit. |
static long |
INFINITE
Infinite precision or scale. |
static Apint |
ONE
Constant for one. |
static Apint |
ZERO
Constant for zero. |
Constructor Summary | |
protected |
Apcomplex()
Default constructor. |
|
Apcomplex(Apfloat real)
Construct a real apcomplex whose imaginary part is zero. |
|
Apcomplex(Apfloat real,
Apfloat imag)
Construct an apcomplex with the specified real and imaginary part. |
|
Apcomplex(java.io.PushbackReader in)
Reads an apcomplex from a reader. |
|
Apcomplex(java.lang.String value)
Constructs an apcomplex from a string. |
Method Summary | |
Apcomplex |
add(Apcomplex z)
Adds two apcomplex numbers. |
byte |
byteValue()
Returns the value of the this number as a byte .
|
Apcomplex |
conj()
Returns the complex conjugate of this apcomplex. |
Apcomplex |
divide(Apcomplex z)
Divides two apcomplex numbers. |
double |
doubleValue()
Returns the value of the this number as a double .
|
long |
equalDigits(Apcomplex z)
Computes number of equal digits. |
boolean |
equals(java.lang.Object obj)
Compares this object to the specified object. |
float |
floatValue()
Returns the value of the this number as a float .
|
int |
hashCode()
Returns a hash code for this apcomplex. |
Apfloat |
imag()
Returns the imaginary part of this apcomplex. |
int |
intValue()
Returns the value of the this number as an int .
|
long |
longValue()
Returns the value of the this number as a long .
|
Apcomplex |
multiply(Apcomplex z)
Multiplies two apcomplex numbers. |
long |
precision()
Returns the precision of this apcomplex. |
int |
radix()
Radix of this apcomplex. |
Apfloat |
real()
Returns the real part of this apcomplex. |
long |
scale()
Returns the scale of this apcomplex. |
short |
shortValue()
Returns the value of the this number as a short .
|
Apcomplex |
subtract(Apcomplex z)
Subtracts two apcomplex numbers. |
java.lang.String |
toString()
Returns a string representation of this apcomplex. |
java.lang.String |
toString(boolean pretty)
Returns a string representation of this apcomplex. |
void |
writeTo(java.io.Writer out)
Write a string representation of this apcomplex to a Writer . |
void |
writeTo(java.io.Writer out,
boolean pretty)
Write a string representation of this apcomplex to a Writer . |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final Apint ZERO
ZERO
in all addition, subtraction, multiplication, division and
comparison operations regardless of the radix used.
public static final Apint ONE
ONE
in all multiplication, division and equality comparison operations
regardless of the radix used. However, in subtraction and addition
it only works with numbers in the same radix.
public static final Apcomplex I
Apcomplex(ZERO, ONE)
.
It is safe to use I
in all multiplication,
division and equality comparison operations
regardless of the radix used. In addition and subtraction
it only works with numbers in the same radix.
public static final long INFINITE
public static final long DEFAULT
Constructor Detail |
protected Apcomplex()
public Apcomplex(Apfloat real)
real
- The real part of the number.public Apcomplex(Apfloat real, Apfloat imag) throws java.lang.IllegalArgumentException
real
- The real part of the number.imag
- The imaginary part of the number.
java.lang.IllegalArgumentException
- If the real part and imaginary part are not zero but have different radixes.public Apcomplex(java.lang.String value) throws java.lang.NumberFormatException, ApfloatRuntimeException
The input must be of one of the formats
realPart
"(" [whitespace] realPart [whitespace] ")"
"(" [whitespace] realPart [whitespace] "," [whitespace] imaginaryPart [whitespace] ")"
value
- The input string.
java.lang.NumberFormatException
- If the number is invalid.
ApfloatRuntimeException
public Apcomplex(java.io.PushbackReader in) throws java.io.IOException, java.lang.NumberFormatException, ApfloatRuntimeException
PushbackReader
so that the invalid character can
be returned back to the stream.The input must be of one of the formats
realPart
"(" [whitespace] realPart [whitespace] ")"
"(" [whitespace] realPart [whitespace] "," [whitespace] imaginaryPart [whitespace] ")"
in
- The input stream.
java.io.IOException
- In case of I/O error reading from the stream.
java.lang.NumberFormatException
- If the number is invalid.
ApfloatRuntimeException
Method Detail |
public int radix()
public Apfloat real()
public Apfloat imag()
public Apcomplex conj() throws ApfloatRuntimeException
x - i y
, where this apcomplex is x + i y
.
ApfloatRuntimeException
public long precision() throws ApfloatRuntimeException
ApfloatRuntimeException
public long scale() throws ApfloatRuntimeException
Zero has a scale of -INFINITE
.
ApfloatRuntimeException
Apfloat.scale()
public Apcomplex add(Apcomplex z) throws ApfloatRuntimeException
z
- The number to be added to this number.
this + z
.
ApfloatRuntimeException
public Apcomplex subtract(Apcomplex z) throws ApfloatRuntimeException
z
- The number to be subtracted from this number.
this - z
.
ApfloatRuntimeException
public Apcomplex multiply(Apcomplex z) throws ApfloatRuntimeException
z
- The number to be multiplied by this number.
this * z
.
ApfloatRuntimeException
public Apcomplex divide(Apcomplex z) throws java.lang.ArithmeticException, ApfloatRuntimeException
z
- The number by which this number is to be divided.
this / z
.
java.lang.ArithmeticException
- In case the divisor is zero.
ApfloatRuntimeException
public double doubleValue()
double
.
Only takes the real part of this number.
double
.Apfloat.doubleValue()
public float floatValue()
float
.
Only takes the real part of this number.
float
.Apfloat.floatValue()
public byte byteValue()
byte
.
Only takes the real part of this number.
byte
.Apfloat.byteValue()
public short shortValue()
short
.
Only takes the real part of this number.
short
.Apfloat.shortValue()
public int intValue()
int
.
Only takes the real part of this number.
int
.Apfloat.intValue()
public long longValue()
long
.
Only takes the real part of this number.
long
.Apfloat.longValue()
public long equalDigits(Apcomplex z) throws ApfloatRuntimeException
Compares the digits of the numbers starting from the most significant digits. The exponent and sign are taken into consideration, so if either one doesn't match, the numbers are considered to have zero equal digits.
For example, the numbers (12345, 123) and (123456, 12) have zero matching digits, and the numbers (12345, 12) and (12355, 13) have three matching digits.
z
- Number to compare with.
ApfloatRuntimeException
public boolean equals(java.lang.Object obj)
Note: two apfloats are considered equal if they have an identical mantissa, but different precision.
obj
- The object to compare with.
true
if the objects are equal; false
otherwise.public int hashCode()
public java.lang.String toString()
public java.lang.String toString(boolean pretty) throws ApfloatRuntimeException
pretty
- true
to use a fixed-point notation, false
to use an exponential notation.
ApfloatRuntimeException
public void writeTo(java.io.Writer out) throws java.io.IOException, ApfloatRuntimeException
Writer
.
out
- The output Writer
.
java.io.IOException
- In case of I/O error writing to the stream.
ApfloatRuntimeException
public void writeTo(java.io.Writer out, boolean pretty) throws java.io.IOException, ApfloatRuntimeException
Writer
.
out
- The output Writer
.pretty
- true
to use a fixed-point notation, false
to use an exponential notation.
java.io.IOException
- In case of I/O error writing to the stream.
ApfloatRuntimeException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |