Struct argmin::core::executor::Executor

pub struct Executor<O: ArgminOp, S> {
    pub op: OpWrapper<O>,
    // some fields omitted
}

Executes a solver

Fields

op: OpWrapper<O>

operator

Implementations

impl<O, S> Executor<O, S> where
    O: ArgminOp,
    S: Solver<O>, 

pub fn new(op: O, solver: S, init_param: O::Param) -> Self

Create a new executor with a solver and an initial parameter init_param

pub fn from_checkpoint<P: AsRef<Path>>(path: P, op: O) -> Result<Self, Error> where
    Self: Sized + DeserializeOwned, 

Create a new executor from a checkpoint

pub fn run(self) -> Result<ArgminResult<O>, Error>

Run the executor

pub fn add_observer<OBS: Observe<O> + 'static>(
    self,
    observer: OBS,
    mode: ObserverMode
) -> Self

Attaches a observer which implements ArgminLog to the solver.

pub fn max_iters(self, iters: u64) -> Self

Set maximum number of iterations

pub fn target_cost(self, cost: O::Float) -> Self

Set target cost value

pub fn cost(self, cost: O::Float) -> Self

Set cost value

pub fn grad(self, grad: O::Param) -> Self

Set Gradient

pub fn hessian(self, hessian: O::Hessian) -> Self

Set Hessian

pub fn jacobian(self, jacobian: O::Jacobian) -> Self

Set Jacobian

pub fn checkpoint_dir(self, dir: &str) -> Self

Set checkpoint directory

pub fn checkpoint_name(self, dir: &str) -> Self

Set checkpoint name

pub fn checkpoint_mode(self, mode: CheckpointMode) -> Self

Set the checkpoint mode

pub fn ctrlc(self, ctrlc: bool) -> Self

Turn Ctrl-C handling on or off (default: on)

pub fn timer(self, timer: bool) -> Self

Turn timer on or off (default: on)

Trait Implementations

impl<O: Clone + ArgminOp, S: Clone> Clone for Executor<O, S>

fn clone(&self) -> Executor<O, S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de, O: ArgminOp, S> Deserialize<'de> for Executor<O, S> where
    IterState<O>: Serialize,
    S: Deserialize<'de>,
    O: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<O: ArgminOp, S> Serialize for Executor<O, S> where
    IterState<O>: Serialize,
    S: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.