Concept OrderedAlphabetConcept

Totally strict ordered alphabet.

/*!
 * @concept OrderedAlphabetConcept
 * 
 * @headerfile <seqan/basic.h>
 * 
 * @extends AlphabetConcept
 * @extends ComparableConcept
 * 
 * @brief Totally strict ordered alphabet.
 * 
 * @signature concept OrderedAlphabetConcept;
 * 
 * @mfn OrderedAlphabetConcept#MaxValue
 * 
 * @headerfile <seqan/basic.h>
 * 
 * @brief Supremum for a given type.
 * 
 * @signature MaxValue<T>::VALUE
 * 
 * @tparam T An ordered type.
 * 
 * @return VALUE The largest value that <tt>T</tt> can represent.
 * 
 * @see OrderedAlphabetConcept#maxValue
 * 
 * @mfn OrderedAlphabetConcept#MinValue
 * 
 * @headerfile <seqan/basic.h>
 * 
 * @brief Infimum for a given type.
 * 
 * @signature MinValue<T>::VALUE
 * 
 * @tparam T An ordered type.
 * 
 * @return VALUE The smallest value that <tt>T</tt> can represent.
 * 
 * @see OrderedAlphabetConcept#minValue
 * 
 * @fn OrderedAlphabetConcept::operator<
 * 
 * @brief Less-than operator.
 * 
 * @signature bool OrderedAlphabetConcept::operator<(other);
 * 
 * @param[in] other Object of the same type to compare to this.
 * 
 * @return bool True in case of this object being smaller than <tt>other</tt>
 * 
 * @fn OrderedAlphabetConcept#supremumValueImpl
 * 
 * @brief Implements maxValue.
 * 
 * @signature T supremumValueImpl(valuePointerTag);
 * 
 * @param[in] 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.
 * 
 * @return T A value <tt>inf</tt> that holds: <tt>inf &gt;= i</tt> for all
 *           values <tt>i</tt>.
 * 
 * This function implements OrderedAlphabetConcept#maxValue. It is recommended
 * to use OrderedAlphabetConcept#maxValue rather than
 * <tt>supremumValueImpl</tt>.
 * 
 * @section Status
 * 
 * Deprecated, will be removed in favour of OrderedAlphabetConcept#MaxValue.
 * 
 * @see OrderedAlphabetConcept#maxValue
 * 
 * @fn OrderedAlphabetConcept#maxValue
 * 
 * @brief Supremum for a given type.
 * 
 * @signature T maxValue<T>();
 * 
 * @tparam T The type to get the max value of.
 * 
 * @return T A value <tt>inf</tt> that holds: <tt>inf >= i</tt> for all values
 *           <tt>i</tt> of type <tt>T</tt>.
 * 
 * The function is implemented in supremumValueImpl. Do not specialize
 * <tt>maxValue</tt>, specialize supremumValueImpl instead!
 * 
 * @section Status
 * 
 * Deprecated, will be removed in favour of MaxValue.
 * 
 * @see OrderedAlphabetConcept#supremumValueImpl
 * @see OrderedAlphabetConcept#minValue
 * @see OrderedAlphabetConcept#MaxValue
 * 
 * @fn OrderedAlphabetConcept#infimumValueImpl
 * 
 * @brief Implements minValue.
 * 
 * @signature T infimumValueImpl(valuePointerTag);
 * 
 * @param[in] 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.
 * 
 * @return T A value <tt>inf</tt> that holds: <tt>inf &lt;= i</tt> for all
 *           values <tt>i</tt>.
 * 
 * This function implements minValue. It is recommended to use minValue rather
 * than <tt>infimumValueImpl</tt>.
 * 
 * @section Status
 * 
 * Deprecated, will be removed in favour of MinValue.
 * 
 * @see OrderedAlphabetConcept#minValue
 * 
 * @fn OrderedAlphabetConcept#minValue
 * 
 * @brief Infimum for a given type.
 * 
 * @signature T minValue<T>();
 * 
 * @tparam T An ordered type.
 * 
 * @return T A value <tt>inf</tt> that holds: <tt>inf &lt;= i</tt> for all
 *           values <tt>i</tt> of type <tt>T</tt>.
 * 
 * The function is implemented in infimumValueImpl. Do not specialize
 * <tt>minValue</tt>, specialize infimumValueImpl instead!
 * 
 * @section Status
 * 
 * Deprecated, will be removed in favour of MinValue.
 * 
 * @see OrderedAlphabetConcept#infimumValueImpl
 * @see OrderedAlphabetConcept#maxValue
 * @see OrderedAlphabetConcept#MinValue
 */