public class FloatComplex
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
FloatComplex
contains inner classes that
provide holder and array support for standard Java primitive
types.Modifier and Type | Class and Description |
---|---|
static class |
FloatComplex.Array
Define a one dimensional array of type
sidl.FloatComplex
for the sidl Java run-time. |
static class |
FloatComplex.Array1
Define a one dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array2
Define a two dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array3
Define a three dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array4
Define a four dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array5
Define a five dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array6
Define a six dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Array7
Define a seven dimensional array of type
sidl.FloatComplex . |
static class |
FloatComplex.Holder
This is the holder inner class for inout and out arguments for
type
FloatComplex . |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
suffix
String used in converting FloatComplex to String.
|
Constructor and Description |
---|
FloatComplex()
Constructs a FloatComplex equal to zero.
|
FloatComplex(float re)
Constructs a FloatComplex with a zero imaginary part.
|
FloatComplex(FloatComplex z)
Constructs a FloatComplex equal to the argument.
|
FloatComplex(float re,
float im)
Constructs a FloatComplex with real and imaginary parts given
by the input arguments.
|
Modifier and Type | Method and Description |
---|---|
static float |
abs(FloatComplex z)
Returns the absolute value (modulus) of a FloatComplex, |z|.
|
static FloatComplex |
acos(FloatComplex z)
Returns the inverse cosine (arc cosine) of a FloatComplex,
with branch cuts outside the interval [-1,1] along the
real axis.
|
static FloatComplex |
acosh(FloatComplex z)
Returns the inverse hyperbolic cosine (arc cosh) of a FloatComplex,
with a branch cut at values less than one along the real axis.
|
static float |
argument(FloatComplex z)
Returns the argument (phase) of a FloatComplex, in radians,
with a branch cut along the negative real axis.
|
static FloatComplex |
asin(FloatComplex z)
Returns the inverse sine (arc sine) of a FloatComplex,
with branch cuts outside the interval [-1,1] along the
real axis.
|
static FloatComplex |
asinh(FloatComplex z)
Returns the inverse hyperbolic sine (arc sinh) of a FloatComplex,
with a branch cuts outside the interval [-i,i].
|
static FloatComplex |
atan(FloatComplex z)
Returns the inverse tangent (arc tangent) of a FloatComplex,
with branch cuts outside the interval [-i,i] along the
imaginary axis.
|
static FloatComplex |
atanh(FloatComplex z)
Returns the inverse hyperbolic tangent (arc tanh) of a FloatComplex,
with a branch cuts outside the interval [-1,1] on the real axis.
|
static FloatComplex |
conjugate(FloatComplex z)
Returns the complex conjugate of a FloatComplex object.
|
static FloatComplex |
cos(FloatComplex z)
Returns the cosine of a FloatComplex.
|
static FloatComplex |
cosh(FloatComplex z)
Returns the hyperbolic cosh of a FloatComplex.
|
boolean |
equals(FloatComplex z)
Compares with another FloatComplex.
|
boolean |
equals(java.lang.Object obj)
Compares this object against the specified object.
|
static FloatComplex |
exp(FloatComplex z)
Returns the exponential of a FloatComplex z, exp(z).
|
int |
hashCode()
Returns a hashcode for this FloatComplex.
|
float |
imag()
Returns the imaginary part of a FloatComplex object.
|
static float |
imag(FloatComplex z)
Returns the imaginary part of a FloatComplex object.
|
static FloatComplex |
log(FloatComplex z)
Returns the logarithm of a FloatComplex z,
with a branch cut along the negative real axis.
|
FloatComplex |
minus(float y)
Subtracts a float from this FloatComplex and returns the difference,
this-y.
|
FloatComplex |
minus(FloatComplex y)
Returns the difference of this FloatComplex object and
another FloatComplex object, this-y.
|
static FloatComplex |
minus(FloatComplex x,
float y)
Returns the difference of a FloatComplex object and a float, x-y.
|
static FloatComplex |
minus(FloatComplex x,
FloatComplex y)
Returns the difference of two FloatComplex objects, x-y.
|
static FloatComplex |
minus(float x,
FloatComplex y)
Returns the difference of a float and a FloatComplex object, x-y.
|
FloatComplex |
minusReverse(float x)
Returns the difference of this FloatComplex object and a float, this-y.
|
static FloatComplex |
negative(FloatComplex z)
Returns the negative of a FloatComplex object, -z.
|
FloatComplex |
over(float y)
Returns this FloatComplex object divided by float, this/y.
|
FloatComplex |
over(FloatComplex y)
Returns this FloatComplex object divided by another
FloatComplex object, this/y.
|
static FloatComplex |
over(FloatComplex x,
float y)
Returns FloatComplex object divided by a float, x/y.
|
static FloatComplex |
over(FloatComplex x,
FloatComplex y)
Returns FloatComplex object divided by a FloatComplex object, x/y.
|
static FloatComplex |
over(float x,
FloatComplex y)
Returns a float divided by a FloatComplex object, x/y.
|
FloatComplex |
overReverse(float x)
Returns a float dividied by this FloatComplex object, x/this.
|
FloatComplex |
plus(float y)
Returns the sum of this FloatComplex a float, this+y.
|
FloatComplex |
plus(FloatComplex y)
Returns the sum of this FloatComplex and another FloatComplex, this+y.
|
static FloatComplex |
plus(FloatComplex x,
float y)
Returns the sum of a FloatComplex and a float, x+y.
|
static FloatComplex |
plus(FloatComplex x,
FloatComplex y)
Returns the sum of two FloatComplex objects, x+y.
|
static FloatComplex |
plus(float x,
FloatComplex y)
Returns the sum of a float and a FloatComplex, x+y.
|
FloatComplex |
plusReverse(float x)
Returns the sum of this FloatComplex and a float, x+this.
|
static FloatComplex |
pow(FloatComplex z,
float x)
Returns the FloatComplex z raised to the x power,
with a branch cut for the first parameter (z) along the
negative real axis.
|
static FloatComplex |
pow(FloatComplex x,
FloatComplex y)
Returns the FloatComplex x raised to the FloatComplex y power.
|
float |
real()
Returns the real part of a FloatComplex object.
|
static float |
real(FloatComplex z)
Returns the real part of a FloatComplex object.
|
void |
set(float real,
float imag)
Set the real and imaginary parts of the FloatComplex object.
|
static FloatComplex |
sin(FloatComplex z)
Returns the sine of a FloatComplex.
|
static FloatComplex |
sinh(FloatComplex z)
Returns the hyperbolic sine of a FloatComplex.
|
static FloatComplex |
sqrt(FloatComplex z)
Returns the square root of a FloatComplex,
with a branch cut along the negative real axis.
|
static FloatComplex |
tan(FloatComplex z)
Returns the tangent of a FloatComplex.
|
static FloatComplex |
tanh(FloatComplex z)
Returns the hyperbolic tanh of a FloatComplex.
|
FloatComplex |
times(float y)
Returns the product of this FloatComplex object and a float, this*y.
|
FloatComplex |
times(FloatComplex y)
Returns the product of this FloatComplex object and another
FloatComplex object, this*y.
|
static FloatComplex |
times(FloatComplex x,
float y)
Returns the product of a FloatComplex object and a float, x*y.
|
static FloatComplex |
times(FloatComplex x,
FloatComplex y)
Returns the product of two FloatComplex objects, x*y.
|
static FloatComplex |
times(float x,
FloatComplex y)
Returns the product of a float and a FloatComplex object, x*y.
|
FloatComplex |
timesReverse(float x)
Returns the product of a float and this FloatComplex, x*this.
|
java.lang.String |
toString()
Returns a String representation for the specified FloatComplex.
|
static FloatComplex |
valueOf(java.lang.String s)
Parses a string into a FloatComplex.
|
public static java.lang.String suffix
public FloatComplex(FloatComplex z)
z
- A FloatComplex object
If z is null then a NullPointerException is thrown.public FloatComplex(float re, float im)
re
- A float value equal to the real part of the
FloatComplex object.im
- A float value equal to the imaginary part of
the FloatComplex object.public FloatComplex(float re)
re
- A float value equal to the real part of FloatComplex object.public FloatComplex()
public boolean equals(FloatComplex z)
Note: To be useful in hashtables this method considers two NaN float values to be equal. This is not according to IEEE specification.
z
- A FloatComplex object.public boolean equals(java.lang.Object obj)
Note: To be useful in hashtables this method considers two NaN float values to be equal. This is not according to IEEE specification
equals
in class java.lang.Object
obj
- The object to compare with.public int hashCode()
hashCode
in class java.lang.Object
public void set(float real, float imag)
public float real()
public float imag()
z
- A FloatComplex object.public static float real(FloatComplex z)
z
- A FloatComplex object.public static float imag(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex negative(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex conjugate(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex plus(FloatComplex x, FloatComplex y)
x
- A FloatComplex object.y
- A FloatComplex object.public static FloatComplex plus(FloatComplex x, float y)
x
- A FloatComplex object.y
- A float value.public static FloatComplex plus(float x, FloatComplex y)
x
- A float value.y
- A FloatComplex object.public FloatComplex plus(FloatComplex y)
y
- A FloatComplex object.public FloatComplex plus(float y)
y
- A float value.public FloatComplex plusReverse(float x)
x
- A float value.public static FloatComplex minus(FloatComplex x, FloatComplex y)
x
- A FloatComplex object.y
- A FloatComplex object.public static FloatComplex minus(FloatComplex x, float y)
x
- A FloatComplex object.y
- A float value.public static FloatComplex minus(float x, FloatComplex y)
x
- A float value.y
- A FloatComplex object.public FloatComplex minus(FloatComplex y)
y
- A FloatComplex object.public FloatComplex minus(float y)
y
- A float value.public FloatComplex minusReverse(float x)
y
- A float value.public static FloatComplex times(FloatComplex x, FloatComplex y)
x
- A FloatComplex object.y
- A FloatComplex object.public static FloatComplex times(FloatComplex x, float y)
x
- A FloatComplex object.y
- A float value.public static FloatComplex times(float x, FloatComplex y)
x
- A float value.y
- A FloatComplex object.public FloatComplex times(FloatComplex y)
y
- A FloatComplex object.public FloatComplex times(float y)
y
- A float value.public FloatComplex timesReverse(float x)
y
- A float value.public static FloatComplex over(FloatComplex x, FloatComplex y)
x
- The numerator, a FloatComplex object.y
- The denominator, a FloatComplex object.public static FloatComplex over(FloatComplex x, float y)
x
- The numerator, a FloatComplex object.y
- The denominator, a float.public static FloatComplex over(float x, FloatComplex y)
x
- A float value.y
- The denominator, a FloatComplex object.public FloatComplex over(FloatComplex y)
y
- The denominator, a FloatComplex object.public FloatComplex over(float y)
y
- The denominator, a float.public FloatComplex overReverse(float x)
x
- The numerator, a float.public static float abs(FloatComplex z)
z
- A FloatComplex object.public static float argument(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex sqrt(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex exp(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex log(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex sin(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex cos(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex tan(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex asin(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex acos(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex atan(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex sinh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex cosh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex tanh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex pow(FloatComplex z, float x)
z
- A FloatComplex object.x
- A float value.public static FloatComplex asinh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex acosh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex atanh(FloatComplex z)
z
- A FloatComplex object.public static FloatComplex pow(FloatComplex x, FloatComplex y)
x
- A FloatComplex object.y
- A FloatComplex object.public java.lang.String toString()
toString
in class java.lang.Object
public static FloatComplex valueOf(java.lang.String s) throws java.lang.NumberFormatException
s
- The string to be parsed.java.lang.NumberFormatException
- If the string does not contain
a parsable FloatComplex number.java.lang.NullPointerException
- If the input argument is null.