[−][src]Struct argmin::prelude::OpWrapper
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
cost_func_count: u64
grad_func_count: u64
hessian_func_count: u64
jacobian_func_count: u64
modify_func_count: u64
Methods
impl<O> OpWrapper<O> where
O: ArgminOp,
[src]
O: ArgminOp,
pub fn new(op: &O) -> OpWrapper<O>
[src]
Constructor
pub fn new_move(op: O) -> OpWrapper<O>
[src]
Constructor (moves op)
pub fn apply(
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Output, Error>
[src]
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Output, Error>
Calls the apply
method of op
and increments cost_func_count
.
pub fn gradient(
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Param, Error>
[src]
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Param, Error>
Calls the gradient
method of op
and increments gradient_func_count
.
pub fn hessian(
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Hessian, Error>
[src]
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Hessian, Error>
Calls the hessian
method of op
and increments hessian_func_count
.
pub fn jacobian(
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Jacobian, Error>
[src]
&mut self,
param: &<O as ArgminOp>::Param
) -> Result<<O as ArgminOp>::Jacobian, Error>
Calls the jacobian
method of op
and increments jacobian_func_count
.
pub fn modify(
&mut self,
param: &<O as ArgminOp>::Param,
extent: f64
) -> Result<<O as ArgminOp>::Param, Error>
[src]
&mut self,
param: &<O as ArgminOp>::Param,
extent: f64
) -> Result<<O as ArgminOp>::Param, Error>
Calls the modify
method of op
and increments modify_func_count
.
pub fn consume_op<O2>(&mut self, other: OpWrapper<O2>) where
O2: ArgminOp,
[src]
O2: ArgminOp,
Consumes an operator by increasing the function call counts of self
by the ones in
other
.
pub fn reset(self) -> OpWrapper<O>
[src]
Reset the cost function counts to zero
pub fn get_op(self) -> O
[src]
Returns the operator op
by taking ownership of self
.
pub fn clone_op(&self) -> O
[src]
Returns a clone of the operator op
.
pub fn new_from_op(op: &OpWrapper<O>) -> OpWrapper<O>
[src]
Creates a new OpWrapper<O>
from another OpWrapper<O>
by cloning the op
and
initializing all counts with 0
.
Trait Implementations
impl<O> ArgminOp for OpWrapper<O> where
O: ArgminOp,
[src]
O: ArgminOp,
The OpWrapperArgminOp
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
fn apply(
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Output, Error>
[src]
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Output, Error>
fn gradient(
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Param, Error>
[src]
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Param, Error>
fn hessian(
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Hessian, Error>
[src]
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Hessian, Error>
fn jacobian(
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Jacobian, Error>
[src]
&self,
param: &<OpWrapper<O> as ArgminOp>::Param
) -> Result<<OpWrapper<O> as ArgminOp>::Jacobian, Error>
fn modify(
&self,
param: &<OpWrapper<O> as ArgminOp>::Param,
extent: f64
) -> Result<<OpWrapper<O> as ArgminOp>::Param, Error>
[src]
&self,
param: &<OpWrapper<O> as ArgminOp>::Param,
extent: f64
) -> Result<<OpWrapper<O> as ArgminOp>::Param, Error>
impl<O> Serialize for OpWrapper<O> where
O: ArgminOp + Serialize,
[src]
O: ArgminOp + Serialize,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
[src]
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
impl<'de, O> Deserialize<'de> for OpWrapper<O> where
O: ArgminOp + Deserialize<'de>,
[src]
O: ArgminOp + Deserialize<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<OpWrapper<O>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]
__deserializer: __D
) -> Result<OpWrapper<O>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
impl<O> Debug for OpWrapper<O> where
O: ArgminOp + Debug,
[src]
O: ArgminOp + Debug,
impl<O> Clone for OpWrapper<O> where
O: ArgminOp + Clone,
[src]
O: ArgminOp + Clone,
Auto Trait Implementations
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,
T: Send + Sync + UnwindSafe + ?Sized,