sopt/types_8h_source.html

 #ifndef BICO_TRAITS_H

 #define BICO_TRAITS_H


 #include "sopt/config.h"

 #include <complex>

 #include <functional>

 #include <Eigen/Core>

 #include "sopt/real_type.h"


 namespace sopt {


 using t_int = int;

 using t_uint = size_t;

 using t_real = double;

 using t_complex = std::complex<t_real>;


 template <typename T = t_real>

 using Vector = Eigen::Matrix<T, Eigen::Dynamic, 1>;


 template <typename T = t_real>

 using Matrix = Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>;


 template <typename T = t_real>

 using Array = Eigen::Array<T, Eigen::Dynamic, 1>;


 template <typename T = t_real>

 using Image = Eigen::Array<T, Eigen::Dynamic, Eigen::Dynamic>;


 template <typename VECTOR = Vector<>>

 using OperatorFunction = std::function<void(VECTOR &, VECTOR const &)>;


 template <typename SCALAR = t_real>

 using ProximalFunction =

     std::function<void(Vector<SCALAR> &output, typename real_type<SCALAR>::type const weight, Vector<SCALAR> const &input)>;


 template <typename SCALAR = t_real>

 using ConvergenceFunction = std::function<bool(Vector<SCALAR> const &)>;

 }  // namespace sopt

 #endif

sopt::details::underlying_value_type
Computes inner-most element type.
Definition: real_type.h:42

sopt
Definition: bisection_method.h:10

sopt::t_int
int t_int
Root of the type hierarchy for signed integers.
Definition: types.h:13

sopt::t_real
double t_real
Root of the type hierarchy for real numbers.
Definition: types.h:17

sopt::t_uint
size_t t_uint
Root of the type hierarchy for unsigned integers.
Definition: types.h:15

sopt::Image
Eigen::Array< T, Eigen::Dynamic, Eigen::Dynamic > Image
A 2-dimensional list of elements of given type.
Definition: types.h:39

sopt::Array
Eigen::Array< T, Eigen::Dynamic, 1 > Array
A 1-dimensional list of elements of given type.
Definition: types.h:34

sopt::OperatorFunction
std::function< void(VECTOR &, VECTOR const &)> OperatorFunction
Typical function out = A*x.
Definition: types.h:43

sopt::Vector
Eigen::Matrix< T, Eigen::Dynamic, 1 > Vector
A vector of a given type.
Definition: types.h:24

sopt::ProximalFunction
std::function< void(Vector< SCALAR > &output, typename real_type< SCALAR >::type const weight, Vector< SCALAR > const &input)> ProximalFunction
Typical function signature for calls to proximal.
Definition: types.h:48

sopt::ConvergenceFunction
std::function< bool(Vector< SCALAR > const &)> ConvergenceFunction
Typical function signature for convergence.
Definition: types.h:52

sopt::t_complex
std::complex< t_real > t_complex
Root of the type hierarchy for (real) complex numbers.
Definition: types.h:19

sopt::Matrix
Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > Matrix
A matrix of a given type.
Definition: types.h:29

real_type.h