package camomile

  1. Overview
  2. Docs
Module type
Class type
type text
type index
val compare : ?locale:string -> ?prec:precision -> ?variable:variable_option -> text -> text -> int

For locale, see Locale. If locale is omitted, the standard UCA order is used. If prec is omitted, the maximum possible strength is used. If variable is omitted, the default of the locale (usually `Shifted) is used. The meaning of the returned value is similar to

val sort_key : ?locale:string -> ?prec:precision -> ?variable:variable_option -> text -> string

Binary comparison of sort_key gives the same result as compare. i.e. compare t1 t2 = (sort_key t1) (sort_key t2) If the same texts are repeatedly compared, pre-computation of sort_key gives better performance.

val compare_with_key : ?locale:string -> ?prec:precision -> ?variable:variable_option -> string -> text -> int

Comparison with the sort key.

val search_with_key : ?locale:string -> ?prec:precision -> ?variable:variable_option -> string -> text -> index -> index * index