Complex.CompareTo Method (Object)

ComplexCompareTo Method (Object)

Compares this Complex to another Object.

Namespace: Imsl.Math
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0

Syntax

public int CompareTo(
	Object obj
)

Public Function CompareTo ( 
	obj As Object
) As Integer

public:
virtual int CompareTo(
	Object^ obj
) sealed

abstract CompareTo : 
        obj : Object -> int 
override CompareTo : 
        obj : Object -> int

Parameters

obj: Type: SystemObject
An Object to be compared.

Return Value

Type: Int32
An int, 0 if obj is equal to this Complex; a value less than 0 if this Complex is less than obj; and a value greater than 0 if this Complex is greater than obj.

Implements

IComparableCompareTo(Object)

Exceptions

Exception	Condition
InvalidCastException	is thrown if obj is not a Complex object

Remarks

If the Object is a Complex, this function behaves like compareTo(Complex). Otherwise, it throws a InvalidCastException (as Complex objects are comparable only to other Complex objects).

Reference

Complex Structure

CompareTo Overload

Imsl.Math Namespace