mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector > Class Template Reference

#include <pgd.hpp>

Public Types
using	value_type = Scalar
using	x_vector_storage_t = ::mundy::storage<XVector>
using	grad_vector_storage_t = ::mundy::storage<GradVector>
using	x_tmp_vector_storage_t = ::mundy::storage<XTmpVector>
using	grad_tmp_vector_storage_t = ::mundy::storage<GradTmpVector>

Public Member Functions
	PGDState (XVector &&x, GradVector &&g, XTmpVector &&x_tmp, GradTmpVector &&g_tmp)
auto &	x ()
const auto &	x () const
auto &	grad ()
const auto &	grad () const
auto &	x_tmp ()
const auto &	x_tmp () const
auto &	grad_tmp ()
const auto &	grad_tmp () const
unsigned &	iter ()
bool &	converged ()
value_type &	residual ()
value_type &	step_size ()
unsigned	iter () const
bool	converged () const
value_type	residual () const
value_type	step_size () const

Member Typedef Documentation

value_type

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

using mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::value_type = Scalar

x_vector_storage_t

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

using mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x_vector_storage_t = ::mundy::storage<XVector>

grad_vector_storage_t

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

using mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad_vector_storage_t = ::mundy::storage<GradVector>

x_tmp_vector_storage_t

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

using mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x_tmp_vector_storage_t = ::mundy::storage<XTmpVector>

grad_tmp_vector_storage_t

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

using mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad_tmp_vector_storage_t = ::mundy::storage<GradTmpVector>

Constructor & Destructor Documentation

PGDState()

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::PGDState ( XVector && x, GradVector && g, XTmpVector && x_tmp, GradTmpVector && g_tmp )

inline

Member Function Documentation

x() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x ( )

inline

x() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

const auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x ( ) const

inline

grad() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad ( )

inline

grad() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

const auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad ( ) const

inline

x_tmp() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x_tmp ( )

inline

x_tmp() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

const auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::x_tmp ( ) const

inline

grad_tmp() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad_tmp ( )

inline

grad_tmp() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

const auto & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::grad_tmp ( ) const

inline

iter() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

unsigned & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::iter ( )

inline

converged() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

bool & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::converged ( )

inline

residual() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

value_type & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::residual ( )

inline

step_size() [1/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

value_type & mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::step_size ( )

inline

iter() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

unsigned mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::iter ( ) const

inline

converged() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

bool mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::converged ( ) const

inline

residual() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

value_type mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::residual ( ) const

inline

step_size() [2/2]

template<class Scalar, class XVector, class GradVector, class XTmpVector, class GradTmpVector>

value_type mundy::PGDState< Scalar, XVector, GradVector, XTmpVector, GradTmpVector >::step_size ( ) const

inline