Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Util.STPair Class Reference

A pair of unsigned integers of type std::size_t. More...

+ Inheritance diagram for CDPL.Util.STPair:

Public Member Functions

None __init__ ()
 Initializes the STPair instance.
 
None __init__ (STPair pair)
 Initializes a copy of the STPair instance pair. More...
 
None __init__ (int first, int second)
 Initializes the STPair instance. More...
 
int getFirst ()
 
None setFirst (int value)
 
int getSecond ()
 
None setSecond (int value)
 
STPair assign (STPair array)
 Replaces the current state of self with a copy of the state of the STPair instance array. More...
 
bool __eq__ (STPair pair)
 Returns the result of the comparison operation self == pair. More...
 
bool __ne__ (STPair pair)
 Returns the result of the comparison operation self != pair. More...
 
bool __le__ (STPair pair)
 Returns the result of the comparison operation self <= pair. More...
 
bool __ge__ (STPair pair)
 Returns the result of the comparison operation self >= pair. More...
 
bool __lt__ (STPair pair)
 Returns the result of the comparison operation self < pair. More...
 
bool __gt__ (STPair pair)
 Returns the result of the comparison operation self > pair. More...
 

Properties

 first = property(getFirst, setFirst)
 
 second = property(getSecond, setSecond)
 

Detailed Description

A pair of unsigned integers of type std::size_t.

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Util.STPair.__init__ ( STPair  pair)

Initializes a copy of the STPair instance pair.

Parameters
pairThe STPair instance to copy.

◆ __init__() [2/2]

None CDPL.Util.STPair.__init__ ( int  first,
int  second 
)

Initializes the STPair instance.

Parameters
first
second

Member Function Documentation

◆ getFirst()

int CDPL.Util.STPair.getFirst ( )
Returns

◆ setFirst()

None CDPL.Util.STPair.setFirst ( int  value)
Parameters
value

◆ getSecond()

int CDPL.Util.STPair.getSecond ( )
Returns

◆ setSecond()

None CDPL.Util.STPair.setSecond ( int  value)
Parameters
value

◆ assign()

STPair CDPL.Util.STPair.assign ( STPair  array)

Replaces the current state of self with a copy of the state of the STPair instance array.

Parameters
arrayThe STPair instance to copy.
Returns
self

◆ __eq__()

bool CDPL.Util.STPair.__eq__ ( STPair  pair)

Returns the result of the comparison operation self == pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__()

bool CDPL.Util.STPair.__ne__ ( STPair  pair)

Returns the result of the comparison operation self != pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.

◆ __le__()

bool CDPL.Util.STPair.__le__ ( STPair  pair)

Returns the result of the comparison operation self <= pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.

◆ __ge__()

bool CDPL.Util.STPair.__ge__ ( STPair  pair)

Returns the result of the comparison operation self >= pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.

◆ __lt__()

bool CDPL.Util.STPair.__lt__ ( STPair  pair)

Returns the result of the comparison operation self < pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.

◆ __gt__()

bool CDPL.Util.STPair.__gt__ ( STPair  pair)

Returns the result of the comparison operation self > pair.

Parameters
pairThe STPair instance to be compared with.
Returns
The result of the comparison operation.