View source for cpp/locale/collate byname

{{cpp/title|collate_byname}}
{{cpp/locale/navbar}}
{{dcl begin}}
{{dcl header|locale}}
{{dcl|1=
template< class CharT >
class collate_byname : public std::collate<CharT>;
}}
{{dcl end}}

{{tt|std::collate_byname}} is a {{lc|std::collate}} facet which encapsulates locale-specific collation (comparison) and hashing of strings. Just like {{lc|std::collate}}, it can be imbued in {{lc|std::regex}} and applied, by means of {{l2tt std|cpp/locale/locale/operator()}}, directly to all standard algorithms that expect a string comparison predicate.

===Specializations===
The standard library is guaranteed to provide the following specializations:
{{dsc begin}}
{{dsc header | locale }}
{{dsc | {{c/core|std::collate_byname<char>}} | locale-specific collation of multibyte strings }}
{{dsc | {{c/core|std::collate_byname<wchar_t>}} | locale-specific collation of wide strings}}
{{dsc end}}

===Member functions===
{{dsc begin}}
{{dsc inc | cpp/locale/byname/dsc constructor | collate_byname}}
{{dsc inc | cpp/locale/byname/dsc destructor | collate_byname}}
{{dsc end}}

{{include | cpp/locale/byname/constructor | collate_byname}}
{{include | cpp/locale/byname/destructor | collate_byname}}

{{cpp/locale/collate/inherit}}

===Notes===
{{cpp/locale/collate/collation_note}}

===Example===
{{example
|<!-- TODO: a useful example would probably be a regex, check on clang -->
|code=
|output=
}}

===See also===
{{dsc begin}}
{{dsc inc | cpp/locale/dsc collate}}
{{dsc inc | cpp/string/byte/dsc strcoll}}
{{dsc inc | cpp/string/wide/dsc wcscoll}}
{{dsc inc | cpp/locale/locale/dsc operator()}}
{{dsc end}}

{{langlinks|de|es|fr|it|ja|pt|ru|zh}}