minuit2 0.4.1

Pure Rust port of CERN Minuit2 parameter optimization engine
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

//! MnCross: result of a single crossing-point search.
//!
//! Replaces MnCross.h. Contains the crossing multiplier, user parameter state,
//! number of function calls, and status flags.

use crate::user_parameter_state::MnUserParameterState;

/// Result of searching for one crossing point (upper or lower).
#[derive(Debug, Clone)]
pub struct MnCross {
    /// Crossing parameter multiplier.
    value: f64,
    /// Parameter state at the crossing.
    state: MnUserParameterState,
    /// Number of function calls used.
    nfcn: usize,
    /// Whether the crossing was found successfully.
    valid: bool,
    /// Whether the crossing is at a parameter limit.
    is_at_limit: bool,
    /// Whether the function call limit was reached.
    is_at_max_fcn: bool,
    /// Whether a new minimum was found during the search.
    new_minimum: bool,
}

impl MnCross {
    /// Successful crossing result.
    pub fn valid(value: f64, state: MnUserParameterState, nfcn: usize) -> Self {
        Self {
            value,
            state,
            nfcn,
            valid: true,
            is_at_limit: false,
            is_at_max_fcn: false,
            new_minimum: false,
        }
    }

    /// Crossing at a parameter limit.
    pub fn limit_reached(nfcn: usize) -> Self {
        Self {
            value: 0.0,
            state: MnUserParameterState::new(crate::user_parameters::MnUserParameters::new()),
            nfcn,
            valid: false,
            is_at_limit: true,
            is_at_max_fcn: false,
            new_minimum: false,
        }
    }

    /// Call limit reached.
    pub fn call_limit_reached(nfcn: usize) -> Self {
        Self {
            value: 0.0,
            state: MnUserParameterState::new(crate::user_parameters::MnUserParameters::new()),
            nfcn,
            valid: false,
            is_at_limit: false,
            is_at_max_fcn: true,
            new_minimum: false,
        }
    }

    /// A new minimum was found (original minimum is no longer valid).
    pub fn new_minimum_found(state: MnUserParameterState, nfcn: usize) -> Self {
        Self {
            value: 0.0,
            state,
            nfcn,
            valid: false,
            is_at_limit: false,
            is_at_max_fcn: false,
            new_minimum: true,
        }
    }

    /// Invalid result (generic failure).
    pub fn invalid(nfcn: usize) -> Self {
        Self {
            value: 0.0,
            state: MnUserParameterState::new(crate::user_parameters::MnUserParameters::new()),
            nfcn,
            valid: false,
            is_at_limit: false,
            is_at_max_fcn: false,
            new_minimum: false,
        }
    }

    /// Get the crossing value (multiplier).
    pub fn value(&self) -> f64 {
        self.value
    }

    pub fn state(&self) -> &MnUserParameterState {
        &self.state
    }

    pub fn nfcn(&self) -> usize {
        self.nfcn
    }

    /// Check if the crossing was found successfully.
    pub fn is_valid(&self) -> bool {
        self.valid
    }

    /// Check if the crossing is at a parameter limit.
    pub fn at_limit(&self) -> bool {
        self.is_at_limit
    }

    pub fn at_max_fcn(&self) -> bool {
        self.is_at_max_fcn
    }

    /// Check if a new minimum was found during the search.
    pub fn new_minimum(&self) -> bool {
        self.new_minimum
    }
}