Struct argmin::prelude::executor::Executor

pub struct Executor<O, S> where
    O: ArgminOp,  { /* fields omitted */ }

Methods

impl<O, S> Executor<O, S> where
    O: ArgminOp,
    S: Solver<O>,
    <O as ArgminOp>::Param: Clone,
    <O as ArgminOp>::Param: Default,
    <O as ArgminOp>::Hessian: Default, 

pub fn new(
    op: O,
    solver: S,
    init_param: <O as ArgminOp>::Param
) -> Executor<O, S>

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

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

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

Attaches a observer which implements ArgminLog to the solver.

pub fn max_iters(self, iters: u64) -> Executor<O, S>

Set maximum number of iterations

pub fn target_cost(self, cost: f64) -> Executor<O, S>

Set target cost value

pub fn cost(self, cost: f64) -> Executor<O, S>

Set cost value

pub fn grad(self, grad: <O as ArgminOp>::Param) -> Executor<O, S>

Set Gradient

pub fn hessian(self, hessian: <O as ArgminOp>::Hessian) -> Executor<O, S>

Set Hessian

pub fn jacobian(self, jacobian: <O as ArgminOp>::Jacobian) -> Executor<O, S>

Set Jacobian

pub fn checkpoint_dir(self, dir: &str) -> Executor<O, S>

Set checkpoint directory

pub fn checkpoint_name(self, dir: &str) -> Executor<O, S>

Set checkpoint name

pub fn checkpoint_mode(self, mode: CheckpointMode) -> Executor<O, S>

pub fn ctrlc(self, ctrlc: bool) -> Executor<O, S>

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

Trait Implementations

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

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

Serialize this value into the given Serde serializer.

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

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Executor<O, S>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.