Comprehensive list of documented constants and functions

Unicode codepoint for aleph as a Char.

Unicode codepoint for ayin as a Char.

Vector of the begadkepat letters as Chars.

Unicode codepoint for bet as a Char.

Vector of all consonants as Chars.

Unicode codepoint for dagesh as a Char.

Unicode codepoint for dalet as a Char.

Unicode codepoint for multiple-digit number marker gershayim as a Char.

Unicode codepoint for single number marker gershe as a Char.

Unicode codepoint for gimel as a Char.

Vector of the guttural consonants as Chars.

Unicode codepoint for he as a Char.

Unicode codepoint for het as a Char.

Unicode codepoint for hiriq as a Char.

Unicode codepoint for holam as a Char.

Unicode codepoint for kaph as a Char.

Unicode codepoint for final kaph as a Char.

Unicode codepoint for lamed as a Char.

Unicode codepoint for mappiq as a Char.

Vector of the matres lectionis as Chars.

Unicode codepoint for mem as a Char.

Unicode codepoint for final mem as a Char.

Unicode codepoint for metheg as a Char.

Vector of all Unicode combining codepoints for vowel markings as Chars.

Unicode codepoint for mem as a Char.

Unicode codepoint for final nun as a Char.

Unicode codepoint for ole accent as a Char.

Unicode codepoint for patah as a Char.

Unicode codepoint for pe as a Char.

Unicode codepoint for final pe as a Char.

Unicode codepoint for qamats as a Char.

Unicode codepoint for qof as a Char.

Unicode codepoint for qubbuts as a Char.

Unicode codepoint for resh as a Char.

Unicode codepoint for samekh as a Char.

Unicode codepoint for seghol as a Char.

Unicode codepoint for sheva as a Char.

String combining Unicode codepoint for sin/shin with shin dot.

Unicode codepoint for shin dot as a Char.

String combining Unicode codepoint for sin/shin with sin dot.

Unicode codepoint for sin dot as a Char.

Unicode codepoint for sin/shin grapheme as a Char.

Unicode codepoint for tav as a Char.

Unicode codepoint for tet as a Char.

Unicode codepoint for pe as a Char.

Unicode codepoint for final tsadi as a Char.

Unicode codepoint for tsere as a Char.

Unicode codepoint for vav as a Char.

Unicode codepoint for yod as a Char.

Unicode codepoint for zayin as a Char.

Find Unicode codepoint for a hexadecimal string.

Look up Unicode summary name for a codepoint in the Hebrew range of Unicode.

Example

julia> codept_name('ב')
"bet"

codept_name(ch)

Split string s into substrings separated by character c; if keep is true, also maintain c as a string in the resulting list.

Add dagesh to string s.

dagesh(s)

Append gershe to string s.

Example

julia> gershe("ב")
"ב׳"

gershe(s)

True if a syllable has a sheva.

has_sheva(s)

True if a grapheme (a String value) has a vowel point.

has_vowelpoint(s)

Compose a list of all defined characters in the Hebrew range of Unicode as Chars, sorted in Unicode order.

Compose hexadecimal string for integer value of ch.

Find hexadecimal string for an integer.

Find hexadecimal string for an integer.

Add hiriq to string s.

Example

julia> hiriq("ב")
"בִ"

hiriq(s)

Add holam to string s.

Example

julia> holam("ב")
"בֹ"

holam(s)

Find integer value of a hexadecimal string.

True if a Char is a vowel point, a consonant, or one of the Unicode combining characters that are part of writing consonantal values.

Examples

julia> is_alphabetic('א')
true

julia> is_alphabetic(BiblicalHebrew.qamats_ch)
true

is_alphabetic(c)

True if initial consonant of s is a consonant in the begadkepat.

is_begadkepat(s)

True if Char is a Hebrew consonant.

Examples

julia> is_consonant('א')
true

julia> is_consonant(BiblicalHebrew.qamats_ch)
false

is_consonant(c)

True if String begins with a guttural.

is_guttural(s)

True if a syllable is long.

is_long(s)

True if a syllable represents a mater lectionis.

is_mater(s)

True if Char is a Hebrew vowel point.

Examples

julia> is_vowelpoint('א')
false

julia> is_vowelpoint(BiblicalHebrew.qamats_ch)
true

is_vowelpoint(c)

Add mappiq to string s.

Example

julia> mappiq("ה")
"הּ"

mappiq(s)

Join a pair of strings together with maqaf.

Example

julia> maqaf_join("עַל", "פְנֵי")
"עַל־פְנֵי"

maqaf_join(s1, s2)

Connect a list of tokens together with maqaf.

Example

julia> maqaf_join(["עַל", "פְנֵי"])
"עַל־פְנֵי"

maqaf_join(v)

Add metheg to string s.

Example

julia> qamats("ב") |> metheg
"בָֽ"

metheg(s)

Add accent ole to string s.

Example

julia> ole("עוֹלֶה")
"עוֹלֶה֫"

ole(s)

Add patah to string s.

Example

julia> patah("ב")
"בַ"

patah(s)

Add qamats to string s.

Example

julia> qamats("ב")
"בָ"

qamats(s)

Add qubbuts to string s.

Example

julia> qubbuts("ב")
"בֻ"

qubbuts(s)

True if a syllable has a reduced vowel.

reduced_vowel(s)

Remove all accents and cantillation marks from a string, leaving only consonants, vowel points and dagesh/mappiq (the same code point in Unicode).

rm_accents(s)

Add seghol to string s.

Example

julia> seghol("ב")
"בֶ"

seghol(s)

Add sheva to string s.

Example

julia> sheva("ב")
"בְ"

sheva(s)

Syllabify string.

syllabify(s)

Tokenize a string s where s has already isolated the token separators maqaf and soph pasuq. This can be accomplished by feeding s to the tokenize function with a HebrewOrthography.

Add tsere to string s.

Example

julia> tsere("ב")
"בֵ"

tsere(s)

Reduce a string to consonantal representation by removing all pointing and accents.

Example

julia> unpointed("קָמ")
"קמ"

unpointed(s)

Compose a list of all defined codepoints in the Hebrew range of Unicode sorted in codepoint order.

validcps()

Whitespace characters accepted in this orthography

Implement Orthography's codepoints functions for HebrewOrthography.

codepoints(ortho)

Implement Orthography's tokenize function for HebrewOrthography.

tokenize(s, o)

Implement Orthography's tokentypes functions for HebrewOrthography.

tokentypes(ortho)

Implement validstring function for HebrewOrthography. True if every code point in s appears in the HebrewOrthography's values for codepoints.