Base class for comparable objects. More...
#include <comparable.h>
Public Member Functions | |
| virtual integer | compareTo (const DERIVED &other) const =0 |
| Compares the current object with another of the same type. | |
| bool | operator== (const DERIVED &other) const |
| Checks if the current object is equal to another. | |
| bool | operator!= (const DERIVED &other) const |
| Checks if the current object is not equal to another. | |
| bool | operator< (const DERIVED &other) const |
| Checks if the current object is less than another. | |
| bool | operator> (const DERIVED &other) const |
| Checks if the current object is greater than another. | |
| bool | operator<= (const DERIVED &other) const |
| Checks if the current object is less than or equal to another. | |
| bool | operator>= (const DERIVED &other) const |
| Checks if the current object is greater than or equal to another. | |
| virtual | ~comparable ()=default |
| Virtual destructor for proper cleanup of derived objects. | |
Detailed Description
Base class for comparable objects.
- Template Parameters
-
DERIVED The type of the derived class.
This class defines a compareTo() method that must be implemented by derived classes to compare their instances. It also provides common comparison operators (==, !=, <, >, <=, >=) based on the compareTo() method.
Derived classes are expected to override compareTo() to return:
- A negative value if the current object is less than the other.
- Zero if the current object is equal to the other.
- A positive value if the current object is greater than the other.
Classes implementing this interface automatically satisfy the CmpTraits concept.
- See also
- CmpTraits
Member Function Documentation
◆ compareTo()
|
pure virtual |
Compares the current object with another of the same type.
- Parameters
-
other The object to compare against.
- Returns
- A negative value if less than, zero if equal, and positive if greater than.
Implemented in original::autoPtr< TYPE, DERIVED, DELETER >, original::containerAdapter< TYPE, SERIAL, ALLOC >, original::couple< F_TYPE, S_TYPE >, original::iterationStream< TYPE, DERIVED >, and original::iterator< TYPE >.
◆ operator!=()
| auto original::comparable< DERIVED >::operator!= | ( | const DERIVED & | other | ) | const |
Checks if the current object is not equal to another.
- Parameters
-
other The object to compare against.
- Returns
- True if not equal, otherwise false.
◆ operator<()
| auto original::comparable< DERIVED >::operator< | ( | const DERIVED & | other | ) | const |
Checks if the current object is less than another.
- Parameters
-
other The object to compare against.
- Returns
- True if less than, otherwise false.
◆ operator<=()
| auto original::comparable< DERIVED >::operator<= | ( | const DERIVED & | other | ) | const |
Checks if the current object is less than or equal to another.
- Parameters
-
other The object to compare against.
- Returns
- True if less than or equal, otherwise false.
◆ operator==()
| auto original::comparable< DERIVED >::operator== | ( | const DERIVED & | other | ) | const |
Checks if the current object is equal to another.
- Parameters
-
other The object to compare against.
- Returns
- True if equal, otherwise false.
◆ operator>()
| auto original::comparable< DERIVED >::operator> | ( | const DERIVED & | other | ) | const |
Checks if the current object is greater than another.
- Parameters
-
other The object to compare against.
- Returns
- True if greater than, otherwise false.
◆ operator>=()
| auto original::comparable< DERIVED >::operator>= | ( | const DERIVED & | other | ) | const |
Checks if the current object is greater than or equal to another.
- Parameters
-
other The object to compare against.
- Returns
- True if greater than or equal, otherwise false.
The documentation for this class was generated from the following file:
- src/core/comparable.h
