ganesh 0.28.1

Minimization and sampling in Rust, simplified
Documentation 
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

use serde::{Deserialize, Serialize};
use std::ops::{Add, AddAssign};

/// Evaluation counts for objective, gradient, and Hessian quantities requested through the
/// algorithm API.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
pub struct EvalCounts {
    /// Function evaluation count.
    #[serde(default, rename = "n_f_evals")]
    f: usize,
    /// Gradient evaluation count.
    #[serde(default, rename = "n_g_evals")]
    g: usize,
    /// Hessian evaluation count.
    #[serde(default, rename = "n_h_evals")]
    h: usize,
}

impl EvalCounts {
    /// Create evaluation counts from raw component counts.
    pub const fn new(f: usize, g: usize, h: usize) -> Self {
        Self { f, g, h }
    }

    /// Return the function evaluation count.
    pub const fn f(&self) -> usize {
        self.f
    }

    /// Return the gradient evaluation count.
    pub const fn g(&self) -> usize {
        self.g
    }

    /// Return the Hessian evaluation count.
    pub const fn h(&self) -> usize {
        self.h
    }

    /// Record one function evaluation result.
    pub const fn record_f(&mut self) {
        self.f += 1;
    }

    /// Record `count` function evaluation results.
    pub const fn record_many_f(&mut self, count: usize) {
        self.f += count;
    }

    /// Record one gradient evaluation result.
    pub const fn record_g(&mut self) {
        self.g += 1;
    }

    /// Record `count` gradient evaluation results.
    pub const fn record_many_g(&mut self, count: usize) {
        self.g += count;
    }

    /// Record one Hessian evaluation result.
    pub const fn record_h(&mut self) {
        self.h += 1;
    }

    /// Record `count` Hessian evaluation results.
    pub const fn record_many_h(&mut self, count: usize) {
        self.h += count;
    }

    /// Record one combined function and gradient evaluation result.
    pub const fn record_fg(&mut self) {
        self.record_f();
        self.record_g();
    }

    /// Record one combined function and Hessian evaluation result.
    pub const fn record_fh(&mut self) {
        self.record_f();
        self.record_h();
    }

    /// Record one combined gradient and Hessian evaluation result.
    pub const fn record_gh(&mut self) {
        self.record_g();
        self.record_h();
    }

    /// Record one combined function, gradient, and Hessian evaluation result.
    pub const fn record_fgh(&mut self) {
        self.record_f();
        self.record_g();
        self.record_h();
    }
}

impl AddAssign for EvalCounts {
    fn add_assign(&mut self, rhs: Self) {
        self.f += rhs.f;
        self.g += rhs.g;
        self.h += rhs.h;
    }
}

impl Add for EvalCounts {
    type Output = Self;

    fn add(mut self, rhs: Self) -> Self::Output {
        self += rhs;
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn records_primitive_and_combined_evaluations() {
        let mut counts = EvalCounts::default();
        counts.record_f();
        counts.record_g();
        counts.record_h();
        counts.record_fg();
        counts.record_fh();
        counts.record_gh();
        counts.record_fgh();

        assert_eq!(counts, EvalCounts::new(4, 4, 4));
    }

    #[test]
    fn serializes_with_compatibility_field_names() {
        let json = serde_json::to_string(&EvalCounts::new(1, 2, 3)).unwrap();
        assert_eq!(json, r#"{"n_f_evals":1,"n_g_evals":2,"n_h_evals":3}"#);

        let counts: EvalCounts = serde_json::from_str(&json).unwrap();
        assert_eq!(counts.f(), 1);
        assert_eq!(counts.g(), 2);
        assert_eq!(counts.h(), 3);
    }

    #[test]
    fn defaults_missing_compatibility_fields() {
        let counts: EvalCounts = serde_json::from_str(r#"{"n_f_evals":5}"#).unwrap();
        assert_eq!(counts, EvalCounts::new(5, 0, 0));
    }
}