ComplexCompareTo Method (Complex) |
Compares two Complex objects.
Namespace: Imsl.MathAssembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0
Syntax public int CompareTo(
Complex z
)
Public Function CompareTo (
z As Complex
) As Integer
public:
int CompareTo(
Complex z
)
member CompareTo :
z : Complex -> int
Parameters
- z
- Type: Imsl.MathComplex
A Complex to be compared.
Return Value
Type:
Int32
The value 0 if
z is equal to this
Complex; a value less
than 0 if this
Complex is less than
z; and a value
greater than 0 if this
Complex is greater than
z.
Remarks
A lexigraphical ordering is used. First the real parts are compared
in the sense of Double.compareTo. If the real parts are unequal this
is the return value. If the return parts are equal then the
comparison of the imaginary parts is returned.
See Also