EigenConfig< RealT > Struct Template Reference

#include <alpaqa/config/config.hpp>

Detailed Description

template<class RealT>
struct alpaqa::EigenConfig< RealT >

Definition at line 118 of file config.hpp.

Collaboration diagram for EigenConfig< RealT >:

Public Types
using	real_t = RealT
	Real scalar element type.
using	cplx_t = std::complex<real_t>
	Complex scalar element type.
using	vec = Eigen::VectorX<real_t>
	Dynamic vector type.
using	mvec = Eigen::Map<vec>
	Map of vector type.
using	cmvec = Eigen::Map<const vec>
	Immutable map of vector type.
using	rvec = Eigen::Ref<vec>
	Reference to mutable vector.
using	crvec = Eigen::Ref<const vec>
	Reference to immutable vector.
using	mat = Eigen::MatrixX<real_t>
	Dynamic matrix type.
using	mmat = Eigen::Map<mat>
	Map of matrix type.
using	cmmat = Eigen::Map<const mat>
	Immutable map of matrix type.
using	rmat = Eigen::Ref<mat>
	Reference to mutable matrix.
using	crmat = Eigen::Ref<const mat>
	Reference to immutable matrix.
using	cmat = Eigen::MatrixX<cplx_t>
	Dynamic complex matrix type.
using	mcmat = Eigen::Map<cmat>
	Map of complex matrix type.
using	cmcmat = Eigen::Map<const cmat>
	Immutable map of complex matrix type.
using	rcmat = Eigen::Ref<cmat>
	Reference to mutable complex matrix.
using	crcmat = Eigen::Ref<const cmat>
	Reference to immutable complex matrix.
using	length_t = Eigen::Index
	Type for lengths and sizes.
using	index_t = Eigen::Index
	Type for vector and matrix indices.
using	indexvec = Eigen::VectorX<index_t>
	Dynamic vector of indices.
using	rindexvec = Eigen::Ref<indexvec>
	Reference to mutable index vector.
using	crindexvec = Eigen::Ref<const indexvec>
	Reference to immutable index vector.
using	mindexvec = Eigen::Map<indexvec>
	Map of index vector type.
using	cmindexvec = Eigen::Map<const indexvec>
	Immutable map of index vector type.

Static Public Attributes
static constexpr bool	supports_indexvec = true
	Whether indexing by vectors of indices is supported.

Member Typedef Documentation

real_t

template<class RealT>

using real_t = RealT

Real scalar element type.

Definition at line 120 of file config.hpp.

cplx_t

template<class RealT>

using cplx_t = std::complex<real_t>

Complex scalar element type.

Definition at line 122 of file config.hpp.

vec

template<class RealT>

using vec = Eigen::VectorX<real_t>

Dynamic vector type.

Definition at line 124 of file config.hpp.

mvec

template<class RealT>

using mvec = Eigen::Map<vec>

Map of vector type.

Definition at line 126 of file config.hpp.

cmvec

template<class RealT>

using cmvec = Eigen::Map<const vec>

Immutable map of vector type.

Definition at line 128 of file config.hpp.

rvec

template<class RealT>

using rvec = Eigen::Ref<vec>

Reference to mutable vector.

Definition at line 130 of file config.hpp.

crvec

template<class RealT>

using crvec = Eigen::Ref<const vec>

Reference to immutable vector.

Definition at line 132 of file config.hpp.

mat

template<class RealT>

using mat = Eigen::MatrixX<real_t>

Dynamic matrix type.

Definition at line 134 of file config.hpp.

mmat

template<class RealT>

using mmat = Eigen::Map<mat>

Map of matrix type.

Definition at line 136 of file config.hpp.

cmmat

template<class RealT>

using cmmat = Eigen::Map<const mat>

Immutable map of matrix type.

Definition at line 138 of file config.hpp.

rmat

template<class RealT>

using rmat = Eigen::Ref<mat>

Reference to mutable matrix.

Definition at line 140 of file config.hpp.

crmat

template<class RealT>

using crmat = Eigen::Ref<const mat>

Reference to immutable matrix.

Definition at line 142 of file config.hpp.

cmat

template<class RealT>

using cmat = Eigen::MatrixX<cplx_t>

Dynamic complex matrix type.

Definition at line 144 of file config.hpp.

mcmat

template<class RealT>

using mcmat = Eigen::Map<cmat>

Map of complex matrix type.

Definition at line 146 of file config.hpp.

cmcmat

template<class RealT>

using cmcmat = Eigen::Map<const cmat>

Immutable map of complex matrix type.

Definition at line 148 of file config.hpp.

rcmat

template<class RealT>

using rcmat = Eigen::Ref<cmat>

Reference to mutable complex matrix.

Definition at line 150 of file config.hpp.

crcmat

template<class RealT>

using crcmat = Eigen::Ref<const cmat>

Reference to immutable complex matrix.

Definition at line 152 of file config.hpp.

length_t

template<class RealT>

using length_t = Eigen::Index

Type for lengths and sizes.

Definition at line 154 of file config.hpp.

index_t

template<class RealT>

using index_t = Eigen::Index

Type for vector and matrix indices.

Definition at line 156 of file config.hpp.

indexvec

template<class RealT>

using indexvec = Eigen::VectorX<index_t>

Dynamic vector of indices.

Definition at line 158 of file config.hpp.

rindexvec

template<class RealT>

using rindexvec = Eigen::Ref<indexvec>

Reference to mutable index vector.

Definition at line 160 of file config.hpp.

crindexvec

template<class RealT>

using crindexvec = Eigen::Ref<const indexvec>

Reference to immutable index vector.

Definition at line 162 of file config.hpp.

mindexvec

template<class RealT>

using mindexvec = Eigen::Map<indexvec>

Map of index vector type.

Definition at line 164 of file config.hpp.

cmindexvec

template<class RealT>

using cmindexvec = Eigen::Map<const indexvec>

Immutable map of index vector type.

Definition at line 166 of file config.hpp.

Member Data Documentation

supports_indexvec

template<class RealT>

bool supports_indexvec = true

staticconstexpr

Whether indexing by vectors of indices is supported.

Definition at line 168 of file config.hpp.

---

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

• src/alpaqa/include/alpaqa/config/config.hpp