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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
use super::*;
use crate::Lbfgs;
use crate::solver::*;
macro_rules! cost_setters {
([$($generic:tt)*] $solver:ty, [$($bound:tt)*]) => {
impl<$($generic)*> $solver where $($bound)* {
/// Stop when the absolute change between consecutive observed costs is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_cost_change_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, (), (), CostChecks<Q>, ()>
{ ConfiguredSolver::new(self).set_absolute_cost_change_tolerance(value) }
/// Stop when the observed cost change is at most the tolerance times the previous absolute cost.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_relative_cost_change_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, (), (), CostChecks<Q>, ()>
{ ConfiguredSolver::new(self).set_relative_cost_change_tolerance(value) }
}
impl<CG, CX, CC, CT, $($generic)*> ConfiguredSolver<$solver, CG, CX, CC, CT> where $($bound)* {
/// Stop when the absolute change between consecutive observed costs is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_cost_change_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, CG, CX, CostChecks<Q>, CT>
where CC: Into<CostChecks<Q>> { self.set_absolute_cost_change_tolerance(value) }
/// Stop when the observed cost change is at most the tolerance times the previous absolute cost.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_relative_cost_change_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, CG, CX, CostChecks<Q>, CT>
where CC: Into<CostChecks<Q>> { self.set_relative_cost_change_tolerance(value) }
}
};
}
macro_rules! step_setters {
([$($generic:tt)*] $solver:ty, [$($bound:tt)*]) => {
impl<$($generic)*> $solver where $($bound)* {
/// Stop when the Euclidean distance between consecutive observed iterates is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, (), StepChecks<Param,Q>, (), ()>
{ ConfiguredSolver::new(self).set_absolute_step_tolerance(value) }
/// Stop when the Euclidean iterate change is at most the tolerance times the current iterate norm.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_relative_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, (), StepChecks<Param,Q>, (), ()>
{ ConfiguredSolver::new(self).set_relative_step_tolerance(value) }
}
impl<CG, CX, CC, CT, $($generic)*> ConfiguredSolver<$solver, CG, CX, CC, CT> where $($bound)* {
/// Stop when the Euclidean distance between consecutive observed iterates is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, CG, StepChecks<Param,Q>, CC, CT>
where CX: Into<StepChecks<Param,Q>> { self.set_absolute_step_tolerance(value) }
/// Stop when the Euclidean iterate change is at most the tolerance times the current iterate norm.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_relative_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, CG, StepChecks<Param,Q>, CC, CT>
where CX: Into<StepChecks<Param,Q>> { self.set_relative_step_tolerance(value) }
}
};
}
macro_rules! gradient_setters {
([$($generic:tt)*] $solver:ty, [$($bound:tt)*]) => {
impl<$($generic)*> $solver where $($bound)* {
/// Stop when the Euclidean gradient norm is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_absolute_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, GradientChecks<Q>, (), (), ()>
{ ConfiguredSolver::new(self).set_absolute_gradient_tolerance(value) }
/// Stop when the Euclidean gradient norm is at most the tolerance times its initial norm.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_relative_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, GradientChecks<Q>, (), (), ()>
{ ConfiguredSolver::new(self).set_relative_gradient_tolerance(value) }
}
impl<CG, CX, CC, CT, $($generic)*> ConfiguredSolver<$solver, CG, CX, CC, CT> where $($bound)* {
/// Stop when the Euclidean gradient norm is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_absolute_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, GradientChecks<Q>, CX, CC, CT>
where CG: Into<GradientChecks<Q>> { self.set_absolute_gradient_tolerance(value) }
/// Stop when the Euclidean gradient norm is at most the tolerance times its initial norm.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_relative_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, GradientChecks<Q>, CX, CC, CT>
where CG: Into<GradientChecks<Q>> { self.set_relative_gradient_tolerance(value) }
}
};
}
macro_rules! projected_setters {
([$($generic:tt)*] $solver:ty, [$($bound:tt)*]) => {
impl<$($generic)*> $solver where $($bound)* {
/// Stop when the infinity norm of `x - project(x - gradient)` is at most the tolerance; use the current problem bounds.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_absolute_projected_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, ProjectedGradientCheck<Q>, (), (), ()>
{ ConfiguredSolver::new(self).set_absolute_projected_gradient_tolerance(value) }
}
impl<CG, CX, CC, CT, $($generic)*> ConfiguredSolver<$solver, CG, CX, CC, CT> where $($bound)* {
/// Stop when the infinity norm of `x - project(x - gradient)` is at most the tolerance; use the current problem bounds.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates.
pub fn with_absolute_projected_gradient_tolerance<Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, ProjectedGradientCheck<Q>, CX, CC, CT>
where CG: Into<ProjectedGradientCheck<Q>> { self.set_absolute_projected_gradient_tolerance(value) }
}
};
}
cost_setters!([L, V, F: Scalar] GradientDescent<L, V, F>, []);
step_setters!([L, V, F: Scalar] GradientDescent<L, V, F>, []);
cost_setters!([L, V, F: Scalar] NonlinearCg<L, V, F>, []);
step_setters!([L, V, F: Scalar] NonlinearCg<L, V, F>, []);
gradient_setters!([L, V, F: Scalar] NonlinearCg<L, V, F>, []);
cost_setters!([V, F: Scalar] Sgd<V,F>, []);
step_setters!([V, F: Scalar] Sgd<V,F>, []);
cost_setters!([V, L, M, I, F: Scalar] Bfgs<V,F,M,L,I>, [V: crate::DenseBackend<F>]);
step_setters!([V, L, M, I, F: Scalar] Bfgs<V,F,M,L,I>, [V: crate::DenseBackend<F>]);
cost_setters!([V,Mode,L,F:Scalar] Lbfgs<V,F,Mode,L>, []);
step_setters!([V,Mode,L,F:Scalar] Lbfgs<V,F,Mode,L>, []);
cost_setters!([L,F:Scalar] ProjectedGradientDescent<L,F>, []);
step_setters!([L,F:Scalar] ProjectedGradientDescent<L,F>, []);
cost_setters!([Sub,F:Scalar,Mode] TrustRegion<Sub,F,Mode>, []);
step_setters!([Sub,F:Scalar,Mode] TrustRegion<Sub,F,Mode>, []);
cost_setters!([V,Mode,F:Scalar] NelderMead<V,F,Mode>, []);
step_setters!([V,Mode,F:Scalar] NelderMead<V,F,Mode>, []);
cost_setters!([V,M,F:Scalar] GaussNewton<V,M,F>, []);
step_setters!([V,M,F:Scalar] GaussNewton<V,M,F>, []);
cost_setters!([V,M,F:Scalar] LevenbergMarquardt<V,M,F>, []);
cost_setters!([V,M,F:Scalar] LevenbergMarquardtQr<V,M,F>, [M: crate::FactorizePivotedQr<V,F>]);
cost_setters!([V,M,F:Scalar] BoundedLevenbergMarquardt<V,M,F>, []);
step_setters!([V,M,F:Scalar] BoundedLevenbergMarquardt<V,M,F>, []);
cost_setters!([F:Scalar] TrustRegionReflective<F>, []);
step_setters!([F:Scalar] TrustRegionReflective<F>, []);
cost_setters!([F:Scalar] Brent<F>, []);
step_setters!([F:Scalar] Brent<F>, []);
cost_setters!([F:Scalar] BrentDerivative<F>, []);
step_setters!([F:Scalar] BrentDerivative<F>, []);
cost_setters!([F:Scalar] GoldenSection<F>, []);
step_setters!([F:Scalar] GoldenSection<F>, []);
cost_setters!([V, F:Scalar] SolisWets<V,F>, []);
step_setters!([V, F:Scalar] SolisWets<V,F>, []);
cost_setters!([F:Scalar] Newuoa<F>, []);
step_setters!([F:Scalar] Newuoa<F>, []);
cost_setters!([Mode,F:Scalar] Bobyqa<Mode,F>, []);
step_setters!([Mode,F:Scalar] Bobyqa<Mode,F>, []);
cost_setters!([F:Scalar] Lincoa<F>, []);
step_setters!([F:Scalar] Lincoa<F>, []);
cost_setters!([V,F:Scalar] Cobyla<V,F>, []);
step_setters!([V,F:Scalar] Cobyla<V,F>, []);
cost_setters!([Mode,F:Scalar] Mads<Mode,F>, []);
step_setters!([Mode,F:Scalar] Mads<Mode,F>, []);
cost_setters!([V,F:Scalar] Gbnm<V,F>, []);
step_setters!([V,F:Scalar] Gbnm<V,F>, []);
cost_setters!([V,M,F:Scalar] CmaEs<V,M,F>, []);
step_setters!([V,M,F:Scalar] CmaEs<V,M,F>, []);
cost_setters!([V,M,F:Scalar] BoundedCmaEs<V,M,F>, []);
step_setters!([V,M,F:Scalar] BoundedCmaEs<V,M,F>, []);
cost_setters!([F:Scalar] De<F>, []);
step_setters!([F:Scalar] De<F>, []);
cost_setters!([F:Scalar] Ssga<F>, []);
step_setters!([F:Scalar] Ssga<F>, []);
cost_setters!([] RandomSearch, []);
step_setters!([] RandomSearch, []);
cost_setters!([N,F:Scalar,R] SimulatedAnnealing<N,F,R>, []);
step_setters!([N,F:Scalar,R] SimulatedAnnealing<N,F,R>, []);
cost_setters!([V,F:Scalar,R] GlobalBestPso<V,F,R>, []);
step_setters!([V,F:Scalar,R] GlobalBestPso<V,F,R>, []);
cost_setters!([So,F:Scalar] BarrierMethod<So,F>, []);
step_setters!([So,F:Scalar] BarrierMethod<So,F>, []);
cost_setters!([So,V,F:Scalar] AugmentedLagrangianMethod<So,V,F>, []);
step_setters!([So,V,F:Scalar] AugmentedLagrangianMethod<So,V,F>, []);
cost_setters!([V,LS,F:Scalar] MaLsCh<V,LS,F>, [LS: crate::ResumableInner<V,F>]);
step_setters!([V,LS,F:Scalar] MaLsCh<V,LS,F>, [LS: crate::ResumableInner<V,F>]);
cost_setters!([I,V,M,F:Scalar] CmaInject<I,V,M,F>, [I: MemeticInner<V,F>]);
step_setters!([I,V,M,F:Scalar] CmaInject<I,V,M,F>, [I: MemeticInner<V,F>]);
cost_setters!([I,V,M,F:Scalar] BoundedCmaInject<I,V,M,F>, [I: MemeticInner<V,F>]);
step_setters!([I,V,M,F:Scalar] BoundedCmaInject<I,V,M,F>, [I: MemeticInner<V,F>]);
cost_setters!([I,V,F:Scalar] DeInject<I,V,F>, [I: MemeticInner<V,F>]);
step_setters!([I,V,F:Scalar] DeInject<I,V,F>, [I: MemeticInner<V,F>]);
cost_setters!([V,I,T,A,F:Scalar] BasinHopping<I,V,F,T,A>, [I: crate::WarmStart<V>]);
step_setters!([V,I,T,A,F:Scalar] BasinHopping<I,V,F,T,A>, [I: crate::WarmStart<V>]);
gradient_setters!([L, V, F: Scalar] GradientDescent<L, V, F>, []);
gradient_setters!([V, L, M, I, F: Scalar] Bfgs<V,F,M,L,I>, [V: crate::DenseBackend<F>]);
gradient_setters!([V,L,F:Scalar] Lbfgs<V,F,crate::solver::lbfgs::Unbounded,L>, []);
gradient_setters!([Sub,F:Scalar,Mode] TrustRegion<Sub,F,Mode>, []);
gradient_setters!([F:Scalar] BrentDerivative<F>, []);
projected_setters!([L,F:Scalar] ProjectedGradientDescent<L,F>, []);
macro_rules! absolute_step_setters {
([$($generic:tt)*] $solver:ty, [$($bound:tt)*]) => {
impl<$($generic)*> $solver where $($bound)* {
/// Stop when the Euclidean distance between consecutive observed iterates is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, (), StepChecks<Param,Q>, (), ()>
{ ConfiguredSolver::new(self).set_absolute_step_tolerance(value) }
}
impl<CG, CX, CC, CT, $($generic)*> ConfiguredSolver<$solver, CG, CX, CC, CT> where $($bound)* {
/// Stop when the Euclidean distance between consecutive observed iterates is at most the tolerance.
///
/// Disabled by default. `None` disables; zero requests an exact-zero
/// threshold. Values must be finite and nonnegative. Distinct enabled tests combine with OR.
/// Evaluated at initialized iteration boundaries; repeated calls replace
/// this setting. Change tests need two observed iterates. Trust-region
/// solvers skip rejected iterations and compare accepted iterates.
pub fn with_absolute_step_tolerance<Param, Q: Scalar>(self, value: impl Into<Option<Q>>) -> ConfiguredSolver<$solver, CG, StepChecks<Param,Q>, CC, CT>
where CX: Into<StepChecks<Param,Q>> { self.set_absolute_step_tolerance(value) }
}
};
}
absolute_step_setters!([V,M,F:Scalar] LevenbergMarquardt<V,M,F>, []);
absolute_step_setters!([V,M,F:Scalar] LevenbergMarquardtQr<V,M,F>, [M: crate::FactorizePivotedQr<V,F>]);