types.h File Reference

#include "sopt/config.h"
#include <complex>
#include <functional>
#include <Eigen/Core>
#include "sopt/real_type.h"

Include dependency graph for types.h:

Go to the source code of this file.

Namespaces
	sopt

Typedefs
using	sopt::t_int = int
	Root of the type hierarchy for signed integers. More...
using	sopt::t_uint = size_t
	Root of the type hierarchy for unsigned integers. More...
using	sopt::t_real = double
	Root of the type hierarchy for real numbers. More...
using	sopt::t_complex = std::complex< t_real >
	Root of the type hierarchy for (real) complex numbers. More...
template<typename T = t_real>
using	sopt::Vector = Eigen::Matrix< T, Eigen::Dynamic, 1 >
	A vector of a given type. More...
template<typename T = t_real>
using	sopt::Matrix = Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic >
	A matrix of a given type. More...
template<typename T = t_real>
using	sopt::Array = Eigen::Array< T, Eigen::Dynamic, 1 >
	A 1-dimensional list of elements of given type. More...
template<typename T = t_real>
using	sopt::Image = Eigen::Array< T, Eigen::Dynamic, Eigen::Dynamic >
	A 2-dimensional list of elements of given type. More...
template<typename VECTOR = Vector<>>
using	sopt::OperatorFunction = std::function< void(VECTOR &, VECTOR const &)>
	Typical function out = A*x. More...
template<typename SCALAR = t_real>
using	sopt::ProximalFunction = std::function< void(Vector< SCALAR > &output, typename real_type< SCALAR >::type const weight, Vector< SCALAR > const &input)>
	Typical function signature for calls to proximal. More...
template<typename SCALAR = t_real>
using	sopt::ConvergenceFunction = std::function< bool(Vector< SCALAR > const &)>
	Typical function signature for convergence. More...