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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
//! Optimizer-facing objective traits.
//!
//! Each model implements them on its own adapter (`GprObjective` in
//! `src/gpr/`, `SgprObjective` in `src/sgpr/`), which borrows the fitted
//! model during `fit` / `refit` and forwards concatenated kernel-then-
//! likelihood `θ` to it. Capability is split so a derivative-free solver
//! can require only [`Objective`], L-BFGS can require [`Differentiable`],
//! and a Hessian-based solver ([`crate::TrustRegion`]) can require [`TwiceDifferentiable`].
use crateGprError;
use crateInterval;
/// Calls the model adapters make, for the `compare/perf` optimizer tables.
///
/// Present only with the non-default feature `bench-internals`. One global
/// pair of counters: fits must not run concurrently while it is read.
pub
pub use ;
/// Represents the optimizer-facing scalar objective (`value` only).
///
/// Default [`Differentiable::value_and_gradient_into`] is not on this trait.
/// A solver that needs derivatives takes [`Differentiable`], not a runtime
/// flag.
///
/// # Examples
///
/// ```rust
/// use gprx::Objective;
///
/// struct Zero;
///
/// impl Objective for Zero {
/// fn num_params(&self) -> usize {
/// 0
/// }
///
/// fn value(&mut self, _params: &[f64]) -> Result<f64, gprx::GprError> {
/// Ok(0.0)
/// }
/// }
///
/// # fn main() -> Result<(), gprx::GprError> {
/// let mut objective = Zero;
/// assert_eq!(objective.value(&[])?, 0.0);
/// # Ok(())
/// # }
/// ```
/// Represents the first-order objective.
///
/// Supertrait of [`Objective`].
///
/// The GPR fit objective overrides [`Self::value_and_gradient_into`] so one
/// Cholesky produces `L`, `α`, and `W`.
///
/// # Examples
///
/// ```rust
/// use gprx::{Differentiable, Objective};
///
/// struct Zero;
///
/// impl Objective for Zero {
/// fn num_params(&self) -> usize {
/// 1
/// }
///
/// fn value(&mut self, _params: &[f64]) -> Result<f64, gprx::GprError> {
/// Ok(0.0)
/// }
/// }
///
/// impl Differentiable for Zero {
/// fn gradient_into(
/// &mut self,
/// _params: &[f64],
/// out: &mut [f64],
/// ) -> Result<(), gprx::GprError> {
/// out.fill(0.0);
/// Ok(())
/// }
/// }
///
/// # fn main() -> Result<(), gprx::GprError> {
/// let mut objective = Zero;
/// let mut grad = [1.0];
/// objective.gradient_into(&[0.0], &mut grad)?;
/// assert_eq!(grad, [0.0]);
/// # Ok(())
/// # }
/// ```
/// Represents the second-order objective.
///
/// Supertrait of [`Differentiable`].
///
/// The GPR fit objective implements this by forwarding to
/// [`crate::FittedGpr::hessian_into`]. There is no runtime `NotImplemented`.
///
/// # Examples
///
/// ```rust
/// use gprx::{Differentiable, Objective, TwiceDifferentiable};
///
/// struct Zero;
///
/// impl Objective for Zero {
/// fn num_params(&self) -> usize {
/// 1
/// }
///
/// fn value(&mut self, _params: &[f64]) -> Result<f64, gprx::GprError> {
/// Ok(0.0)
/// }
/// }
///
/// impl Differentiable for Zero {
/// fn gradient_into(
/// &mut self,
/// _params: &[f64],
/// out: &mut [f64],
/// ) -> Result<(), gprx::GprError> {
/// out.fill(0.0);
/// Ok(())
/// }
/// }
///
/// impl TwiceDifferentiable for Zero {
/// fn hessian_into(
/// &mut self,
/// _params: &[f64],
/// out: &mut [f64],
/// ) -> Result<(), gprx::GprError> {
/// out.fill(0.0);
/// Ok(())
/// }
/// }
///
/// # fn main() -> Result<(), gprx::GprError> {
/// let mut objective = Zero;
/// let mut hess = [1.0];
/// objective.hessian_into(&[0.0], &mut hess)?;
/// assert_eq!(hess, [0.0]);
/// # Ok(())
/// # }
/// ```
/// Represents the partial kernel rebuild from changed parameter indices.
///
/// `indices` is every flat `θ` position that changed since the previous
/// evaluation on this objective (see [`Objective::value_at_changes`]). Only
/// those positions decide which leaves are rebuilt; changes are never
/// inferred from the numbers. Empty, duplicate, or out-of-range indices, and
/// an unlisted change, are a [`GprError`] at this boundary. Full rebuilds use
/// [`Objective::value`]. The GPR fit objective implements this for every
/// optimizer and buffer policy.
///
/// # Examples
///
/// ```rust
/// use gprx::{IncrementalObjective, Objective};
///
/// struct Zero;
///
/// impl Objective for Zero {
/// fn num_params(&self) -> usize {
/// 1
/// }
///
/// fn value(&mut self, _params: &[f64]) -> Result<f64, gprx::GprError> {
/// Ok(0.0)
/// }
/// }
///
/// impl IncrementalObjective for Zero {
/// fn value_with_changes(
/// &mut self,
/// _params: &[f64],
/// _indices: &[usize],
/// ) -> Result<f64, gprx::GprError> {
/// Ok(0.0)
/// }
/// }
///
/// # fn main() -> Result<(), gprx::GprError> {
/// let mut objective = Zero;
/// assert_eq!(objective.value_with_changes(&[0.0], &[0])?, 0.0);
/// # Ok(())
/// # }
/// ```