stringi (version 0.2-4)

stri_order: Ordering Permutation and Sorting

Description

stri_order determines a permutation which rearranges strings into ascending or descending order. stri_sort sorts the vector according to a lexicographic order.

Usage

stri_order(str, decreasing = FALSE, na_last = TRUE, opts_collator = NULL)
stri_sort(str, decreasing = FALSE, na_last = NA, opts_collator = NULL)

Arguments

str

character vector

decreasing

single logical value; should the sort order be nondecreasing (FALSE, default) or nonincreasing (TRUE)?

na_last

single logical value controlling the treatment of NAs in str. If TRUE, then missing values in str are put at the end; if FALSE, they are put first; if NA, then they are removed

opts_collator

a named list with ICU Collator's options as generated with stri_opts_collator, NULL for default collation options

Value

• For stri_order, an integer vector that gives the sort order is returned.

  For stri_order, you get a sorted version of str, i.e. a character vector.

Details

For more information on ICU's Collator and how to tune it up in stringi, refer to stri_opts_collator.

These functions use a stable sort algorithm (STL's stable_sort), which performs up to $N*log^2(N)$ element comparisons, where $N$ is the length of str.

Interestingly, our benchmarks indicate that stri_order is most often faster that R's order.

See Also

Other locale_sensitive: %!==%, %!=%, %<=%< a="">, %<%< a="">, %===%, %==%, %>=%, %>%, %stri!==%, %stri!=%, %stri<=%< a="">, %stri<%< a="">, %stri===%, %stri==%, %stri>=%, %stri>%; stri_cmp, stri_cmp_eq, stri_cmp_equiv, stri_cmp_ge, stri_cmp_gt, stri_cmp_le, stri_cmp_lt, stri_cmp_neq, stri_cmp_nequiv, stri_compare; stri_count_coll; stri_detect_coll; stri_duplicated, stri_duplicated_any; stri_enc_detect2; stri_extract_all_coll, stri_extract_first_coll, stri_extract_first_coll, stri_extract_last_coll, stri_extract_last_coll; stri_extract_words; stri_locate_all_coll, stri_locate_first_coll, stri_locate_first_coll, stri_locate_last_coll, stri_locate_last_coll; stri_locate_boundaries; stri_locate_words; stri_opts_collator; stri_replace_all_coll, stri_replace_first_coll, stri_replace_first_coll, stri_replace_last_coll, stri_replace_last_coll; stri_split_boundaries; stri_split_coll; stri_trans_tolower, stri_trans_totitle, stri_trans_toupper; stri_unique; stri_wrap; stringi-locale; stringi-search-coll

Examples

stri_sort(c("hladny", "chladny"), opts_collator=stri_opts_collator(locale="pl_PL"))
stri_sort(c("hladny", "chladny"), opts_collator=stri_opts_collator(locale="sk_SK"))