Struct argmin::solver::quasinewton::dfp::DFP

source · [−]

pub struct DFP<L, H, F> { /* private fields */ }

Expand description

DFP method

References:

[0] Jorge Nocedal and Stephen J. Wright (2006). Numerical Optimization. Springer. ISBN 0-387-30303-0.

Implementations

source

impl<L, H, F> DFP<L, H, F> where
F: ArgminFloat,

source

pub fn new(init_inverse_hessian: H, linesearch: L) -> Self

Constructor

source

pub fn with_tolerance_grad(self, tol_grad: F) -> Self

Sets tolerance for the stopping criterion based on the change of the norm on the gradient

Trait Implementations

source

impl<L: Clone, H: Clone, F: Clone> Clone for DFP<L, H, F>

source

fn clone(&self) -> DFP<L, H, F>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'de, L, H, F> Deserialize<'de> for DFP<L, H, F> where
 L: Deserialize<'de>,
 H: Deserialize<'de>,
 F: Deserialize<'de>,

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl<L, H, F> Serialize for DFP<L, H, F> where
 L: Serialize,
 H: Serialize,
 F: Serialize,

source

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

Serialize this value into the given Serde serializer. Read more

source

impl<O, L, P, G, H, F> Solver<O, IterState<P, G, (), H, F>> for DFP<L, H, F> where
 O: CostFunction<Param = P, Output = F> + Gradient<Param = P, Gradient = G>,
 P: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminSub<P, P> + ArgminDot<G, F> + ArgminDot<P, H> + ArgminMul<F, P>,
 G: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminSub<G, G> + ArgminNorm<F> + ArgminDot<P, F>,
 H: Clone + SerializeAlias + DeserializeOwnedAlias + ArgminSub<H, H> + ArgminDot<G, P> + ArgminAdd<H, H> + ArgminMul<F, H>,
 L: Clone + LineSearch<P, F> + Solver<O, IterState<P, G, (), (), F>>,
 F: ArgminFloat,

source

const NAME: &'static str

Name of the solver. Mainly used in Observers.

source

fn init(
 &mut self,
 problem: &mut Problem<O>,
 state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

Initializes the algorithm. Read more

source

fn next_iter(
 &mut self,
 problem: &mut Problem<O>,
 state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

Computes a single iteration of the algorithm and has access to the optimization problem definition and the internal state of the solver. Returns an updated state and optionally a KV which holds key-value pairs used in Observers. Read more

source

fn terminate(&mut self, state: &IterState<P, G, (), H, F>) -> TerminationReason

Used to implement stopping criteria, in particular criteria which are not covered by (terminate_internal. Read more

source

fn terminate_internal(&mut self, state: &I) -> TerminationReason

Checks whether basic termination reasons apply. Read more

Auto Trait Implementations

impl<L, H, F> RefUnwindSafe for DFP<L, H, F> where
 F: RefUnwindSafe,
 H: RefUnwindSafe,
 L: RefUnwindSafe,

impl<L, H, F> Send for DFP<L, H, F> where
 F: Send,
 H: Send,
 L: Send,

impl<L, H, F> Sync for DFP<L, H, F> where
 F: Sync,
 H: Sync,
 L: Sync,

impl<L, H, F> Unpin for DFP<L, H, F> where
 F: Unpin,
 H: Unpin,
 L: Unpin,

impl<L, H, F> UnwindSafe for DFP<L, H, F> where
 F: UnwindSafe,
 H: UnwindSafe,
 L: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

Struct argmin::solver::quasinewton::dfp::DFP

Implementations

impl<L, H, F> DFP<L, H, F> where F: ArgminFloat,

pub fn new(init_inverse_hessian: H, linesearch: L) -> Self

pub fn with_tolerance_grad(self, tol_grad: F) -> Self

Trait Implementations

impl<L: Clone, H: Clone, F: Clone> Clone for DFP<L, H, F>

fn clone(&self) -> DFP<L, H, F>

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

impl<'de, L, H, F> Deserialize<'de> for DFP<L, H, F> where L: Deserialize<'de>, H: Deserialize<'de>, F: Deserialize<'de>,

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

impl<L, H, F> Serialize for DFP<L, H, F> where L: Serialize, H: Serialize, F: Serialize,

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

const NAME: &'static str

fn init( &mut self, problem: &mut Problem<O>, state: IterState<P, G, (), H, F>) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

fn next_iter( &mut self, problem: &mut Problem<O>, state: IterState<P, G, (), H, F>) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

fn terminate(&mut self, state: &IterState<P, G, (), H, F>) -> TerminationReason

fn terminate_internal(&mut self, state: &I) -> TerminationReason

Auto Trait Implementations

impl<L, H, F> RefUnwindSafe for DFP<L, H, F> where F: RefUnwindSafe, H: RefUnwindSafe, L: RefUnwindSafe,

impl<L, H, F> Send for DFP<L, H, F> where F: Send, H: Send, L: Send,

impl<L, H, F> Sync for DFP<L, H, F> where F: Sync, H: Sync, L: Sync,

impl<L, H, F> Unpin for DFP<L, H, F> where F: Unpin, H: Unpin, L: Unpin,

impl<L, H, F> UnwindSafe for DFP<L, H, F> where F: UnwindSafe, H: UnwindSafe, L: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

impl<T> SendSyncUnwindSafe for T where T: Send + Sync + UnwindSafe + ?Sized,

impl<L, H, F> DFP<L, H, F> where
F: ArgminFloat,

impl<'de, L, H, F> Deserialize<'de> for DFP<L, H, F> where
L: Deserialize<'de>,
H: Deserialize<'de>,
F: Deserialize<'de>,

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

impl<L, H, F> Serialize for DFP<L, H, F> where
L: Serialize,
H: Serialize,
F: Serialize,

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

fn init(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

fn next_iter(
&mut self,
problem: &mut Problem<O>,
state: IterState<P, G, (), H, F>
) -> Result<(IterState<P, G, (), H, F>, Option<KV>), Error>

impl<L, H, F> RefUnwindSafe for DFP<L, H, F> where
F: RefUnwindSafe,
H: RefUnwindSafe,
L: RefUnwindSafe,

impl<L, H, F> Send for DFP<L, H, F> where
F: Send,
H: Send,
L: Send,

impl<L, H, F> Sync for DFP<L, H, F> where
F: Sync,
H: Sync,
L: Sync,

impl<L, H, F> Unpin for DFP<L, H, F> where
F: Unpin,
H: Unpin,
L: Unpin,

impl<L, H, F> UnwindSafe for DFP<L, H, F> where
F: UnwindSafe,
H: UnwindSafe,
L: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

impl<T> SendSyncUnwindSafe for T where
T: Send + Sync + UnwindSafe + ?Sized,