heuropt 0.11.0

A practical Rust toolkit for heuristic single-, multi-, and many-objective optimization.
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

//! A decision paired with its evaluation.

use crate::core::evaluation::Evaluation;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// A decision together with its evaluated objective values.
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq)]
pub struct Candidate<D> {
    /// The decision (input to the problem).
    pub decision: D,
    /// The evaluated objective values and constraint violation.
    pub evaluation: Evaluation,
}

impl<D> Candidate<D> {
    /// Pair a decision with its evaluation.
    pub fn new(decision: D, evaluation: Evaluation) -> Self {
        Self {
            decision,
            evaluation,
        }
    }
}

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

    #[test]
    fn new_pairs_decision_and_evaluation() {
        let c = Candidate::new(vec![1.0, 2.0], Evaluation::new(vec![5.0]));
        assert_eq!(c.decision, vec![1.0, 2.0]);
        assert_eq!(c.evaluation.objectives, vec![5.0]);
    }
}