Struct OpWrapper

pub struct OpWrapper<O: ArgminOp> {
    pub op: Option<O>,
    pub cost_func_count: u64,
    pub grad_func_count: u64,
    pub hessian_func_count: u64,
    pub jacobian_func_count: u64,
    pub modify_func_count: u64,
}

This wraps an operator and keeps track of how often the cost, gradient and Hessian have been computed and how often the modify function has been called. Usually, this is an implementation detail unless a solver is needed within another solver (such as a line search within a gradient descent method), then it may be necessary to wrap the operator in an OpWrapper.

Fields

op: Option<O>

Operator

cost_func_count: u64

Number of cost function evaluations

grad_func_count: u64

Number of gradient function evaluations

hessian_func_count: u64

Number of Hessian function evaluations

jacobian_func_count: u64

Number of Jacobian function evaluations

modify_func_count: u64

Number of modify function evaluations

Implementations

impl<O: ArgminOp> OpWrapper<O>

pub fn new(op: O) -> Self

Constructor

pub fn new_from_wrapper(op: &mut OpWrapper<O>) -> Self

Construct struct from other OpWrapper. Takes the operator from op (replaces it with None) and crates a new OpWrapper

pub fn apply(&mut self, param: &O::Param) -> Result<O::Output, Error>

Calls the apply method of op and increments cost_func_count.

pub fn gradient(&mut self, param: &O::Param) -> Result<O::Param, Error>

Calls the gradient method of op and increments gradient_func_count.

pub fn hessian(&mut self, param: &O::Param) -> Result<O::Hessian, Error>

Calls the hessian method of op and increments hessian_func_count.

pub fn jacobian(&mut self, param: &O::Param) -> Result<O::Jacobian, Error>

Calls the jacobian method of op and increments jacobian_func_count.

pub fn modify( &mut self, param: &O::Param, extent: O::Float, ) -> Result<O::Param, Error>

Calls the modify method of op and increments modify_func_count.

pub fn take_op(&mut self) -> Option<O>

Moves the operator out of the struct and replaces it with None

pub fn consume_op(&mut self, other: OpWrapper<O>)

Consumes an operator by increasing the function call counts of self by the ones in other.

pub fn consume_func_counts<O2: ArgminOp>(&mut self, other: OpWrapper<O2>)

Adds function evaluation counts of another operator.

pub fn reset(self) -> Self

Reset the cost function counts to zero.

pub fn get_op(self) -> O

Returns the operator op by taking ownership of self.

Trait Implementations

impl<O: ArgminOp> ArgminOp for OpWrapper<O>

The OpWrapper should behave just like any other ArgminOp

type Param = <O as ArgminOp>::Param

Type of the parameter vector

type Output = <O as ArgminOp>::Output

Output of the operator

type Hessian = <O as ArgminOp>::Hessian

Type of Hessian

type Jacobian = <O as ArgminOp>::Jacobian

Type of Jacobian

type Float = <O as ArgminOp>::Float

Precision of floats

fn apply(&self, param: &Self::Param) -> Result<Self::Output, Error>

Applies the operator/cost function to parameters

fn gradient(&self, param: &Self::Param) -> Result<Self::Param, Error>

Computes the gradient at the given parameters

fn hessian(&self, param: &Self::Param) -> Result<Self::Hessian, Error>

Computes the Hessian at the given parameters

fn jacobian(&self, param: &Self::Param) -> Result<Self::Jacobian, Error>

Computes the Hessian at the given parameters

fn modify( &self, param: &Self::Param, extent: Self::Float, ) -> Result<Self::Param, Error>

Modifies a parameter vector. Comes with a variable that indicates the “degree” of the modification.

impl<O: Clone + ArgminOp> Clone for OpWrapper<O>

fn clone(&self) -> OpWrapper<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + ArgminOp> Debug for OpWrapper<O>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<O: Default + ArgminOp> Default for OpWrapper<O>

fn default() -> OpWrapper<O>

Returns the “default value” for a type.

impl<'de, O> Deserialize<'de> for OpWrapper<O>

where O: Deserialize<'de> + ArgminOp,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<O> Serialize for OpWrapper<O>

where O: Serialize + ArgminOp,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.