# Struct argmin::solver::trustregion::Steihaug

``pub struct Steihaug<P, F> { /* private fields */ }``
Expand description

## Steihaug method

The Steihaug method is a conjugate gradients based approach for finding an approximate solution to the second order approximation of the cost function within the trust region.

### Reference

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

## Implementations§

source§

### impl<P, F> Steihaug<P, F>where P: ArgminMul<F, P> + ArgminDot<P, F> + ArgminAdd<P, P>, F: ArgminFloat,

source

#### pub fn new() -> Self

Construct a new instance of `Steihaug`

##### Example
``let sh: Steihaug<Vec<f64>, f64> = Steihaug::new();``
source

#### pub fn with_epsilon(self, epsilon: F) -> Result<Self, Error>

Set epsilon

The algorithm stops when the residual is smaller than `epsilon`.

Must be larger than 0 and defaults to 10^-10.

##### Example
``let sh: Steihaug<Vec<f64>, f64> = Steihaug::new().with_epsilon(10e-9)?;``
source

#### pub fn with_max_iters(self, iters: u64) -> Self

Set maximum number of iterations

The algorithm stops after `iter` iterations.

Defaults to `u64::MAX`.

##### Example
``let sh: Steihaug<Vec<f64>, f64> = Steihaug::new().with_max_iters(100);``

## Trait Implementations§

source§

### impl<P: Clone, F: Clone> Clone for Steihaug<P, F>

source§

#### fn clone(&self) -> Steihaug<P, 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<P: Default, F: Default> Default for Steihaug<P, F>

source§

#### fn default() -> Steihaug<P, F>

Returns the “default value” for a type. Read more
source§

### impl<'de, P, F> Deserialize<'de> for Steihaug<P, F>where P: 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<P, F> Serialize for Steihaug<P, F>where P: 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<P, O, F, H> Solver<O, IterState<P, P, (), H, F>> for Steihaug<P, F>where P: Clone + SerializeAlias + ArgminMul<F, P> + ArgminL2Norm<F> + ArgminDot<P, F> + ArgminAdd<P, P> + ArgminZeroLike, H: ArgminDot<P, P>, F: ArgminFloat,

source§

#### const NAME: &'static str = "Steihaug"

Name of the solver. Mainly used in Observers.
source§

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

Initializes the algorithm. Read more
source§

#### fn next_iter( &mut self, _problem: &mut Problem<O>, state: IterState<P, P, (), H, F> ) -> Result<(IterState<P, P, (), 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.
source§

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

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) -> TerminationStatus

Checks whether basic termination reasons apply. Read more
source§

### impl<P, F: ArgminFloat> TrustRegionRadius<F> for Steihaug<P, F>

source§

#### fn set_radius(&mut self, radius: F)

Set current radius.

Needed by `TrustRegion`.

##### Example
``````use argmin::solver::trustregion::{Steihaug, TrustRegionRadius};
let mut sh: Steihaug<Vec<f64>, f64> = Steihaug::new();
sh.set_radius(0.8);``````

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

#### 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§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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 Twhere T: Clone,

§

#### 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 Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

§

source§

source§