std::collate< _CharT > - Facet for localized string comparison.

       Generated automatically by Doxygen for libstdc++ from the source code.

                                                    libstdc++                       std::collate<_CharT>(3cxx)

template<typename_CharT>std::collate<_CharT>::collate(size_t__refs=0)[inline],[explicit]
       Constructor performs initialization. This is the constructor provided by the standard.

       Parameters__refs Passed to the base facet class.

   template<typename_CharT>std::collate<_CharT>::collate(__c_locale__cloc,size_t__refs=0)[inline],[explicit]
       Internal constructor. Not for general use. This is a constructor for use by the library itself to set up
       new locales.

       Parameters__cloc The C locale.
           __refs Passed to the base facet class.

   template<typename_CharT>virtualstd::collate<_CharT>::~collate()[inline],[protected],[virtual]
       Destructor.

template<typename_CharT>
       class std::collate< _CharT >"Facet for localized string comparison.

       This facet encapsulates the code to compare strings in a localized manner.

       The collate template uses protected virtual functions to provide the actual results. The public accessors
       forward the call to the virtual functions. These virtual functions are hooks for developers to implement
       the behavior they require from the collate facet.

template<typename_CharT>locale::idstd::collate<_CharT>::id[static]
       Numpunct facet id.

template<typename_CharT>intstd::collate<_CharT>::compare(const_CharT*__lo1,const_CharT*__hi1,const_CharT*__lo2,const_CharT*__hi2)const[inline]
       Compare two strings. This function compares two strings and returns the result by calling
       collate::do_compare().

       Parameters__lo1 Start of string 1.
           __hi1 End of string 1.
           __lo2 Start of string 2.
           __hi2 End of string 2.

       Returns
           1 if string1 > string2, -1 if string1 < string2, else 0.

   template<typename_CharT>intstd::collate<_CharT>::do_compare(const_CharT*__lo1,const_CharT*__hi1,const_CharT*__lo2,const_CharT*__hi2)const[protected],[virtual]
       Compare two strings. This function is a hook for derived classes to change the value returned.

       Seealso
           compare().

       Parameters__lo1 Start of string 1.
           __hi1 End of string 1.
           __lo2 Start of string 2.
           __hi2 End of string 2.

       Returns
           1 if string1 > string2, -1 if string1 < string2, else 0.

   template<typename_CharT>longstd::collate<_CharT>::do_hash(const_CharT*__lo,const_CharT*__hi)const[protected],[virtual]
       Return hash of a string. This function computes and returns a hash on the input string. This function is
       a hook for derived classes to change the value returned.

       Parameters__lo Start of string.
           __hi End of string.

       Returns
           Hash value.

   template<typename_CharT>collate<_CharT>::string_typestd::collate<_CharT>::do_transform(const_CharT*__lo,const_CharT*__hi)const[protected],[virtual]
       Transform string to comparable form. This function is a hook for derived classes to change the value
       returned.

       Parameters__lo Start.
           __hi End.

       Returns
           transformed string.

   template<typename_CharT>longstd::collate<_CharT>::hash(const_CharT*__lo,const_CharT*__hi)const[inline]
       Return hash of a string. This function computes and returns a hash on the input string. It does so by
       returning collate::do_hash().

       Parameters__lo Start of string.
           __hi End of string.

       Returns
           Hash value.

   template<typename_CharT>string_typestd::collate<_CharT>::transform(const_CharT*__lo,const_CharT*__hi)const[inline]
       Transform string to comparable form. This function is a wrapper for strxfrm functionality. It takes the
       input string and returns a modified string that can be directly compared to other transformed strings. In
       the C locale, this function just returns a copy of the input string. In some other locales, it may
       replace two chars with one, change a char for another, etc. It does so by returning
       collate::do_transform().

       Parameters__lo Start of string.
           __hi End of string.

       Returns
           Transformed string_type.

template<typename_CharT>typedef_CharTstd::collate<_CharT>::char_type
       Public typedefs.

   template<typename_CharT>typedefbasic_string<_CharT>std::collate<_CharT>::string_type
       Public typedefs.

       std::collate< _CharT > - Facet for localized string comparison.

       #include <locale>

       Inherits std::locale::facet.

       Inherited by std::collate_byname<_CharT>.

   PublicTypestypedef _CharT char_type
               Public typedefs.
           typedefbasic_string< _CharT > string_type
               Public typedefs.

   PublicMemberFunctionscollate (__c_locale __cloc, size_t __refs=0)
           Internal constructor. Not for general use.
       collate (size_t __refs=0)
           Constructor performs initialization.
       int _M_compare (const _CharT *, const _CharT *) const  throw ()
       int _M_compare (const char *, const char *) const throw()
       int _M_compare (const wchar_t *, const wchar_t *) const throw()
       size_t _M_transform (_CharT *, const _CharT *, size_t) const  throw ()
       size_t _M_transform (char *, const char *, size_t) const throw()
       size_t _M_transform (wchar_t *, const wchar_t *, size_t) const throw()
       int compare (const _CharT *__lo1, const _CharT *__hi1, const _CharT *__lo2, const _CharT *__hi2) const
           Compare two strings.
       long hash (const _CharT *__lo, const _CharT *__hi) const
           Return hash of a string.
       string_typetransform (const _CharT *__lo, const _CharT *__hi) const
           Transform string to comparable form.

   StaticPublicAttributesstaticlocale::idid
           Numpunct facet id.

   ProtectedMemberFunctionsvirtual~collate ()
           Destructor.
       virtual int do_compare (const _CharT *__lo1, const _CharT *__hi1, const _CharT *__lo2, const _CharT
           *__hi2) const
           Compare two strings.
       virtual long do_hash (const _CharT *__lo, const _CharT *__hi) const
           Return hash of a string.
       virtualstring_typedo_transform (const _CharT *__lo, const _CharT *__hi) const
           Transform string to comparable form.

   StaticProtectedMemberFunctionsstatic __c_locale _S_clone_c_locale (__c_locale &__cloc)  throw ()
       staticvoid_S_create_c_locale (__c_locale &__cloc, const char *__s, __c_locale __old=0)
       staticvoid_S_destroy_c_locale (__c_locale &__cloc)
       static __c_locale _S_get_c_locale ()
       static const char * _S_get_c_name ()  throw ()
       static __c_locale _S_lc_ctype_c_locale (__c_locale __cloc, const char *__s)

   ProtectedAttributes
       __c_locale _M_c_locale_collate