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

// Copyright 2018 Stefan Kroboth
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! `ArgminResult`
//!
//! TODO Documentation

use parameter::ArgminParameter;
use ArgminCostValue;
use termination::TerminationReason;

/// Return struct for all solvers.
#[derive(Debug)]
pub struct ArgminResult<T: ArgminParameter, U: ArgminCostValue> {
    /// Final parameter vector
    pub param: T,
    /// Final cost value
    pub cost: U,
    /// Number of iterations
    pub iters: u64,
    /// Indicated whether it terminated or not
    pub terminated: bool,
    /// Reason of termination
    pub termination_reason: TerminationReason,
}

impl<T: ArgminParameter, U: ArgminCostValue> ArgminResult<T, U> {
    /// Constructor
    ///
    /// `param`: Final (best) parameter vector
    /// `cost`: Final (best) cost function value
    /// `iters`: Number of iterations
    pub fn new(param: T, cost: U, iters: u64) -> Self {
        ArgminResult {
            param: param,
            cost: cost,
            iters: iters,
            terminated: false,
            termination_reason: TerminationReason::NotTerminated,
        }
    }

    /// Set the termination reason
    ///
    /// In case of `NotTerminated`, the field `terminated` is set to `false` and `true` otherwise.
    ///
    /// `termination_reason`: Termination reason of type `TerminationReason`
    pub fn set_termination_reason(&mut self, termination_reason: TerminationReason) -> &mut Self {
        self.termination_reason = termination_reason;
        self.terminated = match self.termination_reason {
            TerminationReason::NotTerminated => false,
            _ => true,
        };
        self
    }
}