forward declaration of affine subspace More...

#include <affine_subspace.hpp>

Inheritance diagram for convex::AffineSubspace< Meta, Child >:

Public Types
using	ConvexBase = ConvexSet< Meta, AffineSubspace< Meta, Child >, Child >
	bring into scope convex fn alias / helpers

using	Mat = linalg::Matrix< T, M, N >
	linear map

using	AmbientVec = linalg::Vector< T, M >
	alias for ambient vector

Public Types inherited from convex::ConvexSet< Meta, AffineSubspace< Meta, Child >, Child >
using	BaseT = Atom< Meta, ConvexSet< Meta, AffineSubspace< Meta, Child >, Child >, Child >
	alias to extract type traits from Domain convex set

Public Types inherited from convex::Atom< Meta, Derived, Cs >
using	Domain = meta_dom_t< Meta >
	Atom input domain.

using	Codomain = meta_codom_t< Meta >
	Atom output codomain.

using	ChildrenT = std::tuple< atom_decay_t< Cs >... >
	Tuple of decayed child atom types.

using	T = dom_type_t< Domain >
	Scalar field for the atom domain.

using	PointT = dom_point_t< Domain >
	Point type accepted by the atom domain.

Public Member Functions
constexpr	AffineSubspace (const Mat &A_in, const AmbientVec &b_in, const Child &child_in)
	CTOR for affine subspace.

constexpr bool	contains_impl (const PointT &x, T tol) const
	contains function

constexpr bool	is_well_formed () const
	is well formed checks to see if basis fully spans subspace

template<typename Other >
constexpr bool	is_equal_impl (const Other &other) const
	equality comparison

template<linalg::SquareMatrix TMat> requires (linalg::mat_cols_v<TMat> == N && std::same_as<linalg::matrix_scalar_t<TMat>, T>)
constexpr auto	transform_impl (const affine::AffineMap< TMat > &map) const
	transform

template<AtomType Type, conic::BuilderLike Builder>
constexpr auto	canonicalize_set (const Builder &builder) const
	canonicalize impl

Public Member Functions inherited from convex::ConvexSet< Meta, AffineSubspace< Meta, Child >, Child >
constexpr	ConvexSet (const Child &child_in)
	CTOR.

constexpr void	validate_domain_impl () const
	is_well_formed

constexpr bool	contains (const PointT &x, T tol=1e-8) const
	contains to check if the point lies in the convex set

constexpr auto	transform (const affine::AffineMap< Mat > &map) const
	transform convex set by affine map

constexpr bool	operator== (const ConvexSet< Meta, OtherDerived, OtherChild > &other) const
	equality comparison overload

constexpr bool	operator!= (const ConvexSet< Meta, OtherDerived, OtherChild > &other) const
	inequality comparison overload

constexpr auto	canonicalize_impl (const Builder &builder) const
	canonicalize

constexpr auto	self () const
	self function which returns a const ref to the derived object

Public Member Functions inherited from convex::Atom< Meta, Derived, Cs >
constexpr	Atom ()
	Construct a leaf atom with no children.

constexpr	Atom (ChildrenT child_in)
	Construct an atom with normalized children.

constexpr void	validate_fn_domain (const auto &child) const
	Validate DCP composition for a function child.

constexpr void	validate_domain () const
	Validate child domains, signs, curvature, and composition rules.

template<AtomType Type, conic::BuilderLike Builder>
constexpr auto	canonicalize (const Builder &builder) const
	Dispatch canonicalization to the derived atom.

constexpr const Derived &	self () const
	Return this object as the CRTP-derived atom type.

Public Attributes
Mat	A
	data members for affine subspace

AmbientVec	b

Public Attributes inherited from convex::Atom< Meta, Derived, Cs >
ChildrenT	children
	Tuple of normalized child atoms.

Additional Inherited Members
Static Public Attributes inherited from convex::Atom< Meta, Derived, Cs >
static constexpr std::size_t	N = dom_size_v<Domain>
	Domain dimension.

static constexpr std::size_t	M = dom_size_v<Codomain>
	Codomain dimension.

static constexpr CurvatureType	Curvature = meta_curv_v<Meta>
	Curvature declared by atom metadata.

static constexpr VarType	DomSign = dom_vartype_v<Domain>
	Domain sign declared by atom metadata.

static constexpr VarType	CodomSign = dom_vartype_v<Codomain>
	Codomain sign declared by atom metadata.

Detailed Description

template<typename Meta, typename Child>
struct convex::AffineSubspace< Meta, Child >

forward declaration of affine subspace

Affine Set in the perspective of an affine equality set.

C = { x | A x = b } C is an affine subspace of R^n where A in R^{m x n} and b in R^m

Definition at line 32 of file affine_subspace.hpp.

Member Typedef Documentation

◆ AmbientVec

template<typename Meta , typename Child >

using convex::AffineSubspace< Meta, Child >::AmbientVec = linalg::Vector<T, M>

alias for ambient vector

Definition at line 46 of file affine_subspace.hpp.

◆ ConvexBase

template<typename Meta , typename Child >

using convex::AffineSubspace< Meta, Child >::ConvexBase = ConvexSet<Meta, AffineSubspace<Meta, Child>, Child>

bring into scope convex fn alias / helpers

Definition at line 34 of file affine_subspace.hpp.

◆ Mat

template<typename Meta , typename Child >

using convex::AffineSubspace< Meta, Child >::Mat = linalg::Matrix<T, M, N>

linear map

Definition at line 43 of file affine_subspace.hpp.

Constructor & Destructor Documentation

◆ AffineSubspace()

template<typename Meta , typename Child >

constexpr convex::AffineSubspace< Meta, Child >::AffineSubspace	(	const Mat &	A_in,
		const AmbientVec &	b_in,
		const Child &	child_in
	)

inlineexplicitconstexpr

CTOR for affine subspace.

Parameters

A	in R^{m x n}
b	in R^m
child

Definition at line 55 of file affine_subspace.hpp.

Member Function Documentation

◆ canonicalize_set()

template<typename Meta , typename Child >

template<AtomType Type, conic::BuilderLike Builder>

constexpr auto convex::AffineSubspace< Meta, Child >::canonicalize_set ( const Builder & builder ) const

inlineconstexpr

canonicalize impl

Affine subspace: A x = b

The current path keeps affine sets in the explicit equality map rather than lifting them into cone constraints.

Returns: cone block

Definition at line 131 of file affine_subspace.hpp.

References convex::AffineSubspace< Meta, Child >::A, convex::AffineSubspace< Meta, Child >::b, convex::Atom< Meta, Derived, Cs >::children, convex::dom_size_v, and convex::Atom< Meta, Derived, Cs >::N.

◆ contains_impl()

template<typename Meta , typename Child >

constexpr bool convex::AffineSubspace< Meta, Child >::contains_impl	(	const PointT &	x,
		T	tol
	)		const

inlineconstexpr

contains function

Parameters

point	x in R^n
tolerance

Returns: T/F

Definition at line 67 of file affine_subspace.hpp.

References convex::AffineSubspace< Meta, Child >::A, convex::AffineSubspace< Meta, Child >::b, and convex::dom_size_v.

◆ is_equal_impl()

template<typename Meta , typename Child >

template<typename Other >

constexpr bool convex::AffineSubspace< Meta, Child >::is_equal_impl ( const Other & other ) const

inlineconstexpr

equality comparison

Parameters

affine set

Returns: T/F

Definition at line 89 of file affine_subspace.hpp.

References convex::AffineSubspace< Meta, Child >::A, convex::AffineSubspace< Meta, Child >::b, and convex::dom_size_v.

◆ is_well_formed()

template<typename Meta , typename Child >

constexpr bool convex::AffineSubspace< Meta, Child >::is_well_formed ( ) const

inlineconstexpr

is well formed checks to see if basis fully spans subspace

Returns: T/F

Definition at line 76 of file affine_subspace.hpp.

References convex::AffineSubspace< Meta, Child >::A, convex::dom_size_v, and convex::Atom< Meta, Derived, Cs >::N.

◆ transform_impl()

template<typename Meta , typename Child >

template<linalg::SquareMatrix TMat>
requires (linalg::mat_cols_v<TMat> == N && std::same_as<linalg::matrix_scalar_t<TMat>, T>)

constexpr auto convex::AffineSubspace< Meta, Child >::transform_impl ( const affine::AffineMap< TMat > & map ) const

inlineconstexpr

transform

C = { x | A x = b } f(C) = { y = f(x) | x in C } y = U x + t to x = U^{-1} (y - t) A U^{-1} (y - t) = b to A U^{-1} y = b + A U^{-1} t

Parameters

affine map

Returns: transformed affine subspace

Definition at line 109 of file affine_subspace.hpp.

References convex::AffineSubspace< Meta, Child >::A, convex::AffineSubspace< Meta, Child >::b, convex::Atom< Meta, Derived, Cs >::children, and convex::dom_size_v.

Member Data Documentation

◆ A

template<typename Meta , typename Child >

Mat convex::AffineSubspace< Meta, Child >::A

data members for affine subspace

Definition at line 150 of file affine_subspace.hpp.

Referenced by convex::AffineSubspace< Meta, Child >::canonicalize_set(), convex::AffineSubspace< Meta, Child >::contains_impl(), convex::AffineSubspace< Meta, Child >::is_equal_impl(), convex::AffineSubspace< Meta, Child >::is_well_formed(), and convex::AffineSubspace< Meta, Child >::transform_impl().

◆ b

template<typename Meta , typename Child >

AmbientVec convex::AffineSubspace< Meta, Child >::b

Definition at line 151 of file affine_subspace.hpp.

Referenced by convex::AffineSubspace< Meta, Child >::canonicalize_set(), convex::AffineSubspace< Meta, Child >::contains_impl(), convex::AffineSubspace< Meta, Child >::is_equal_impl(), and convex::AffineSubspace< Meta, Child >::transform_impl().

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

include/akreon/convex/convex_traits.hpp
include/akreon/convex/sets/affine_subspace.hpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AmbientVec

◆ ConvexBase

◆ Mat

Constructor & Destructor Documentation

◆ AffineSubspace()

Member Function Documentation

◆ canonicalize_set()

◆ contains_impl()

◆ is_equal_impl()

◆ is_well_formed()

◆ transform_impl()

Member Data Documentation

◆ A

◆ b