// Copyright (c) 2016-2022 Frank Fischer <frank-fischer@shadow-soft.de>
//
// This program is free software: you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see  <http://www.gnu.org/licenses/>
//

//! Proximal bundle method implementation.

use std::result::Result;

#[macro_export]
macro_rules! dvec {
    ( $ elem : expr ; $ n : expr ) => { DVector(vec![$elem; $n]) };
    ( $ ( $ x : expr ) , * ) => { DVector(vec![$($x),*]) };
    ( $ ( $ x : expr , ) * ) => { DVector(vec![$($x,)*]) };
}

/// A trait for all solvers that can be saved and restored to a persistent state.
pub trait Saveable {
    /// Type of the persistent state.
    type State: Send + Clone;

    /// Type of errors.
    type Err;

    /// Return a persistent state.
    fn get_state(&self) -> Result<Self::State, Self::Err>;

    /// Set the persistent state.
    ///
    /// Note that this method must not fail, i.e. a `State` object
    /// must always be valid.
    fn set_state(&mut self, state: Self::State) -> Result<(), Self::Err>;
}

mod data;
pub use data::{Aggregatable, DVector, Minorant, Real, Vector};

pub mod problem;

pub mod solver;

pub mod weighter;

pub mod terminator;

pub mod master;

#[cfg(feature = "mcf")]
pub mod mcf;
