LBFGSStorage Struct Reference

#include <quala/decl/lbfgs.hpp>

Detailed Description

Layout:

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

Definition at line 47 of file decl/lbfgs.hpp.

Collaboration diagram for LBFGSStorage:

Public Types
using	storage_t = Eigen::Matrix< real_t, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor >

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

Public Attributes
storage_t	sto

Member Typedef Documentation

storage_t

using storage_t = Eigen::Matrix<real_t, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor>

Definition at line 65 of file decl/lbfgs.hpp.

Member Function Documentation

resize()

void resize ( length_t  n, length_t  history  )

inline

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

Definition at line 192 of file lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

n()

length_t n ( ) const

inline

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

Definition at line 52 of file decl/lbfgs.hpp.

Here is the caller graph for this function:

history()

length_t history ( ) const

inline

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

Definition at line 54 of file decl/lbfgs.hpp.

Here is the caller graph for this function:

s() [1/2]

auto s ( index_t  i )

inline

Definition at line 56 of file decl/lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

s() [2/2]

auto s ( index_t  i ) const

inline

Definition at line 57 of file decl/lbfgs.hpp.

Here is the call graph for this function:

y() [1/2]

auto y ( index_t  i )

inline

Definition at line 58 of file decl/lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

y() [2/2]

auto y ( index_t  i ) const

inline

Definition at line 59 of file decl/lbfgs.hpp.

Here is the call graph for this function:

ρ() [1/2]

real_t & ρ ( index_t  i )

inline

Definition at line 60 of file decl/lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

ρ() [2/2]

const real_t & ρ ( index_t  i ) const

inline

Definition at line 61 of file decl/lbfgs.hpp.

Here is the call graph for this function:

α() [1/2]

real_t & α ( index_t  i )

inline

Definition at line 62 of file decl/lbfgs.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

α() [2/2]

const real_t & α ( index_t  i ) const

inline

Definition at line 63 of file decl/lbfgs.hpp.

Here is the call graph for this function:

Member Data Documentation

sto

storage_t sto

Definition at line 67 of file decl/lbfgs.hpp.

---

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

• decl/lbfgs.hpp
• lbfgs.hpp