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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
use crate::gaussian_mixture::errors::{GmmError, Result};
use ndarray_rand::rand::{Rng, SeedableRng};
use rand_isaac::Isaac64Rng;
#[cfg(feature = "serde")]
use serde_crate::{Deserialize, Serialize};
use linfa::{Float, ParamGuard};
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(crate = "serde_crate")
)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum GmmCovarType {
Full,
}
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(crate = "serde_crate")
)]
#[derive(Clone, Copy, Debug)]
pub enum GmmInitMethod {
KMeans,
Random,
}
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(crate = "serde_crate")
)]
#[derive(Clone, Debug)]
pub struct GmmValidParams<F: Float, R: Rng> {
n_clusters: usize,
covar_type: GmmCovarType,
tolerance: F,
reg_covar: F,
n_runs: u64,
max_n_iter: u64,
init_method: GmmInitMethod,
rng: R,
}
impl<F: Float, R: Rng + Clone> GmmValidParams<F, R> {
pub fn n_clusters(&self) -> usize {
self.n_clusters
}
pub fn covariance_type(&self) -> &GmmCovarType {
&self.covar_type
}
pub fn tolerance(&self) -> F {
self.tolerance
}
pub fn reg_covariance(&self) -> F {
self.reg_covar
}
pub fn n_runs(&self) -> u64 {
self.n_runs
}
pub fn max_n_iterations(&self) -> u64 {
self.max_n_iter
}
pub fn init_method(&self) -> &GmmInitMethod {
&self.init_method
}
pub fn rng(&self) -> R {
self.rng.clone()
}
}
#[cfg_attr(
feature = "serde",
derive(Serialize, Deserialize),
serde(crate = "serde_crate")
)]
#[derive(Clone, Debug)]
pub struct GmmParams<F: Float, R: Rng>(GmmValidParams<F, R>);
impl<F: Float> GmmParams<F, Isaac64Rng> {
#[allow(clippy::new_ret_no_self)]
pub fn new(n_clusters: usize) -> GmmParams<F, Isaac64Rng> {
Self::new_with_rng(n_clusters, Isaac64Rng::seed_from_u64(42))
}
}
impl<F: Float, R: Rng + Clone> GmmParams<F, R> {
fn new_with_rng(n_clusters: usize, rng: R) -> GmmParams<F, R> {
Self(GmmValidParams {
n_clusters,
covar_type: GmmCovarType::Full,
tolerance: F::cast(1e-3),
reg_covar: F::cast(1e-6),
n_runs: 1,
max_n_iter: 100,
init_method: GmmInitMethod::KMeans,
rng,
})
}
pub fn covariance_type(mut self, covar_type: GmmCovarType) -> Self {
self.0.covar_type = covar_type;
self
}
pub fn tolerance(mut self, tolerance: F) -> Self {
self.0.tolerance = tolerance;
self
}
pub fn reg_covariance(mut self, reg_covar: F) -> Self {
self.0.reg_covar = reg_covar;
self
}
pub fn n_runs(mut self, n_runs: u64) -> Self {
self.0.n_runs = n_runs;
self
}
pub fn max_n_iterations(mut self, max_n_iter: u64) -> Self {
self.0.max_n_iter = max_n_iter;
self
}
pub fn init_method(mut self, init_method: GmmInitMethod) -> Self {
self.0.init_method = init_method;
self
}
pub fn with_rng<R2: Rng + Clone>(self, rng: R2) -> GmmParams<F, R2> {
GmmParams(GmmValidParams {
n_clusters: self.0.n_clusters,
covar_type: self.0.covar_type,
tolerance: self.0.tolerance,
reg_covar: self.0.reg_covar,
n_runs: self.0.n_runs,
max_n_iter: self.0.max_n_iter,
init_method: self.0.init_method,
rng,
})
}
}
impl<F: Float, R: Rng> ParamGuard for GmmParams<F, R> {
type Checked = GmmValidParams<F, R>;
type Error = GmmError;
fn check_ref(&self) -> Result<&Self::Checked> {
if self.0.n_clusters == 0 {
Err(GmmError::InvalidValue(
"`n_clusters` cannot be 0!".to_string(),
))
} else if self.0.tolerance <= F::zero() {
Err(GmmError::InvalidValue(
"`tolerance` must be greater than 0!".to_string(),
))
} else if self.0.reg_covar < F::zero() {
Err(GmmError::InvalidValue(
"`reg_covar` must be positive!".to_string(),
))
} else if self.0.n_runs == 0 {
Err(GmmError::InvalidValue("`n_runs` cannot be 0!".to_string()))
} else if self.0.max_n_iter == 0 {
Err(GmmError::InvalidValue(
"`max_n_iterations` cannot be 0!".to_string(),
))
} else {
Ok(&self.0)
}
}
fn check(self) -> Result<Self::Checked> {
self.check_ref()?;
Ok(self.0)
}
}