stri_opts_fixed: Generate a List with Fixed Pattern Search Engine’s Settings

Description

A convenience function used to tune up the behavior of stri_*_fixed functions, see stringi-search-fixed.

Usage

stri_opts_fixed(case_insensitive = FALSE, overlap = FALSE, ...)

Arguments


`case_insensitive`	logical; enable simple case insensitive matching
`overlap`	logical; enable overlapping matches’ detection
`...`	[DEPRECATED] any other arguments passed to this function generate a warning; this argument will be removed in the future

Details

Case-insensitive matching uses a simple, single-code point case mapping (via ICU’s u_toupper() function). Full case mappings should be used whenever possible because they produce better results by working on whole strings. They also take into account the string context and the language, see stringi-search-coll.

Searching for overlapping pattern matches is available in stri_extract_all_fixed, stri_locate_all_fixed, and stri_count_fixed functions.

Value

Returns a named list object.

Author(s)

Marek Gagolewski and other contributors

References

C/POSIX Migration – ICU User Guide, https://unicode-org.github.io/icu/userguide/icu/posix.html

Examples

stri_detect_fixed('ala', 'ALA') # case-sensitive by default
## [1] FALSE
stri_detect_fixed('ala', 'ALA', opts_fixed=stri_opts_fixed(case_insensitive=TRUE))
## [1] TRUE
stri_detect_fixed('ala', 'ALA', case_insensitive=TRUE) # equivalent
## [1] TRUE