All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Jampack.Z 

java.lang.Object
   |
   +----Jampack.Z
public class Z
extends Object
Z is a mutable complex variable class. It is designed to perform complex arithmetic without creating a new Z at each operation. Specifically, binary operations have the form c.op(a,b), in which a, b, and c need not be different. The method places the complex number a.op.b in c. The method also returns a pointer to c. Thus the class supports two styles of programming. For example to compute e = a*b + c*d you can write

z1.Times(a,b)
z2.Times(c,d)
e.Plus(z1,z2)

or

e.Plus(z1.Times(a,b), z2.Times(a,b))

Since objects of class Z are mutable, the use of the assignment operator "=" with these objects is deprecated. Use Eq.

The functions are reasonably resistent to overflow and underflow. But the more complicated ones could almost certainly be improved.

Variable Index

o I
Imaginary unit.
o im
The imaginary part of Z.
o ONE
Complex 1.
o re
The real part of Z.
o ZERO
Complex 0.

Constructor Index

o Z()
Creates a Z and initializes it to zero.
o Z(double)
Creates a Z and initializes its real part.
o Z(double, double)
Creates a Z and initializes its real and imaginary parts.
o Z(Z)
Creates a Z and initializes it to another Z.

Method Index

o abs(Z)
Computes the absolute value of a Z.
o abs1(Z)
Computes the 1-norm of a Z
o Conj(Z)
Computes the conjugate of a Z.
o Div(Z, double)
Computes the quotient of a Z and a double.
o Div(Z, Z)
Computes the quotient of two Z's.
o Eq(double, double)
Resets the real and imaginary parts of a Z.
o Eq(Z)
Resets the real and imaginary parts of a Z to those of another Z.
o Exch(Z)
Interchanges the real and imaginary parts of two Z's.
o IsEqual(Z, Z)
Tests two Z'z for equality.
o Minus(Z)
Computes unary minus of a Z.
o Minus(Z, Z)
Computes the difference of two Z's.
o Plus(Z, Z)
Computes the sum of two Z's.
o Sqrt(Z)
Computes the principal value of the square root of a Z.
o Times(double, Z)
Computes the product of a double and a Z.
o Times(Z, Z)
Computes the product of two Z's.

Variables

o ONE 
 public static final Z ONE
Complex 1.

o ZERO 
 public static final Z ZERO
Complex 0.

o I 
 public static final Z I
Imaginary unit.

o re 
 public double re
The real part of Z.

o im 
 public double im
The imaginary part of Z.

Constructors

o Z 
 public Z()
Creates a Z and initializes it to zero.

Returns:
a Z initialized to zero.
o Z 
 public Z(double x,
          double y)
Creates a Z and initializes its real and imaginary parts.

Parameters:
x - a double
y - a double
Returns:
x + iy
o Z 
 public Z(double x)
Creates a Z and initializes its real part.

Parameters:
x - a double
Returns:
x + i*0
o Z 
 public Z(Z a)
Creates a Z and initializes it to another Z.

Parameters:
a - a Z
Returns:
a

Methods

o IsEqual 
 public boolean IsEqual(Z z1,
                        Z z2)
Tests two Z'z for equality.

Parameters:
z1 - a Z
z2 - a Z
Returns:
true if z1=z2, otherwise false
o Eq 
 public Z Eq(Z a)
Resets the real and imaginary parts of a Z to those of another Z.

Parameters:
a - a Z
Returns:
this = a;
o Eq 
 public Z Eq(double a,
             double b)
Resets the real and imaginary parts of a Z.

Parameters:
a - a double
b - a double
Returns:
this = a + ib
o Exch 
 public Z Exch(Z a)
Interchanges the real and imaginary parts of two Z's.

Parameters:
a - a Z
Returns:
this = a, with a set to the original value of this.
o abs1 
 public static double abs1(Z z)
Computes the 1-norm of a Z

o abs 
 public static double abs(Z z)
Computes the absolute value of a Z.

Parameters:
z - a Z
Returns:
the absolute vaue of Z
o Conj 
 public Z Conj(Z a)
Computes the conjugate of a Z.

Parameters:
a - a Z
Returns:
this = conj(a);
o Minus 
 public Z Minus(Z a)
Computes unary minus of a Z.

Parameters:
a - a Z
Returns:
this = -a;
o Plus 
 public Z Plus(Z a,
               Z b)
Computes the sum of two Z's.

Parameters:
a - a Z
b - a Z
Returns:
this = a + b
o Minus 
 public Z Minus(Z a,
                Z b)
Computes the difference of two Z's.

Parameters:
a - a Z
b - a Z
Returns:
this = a - b
o Times 
 public Z Times(Z a,
                Z b)
Computes the product of two Z's.

Parameters:
a - a Z
b - a Z
Returns:
this = ab
o Times 
 public Z Times(double a,
                Z b)
Computes the product of a double and a Z.

Parameters:
a - a double
b - a Z
Returns:
this = ab
o Div 
 public Z Div(Z a,
              Z b) throws JampackException
Computes the quotient of two Z's. Throws a JampackException if the denominator is zero.

Parameters:
a - a Z
b - a Z
Returns:
this = a/b
Throws: JampackException
Thrown if b is zero.
o Div 
 public Z Div(Z a,
              double b) throws JampackException
Computes the quotient of a Z and a double. Throws a JampackException if the denominator is zero.

Parameters:
a - a Z
b - a double
Returns:
this = a/b
Throws: JampackException
Thrown if b is zero.
o Sqrt 
 public Z Sqrt(Z a)
Computes the principal value of the square root of a Z.

Parameters:
a - a Z
this - = sqrt(a) 
All Packages  Class Hierarchy  This Package  Previous  Next  Index