PrevUpHomeNext

Function template collate

boost::text::v1::collate

Synopsis

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


template<code_point_iter I1, std::sentinel_for< I1 > S1, code_point_iter I2, 
         std::sentinel_for< I2 > S2> 
  int collate(I1 first1, S1 last1, I2 first2, S2 last2, 
              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

Creates sort keys for [first1, last1) and [first2, last2), then returns the result of calling compare() on the keys. 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:

[first1, last1) is normalized NFD or FCC.

Requires:

[first2, last2) is normalized NFD or FCC.


PrevUpHomeNext