SOPT
Sparse OPTimisation
Classes | Public Types | Public Member Functions | List of all members
sopt::algorithm::TVPrimalDual< SCALAR > Class Template Reference

#include <tv_primal_dual.h>

Classes

struct  Diagnostic
 Values indicating how the algorithm ran. More...
 
struct  DiagnosticAndResult
 Holds result vector as well. More...
 

Public Types

using value_type = typename PD::value_type
 
using Scalar = typename PD::Scalar
 
using Real = typename PD::Real
 
using t_Vector = typename PD::t_Vector
 
using t_LinearTransform = typename PD::t_LinearTransform
 
template<typename T >
using t_Proximal = std::function< void(t_Vector &, const T &, const t_Vector &)>
 
using t_IsConverged = typename PD::t_IsConverged
 
using t_Constraint = typename PD::t_Constraint
 
using t_Random_Updater = typename PD::t_Random_Updater
 

Public Member Functions

template<typename DERIVED >
 TVPrimalDual (Eigen::MatrixBase< DERIVED > const &target)
 
virtual ~TVPrimalDual ()
 
 SOPT_MACRO (tv_proximal, t_Proximal< Real >)
 The tv prox functioning as f. More...
 
 SOPT_MACRO (tv_proximal_weighted, t_Proximal< Vector< Real >>)
 The tv prox with weights functioning as f. More...
 
 SOPT_MACRO (tv_proximal_weights, Vector< Real >)
 The tv prox weights functioning. More...
 
 SOPT_MACRO (l2ball_proximal, proximal::WeightedL2Ball< Scalar >)
 The weighted L2 proximal functioning as g. More...
 
 SOPT_MACRO (residual_tolerance, Real)
 Convergence of the relative variation of the objective functions. More...
 
 SOPT_MACRO (relative_variation, Real)
 Convergence of the relative variation of the objective functions. More...
 
 SOPT_MACRO (residual_convergence, t_IsConverged)
 Convergence of the residuals. More...
 
 SOPT_MACRO (objective_convergence, t_IsConverged)
 Convergence of the residuals. More...
 
 SOPT_MACRO (itermax, t_uint)
 Maximum number of iterations. More...
 
 SOPT_MACRO (regulariser_strength, Real)
 regulariser_strength parameter More...
 
 SOPT_MACRO (update_scale, Real)
 update parameter More...
 
 SOPT_MACRO (positivity_constraint, bool)
 Apply positivity constraint. More...
 
 SOPT_MACRO (real_constraint, bool)
 Apply real constraint. More...
 
 SOPT_MACRO (sigma, Real)
 sigma parameter More...
 
 SOPT_MACRO (tau, Real)
 tau parameter More...
 
 SOPT_MACRO (xi, Real)
 xi parameter More...
 
 SOPT_MACRO (rho, Real)
 rho parameter More...
 
 SOPT_MACRO (precondition_stepsize, Real)
 precondtion step size parameter More...
 
 SOPT_MACRO (precondition_weights, t_Vector)
 precondition weights parameter More...
 
 SOPT_MACRO (precondition_iters, t_uint)
 precondition iterations parameter More...
 
 SOPT_MACRO (is_converged, t_IsConverged)
 A function verifying convergence. More...
 
 SOPT_MACRO (Phi, t_LinearTransform)
 Measurement operator. More...
 
 SOPT_MACRO (Psi, t_LinearTransform)
 Wavelet operator. More...
 
 SOPT_MACRO (random_measurement_updater, t_Random_Updater)
 lambda that determines if to update measurements More...
 
 SOPT_MACRO (random_wavelet_updater, t_Random_Updater)
 lambda that determines if to update wavelets More...
 
t_Vector const & target () const
 Vector of target measurements. More...
 
template<typename DERIVED >
TVPrimalDual< Scalar > & target (Eigen::MatrixBase< DERIVED > const &target)
 Sets the vector of target measurements. More...
 
Diagnostic operator() (t_Vector &out) const
 Calls Primal Dual. More...
 
Diagnostic operator() (t_Vector &out, std::tuple< t_Vector, t_Vector > const &guess) const
 Calls Primal Dual. More...
 
Diagnostic operator() (t_Vector &out, std::tuple< t_Vector const &, t_Vector const & > const &guess) const
 Calls Primal Dual. More...
 
DiagnosticAndResult operator() (std::tuple< t_Vector, t_Vector > const &guess) const
 Calls Primal Dual. More...
 
DiagnosticAndResult operator() (std::tuple< t_Vector const &, t_Vector const & > const &guess) const
 Calls Primal Dual. More...
 
DiagnosticAndResult operator() () const
 Calls Primal Dual. More...
 
DiagnosticAndResult operator() (DiagnosticAndResult const &warmstart) const
 Makes it simple to chain different calls to PD. More...
 
TVPrimalDual &::type Phi (ARGS &&... args)
 
proximal::WeightedL2Ball< Scalar > & l2ball_proximal ()
 Proximal of the L2 ball. More...
 
TVPrimalDual &::type Psi (ARGS &&... args)
 
 SOPT_MACRO (epsilon, l2ball, WeightedL2Ball)
 
 SOPT_MACRO (weights, l2ball, WeightedL2Ball)
 
TVPrimalDual< Scalar > & residual_convergence (Real const &tolerance)
 Helper function to set-up default residual convergence function. More...
 
TVPrimalDual< Scalar > & objective_convergence (Real const &tolerance)
 Helper function to set-up default residual convergence function. More...
 
TVPrimalDual< Scalar > & is_converged (std::function< bool(t_Vector const &x)> const &func)
 Convergence function that takes only the output as argument. More...
 

Detailed Description

template<typename SCALAR>
class sopt::algorithm::TVPrimalDual< SCALAR >

Definition at line 19 of file tv_primal_dual.h.

Member Typedef Documentation

◆ Real

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::Real = typename PD::Real

Definition at line 26 of file tv_primal_dual.h.

◆ Scalar

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::Scalar = typename PD::Scalar

Definition at line 25 of file tv_primal_dual.h.

◆ t_Constraint

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_Constraint = typename PD::t_Constraint

Definition at line 32 of file tv_primal_dual.h.

◆ t_IsConverged

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_IsConverged = typename PD::t_IsConverged

Definition at line 31 of file tv_primal_dual.h.

◆ t_LinearTransform

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_LinearTransform = typename PD::t_LinearTransform

Definition at line 28 of file tv_primal_dual.h.

◆ t_Proximal

template<typename SCALAR >
template<typename T >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_Proximal = std::function<void(t_Vector &, const T &, const t_Vector &)>

Definition at line 30 of file tv_primal_dual.h.

◆ t_Random_Updater

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_Random_Updater = typename PD::t_Random_Updater

Definition at line 33 of file tv_primal_dual.h.

◆ t_Vector

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::t_Vector = typename PD::t_Vector

Definition at line 27 of file tv_primal_dual.h.

◆ value_type

template<typename SCALAR >
using sopt::algorithm::TVPrimalDual< SCALAR >::value_type = typename PD::value_type

Definition at line 24 of file tv_primal_dual.h.

Constructor & Destructor Documentation

◆ TVPrimalDual()

template<typename SCALAR >
template<typename DERIVED >
sopt::algorithm::TVPrimalDual< SCALAR >::TVPrimalDual ( Eigen::MatrixBase< DERIVED > const &  target)
inline

Setups imaging wrapper for PD

Parameters
[in]f_proximalproximal operator of the \(f\) function.
[in]g_proximalproximal operator of the \(g\) function

Definition at line 51 of file tv_primal_dual.h.

52  : tv_proximal_([](t_Vector &out, const Real &regulariser_strength, const t_Vector &x) {
53  proximal::tv_norm<t_Vector, t_Vector>(out, regulariser_strength, x);
54  }),
55  tv_proximal_weighted_([](t_Vector &out, const Vector<Real> &regulariser_strength, const t_Vector &x) {
56  proximal::tv_norm<t_Vector, t_Vector, Vector<Real>>(out, regulariser_strength, x);
57  }),
58  tv_proximal_weights_(Vector<Real>::Ones(1)),
59  l2ball_proximal_(1e0),
60  residual_tolerance_(1e-4),
61  relative_variation_(1e-4),
62  residual_convergence_(nullptr),
63  objective_convergence_(nullptr),
64  itermax_(std::numeric_limits<t_uint>::max()),
65  sigma_(1),
66  tau_(0.5),
67  regulariser_strength_(0.5),
68  update_scale_(1),
69  precondition_stepsize_(0.5),
70  precondition_weights_(t_Vector::Ones(target.size())),
71  precondition_iters_(0),
72  xi_(1),
73  rho_(1),
74  is_converged_(),
75  Phi_(linear_transform_identity<Scalar>()),
76  Psi_(linear_transform_identity<Scalar>()),
77  random_measurement_updater_([]() { return true; }),
78  random_wavelet_updater_([]() { return true; }),
79  target_(target) {}
t_Vector
sopt::Vector< Scalar > t_Vector
Definition: bisection_method.cc:10
sopt::algorithm::TVPrimalDual::target
t_Vector const & target() const
Vector of target measurements.
Definition: tv_primal_dual.h:158
Vector
sopt::Vector< Scalar > Vector
Definition: inpainting.cc:28

◆ ~TVPrimalDual()

template<typename SCALAR >
virtual sopt::algorithm::TVPrimalDual< SCALAR >::~TVPrimalDual ( )
inlinevirtual

Definition at line 80 of file tv_primal_dual.h.

80 {}

Member Function Documentation

◆ is_converged()

template<typename SCALAR >
TVPrimalDual<Scalar>& sopt::algorithm::TVPrimalDual< SCALAR >::is_converged ( std::function< bool(t_Vector const &x)> const &  func)
inline

Convergence function that takes only the output as argument.

Definition at line 262 of file tv_primal_dual.h.

262  {
263  return is_converged([func](t_Vector const &x, t_Vector const &) { return func(x); });
264  }
sopt::algorithm::TVPrimalDual::is_converged
TVPrimalDual< Scalar > & is_converged(std::function< bool(t_Vector const &x)> const &func)
Convergence function that takes only the output as argument.
Definition: tv_primal_dual.h:262

◆ l2ball_proximal()

template<typename SCALAR >
proximal::WeightedL2Ball<Scalar>& sopt::algorithm::TVPrimalDual< SCALAR >::l2ball_proximal ( )
inline

Proximal of the L2 ball.

Non-const version to setup the object.

Definition at line 221 of file tv_primal_dual.h.

221 { return l2ball_proximal_; }

◆ objective_convergence()

template<typename SCALAR >
TVPrimalDual<Scalar>& sopt::algorithm::TVPrimalDual< SCALAR >::objective_convergence ( Real const &  tolerance)
inline

Helper function to set-up default residual convergence function.

Definition at line 258 of file tv_primal_dual.h.

258  {
259  return objective_convergence(nullptr).relative_variation(tolerance);
260  }
sopt::algorithm::TVPrimalDual::objective_convergence
TVPrimalDual< Scalar > & objective_convergence(Real const &tolerance)
Helper function to set-up default residual convergence function.
Definition: tv_primal_dual.h:258

◆ operator()() [1/7]

template<typename SCALAR >
DiagnosticAndResult sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( ) const
inline

Calls Primal Dual.

Parameters
[in]guessinitial guess

Definition at line 199 of file tv_primal_dual.h.

199  {
200  DiagnosticAndResult result;
201  static_cast<Diagnostic &>(result) = operator()(result.x,
202  PD::initial_guess(target(), Phi()));
203  return result;
204  }
sopt::algorithm::PrimalDual::initial_guess
std::tuple< t_Vector, t_Vector > initial_guess() const
Computes initial guess for x and the residual using the targets.
Definition: primal_dual.h:233
sopt::algorithm::TVPrimalDual::Phi
TVPrimalDual &::type Phi(ARGS &&... args)
Definition: tv_primal_dual.h:214

References sopt::algorithm::PrimalDual< SCALAR >::initial_guess(), sopt::algorithm::TVPrimalDual< SCALAR >::Phi(), sopt::algorithm::TVPrimalDual< SCALAR >::target(), and sopt::algorithm::TVPrimalDual< SCALAR >::DiagnosticAndResult::x.

Referenced by sopt::algorithm::TVPrimalDual< SCALAR >::operator()().

◆ operator()() [2/7]

template<typename SCALAR >
DiagnosticAndResult sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( DiagnosticAndResult const &  warmstart) const
inline

Makes it simple to chain different calls to PD.

Definition at line 206 of file tv_primal_dual.h.

206  {
207  DiagnosticAndResult result = warmstart;
208  static_cast<Diagnostic &>(result) = operator()(result.x, warmstart.x, warmstart.residual);
209  return result;
210  }

References sopt::algorithm::PrimalDual< SCALAR >::Diagnostic::residual, and sopt::algorithm::TVPrimalDual< SCALAR >::DiagnosticAndResult::x.

◆ operator()() [3/7]

template<typename SCALAR >
DiagnosticAndResult sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( std::tuple< t_Vector const &, t_Vector const & > const &  guess) const
inline

Calls Primal Dual.

Parameters
[in]guessinitial guess

Definition at line 191 of file tv_primal_dual.h.

192  {
193  DiagnosticAndResult result;
194  static_cast<Diagnostic &>(result) = operator()(result.x, guess);
195  return result;
196  }

References sopt::algorithm::TVPrimalDual< SCALAR >::DiagnosticAndResult::x.

◆ operator()() [4/7]

template<typename SCALAR >
DiagnosticAndResult sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( std::tuple< t_Vector, t_Vector > const &  guess) const
inline

Calls Primal Dual.

Parameters
[in]guessinitial guess

Definition at line 186 of file tv_primal_dual.h.

186  {
187  return operator()(std::tie(std::get<0>(guess), std::get<1>(guess)));
188  }
sopt::algorithm::TVPrimalDual::operator()
DiagnosticAndResult operator()() const
Calls Primal Dual.
Definition: tv_primal_dual.h:199

References sopt::algorithm::TVPrimalDual< SCALAR >::operator()().

◆ operator()() [5/7]

template<typename SCALAR >
Diagnostic sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( t_Vector &  out) const
inline

Calls Primal Dual.

Parameters
[out]outOutput vector x

Definition at line 168 of file tv_primal_dual.h.

168  {
169  return operator()(out, PD::initial_guess(target(), Phi()));
170  }

References sopt::algorithm::PrimalDual< SCALAR >::initial_guess(), sopt::algorithm::TVPrimalDual< SCALAR >::operator()(), sopt::algorithm::TVPrimalDual< SCALAR >::Phi(), and sopt::algorithm::TVPrimalDual< SCALAR >::target().

◆ operator()() [6/7]

template<typename SCALAR >
Diagnostic sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( t_Vector &  out,
std::tuple< t_Vector const &, t_Vector const & > const &  guess 
) const
inline

Calls Primal Dual.

Parameters
[out]outOutput vector x
[in]guessinitial guess

Definition at line 180 of file tv_primal_dual.h.

181  {
182  return operator()(out, std::get<0>(guess), std::get<1>(guess));
183  }

References sopt::algorithm::TVPrimalDual< SCALAR >::operator()().

◆ operator()() [7/7]

template<typename SCALAR >
Diagnostic sopt::algorithm::TVPrimalDual< SCALAR >::operator() ( t_Vector &  out,
std::tuple< t_Vector, t_Vector > const &  guess 
) const
inline

Calls Primal Dual.

Parameters
[out]outOutput vector x
[in]guessinitial guess

Definition at line 174 of file tv_primal_dual.h.

174  {
175  return operator()(out, std::get<0>(guess), std::get<1>(guess));
176  }

References sopt::algorithm::TVPrimalDual< SCALAR >::operator()().

◆ Phi()

template<typename SCALAR >
TVPrimalDual& ::type sopt::algorithm::TVPrimalDual< SCALAR >::Phi ( ARGS &&...  args)
inline

Definition at line 214 of file tv_primal_dual.h.

214  {
215  Phi_ = linear_transform(std::forward<ARGS>(args)...);
216  return *this;
217  }
sopt::linear_transform
LinearTransform< VECTOR > linear_transform(OperatorFunction< VECTOR > const &direct, OperatorFunction< VECTOR > const &indirect, std::array< t_int, 3 > const &sizes={{1, 1, 0}})
Definition: linear_transform.h:124

References sopt::linear_transform().

Referenced by main(), and sopt::algorithm::TVPrimalDual< SCALAR >::operator()().

◆ Psi()

template<typename SCALAR >
TVPrimalDual& ::type sopt::algorithm::TVPrimalDual< SCALAR >::Psi ( ARGS &&...  args)
inline

Definition at line 225 of file tv_primal_dual.h.

225  {
226  Psi_ = linear_transform(std::forward<ARGS>(args)...);
227  return *this;
228  }

References sopt::linear_transform().

Referenced by main().

◆ residual_convergence()

template<typename SCALAR >
TVPrimalDual<Scalar>& sopt::algorithm::TVPrimalDual< SCALAR >::residual_convergence ( Real const &  tolerance)
inline

Helper function to set-up default residual convergence function.

Definition at line 254 of file tv_primal_dual.h.

254  {
255  return residual_convergence(nullptr).residual_tolerance(tolerance);
256  }
sopt::algorithm::TVPrimalDual::residual_convergence
TVPrimalDual< Scalar > & residual_convergence(Real const &tolerance)
Helper function to set-up default residual convergence function.
Definition: tv_primal_dual.h:254

Referenced by main().

◆ SOPT_MACRO() [1/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( epsilon  ,
l2ball  ,
WeightedL2Ball   
)

◆ SOPT_MACRO() [2/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( is_converged  ,
t_IsConverged   
)

A function verifying convergence.

◆ SOPT_MACRO() [3/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( itermax  ,
t_uint   
)

Maximum number of iterations.

◆ SOPT_MACRO() [4/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( l2ball_proximal  ,
proximal::WeightedL2Ball< Scalar >   
)

The weighted L2 proximal functioning as g.

◆ SOPT_MACRO() [5/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( objective_convergence  ,
t_IsConverged   
)

Convergence of the residuals.

If negative, this convergence criteria is disabled.

◆ SOPT_MACRO() [6/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( Phi  ,
t_LinearTransform   
)

Measurement operator.

◆ SOPT_MACRO() [7/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( positivity_constraint  ,
bool   
)

Apply positivity constraint.

◆ SOPT_MACRO() [8/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( precondition_iters  ,
t_uint   
)

precondition iterations parameter

◆ SOPT_MACRO() [9/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( precondition_stepsize  ,
Real   
)

precondtion step size parameter

◆ SOPT_MACRO() [10/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( precondition_weights  ,
t_Vector   
)

precondition weights parameter

◆ SOPT_MACRO() [11/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( Psi  ,
t_LinearTransform   
)

Wavelet operator.

◆ SOPT_MACRO() [12/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( random_measurement_updater  ,
t_Random_Updater   
)

lambda that determines if to update measurements

◆ SOPT_MACRO() [13/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( random_wavelet_updater  ,
t_Random_Updater   
)

lambda that determines if to update wavelets

◆ SOPT_MACRO() [14/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( real_constraint  ,
bool   
)

Apply real constraint.

◆ SOPT_MACRO() [15/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( regulariser_strength  ,
Real   
)

regulariser_strength parameter

◆ SOPT_MACRO() [16/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( relative_variation  ,
Real   
)

Convergence of the relative variation of the objective functions.

If negative, this convergence criteria is disabled.

◆ SOPT_MACRO() [17/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( residual_convergence  ,
t_IsConverged   
)

Convergence of the residuals.

If negative, this convergence criteria is disabled.

◆ SOPT_MACRO() [18/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( residual_tolerance  ,
Real   
)

Convergence of the relative variation of the objective functions.

If negative, this convergence criteria is disabled.

◆ SOPT_MACRO() [19/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( rho  ,
Real   
)

rho parameter

◆ SOPT_MACRO() [20/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( sigma  ,
Real   
)

sigma parameter

◆ SOPT_MACRO() [21/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( tau  ,
Real   
)

tau parameter

◆ SOPT_MACRO() [22/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( tv_proximal  ,
t_Proximal< Real >   
)

The tv prox functioning as f.

◆ SOPT_MACRO() [23/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( tv_proximal_weighted  ,
t_Proximal< Vector< Real >>   
)

The tv prox with weights functioning as f.

◆ SOPT_MACRO() [24/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( tv_proximal_weights  ,
Vector< Real >   
)

The tv prox weights functioning.

◆ SOPT_MACRO() [25/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( update_scale  ,
Real   
)

update parameter

◆ SOPT_MACRO() [26/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( weights  ,
l2ball  ,
WeightedL2Ball   
)

◆ SOPT_MACRO() [27/27]

template<typename SCALAR >
sopt::algorithm::TVPrimalDual< SCALAR >::SOPT_MACRO ( xi  ,
Real   
)

xi parameter

◆ target() [1/2]

template<typename SCALAR >
t_Vector const& sopt::algorithm::TVPrimalDual< SCALAR >::target ( ) const
inline

Vector of target measurements.

Definition at line 158 of file tv_primal_dual.h.

158 { return target_; }

Referenced by sopt::algorithm::TVPrimalDual< SCALAR >::operator()(), and sopt::algorithm::TVPrimalDual< SCALAR >::target().

◆ target() [2/2]

template<typename SCALAR >
template<typename DERIVED >
TVPrimalDual<Scalar>& sopt::algorithm::TVPrimalDual< SCALAR >::target ( Eigen::MatrixBase< DERIVED > const &  target)
inline

Sets the vector of target measurements.

Definition at line 161 of file tv_primal_dual.h.

161  {
162  target_ = target;
163  return *this;
164  }

References sopt::algorithm::TVPrimalDual< SCALAR >::target().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1