optirustic 1.2.3

This crate moved to https://github.com/s-simoncelli/nsga-rs
use serde::{Deserialize, Serialize};
use std::fmt::Display;

#[cfg(feature = "python")]
use pyo3::prelude::*;

/// The type of stopping condition. Pick one type to inform the algorithm how/when it should
/// terminate the population evolution.
#[derive(Serialize, Deserialize, Clone)]
#[cfg_attr(feature = "python", pyclass)]
pub enum StoppingCondition {
    /// Set a maximum duration (as number of minutes).
    MaxDurationAsMinutes(u32),
    /// Set a maximum duration (as number of hours).
    MaxDurationAsHours(u32),
    /// Set a maximum number of generations.
    MaxGeneration(u32),
    /// Set a maximum number of function evaluations.
    MaxFunctionEvaluations(u32),
    /// Stop when at least on condition is met (this acts as an OR operator).
    Any(Vec<StoppingCondition>),
    /// Stop when all conditions are met (this acts as an AND operator).
    All(Vec<StoppingCondition>),
}

impl StoppingCondition {
    /// A name describing the stopping condition.
    ///
    /// returns: `String`
    pub fn name(&self) -> String {
        match self {
            StoppingCondition::MaxDurationAsMinutes(v) => format!("maximum duration={v} minutes"),
            StoppingCondition::MaxDurationAsHours(v) => format!("maximum duration={v} hours"),
            StoppingCondition::MaxGeneration(v) => format!("maximum number of generations={v}"),
            StoppingCondition::MaxFunctionEvaluations(v) => {
                format!("maximum number of function evaluations={v}")
            }
            StoppingCondition::Any(s) => s
                .iter()
                .map(|cond| cond.name())
                .collect::<Vec<String>>()
                .join(" OR "),
            StoppingCondition::All(s) => s
                .iter()
                .map(|cond| cond.name())
                .collect::<Vec<String>>()
                .join(" AND "),
        }
    }

    /// Check whether the stopping condition is a vector and has nested vector in it.
    ///
    /// # Arguments
    ///
    /// * `conditions`: A vector of stopping conditions.
    ///
    /// returns: `bool`
    pub fn has_nested_vector(conditions: &[StoppingCondition]) -> bool {
        conditions.iter().any(|c| match c {
            StoppingCondition::Any(_) | StoppingCondition::All(_) => true,
            _ => false,
        })
    }
}

impl Display for StoppingCondition {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
        match self {
            StoppingCondition::MaxDurationAsMinutes(duration) => write!(f, "{duration} minutes"),
            StoppingCondition::MaxDurationAsHours(duration) => write!(f, "{duration} hours"),
            StoppingCondition::MaxGeneration(generation) => write!(f, "{generation} generations"),
            StoppingCondition::MaxFunctionEvaluations(nfe) => write!(f, "{nfe} evaluations"),
            StoppingCondition::Any(values) => {
                let values: Vec<String> = values.iter().map(|c| format!("{c}")).collect();
                write!(f, "{}", values.join(" OR "))
            }
            StoppingCondition::All(values) => {
                let values: Vec<String> = values.iter().map(|c| format!("{c}")).collect();
                write!(f, "{}", values.join(" AND "))
            }
        }
    }
}

#[cfg(feature = "python")]
pub mod py {
    use crate::algorithms::StoppingCondition;
    use pyo3::prelude::*;

    /// The stopping condition class in Python. Each enum item is a Python function of the
    /// StoppingConditionValue class. Items are lower-case to be PEP compliant.
    #[pyclass(name = "StoppingConditionValue")]
    #[derive(Clone)]
    #[allow(non_camel_case_types)]
    pub enum PyStoppingConditionValue {
        max_duration_as_minutes(u32),
        max_duration_as_hours(u32),
        max_generation(u32),
        max_function_evaluations(u32),
    }

    #[pymethods]
    impl PyStoppingConditionValue {
        fn value(&self) -> u32 {
            match self {
                PyStoppingConditionValue::max_duration_as_minutes(v) => *v,
                PyStoppingConditionValue::max_duration_as_hours(v) => *v,
                PyStoppingConditionValue::max_generation(v) => *v,
                PyStoppingConditionValue::max_function_evaluations(v) => *v,
            }
        }

        fn __repr__(&self) -> PyResult<String> {
            let attr = match &self {
                PyStoppingConditionValue::max_duration_as_minutes(duration) => {
                    format!("duration={duration} minutes")
                }
                PyStoppingConditionValue::max_duration_as_hours(duration) => {
                    format!("duration={duration} hours")
                }
                PyStoppingConditionValue::max_generation(generation) => {
                    format!("generation={generation} generations")
                }
                PyStoppingConditionValue::max_function_evaluations(nfe) => {
                    format!("NFE={nfe} evaluations")
                }
            };
            Ok(format!("StoppingConditionValue({attr})"))
        }

        fn __str__(&self) -> String {
            self.__repr__().unwrap()
        }
    }

    impl From<PyStoppingConditionValue> for StoppingCondition {
        fn from(cond: PyStoppingConditionValue) -> Self {
            match cond {
                PyStoppingConditionValue::max_duration_as_minutes(duration) => {
                    StoppingCondition::MaxDurationAsMinutes(duration)
                }
                PyStoppingConditionValue::max_duration_as_hours(duration) => {
                    StoppingCondition::MaxDurationAsHours(duration)
                }
                PyStoppingConditionValue::max_generation(generation) => {
                    StoppingCondition::MaxGeneration(generation)
                }
                PyStoppingConditionValue::max_function_evaluations(nfe) => {
                    StoppingCondition::MaxFunctionEvaluations(nfe)
                }
            }
        }
    }

    #[derive(FromPyObject)]
    enum PyStoppingConditionMap {
        #[pyo3(transparent, annotation = "condition")]
        Condition(PyStoppingConditionValue),
        #[pyo3(transparent, annotation = "list of conditions")]
        Vector(Vec<PyStoppingConditionValue>),
    }

    #[pymethods]
    impl StoppingCondition {
        #[new]
        fn new(condition: PyStoppingConditionMap) -> Self {
            match condition {
                PyStoppingConditionMap::Condition(cond) => cond.into(),
                // handle any only
                PyStoppingConditionMap::Vector(conds) => {
                    StoppingCondition::Any(conds.into_iter().map(|c| c.into()).collect())
                }
            }
        }

        fn conditions(&self) -> Vec<PyStoppingConditionValue> {
            match self {
                StoppingCondition::MaxDurationAsMinutes(d) => {
                    vec![PyStoppingConditionValue::max_duration_as_minutes(*d)]
                }
                StoppingCondition::MaxDurationAsHours(d) => {
                    vec![PyStoppingConditionValue::max_duration_as_hours(*d)]
                }
                StoppingCondition::MaxGeneration(g) => {
                    vec![PyStoppingConditionValue::max_generation(*g)]
                }
                StoppingCondition::MaxFunctionEvaluations(nfe) => {
                    vec![PyStoppingConditionValue::max_function_evaluations(*nfe)]
                }
                StoppingCondition::Any(conds) => {
                    let mut vec = vec![];
                    for cond in conds {
                        vec.extend(cond.conditions());
                    }
                    vec
                }
                StoppingCondition::All(_) => panic!("Not supported"),
            }
        }

        fn __repr__(&self) -> PyResult<String> {
            Ok(format!("StoppingCondition({})", self.name()))
        }

        fn __str__(&self) -> String {
            self.__repr__().unwrap()
        }
    }
}