Concept OrderedAlphabetConceptTotally strict ordered alphabet.
Totally strict ordered alphabet.
Extends | AlphabetConcept, ComparableConcept |
---|---|
All Extended | AlphabetConcept, AssignableConcept, ComparableConcept, CopyConstructibleConcept, DefaultConstructibleConcept, EqualityComparableConcept, LessThanComparableConcept |
All Subcl's | FiniteOrderedAlphabetConcept |
Defined in | <seqan/basic.h> |
Signature |
concept OrderedAlphabetConcept;
|
Member Function Overview
-
bool OrderedAlphabetConcept::operator<(other);
Less-than operator.
Member Functions Inherited From AssignableConcept
Member Functions Inherited From ComparableConcept
Member Functions Inherited From EqualityComparableConcept
Member Functions Inherited From LessThanComparableConcept
Interface Function Overview
-
T infimumValueImpl(valuePointerTag);
Implements minValue. -
T maxValue<T>();
Supremum for a given type. -
T minValue<T>();
Infimum for a given type. -
T supremumValueImpl(valuePointerTag);
Implements maxValue.
Interface Functions Inherited From AssignableConcept
Interface Functions Inherited From ComparableConcept
Interface Metafunction Overview
-
MaxValue<T>::VALUE
Supremum for a given type. -
MinValue<T>::VALUE
Infimum for a given type.
Interface Metafunctions Inherited From AlphabetConcept
Member Functions Detail
bool OrderedAlphabetConcept::operator<(other);
Less-than operator.
Parameters
other
|
Object of the same type to compare to this. |
---|
Returns
bool |
True in case of this object being smaller than other |
---|
Data Races
Thread safety unknown!
Interface Functions Detail
T infimumValueImpl(valuePointerTag);
Implements minValue.
Parameters
valuePointerTag
|
A pointer that is used as a tag to specify the value type. The pointer needs not to point to a valid object, so it is possible to use a null pointer here. |
---|
Returns
T |
A value inf that holds: inf <= i for all values i. |
---|
This function implements minValue. It is recommended to use minValue rather than infimumValueImpl.
Status
Deprecated, will be removed in favour of MinValue.
Data Races
Thread safety unknown!
See Also
T maxValue<T>();
Supremum for a given type.
Template Parameters
T |
The type to get the max value of. |
---|
Returns
T |
A value inf that holds: inf >= i for all values i of type T. |
---|
The function is implemented in supremumValueImpl. Do not specialize maxValue, specialize supremumValueImpl instead!
Status
Deprecated, will be removed in favour of MaxValue.
Data Races
Thread safety unknown!
See Also
T minValue<T>();
Infimum for a given type.
Template Parameters
T |
An ordered type. |
---|
Returns
T |
A value inf that holds: inf <= i for all values i of type T. |
---|
The function is implemented in infimumValueImpl. Do not specialize minValue, specialize infimumValueImpl instead!
Status
Deprecated, will be removed in favour of MinValue.
Data Races
Thread safety unknown!
See Also
T supremumValueImpl(valuePointerTag);
Implements maxValue.
Parameters
valuePointerTag
|
A pointer that is used as a tag to specify the value type. The pointer needs not to point to a valid object, so it is possible to use a null pointer here. |
---|
Returns
T |
A value inf that holds: inf >= i for all values i. |
---|
This function implements OrderedAlphabetConcept#maxValue. It is recommended to use OrderedAlphabetConcept#maxValue rather than supremumValueImpl.
Status
Deprecated, will be removed in favour of OrderedAlphabetConcept#MaxValue.
Data Races
Thread safety unknown!