argmin::solver::trustregion::trustregion_method

Struct TrustRegion

Source
pub struct TrustRegion<R, F> { /* private fields */ }
Expand description

The trust region method approximates the cost function within a certain region around the current point in parameter space. Depending on the quality of this approximation, the region is either expanded or contracted.

The calculation of the actual step length and direction is done by one of the following methods:

This subproblem can be set via set_subproblem(...). If this is not provided, it will default to the Steihaug method.

Example

§References:

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

Implementations§

Source§

impl<R, F: ArgminFloat> TrustRegion<R, F>

Source

pub fn new(subproblem: R) -> Self

Constructor

Source

pub fn radius(self, radius: F) -> Self

set radius

Source

pub fn max_radius(self, max_radius: F) -> Self

Set maximum radius

Source

pub fn eta(self, eta: F) -> Result<Self, Error>

Set eta

Trait Implementations§

Source§

impl<R: Clone, F: Clone> Clone for TrustRegion<R, F>

Source§

fn clone(&self) -> TrustRegion<R, 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, R, F> Deserialize<'de> for TrustRegion<R, F>
where R: 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<R, F> Serialize for TrustRegion<R, F>
where R: 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, R, F> Solver<O> for TrustRegion<R, F>
where O: ArgminOp<Output = F, Float = F>, O::Param: Default + Clone + Debug + Serialize + ArgminMul<F, O::Param> + ArgminWeightedDot<O::Param, F, O::Hessian> + ArgminNorm<F> + ArgminDot<O::Param, F> + ArgminAdd<O::Param, O::Param> + ArgminSub<O::Param, O::Param> + ArgminZeroLike, O::Hessian: Default + Clone + Debug + Serialize + ArgminDot<O::Param, O::Param>, R: ArgminTrustRegion<F> + Solver<OpWrapper<O>>, F: ArgminFloat,

Source§

const NAME: &'static str = "Trust region"

Name of the solver
Source§

fn init( &mut self, op: &mut OpWrapper<O>, state: &IterState<O>, ) -> Result<Option<ArgminIterData<O>>, Error>

Initializes the algorithm Read more
Source§

fn next_iter( &mut self, op: &mut OpWrapper<O>, state: &IterState<O>, ) -> Result<ArgminIterData<O>, Error>

Computes one iteration of the algorithm.
Source§

fn terminate(&mut self, _state: &IterState<O>) -> TerminationReason

Checks whether the algorithm must be terminated
Source§

fn terminate_internal(&mut self, state: &IterState<O>) -> TerminationReason

Checks whether basic termination reasons apply. Read more

Auto Trait Implementations§

§

impl<R, F> Freeze for TrustRegion<R, F>
where F: Freeze, R: Freeze,

§

impl<R, F> RefUnwindSafe for TrustRegion<R, F>

§

impl<R, F> Send for TrustRegion<R, F>
where F: Send, R: Send,

§

impl<R, F> Sync for TrustRegion<R, F>
where F: Sync, R: Sync,

§

impl<R, F> Unpin for TrustRegion<R, F>
where F: Unpin, R: Unpin,

§

impl<R, F> UnwindSafe for TrustRegion<R, F>
where F: UnwindSafe, R: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

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

Source§

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