summaryrefslogtreecommitdiff
path: root/sorsyl/lib/syllabifier.mli
diff options
context:
space:
mode:
authorpolwex <polwex@sortug.com>2025-06-22 13:46:57 +0700
committerpolwex <polwex@sortug.com>2025-06-22 13:46:57 +0700
commit5dd49048bb65de3d572d43ba2f1b01435c71a35a (patch)
tree7f8e629ae511c3947a80f99906542f3fd2de0a9f /sorsyl/lib/syllabifier.mli
parent5f495c1d4ee624f9d24f03e50700e7d9a9305b73 (diff)
Diffstat (limited to 'sorsyl/lib/syllabifier.mli')
-rw-r--r--sorsyl/lib/syllabifier.mli24
1 files changed, 24 insertions, 0 deletions
diff --git a/sorsyl/lib/syllabifier.mli b/sorsyl/lib/syllabifier.mli
new file mode 100644
index 0000000..e40feeb
--- /dev/null
+++ b/sorsyl/lib/syllabifier.mli
@@ -0,0 +1,24 @@
+(** Syllabifier module for segmenting words into syllables using sonority *)
+
+(** Result of syllabification *)
+type syllabified = {
+ word : string; (** Original orthographic word *)
+ ipa : string; (** Original IPA transcription *)
+ lang : string; (** Language code *)
+ clean_ipa : string; (** Cleaned IPA without diacritics *)
+ syllables : Syllable.t list; (** List of syllables *)
+}
+
+(** Syllabify a word given its IPA transcription
+ @param sonority The sonority calculator
+ @param ipa The IPA transcription of the word
+ @param word The orthographic form of the word
+ @param lang The language code
+ @return The syllabified result
+*)
+val syllabify :
+ sonority:Sonority.t ->
+ ipa:string ->
+ word:string ->
+ lang:string ->
+ syllabified \ No newline at end of file