R: Generate a List with Fixed Pattern Search Engine's Settings

stri_opts_fixed {stringi} | R Documentation

## Generate a List with Fixed Pattern Search Engine's Settings

### Description

A convenience function used to tune up the `stri_*_fixed` functions' behavior, 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 in certain functions
`...` | any other arguments to this function are purposely ignored

### 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 take into account the string context and the language and can map to a result string with a different length as appropriate, see stringi-search-coll.

Searching for overlapping pattern matches works in case of the `stri_extract_all_fixed`, `stri_locate_all_fixed`, and `stri_count_fixed` functions.

### Value

Returns a named list object.

### References

C/POSIX Migration – ICU User Guide, http://userguide.icu-project.org/posix#case_mappings

### See Also

Other search_fixed: `stringi-search-fixed`, `stringi-search`

### Examples

    stri_detect_fixed("ala", "ALA") # case-sensitive by default
    stri_detect_fixed("ala", "ALA", opts_fixed=stri_opts_fixed(case_insensitive=TRUE))
    stri_detect_fixed("ala", "ALA", case_insensitive=TRUE) # equivalent

[Package stringi version 1.2.4 Index]