[−][src]Struct optimization_engine::core::fbs::FBSCache
Cache for the forward-backward splitting (FBS), or projected gradient, algorithm
This struct allocates memory needed for the FBS algorithm
Methods
impl FBSCache
[src]
pub fn new(n: NonZeroUsize, gamma: f64, tolerance: f64) -> FBSCache
[src]
Construct a new instance of FBSCache
Arguments
gamma
parameter gamma of the algorithmtolerance
tolerance used for termination
Memory allocation
This method allocates new memory (which it owns, of course). You should avoid
constructing instances of FBSCache
in a loop or in any way more than
absolutely necessary
If you need to call an optimizer more than once, perhaps with different
parameters, then construct an FBSCache
only once
This method will allocate memory for 2*n + 3
floats
Panics
This method will panic if there is no available memory for the required allocation (capacity overflow)
Auto Trait Implementations
impl Send for FBSCache
impl Sync for FBSCache
impl Unpin for FBSCache
impl UnwindSafe for FBSCache
impl RefUnwindSafe for FBSCache
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,