sopt::IterationState< T > Class Template Reference

#include <gradient_utils.h>

Public Member Functions
	IterationState (const T &target)
	IterationState (const T &target, std::shared_ptr< sopt::LinearTransform< T >> Phi)
const T &	target () const
const sopt::LinearTransform< T > &	Phi () const
void	Phi (const sopt::LinearTransform< T > &new_phi)

Detailed Description

template<typename T>
class sopt::IterationState< T >

A helper object that can hold the measurement operator and the target vector for a given iteration state

Definition at line 13 of file gradient_utils.h.

Constructor & Destructor Documentation

IterationState() [1/2]

template<typename T >

sopt::IterationState< T >::IterationState ( const T &  target )

inline

Definition at line 15 of file gradient_utils.h.

  {
    _Phi = std::make_shared<sopt::LinearTransform<T>>(linear_transform_identity<T>());
  }

IterationState() [2/2]

template<typename T >

sopt::IterationState< T >::IterationState ( const T &  target, std::shared_ptr< sopt::LinearTransform< T >>  Phi  )

inline

Definition at line 20 of file gradient_utils.h.

                 : _target(target) {
    _Phi = Phi;
  }

References sopt::IterationState< T >::Phi().

Member Function Documentation

Phi() [1/2]

template<typename T >

const sopt::LinearTransform<T>& sopt::IterationState< T >::Phi ( ) const

inline

Definition at line 28 of file gradient_utils.h.

{ return *_Phi; }

Referenced by sopt::IterationState< T >::IterationState().

Phi() [2/2]

template<typename T >

void sopt::IterationState< T >::Phi ( const sopt::LinearTransform< T > &  new_phi )

inline

Definition at line 30 of file gradient_utils.h.

  {
    _Phi = std::make_shared<sopt::LinearTransform<T>>(new_phi);
  }

target()

template<typename T >

const T& sopt::IterationState< T >::target ( ) const

inline

Definition at line 26 of file gradient_utils.h.

{ return _target; }

---

The documentation for this class was generated from the following file:

• /home/runner/work/sopt/sopt/cpp/sopt/gradient_utils.h