LBFGSStorage< Conf > Struct Template Reference

#include <alpaqa/accelerators/lbfgs.hpp>

Detailed Description

template<Config Conf = DefaultConfig>
struct alpaqa::LBFGSStorage< Conf >

Layout:

      ┌───── 2 m ─────┐
    ┌ ┌───┬───┬───┬───┐
    │ │   │   │   │   │
    │ │ s │ y │ s │ y │
n+1 │ │   │   │   │   │
    │ ├───┼───┼───┼───┤
    │ │ ρ │ α │ ρ │ α │
    └ └───┴───┴───┴───┘

Definition at line 76 of file lbfgs.hpp.

Collaboration diagram for LBFGSStorage< Conf >:

Public Types
using	storage_t = mat

Public Member Functions
void	resize (length_t n, length_t history)
	Re-allocate storage for a problem with a different size.
length_t	n () const
	Get the size of the s and y vectors in the buffer.
length_t	history () const
	Get the number of previous vectors s and y stored in the buffer.
auto	s (index_t i)
auto	s (index_t i) const
auto	y (index_t i)
auto	y (index_t i) const
real_t &	ρ (index_t i)
real_t &	ρ (index_t i) const
real_t &	α (index_t i)
real_t &	α (index_t i) const

Public Attributes
storage_t	sto

Member Typedef Documentation

storage_t

template<Config Conf = DefaultConfig>

using storage_t = mat

Definition at line 100 of file lbfgs.hpp.

Member Function Documentation

resize()

template<Config Conf>

void resize	(	length_t	n,
		length_t	history
	)

Re-allocate storage for a problem with a different size.

Definition at line 221 of file lbfgs.tpp.

n()

template<Config Conf = DefaultConfig>

length_t n ( ) const

inline

Get the size of the s and y vectors in the buffer.

Definition at line 83 of file lbfgs.hpp.

Here is the caller graph for this function:

history()

template<Config Conf = DefaultConfig>

length_t history ( ) const

inline

Get the number of previous vectors s and y stored in the buffer.

Definition at line 85 of file lbfgs.hpp.

Here is the caller graph for this function:

s() [1/2]

template<Config Conf = DefaultConfig>

auto s ( index_t  i )

inline

Definition at line 87 of file lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

s() [2/2]

template<Config Conf = DefaultConfig>

auto s ( index_t  i ) const

inline

Definition at line 88 of file lbfgs.hpp.

Here is the call graph for this function:

y() [1/2]

template<Config Conf = DefaultConfig>

auto y ( index_t  i )

inline

Definition at line 91 of file lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

y() [2/2]

template<Config Conf = DefaultConfig>

auto y ( index_t  i ) const

inline

Definition at line 92 of file lbfgs.hpp.

Here is the call graph for this function:

ρ() [1/2]

template<Config Conf = DefaultConfig>

real_t & ρ ( index_t  i )

inline

Definition at line 95 of file lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ρ() [2/2]

template<Config Conf = DefaultConfig>

real_t & ρ ( index_t  i ) const

inline

Definition at line 96 of file lbfgs.hpp.

Here is the call graph for this function:

α() [1/2]

template<Config Conf = DefaultConfig>

real_t & α ( index_t  i )

inline

Definition at line 97 of file lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

α() [2/2]

template<Config Conf = DefaultConfig>

real_t & α ( index_t  i ) const

inline

Definition at line 98 of file lbfgs.hpp.

Here is the call graph for this function:

Member Data Documentation

sto

template<Config Conf = DefaultConfig>

storage_t sto

mutable

Definition at line 102 of file lbfgs.hpp.

---

The documentation for this struct was generated from the following files:

• src/alpaqa/include/alpaqa/accelerators/lbfgs.hpp
• src/alpaqa/include/alpaqa/implementation/accelerators/lbfgs.tpp