summaryrefslogtreecommitdiff
path: root/sorsyl/lib/sonority.ml
blob: c47d4a0cc1755c115553be91aebebc2b1d2d3e79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
(** Functional sonority module without global state *)

(** Decision tree for computing sonority values *)
type bool_tree =
  | Leaf of int  (** Terminal node with sonority value *)
  | Node of {
      test : Feature.segment -> bool;  (** Test function *)
      t_branch : bool_tree;  (** Branch to follow if test is true *)
      f_branch : bool_tree;  (** Branch to follow if test is false *)
    }

type t = { ipa_table : Ipa_table.t; decision_tree : bool_tree }
(** Type representing a sonority calculator *)

(** Build the decision tree for sonority calculation *)
let build_tree () =
  let open Feature in
  let plusSyl = test (Syllabic, Plus) in
  let minusHi = test (High, Minus) in
  let minusCons = test (Consonantal, Minus) in
  let plusSon = test (Sonorant, Plus) in
  let minusNas = test (Nasal, Minus) in
  let plusCont = test (Continuant, Plus) in
  let plusVoi = test (Voiced, Plus) in

  (* Build the tree bottom-up, matching the Python original exactly *)
  let minusHi_branch =
    Node
      {
        test = minusHi;
        t_branch = Leaf 9;
        (* -hi vowels = low vowels *)
        f_branch = Leaf 8;
        (* +hi vowels = high vowels *)
      }
  in

  let plusVoi1_branch =
    Node
      {
        test = plusVoi;
        t_branch = Leaf 4;
        (* +voi +cont = voiced fricatives *)
        f_branch = Leaf 3;
        (* -voi +cont = voiceless fricatives *)
      }
  in

  let plusVoi2_branch =
    Node
      {
        test = plusVoi;
        t_branch = Leaf 2;
        (* +voi -cont = voiced stops *)
        f_branch = Leaf 1;
        (* -voi -cont = voiceless stops *)
      }
  in

  let plusCont_branch =
    Node
      {
        test = plusCont;
        t_branch = plusVoi1_branch;
        (* +cont = fricatives *)
        f_branch = plusVoi2_branch;
        (* -cont = stops *)
      }
  in

  let minusNas_branch =
    Node
      {
        test = minusNas;
        t_branch = Leaf 6;
        (* -nas +son = liquids *)
        f_branch = Leaf 5;
        (* +nas +son = nasals *)
      }
  in

  let plusSon_branch =
    Node
      {
        test = plusSon;
        t_branch = minusNas_branch;
        (* +son = sonorants *)
        f_branch = plusCont_branch;
        (* -son = obstruents *)
      }
  in

  let minusCons_branch =
    Node
      {
        test = minusCons;
        t_branch = Leaf 7;
        (* -cons = glides *)
        f_branch = plusSon_branch;
        (* +cons = true consonants *)
      }
  in

  Node
    {
      test = plusSyl;
      t_branch = minusHi_branch;
      (* +syl = vowels *)
      f_branch = minusCons_branch;
      (* -syl = non-vowels *)
    }

(** Create a sonority calculator from data directory *)
let create (data_dir : string) : t =
  let ipa_table = Ipa_table.load_csv data_dir in
  let decision_tree = build_tree () in
  { ipa_table; decision_tree }

(** Traverse the decision tree to get sonority value *)
let rec traverse_tree (tree : bool_tree) (segment : Feature.segment) : int =
  match tree with
  | Leaf value -> value
  | Node { test; t_branch; f_branch } ->
      if test segment then traverse_tree t_branch segment
      else traverse_tree f_branch segment

(** Get the sonority value (1-9) for an IPA character *)
let sonority (calc : t) (ipa : string) : int =
  match Ipa_table.lookup_segment calc.ipa_table.table ipa with
  | Some features -> traverse_tree calc.decision_tree features
  | None -> failwith (Printf.sprintf "Unknown IPA segment: %s" ipa)

(** Get the sonority value from a feature specification *)
let sonority_from_features (calc : t) (segment : Feature.segment) : int =
  traverse_tree calc.decision_tree segment

(** Get the underlying IPA table *)
let get_ipa_table (calc : t) : Ipa_table.t = calc.ipa_table