Function template collation_sort

Function template collation_sort_key

boost::text::v1::collation_sort_key

Synopsis

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


template<code_point_iter I, std::sentinel_for< I > S> 
  text_sort_key 
  collation_sort_key(I first, S last, collation_table const & table, 
                     collation_strength strength = collation_strength::tertiary, 
                     case_first case_1st = case_first::off, 
                     case_level case_lvl = case_level::off, 
                     variable_weighting weighting = variable_weighting::non_ignorable, 
                     l2_weight_order l2_order = l2_weight_order::forward);

Description

Returns a collation sort key for the code points in [first, last), using the given collation table. Any optional settings such as case_1st will be honored, so long as they do not conflict with the settings on the given table.

Consider using one of the overloads that takes collation_flags instead.

Requires:

[first, last) is normalized NFD or FCC.