Comprehensive list of documented constants and functions
Constants
BiblicalHebrew.aleph_ch
— ConstantUnicode codepoint for aleph as a Char
.
BiblicalHebrew.ayin_ch
— ConstantUnicode codepoint for ayin as a Char
.
BiblicalHebrew.begadkepat
— ConstantVector of the begadkepat letters as Char
s.
BiblicalHebrew.bet_ch
— ConstantUnicode codepoint for bet as a Char
.
BiblicalHebrew.consonants
— ConstantVector of all consonants as Char
s.
BiblicalHebrew.dagesh_ch
— ConstantUnicode codepoint for dagesh as a Char
.
BiblicalHebrew.dalet_ch
— ConstantUnicode codepoint for dalet as a Char
.
BiblicalHebrew.gershayim_ch
— ConstantUnicode codepoint for multiple-digit number marker gershayim as a Char
.
BiblicalHebrew.gershe_ch
— ConstantUnicode codepoint for single number marker gershe as a Char
.
BiblicalHebrew.gimel_ch
— ConstantUnicode codepoint for gimel as a Char
.
BiblicalHebrew.gutturals
— ConstantVector of the guttural consonants as Char
s.
BiblicalHebrew.he_ch
— ConstantUnicode codepoint for he as a Char
.
BiblicalHebrew.het_ch
— ConstantUnicode codepoint for het as a Char
.
BiblicalHebrew.hiriq_ch
— ConstantUnicode codepoint for hiriq as a Char
.
BiblicalHebrew.holam_ch
— ConstantUnicode codepoint for holam as a Char
.
BiblicalHebrew.kaph_ch
— ConstantUnicode codepoint for kaph as a Char
.
BiblicalHebrew.kaph_final_ch
— ConstantUnicode codepoint for final kaph as a Char
.
BiblicalHebrew.lamed_ch
— ConstantUnicode codepoint for lamed as a Char
.
BiblicalHebrew.mappiq_ch
— ConstantUnicode codepoint for mappiq as a Char
.
BiblicalHebrew.matres
— ConstantVector of the matres lectionis as Char
s.
BiblicalHebrew.mem_ch
— ConstantUnicode codepoint for mem as a Char
.
BiblicalHebrew.mem_final_ch
— ConstantUnicode codepoint for final mem as a Char
.
BiblicalHebrew.metheg_ch
— ConstantUnicode codepoint for metheg as a Char
.
BiblicalHebrew.nequddot
— ConstantVector of all Unicode combining codepoints for vowel markings as Char
s.
BiblicalHebrew.nun_ch
— ConstantUnicode codepoint for mem as a Char
.
BiblicalHebrew.nun_final_ch
— ConstantUnicode codepoint for final nun as a Char
.
BiblicalHebrew.ole_ch
— ConstantUnicode codepoint for ole accent as a Char
.
BiblicalHebrew.patah_ch
— ConstantUnicode codepoint for patah as a Char
.
BiblicalHebrew.pe_ch
— ConstantUnicode codepoint for pe as a Char
.
BiblicalHebrew.pe_final_ch
— ConstantUnicode codepoint for final pe as a Char
.
BiblicalHebrew.qamats_ch
— ConstantUnicode codepoint for qamats as a Char
.
BiblicalHebrew.qof_ch
— ConstantUnicode codepoint for qof as a Char
.
BiblicalHebrew.qubbuts_ch
— ConstantUnicode codepoint for qubbuts as a Char
.
BiblicalHebrew.resh_ch
— ConstantUnicode codepoint for resh as a Char
.
BiblicalHebrew.samekh_ch
— ConstantUnicode codepoint for samekh as a Char
.
BiblicalHebrew.seghol_ch
— ConstantUnicode codepoint for seghol as a Char
.
BiblicalHebrew.sheva_ch
— ConstantUnicode codepoint for sheva as a Char
.
BiblicalHebrew.shin
— ConstantString combining Unicode codepoint for sin/shin with shin dot.
BiblicalHebrew.shin_dot_ch
— ConstantUnicode codepoint for shin dot as a Char
.
BiblicalHebrew.sin
— ConstantString combining Unicode codepoint for sin/shin with sin dot.
BiblicalHebrew.sin_dot_ch
— ConstantUnicode codepoint for sin dot as a Char
.
BiblicalHebrew.sin_shin_ch
— ConstantUnicode codepoint for sin/shin grapheme as a Char
.
BiblicalHebrew.tav_ch
— ConstantUnicode codepoint for tav as a Char
.
BiblicalHebrew.tet_ch
— ConstantUnicode codepoint for tet as a Char
.
BiblicalHebrew.tsadi_ch
— ConstantUnicode codepoint for pe as a Char
.
BiblicalHebrew.tsadi_final_ch
— ConstantUnicode codepoint for final tsadi as a Char
.
BiblicalHebrew.tsere_ch
— ConstantUnicode codepoint for tsere as a Char
.
BiblicalHebrew.vav_ch
— ConstantUnicode codepoint for vav as a Char
.
BiblicalHebrew.yod_ch
— ConstantUnicode codepoint for yod as a Char
.
BiblicalHebrew.zayin_ch
— ConstantUnicode codepoint for zayin as a Char
.
Functions
BiblicalHebrew.codept
— MethodFind Unicode codepoint for a hexadecimal string.
BiblicalHebrew.codept_name
— MethodLook up Unicode summary name for a codepoint in the Hebrew range of Unicode.
Example
julia> codept_name('ב')
"bet"
codept_name(ch)
BiblicalHebrew.codept_split
— MethodSplit string s
into substrings separated by character c
; if keep
is true, also maintain c
as a string in the resulting list.
BiblicalHebrew.dagesh
— MethodAdd dagesh to string s
.
dagesh(s)
BiblicalHebrew.gershe
— MethodAppend gershe to string s
.
Example
julia> gershe("ב")
"ב׳"
gershe(s)
BiblicalHebrew.has_sheva
— MethodTrue if a syllable has a sheva.
has_sheva(s)
BiblicalHebrew.has_vowelpoint
— MethodTrue if a grapheme (a String value) has a vowel point.
has_vowelpoint(s)
BiblicalHebrew.hebrew_chars
— MethodCompose a list of all defined characters in the Hebrew range of Unicode as Char
s, sorted in Unicode order.
BiblicalHebrew.hex
— MethodCompose hexadecimal string for integer value of ch
.
BiblicalHebrew.hex
— MethodFind hexadecimal string for an integer.
BiblicalHebrew.hex
— MethodFind hexadecimal string for an integer.
BiblicalHebrew.hiriq
— MethodAdd hiriq to string s
.
Example
julia> hiriq("ב")
"בִ"
hiriq(s)
BiblicalHebrew.holam
— MethodAdd holam to string s
.
Example
julia> holam("ב")
"בֹ"
holam(s)
BiblicalHebrew.int
— MethodFind integer value of a hexadecimal string.
BiblicalHebrew.is_alphabetic
— MethodTrue 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)
BiblicalHebrew.is_begadkepat
— MethodTrue if initial consonant of s
is a consonant in the begadkepat.
is_begadkepat(s)
BiblicalHebrew.is_consonant
— MethodTrue if Char is a Hebrew consonant.
Examples
julia> is_consonant('א')
true
julia> is_consonant(BiblicalHebrew.qamats_ch)
false
is_consonant(c)
BiblicalHebrew.is_guttural
— MethodTrue if String begins with a guttural.
is_guttural(s)
BiblicalHebrew.is_long
— MethodTrue if a syllable is long.
is_long(s)
BiblicalHebrew.is_mater
— MethodTrue if a syllable represents a mater lectionis.
is_mater(s)
BiblicalHebrew.is_vowelpoint
— MethodTrue if Char is a Hebrew vowel point.
Examples
julia> is_vowelpoint('א')
false
julia> is_vowelpoint(BiblicalHebrew.qamats_ch)
true
is_vowelpoint(c)
BiblicalHebrew.mappiq
— MethodAdd mappiq to string s
.
Example
julia> mappiq("ה")
"הּ"
mappiq(s)
BiblicalHebrew.maqaf_join
— MethodJoin a pair of strings together with maqaf.
Example
julia> maqaf_join("עַל", "פְנֵי")
"עַל־פְנֵי"
maqaf_join(s1, s2)
BiblicalHebrew.maqaf_join
— MethodConnect a list of tokens together with maqaf.
Example
julia> maqaf_join(["עַל", "פְנֵי"])
"עַל־פְנֵי"
maqaf_join(v)
BiblicalHebrew.metheg
— MethodAdd metheg to string s
.
Example
julia> qamats("ב") |> metheg
"בָֽ"
metheg(s)
BiblicalHebrew.ole
— MethodAdd accent ole to string s
.
Example
julia> ole("עוֹלֶה")
"עוֹלֶה֫"
ole(s)
BiblicalHebrew.patah
— MethodAdd patah to string s
.
Example
julia> patah("ב")
"בַ"
patah(s)
BiblicalHebrew.qamats
— MethodAdd qamats to string s
.
Example
julia> qamats("ב")
"בָ"
qamats(s)
BiblicalHebrew.qubbuts
— MethodAdd qubbuts to string s
.
Example
julia> qubbuts("ב")
"בֻ"
qubbuts(s)
BiblicalHebrew.reduced_vowel
— MethodTrue if a syllable has a reduced vowel.
reduced_vowel(s)
BiblicalHebrew.rm_accents
— MethodRemove 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)
BiblicalHebrew.seghol
— MethodAdd seghol to string s
.
Example
julia> seghol("ב")
"בֶ"
seghol(s)
BiblicalHebrew.sheva
— MethodAdd sheva to string s
.
Example
julia> sheva("ב")
"בְ"
sheva(s)
BiblicalHebrew.syllabify
— MethodSyllabify string.
syllabify(s)
BiblicalHebrew.tokenize_string
— FunctionTokenize 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
.
BiblicalHebrew.tsere
— MethodAdd tsere to string s
.
Example
julia> tsere("ב")
"בֵ"
tsere(s)
BiblicalHebrew.unpointed
— MethodReduce a string to consonantal representation by removing all pointing and accents.
Example
julia> unpointed("קָמ")
"קמ"
unpointed(s)
BiblicalHebrew.validcps
— MethodCompose a list of all defined codepoints in the Hebrew range of Unicode sorted in codepoint order.
validcps()
BiblicalHebrew.ws_chars
— MethodWhitespace characters accepted in this orthography
Orthography.codepoints
— MethodImplement Orthography
's codepoints functions for HebrewOrthography
.
codepoints(ortho)
Orthography.tokenize
— MethodImplement Orthography's tokenize function for HebrewOrthography.
tokenize(s, o)
Orthography.tokentypes
— MethodImplement Orthography's tokentypes functions for HebrewOrthography
.
tokentypes(ortho)
Orthography.validstring
— MethodImplement validstring
function for HebrewOrthography
. True if every code point in s
appears in the HebrewOrthography
's values for codepoints
.