Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
sidl.FloatComplex
public class FloatComplex
extends java.lang.Object
implements java.io.Serializable, Cloneable
FloatComplex
contains inner classes that
provide holder and array support for standard Java primitive
types.
Nested Class Summary | |
static class |
|
static class |
|
static class |
|
static class |
|
static class |
|
static class |
|
static class |
|
static class |
|
static class |
|
Field Summary | |
static String |
|
Constructor Summary | |
| |
| |
| |
|
Method Summary | |
static float |
|
static FloatComplex |
|
static FloatComplex |
|
static float |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
boolean |
|
boolean |
|
static FloatComplex |
|
int |
|
float |
|
static float |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
float |
|
static float |
|
void |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
static FloatComplex |
|
static FloatComplex |
|
FloatComplex |
|
String |
|
static FloatComplex |
|
public static String suffix
String used in converting FloatComplex to String. Default is "i", but sometimes "j" is desired. Note that this is set for the class, not for a particular instance of a FloatComplex.
public FloatComplex()
Constructs a FloatComplex equal to zero.
public FloatComplex(float re)
Constructs a FloatComplex with a zero imaginary part.
- Parameters:
re
- A float value equal to the real part of FloatComplex object.
public FloatComplex(float re, float im)
Constructs a FloatComplex with real and imaginary parts given by the input arguments.
- Parameters:
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(FloatComplex z)
Constructs a FloatComplex equal to the argument.
- Parameters:
z
- A FloatComplex object If z is null then a NullPointerException is thrown.
public static float abs(FloatComplex z)
Returns the absolute value (modulus) of a FloatComplex, |z|.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A float value equal to the absolute value of the argument.
public 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.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) cosine of the argument. The real part of the result is in the interval [0,pi].
public 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.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) hyperbolic cosine of the argument. The real part of the result is non-negative and its imaginary part is in the interval [-i*pi,i*pi].
public static float argument(FloatComplex z)
Returns the argument (phase) of a FloatComplex, in radians, with a branch cut along the negative real axis.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A float value equal to the argument (or phase) of a FloatComplex. It is in the interval [-pi,pi].
public 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.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) sine of the argument. The real part of the result is in the interval [-pi/2,+pi/2].
public static FloatComplex asinh(FloatComplex z)
Returns the inverse hyperbolic sine (arc sinh) of a FloatComplex, with a branch cuts outside the interval [-i,i].
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) hyperbolic sine of the argument. Its imaginary part is in the interval [-i*pi/2,i*pi/2].
public 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.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) tangent of the argument. Its real part is in the interval [-pi/2,pi/2].
public 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.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to inverse (arc) hyperbolic tangent of the argument. The imaginary part of the result is in the interval [-i*pi/2,i*pi/2].
public static FloatComplex conjugate(FloatComplex z)
Returns the complex conjugate of a FloatComplex object.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to complex conjugate of z.
public static FloatComplex cos(FloatComplex z)
Returns the cosine of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to cosine of the argument.
public static FloatComplex cosh(FloatComplex z)
Returns the hyperbolic cosh of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to the hyperbolic cosine of the argument.
public boolean equals(Object obj)
Compares this object against the specified object. Note: To be useful in hashtables this method considers two NaN float values to be equal. This is not according to IEEE specification
- Parameters:
obj
- The object to compare with.
- Returns:
- True if the objects are the same; false otherwise.
public boolean equals(FloatComplex z)
Compares with another FloatComplex. Note: To be useful in hashtables this method considers two NaN float values to be equal. This is not according to IEEE specification.
- Parameters:
z
- A FloatComplex object.
- Returns:
- True if the real and imaginary parts of this object are equal to their counterparts in the argument; false, otherwise.
public static FloatComplex exp(FloatComplex z)
Returns the exponential of a FloatComplex z, exp(z).
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to exponential of the argument.
public int hashCode()
Returns a hashcode for this FloatComplex.
- Returns:
- A hash code value for this object.
public float imag()
Returns the imaginary part of a FloatComplex object.
- Parameters:
- Returns:
- The imaginary part of z.
public static float imag(FloatComplex z)
Returns the imaginary part of a FloatComplex object.
- Parameters:
z
- A FloatComplex object.
- Returns:
- The imaginary part of z.
public static FloatComplex log(FloatComplex z)
Returns the logarithm of a FloatComplex z, with a branch cut along the negative real axis.
- Parameters:
z
- A FloatComplex object.
- Returns:
- Newly constructed FloatComplex initialized to logarithm of the argument. Its imaginary part is in the interval [-i*pi,i*pi].
public FloatComplex minus(float y)
Subtracts a float from this FloatComplex and returns the difference, this-y.
- Parameters:
y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to this-y.
public static FloatComplex minus(float x, FloatComplex y)
Returns the difference of a float and a FloatComplex object, x-y.
- Parameters:
x
- A float value.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x-y..
public FloatComplex minus(FloatComplex y)
Returns the difference of this FloatComplex object and another FloatComplex object, this-y.
- Parameters:
y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to this-y.
public static FloatComplex minus(FloatComplex x, float y)
Returns the difference of a FloatComplex object and a float, x-y.
- Parameters:
x
- A FloatComplex object.y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to x-y.
public static FloatComplex minus(FloatComplex x, FloatComplex y)
Returns the difference of two FloatComplex objects, x-y.
- Parameters:
x
- A FloatComplex object.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x-y.
public FloatComplex minusReverse(float x)
Returns the difference of this FloatComplex object and a float, this-y.
- Parameters:
- Returns:
- A newly constructed FloatComplex initialized to x-this.
public static FloatComplex negative(FloatComplex z)
Returns the negative of a FloatComplex object, -z.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to the negative of the argument.
public FloatComplex over(float y)
Returns this FloatComplex object divided by float, this/y.
- Parameters:
y
- The denominator, a float.
- Returns:
- A newly constructed FloatComplex initialized to x/y.
public static FloatComplex over(float x, FloatComplex y)
Returns a float divided by a FloatComplex object, x/y.
- Parameters:
x
- A float value.y
- The denominator, a FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x/y.
public FloatComplex over(FloatComplex y)
Returns this FloatComplex object divided by another FloatComplex object, this/y.
- Parameters:
y
- The denominator, a FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x/y.
public static FloatComplex over(FloatComplex x, float y)
Returns FloatComplex object divided by a float, x/y.
- Parameters:
x
- The numerator, a FloatComplex object.y
- The denominator, a float.
- Returns:
- A newly constructed FloatComplex initialized to x/y.
public static FloatComplex over(FloatComplex x, FloatComplex y)
Returns FloatComplex object divided by a FloatComplex object, x/y.
- Parameters:
x
- The numerator, a FloatComplex object.y
- The denominator, a FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x/y.
public FloatComplex overReverse(float x)
Returns a float dividied by this FloatComplex object, x/this.
- Parameters:
x
- The numerator, a float.
- Returns:
- A newly constructed FloatComplex initialized to x/this.
public FloatComplex plus(float y)
Returns the sum of this FloatComplex a float, this+y.
- Parameters:
y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to this+y.
public static FloatComplex plus(float x, FloatComplex y)
Returns the sum of a float and a FloatComplex, x+y.
- Parameters:
x
- A float value.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x+y.
public FloatComplex plus(FloatComplex y)
Returns the sum of this FloatComplex and another FloatComplex, this+y.
- Parameters:
y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to this+y.
public static FloatComplex plus(FloatComplex x, float y)
Returns the sum of a FloatComplex and a float, x+y.
- Parameters:
x
- A FloatComplex object.y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to x+y.
public static FloatComplex plus(FloatComplex x, FloatComplex y)
Returns the sum of two FloatComplex objects, x+y.
- Parameters:
x
- A FloatComplex object.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x+y.
public FloatComplex plusReverse(float x)
Returns the sum of this FloatComplex and a float, x+this.
- Parameters:
x
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to x+this.
public 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.
- Parameters:
z
- A FloatComplex object.x
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to z to the power x.
public static FloatComplex pow(FloatComplex x, FloatComplex y)
Returns the FloatComplex x raised to the FloatComplex y power.
- Parameters:
x
- A FloatComplex object.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to xy.
public float real()
Returns the real part of a FloatComplex object.
- Returns:
- The real part of z.
public static float real(FloatComplex z)
Returns the real part of a FloatComplex object.
- Parameters:
z
- A FloatComplex object.
- Returns:
- The real part of z.
public void set(float real, float imag)
Set the real and imaginary parts of the FloatComplex object.
public static FloatComplex sin(FloatComplex z)
Returns the sine of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to sine of the argument.
public static FloatComplex sinh(FloatComplex z)
Returns the hyperbolic sine of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to hyperbolic sine of the argument.
public static FloatComplex sqrt(FloatComplex z)
Returns the square root of a FloatComplex, with a branch cut along the negative real axis.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to square root of z. Its real part is non-negative.
public static FloatComplex tan(FloatComplex z)
Returns the tangent of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to tangent of the argument.
public static FloatComplex tanh(FloatComplex z)
Returns the hyperbolic tanh of a FloatComplex.
- Parameters:
z
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to the hyperbolic tangent of the argument.
public FloatComplex times(float y)
Returns the product of this FloatComplex object and a float, this*y.
- Parameters:
y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to this*y.
public static FloatComplex times(float x, FloatComplex y)
Returns the product of a float and a FloatComplex object, x*y.
- Parameters:
x
- A float value.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x*y.
public FloatComplex times(FloatComplex y)
Returns the product of this FloatComplex object and another FloatComplex object, this*y.
- Parameters:
y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to this*y.
public static FloatComplex times(FloatComplex x, float y)
Returns the product of a FloatComplex object and a float, x*y.
- Parameters:
x
- A FloatComplex object.y
- A float value.
- Returns:
- A newly constructed FloatComplex initialized to x*y.
public static FloatComplex times(FloatComplex x, FloatComplex y)
Returns the product of two FloatComplex objects, x*y.
- Parameters:
x
- A FloatComplex object.y
- A FloatComplex object.
- Returns:
- A newly constructed FloatComplex initialized to x*y.
public FloatComplex timesReverse(float x)
Returns the product of a float and this FloatComplex, x*this.
- Parameters:
- Returns:
- A newly constructed FloatComplex initialized to x*this.
public String toString()
Returns a String representation for the specified FloatComplex.
- Returns:
- A String representation for this object.
public static FloatComplex valueOf(String s) throws NumberFormatException
Parses a string into a FloatComplex.
- Parameters:
s
- The string to be parsed.
- Returns:
- A newly constructed FloatComplex initialized to the value represented by the string argument.