Function template collation_sort

Function template collation_sort_key

boost::text::collation_sort_key

Synopsis

// In header: <boost/text/rope.hpp>


template<nf Normalization, typename Char, typename String> 
  text_sort_key 
  collation_sort_key(basic_rope< Normalization, Char, String > const & str, 
                     collation_table const & table, 
                     collation_flags flags = collation_flags::none);

Description

Returns a collation sort key for str, using the given collation table. Any optional settings flags will be honored, so long as they do not conflict with the settings on the given table.

	Note
	The contents of `str` will be normalized into temporary storage before collation if it is not normalized NFD or FCC; this is required by the Unicode collation algorithm.