diffsol-c 0.1.0

A diffsol wrapper featuring runtime scalar/matrix/solver types and a C API
Documentation
use std::sync::{Arc, Mutex};

use serde::{Serialize, Serializer, ser::SerializeStruct};

use crate::{error::DiffsolJsError, ode::Ode};

#[derive(Clone)]
pub struct InitialConditionSolverOptions {
    ode: Arc<Mutex<Ode>>,
}
impl InitialConditionSolverOptions {
    pub(crate) fn new(ode: Arc<Mutex<Ode>>) -> Self {
        Self { ode }
    }
    fn guard(&self) -> Result<std::sync::MutexGuard<'_, Ode>, DiffsolJsError> {
        self.ode.lock().map_err(|_| {
            DiffsolJsError::from(diffsol::error::DiffsolError::Other(
                "Failed to acquire lock on ODE solver".to_string(),
            ))
        })
    }
}

impl InitialConditionSolverOptions {
    pub fn get_use_linesearch(&self) -> Result<bool, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_use_linesearch())
    }
    pub fn set_use_linesearch(&self, value: bool) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_use_linesearch(value);
        Ok(())
    }
    pub fn get_max_linesearch_iterations(&self) -> Result<usize, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_max_linesearch_iterations())
    }
    pub fn set_max_linesearch_iterations(&self, value: usize) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_max_linesearch_iterations(value);
        Ok(())
    }
    pub fn get_max_newton_iterations(&self) -> Result<usize, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_max_newton_iterations())
    }
    pub fn set_max_newton_iterations(&self, value: usize) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_max_newton_iterations(value);
        Ok(())
    }
    pub fn get_max_linear_solver_setups(&self) -> Result<usize, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_max_linear_solver_setups())
    }
    pub fn set_max_linear_solver_setups(&self, value: usize) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_max_linear_solver_setups(value);
        Ok(())
    }
    pub fn get_step_reduction_factor(&self) -> Result<f64, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_step_reduction_factor())
    }
    pub fn set_step_reduction_factor(&self, value: f64) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_step_reduction_factor(value);
        Ok(())
    }
    pub fn get_armijo_constant(&self) -> Result<f64, DiffsolJsError> {
        Ok(self.guard()?.solve.ic_armijo_constant())
    }
    pub fn set_armijo_constant(&self, value: f64) -> Result<(), DiffsolJsError> {
        self.guard()?.solve.set_ic_armijo_constant(value);
        Ok(())
    }
}

impl Serialize for InitialConditionSolverOptions {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut state = serializer.serialize_struct("InitialConditionSolverOptions", 6)?;
        state.serialize_field(
            "use_linesearch",
            &self
                .get_use_linesearch()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.serialize_field(
            "max_linesearch_iterations",
            &self
                .get_max_linesearch_iterations()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.serialize_field(
            "max_newton_iterations",
            &self
                .get_max_newton_iterations()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.serialize_field(
            "max_linear_solver_setups",
            &self
                .get_max_linear_solver_setups()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.serialize_field(
            "step_reduction_factor",
            &self
                .get_step_reduction_factor()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.serialize_field(
            "armijo_constant",
            &self
                .get_armijo_constant()
                .map_err(serde::ser::Error::custom)?,
        )?;
        state.end()
    }
}

#[cfg(all(test, any(feature = "diffsl-cranelift", feature = "diffsl-llvm")))]
mod tests {
    use crate::{
        jit::JitBackendType,
        linear_solver_type::LinearSolverType,
        matrix_type::MatrixType,
        ode::OdeWrapper,
        ode_solver_type::OdeSolverType,
        scalar_type::ScalarType,
        test_support::{available_jit_backends, logistic_diffsl_code},
    };

    use super::InitialConditionSolverOptions;

    fn make_options(jit_backend: JitBackendType) -> InitialConditionSolverOptions {
        OdeWrapper::new_jit(
            logistic_diffsl_code(),
            jit_backend,
            ScalarType::F64,
            MatrixType::NalgebraDense,
            LinearSolverType::Default,
            OdeSolverType::Bdf,
        )
        .unwrap()
        .get_ic_options()
    }

    #[test]
    fn initial_condition_options_roundtrip_and_serialize() {
        for jit_backend in available_jit_backends() {
            let options = make_options(jit_backend);
            options.set_use_linesearch(true).unwrap();
            options.set_max_linesearch_iterations(13).unwrap();
            options.set_max_newton_iterations(17).unwrap();
            options.set_max_linear_solver_setups(19).unwrap();
            options.set_step_reduction_factor(0.5).unwrap();
            options.set_armijo_constant(1e-4).unwrap();

            assert!(options.get_use_linesearch().unwrap());
            assert_eq!(options.get_max_linesearch_iterations().unwrap(), 13);
            assert_eq!(options.get_max_newton_iterations().unwrap(), 17);
            assert_eq!(options.get_max_linear_solver_setups().unwrap(), 19);
            assert_eq!(options.get_step_reduction_factor().unwrap(), 0.5);
            assert_eq!(options.get_armijo_constant().unwrap(), 1e-4);

            let value = serde_json::to_value(&options).unwrap();
            assert_eq!(value["use_linesearch"], true);
            assert_eq!(value["max_linesearch_iterations"], 13);
            assert_eq!(value["max_newton_iterations"], 17);
            assert_eq!(value["max_linear_solver_setups"], 19);
            assert_eq!(value["step_reduction_factor"], 0.5);
            assert_eq!(value["armijo_constant"], 1e-4);
        }
    }
}