Struct argmin::solver::conjugategradient::beta::PolakRibiere

pub struct PolakRibiere {}

Polak and Ribiere (PR) method TODO: Reference

Methods

impl PolakRibiere

pub fn new() -> Self

Constructor

Trait Implementations

impl PartialOrd<PolakRibiere> for PolakRibiere

fn partial_cmp(&self, other: &PolakRibiere) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for PolakRibiere

impl PartialEq<PolakRibiere> for PolakRibiere

fn eq(&self, other: &PolakRibiere) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Default for PolakRibiere

fn default() -> PolakRibiere

Returns the "default value" for a type.

impl Clone for PolakRibiere

fn clone(&self) -> PolakRibiere

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for PolakRibiere

fn cmp(&self, other: &PolakRibiere) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for PolakRibiere

impl Debug for PolakRibiere

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

Formats the value using the given formatter.

impl Hash for PolakRibiere

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'de> Deserialize<'de> for PolakRibiere

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

Deserialize this value from the given Serde deserializer.

impl Serialize for PolakRibiere

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

Serialize this value into the given Serde serializer.

impl<T> ArgminNLCGBetaUpdate<T> for PolakRibiere where
    T: Clone + ArgminDot<T, f64> + ArgminSub<T, T> + ArgminNorm<f64>, 

fn update(&self, dfk: &T, dfk1: &T, _pk: &T) -> f64

Update beta Parameter 1: \nabla f_k Parameter 2: \nabla f_{k+1} Parameter 3: p_k