SOPT
Sparse OPTimisation
List of all members
IntrospectSDMM Class Reference
+ Inheritance diagram for IntrospectSDMM:
+ Collaboration diagram for IntrospectSDMM:

Additional Inherited Members

- Public Types inherited from sopt::algorithm::SDMM< Scalar >
using value_type = Scalar
 Scalar type. More...
 
using Scalar = value_type
 Scalar type. More...
 
using Real = typename real_type< Scalar >::type
 Real type. More...
 
using t_Vector = Vector< Scalar >
 Type of then underlying vectors. More...
 
using t_LinearTransform = LinearTransform< t_Vector >
 Type of the A and A^H operations. More...
 
using t_Proximal = ProximalFunction< Scalar >
 Type of the proximal functions. More...
 
using t_IsConverged = ConvergenceFunction< Scalar >
 Type of the convergence function. More...
 
- Public Member Functions inherited from sopt::algorithm::SDMM< Scalar >
 SDMM ()
 
virtual ~SDMM ()
 
 SOPT_MACRO (itermax, t_uint)
 Maximum number of iterations. More...
 
 SOPT_MACRO (gamma, Real)
 Gamma. More...
 
 SOPT_MACRO (conjugate_gradient, ConjugateGradient)
 Conjugate gradient. More...
 
 SOPT_MACRO (is_converged, t_IsConverged)
 A function verifying convergence. More...
 
SDMM< Scalar > & conjugate_gradient (t_uint itermax, t_real tolerance)
 Helps setup conjugate gradient. More...
 
auto conjugate_gradient (T0 &&t0, T &&... args) const -> decltype(this->conjugate_gradient()(std::forward< T0 >(t0), std::forward< T >(args)...))
 Forwards to internal conjugage gradient object. More...
 
SDMM< Scalar > & append (PROXIMAL proximal, T args)
 Appends a proximal and linear transform. More...
 
SDMM< Scalar > & append (PROXIMAL proximal)
 Appends a proximal with identity as the linear transform. More...
 
SDMM< Scalar > & append (PROXIMAL proximal, L l, LADJOINT ladjoint)
 Appends a proximal with the linear transform as pair of functions. More...
 
SDMM< Scalar > & append (PROXIMAL proximal, L l, LADJOINT ladjoint, std::array< t_int, 3 > sizes)
 Appends a proximal with the linear transform as pair of functions. More...
 
SDMM< Scalar > & append (PROXIMAL proximal, L l, std::array< t_int, 3 > dsizes, LADJOINT ladjoint, std::array< t_int, 3 > isizes)
 Appends a proximal with the linear transform as pair of functions. More...
 
Diagnostic operator() (t_Vector &out, t_Vector const &input) const
 Implements SDMM. More...
 
DiagnosticAndResult operator() (t_Vector const &input) const
 
DiagnosticAndResult operator() (DiagnosticAndResult const &warmstart) const
 Makes it simple to chain different calls to SDMM. More...
 
std::vector< t_LinearTransform > const & transforms () const
 Linear transforms associated with each objective function. More...
 
std::vector< t_LinearTransform > & transforms ()
 Linear transforms associated with each objective function. More...
 
t_LinearTransform const & transforms (t_uint i) const
 Linear transform associated with a given objective function. More...
 
t_LinearTransformtransforms (t_uint i)
 Linear transform associated with a given objective function. More...
 
std::vector< t_Proximal > const & proximals () const
 Proximal of each objective function. More...
 
std::vector< t_Proximal > & proximals ()
 Linear transforms associated with each objective function. More...
 
t_Proximal const & proximals (t_uint i) const
 Proximal associated with a given objective function. More...
 
t_Proximalproximals (t_uint i)
 Proximal associated with a given objective function. More...
 
proximal::ProximalExpression< t_Proximal const &, T0 > proximals (t_uint i, Eigen::MatrixBase< T0 > const &x) const
 Lazy call to specific proximal function. More...
 
t_uint size () const
 Number of terms. More...
 
bool is_converged (t_Vector const &x) const
 Forwards to convergence function parameter. More...
 

Detailed Description

Definition at line 23 of file sdmm.cc.


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