Struct argmin_core::ArgminIterationData

source ·

pub struct ArgminIterationData<T: Clone> { /* private fields */ }

Expand description

The datastructure which is returned by the next_iter method of the ArgminNextIter trait.

TODO: think about removing this or replacing it with something better. Actually, a tuple would be sufficient.

Implementations

source

impl<T: Clone> ArgminIterationData<T>

source

pub fn new(param: T, cost: f64) -> Self

Constructor

source

pub fn param(&self) -> T

Returns the parameter vector

source

pub fn cost(&self) -> f64

Returns the cost function value

source

pub fn add_kv(&mut self, kv: ArgminKV) -> &mut Self

Adds an ArgminKV

source

pub fn get_kv(&self) -> Option<ArgminKV>

Returns an ArgminKV

TODO: Keep it consistent, remove the get_.

Auto Trait Implementations

impl<T> RefUnwindSafe for ArgminIterationData<T>where
T: RefUnwindSafe,

impl<T> Send for ArgminIterationData<T>where
T: Send,

impl<T> Sync for ArgminIterationData<T>where
T: Sync,

impl<T> Unpin for ArgminIterationData<T>where
T: Unpin,

impl<T> UnwindSafe for ArgminIterationData<T>where
T: UnwindSafe,

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 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, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

Struct argmin_core::ArgminIterationData

Implementations

impl<T: Clone> ArgminIterationData<T>

pub fn new(param: T, cost: f64) -> Self

pub fn param(&self) -> T

pub fn cost(&self) -> f64

pub fn add_kv(&mut self, kv: ArgminKV) -> &mut Self

pub fn get_kv(&self) -> Option<ArgminKV>

Auto Trait Implementations

impl<T> RefUnwindSafe for ArgminIterationData<T>where
T: RefUnwindSafe,

impl<T> Send for ArgminIterationData<T>where
T: Send,

impl<T> Sync for ArgminIterationData<T>where
T: Sync,

impl<T> Unpin for ArgminIterationData<T>where
T: Unpin,

impl<T> UnwindSafe for ArgminIterationData<T>where
T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

Struct argmin_core::ArgminIterationData

Implementations

impl<T: Clone> ArgminIterationData<T>

pub fn new(param: T, cost: f64) -> Self

pub fn param(&self) -> T

pub fn cost(&self) -> f64

pub fn add_kv(&mut self, kv: ArgminKV) -> &mut Self

pub fn get_kv(&self) -> Option<ArgminKV>

Auto Trait Implementations

impl<T> RefUnwindSafe for ArgminIterationData<T>where T: RefUnwindSafe,

impl<T> Send for ArgminIterationData<T>where T: Send,

impl<T> Sync for ArgminIterationData<T>where T: Sync,

impl<T> Unpin for ArgminIterationData<T>where T: Unpin,

impl<T> UnwindSafe for ArgminIterationData<T>where T: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

impl<T> RefUnwindSafe for ArgminIterationData<T>where
T: RefUnwindSafe,

impl<T> Send for ArgminIterationData<T>where
T: Send,

impl<T> Sync for ArgminIterationData<T>where
T: Sync,

impl<T> Unpin for ArgminIterationData<T>where
T: Unpin,

impl<T> UnwindSafe for ArgminIterationData<T>where
T: UnwindSafe,

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

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

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

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

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

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

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