Functions to introspect the Unicode Indic syllabic category property for binaries (Strings) and codepoints.
The primary API is indic_syllabic_category/1 which returns the Indic syllabic category for a codepoint or the list of Indic syllabic categories for a string.
The functions fetch/1, get/1 and count/1 provide introspection of the codepoint ranges associated with a given Indic syllabic category. indic_syllabic_categories/0, known_indic_syllabic_categories/0 and aliases/0 return the underlying property data.
Summary
Functions
Returns a map of aliases for Unicode Indic syllabic categories.
Returns the count of the number of characters for a given Indic syllabic category.
Returns the Unicode codepoint ranges for a given Indic syllabic category.
Returns the Unicode codepoint ranges for a given Indic syllabic category.
Returns the map of Unicode Indic syllabic categories.
Returns the Indic syllabic category name(s) for the given binary or codepoint.
Returns a list of known Unicode Indic syllabic category names.
Functions
Returns a map of aliases for Unicode Indic syllabic categories.
An alias is an alternative name for referring to an Indic syllabic category. Aliases are resolved by the fetch/1 and get/1 functions.
Returns
- A map with the alias as a string key and the Indic syllabic category name as an atom value.
Examples
iex> Unicode.IndicSyllabicCategory.aliases() |> Map.get("virama")
:viramaReturns the count of the number of characters for a given Indic syllabic category.
Arguments
indic_syllabic_categoryis any Indic syllabic category name as an atom, or a string alias for an Indic syllabic category.
Returns
The number of codepoints that have the given Indic syllabic category.
:errorif the Indic syllabic category name is not known.
Examples
iex> Unicode.IndicSyllabicCategory.count(:bindu)
99Returns the Unicode codepoint ranges for a given Indic syllabic category.
Aliases are resolved by this function.
Arguments
indic_syllabic_categoryis any Indic syllabic category name as an atom, or a string alias for an Indic syllabic category.
Returns
{:ok, range_list}whererange_listis a list of codepoint ranges as 2-tuples.:errorif the Indic syllabic category name is not known.
Examples
iex> {:ok, ranges} = Unicode.IndicSyllabicCategory.fetch(:virama)
iex> Enum.take(ranges, 2)
[{2381, 2381}, {2509, 2509}]
iex> Unicode.IndicSyllabicCategory.fetch(:invalid)
:errorReturns the Unicode codepoint ranges for a given Indic syllabic category.
Aliases are resolved by this function.
Arguments
indic_syllabic_categoryis any Indic syllabic category name as an atom, or a string alias for an Indic syllabic category.
Returns
range_listwhich is a list of codepoint ranges as 2-tuples.nilif the Indic syllabic category name is not known.
Examples
iex> Unicode.IndicSyllabicCategory.get(:virama) |> Enum.take(2)
[{2381, 2381}, {2509, 2509}]
iex> Unicode.IndicSyllabicCategory.get(:invalid)
nilReturns the map of Unicode Indic syllabic categories.
Returns
- A map with the Indic syllabic category name as the key and a list of codepoint ranges as 2-tuples as the value.
Examples
iex> Unicode.IndicSyllabicCategory.indic_syllabic_categories() |> Map.get(:virama) |> Enum.take(2)
[{2381, 2381}, {2509, 2509}]Returns the Indic syllabic category name(s) for the given binary or codepoint.
Arguments
codepoint_or_stringis either an integer codepoint or a string.
Returns
In the case of a codepoint, a single Indic syllabic category name as an atom. Codepoints with no explicit Indic syllabic category default to
:other.In the case of a string, a list of the distinct Indic syllabic category names represented by the codepoints in the string.
Examples
iex> Unicode.IndicSyllabicCategory.indic_syllabic_category(0x094D)
:virama
iex> Unicode.IndicSyllabicCategory.indic_syllabic_category(?A)
:otherReturns a list of known Unicode Indic syllabic category names.
This function does not return the names of any Indic syllabic category aliases.
Returns
- A list of Indic syllabic category names as atoms.
Examples
iex> Unicode.IndicSyllabicCategory.known_indic_syllabic_categories() |> Enum.sort() |> Enum.take(3)
[:avagraha, :bindu, :brahmi_joining_number]