Struct optimization_engine::core::fbs::FBSCache

pub struct FBSCache { /* private fields */ }

Cache for the forward-backward splitting (FBS), or projected gradient, algorithm

This struct allocates memory needed for the FBS algorithm

Implementations

impl FBSCache

pub fn new(n: NonZeroUsize, gamma: f64, tolerance: f64) -> FBSCache

Construct a new instance of FBSCache

Arguments

• gamma parameter gamma of the algorithm
• tolerance 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)