Tensor< _output_t, _optional_t > Class Template Reference

Tensor product of chain complexes and more. More...

#include <Box.hpp>

Inheritance diagram for Tensor< _output_t, _optional_t >:

Collaboration diagram for Tensor< _output_t, _optional_t >:

Public Member Functions
_output_t &	tensor ()
	Returns the tensor product. More...
auto &	optional ()
	Returns the optional parameter (detailed rank) More...
const _output_t &	tensor () const
	Returns the tensor product. More...
const auto &	optional () const
	Returns the optional parameter (detailed rank) More...
template<typename _input_t >
	Tensor (const _input_t &A, const _input_t &B, int i=-1)
	Constructor that tensors A,B and optionally at given location only. More...

Detailed Description

template<typename _output_t, typename _optional_t = void>
class Mackey::Tensor< _output_t, _optional_t >

Tensor product of chain complexes and more.

Template Parameters

_output_t	The result type of tensor(). Used to resolve "overloads"
_optional_t	The result type of optional(), as long as it's not void. This is the

Constructor & Destructor Documentation

Tensor()

Tensor	(	const _input_t &	A,
		const _input_t &	B,
		int	i = -1
	)

Constructor that tensors A,B and optionally at given location only.

Template Parameters

_input_t

The type of inputs A,B

Parameters

A	The first factor of the tensor product
B	The second factor of the tensor product
i	Optionally only perform the tensor at given location. If i==-1 (default) then i is ignored.

Member Function Documentation

tensor() [1/2]

_output_t& tensor

(

)

Returns the tensor product.

Returns

The tensor product as a non const ref (so you can move it!)

optional() [1/2]

auto& optional

(

)

Returns the optional parameter (detailed rank)

Returns

The detailed rank as a non const ref (so you can move it!) if _optional_t is not void; raises a static assert otherwise.

tensor() [2/2]

const _output_t& tensor

(

)

const

Returns the tensor product.

Returns

The tensor product as a const ref

optional() [2/2]

const auto& optional

(

)

const

Returns the optional parameter (detailed rank)

Returns

The detailed rank as a non const ref if _optional_t is not void; raises a static assert otherwise.

---

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

• Box.hpp