uni20::Domain< Spaces > Class Template Reference

Ordered domain spaces of a tensor morphism. More...

#include <morphism_boundary.hpp>

Public Types
template<std::size_t I>
using	space_type = std::tuple_element_t< I, tuple_type >
	Type of one domain space.
using	tuple_type = std::tuple< Spaces... >
	Tuple containing the ordered domain-space types.

Public Member Functions
	Domain (Spaces... spaces)
	Construct a domain from ordered space values.
auto	operator== (Domain const &other) const -> bool=default
	Compare ordered domain spaces for exact equality.
template<std::size_t I>
void	set_label (std::string label)
	Replace one domain leg label without changing its structure.
template<std::size_t I>
constexpr auto	space () const &noexcept -> space_type< I > const &
	Return one domain space by position.
constexpr auto	spaces () const &noexcept -> tuple_type const &
	Return the ordered domain-space tuple.

Static Public Member Functions
static constexpr auto	empty () noexcept -> bool
	Return whether the domain is the tensor unit.
static constexpr auto	size () noexcept -> std::size_t
	Return the number of domain factors.

Detailed Description

template<Space... Spaces>
class uni20::Domain< Spaces >

Ordered domain spaces of a tensor morphism.

Space structure is exposed read-only. Leg labels may be changed explicitly with set_label<I>().

Template Parameters

Spaces

Concrete space value types in domain order.

Member Typedef Documentation

space_type

template<Space... Spaces>

template<std::size_t I>

using uni20::Domain< Spaces >::space_type = std::tuple_element_t<I, tuple_type>

Type of one domain space.

Template Parameters

I	Zero-based position in the domain.

tuple_type

template<Space... Spaces>

using uni20::Domain< Spaces >::tuple_type = std::tuple<Spaces...>

Tuple containing the ordered domain-space types.

Constructor & Destructor Documentation

Domain()

template<Space... Spaces>

uni20::Domain< Spaces >::Domain ( Spaces...  spaces )

inlineexplicit

Construct a domain from ordered space values.

Parameters

spaces

Space values in domain order.

Member Function Documentation

empty()

template<Space... Spaces>

static constexpr auto uni20::Domain< Spaces >::empty ( ) -> bool

inlinestaticconstexprnoexcept

Return whether the domain is the tensor unit.

Returns

true when the domain contains no factors.

operator==()

template<Space... Spaces>

auto uni20::Domain< Spaces >::operator== ( Domain< Spaces > const &  other ) const -> bool=default

default

Compare ordered domain spaces for exact equality.

Parameters

other

Other domain value.

Returns

true when all space structures and labels are equal.

set_label()

template<Space... Spaces>

template<std::size_t I>

void uni20::Domain< Spaces >::set_label ( std::string  label )

inline

Replace one domain leg label without changing its structure.

Template Parameters

I	Zero-based position in the domain.

Parameters

label

New semantic leg label.

size()

template<Space... Spaces>

static constexpr auto uni20::Domain< Spaces >::size ( ) -> std::size_t

inlinestaticconstexprnoexcept

Return the number of domain factors.

Returns

Compile-time domain size.

space()

template<Space... Spaces>

template<std::size_t I>

constexpr auto uni20::Domain< Spaces >::space ( ) const & -> space_type<I> const&

inlineconstexprnoexcept

Return one domain space by position.

Template Parameters

I	Zero-based position in the domain.

Returns

Read-only space value.

spaces()

template<Space... Spaces>

constexpr auto uni20::Domain< Spaces >::spaces ( ) const & -> tuple_type const&

inlineconstexprnoexcept

Return the ordered domain-space tuple.

Returns

Read-only tuple of space values.

---

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

• morphism_boundary.hpp