Inheritance diagram for TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >:

[legend]

Collaboration diagram for TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >:

[legend]

Documentation

template<typename Result, typename Left, typename Right, typename Scalar>
class TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >

Contract and (sum) reduce operation.

This encodes a binary tensor contraction mapped to a GEMM, as well as the sum reduction and post-processing.

Template Parameters

Result	The result tile type
Left	The left-hand tile type
Right	The right-hand tile type
Scalar	The scaling factor type

Definition at line 232 of file contract_reduce.h.

Public Types
typedef ContractReduce< Result, Left, Right, Scalar >	ContractReduce_
	This class type. More...

typedef ContractReduceBase< Result, Left, Right, Scalar >	ContractReduceBase_
	This class type. More...

typedef ContractReduceBase_::first_argument_type	first_argument_type
	The left tile type. More...

typedef ContractReduceBase_::second_argument_type	second_argument_type
	The right tile type. More...

typedef Result	result_type
	The result tile type. More...

typedef Scalar	scalar_type

using	elem_muladd_op_type = void(result_value_type &, const left_value_type &, const right_value_type &)

using	left_value_type = typename Left::value_type

using	result_value_type = typename Result::value_type

using	right_value_type = typename Right::value_type

Public Types inherited from TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >
typedef ContractReduceBase< Result, Left, Right, Scalar >	ContractReduceBase_
	This class type. More...

typedef const Left &	first_argument_type
	The left tile type. More...

typedef const Right &	second_argument_type
	The right tile type. More...

typedef Result	result_type
	The result type. More...

typedef Scalar	scalar_type
	The scaling factor type. More...

using	left_value_type = typename Left::value_type

using	right_value_type = typename Right::value_type

using	result_value_type = typename Result::value_type

using	elem_muladd_op_type = void(result_value_type &, const left_value_type &, const right_value_type &)

Public Member Functions
	ContractReduce ()=default

	ContractReduce (const ContractReduce_ &)=default

	ContractReduce (ContractReduce_ &&)=default

	~ContractReduce ()=default

ContractReduce_ &	operator= (const ContractReduce_ &)=default

ContractReduce_ &	operator= (ContractReduce_ &&)=default

template<typename Perm = BipartitePermutation, typename ElemMultAddOp = TiledArray::function_ref<elem_muladd_op_type>, typename = std::enable_if_t< TiledArray::detail::is_permutation_v<Perm> && std::is_invocable_r_v<void, std::remove_reference_t<ElemMultAddOp>, result_value_type&, const left_value_type&, const right_value_type&>>>
	ContractReduce (const math::blas::Op left_op, const math::blas::Op right_op, const scalar_type alpha, const unsigned int result_rank, const unsigned int left_rank, const unsigned int right_rank, const Perm &perm={}, ElemMultAddOp &&elem_muladd_op={})
	Construct contract/reduce functor. More...

result_type	operator() () const
	Create a result type object. More...

result_type	operator() (const result_type &temp) const
	Post processing step. More...

void	operator() (result_type &result, const result_type &arg) const
	Reduce two result objects. More...

void	operator() (result_type &result, const first_argument_type &left, const second_argument_type &right) const
	Contract a pair of tiles and add to a target tile. More...

Public Member Functions inherited from TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >
	ContractReduceBase ()=default

	ContractReduceBase (const ContractReduceBase_ &)=default

	ContractReduceBase (ContractReduceBase_ &&)=default

	~ContractReduceBase ()=default

ContractReduceBase_ &	operator= (const ContractReduceBase_ &)=default

ContractReduceBase_ &	operator= (ContractReduceBase_ &&)=default

template<typename Perm = BipartitePermutation, typename ElemMultAddOp = TiledArray::function_ref<elem_muladd_op_type>, typename = std::enable_if_t< TiledArray::detail::is_permutation_v<Perm> && std::is_invocable_r_v<void, std::remove_reference_t<ElemMultAddOp>, result_value_type&, const left_value_type&, const right_value_type&>>>
	ContractReduceBase (const math::blas::Op left_op, const math::blas::Op right_op, const scalar_type alpha, const unsigned int result_rank, const unsigned int left_rank, const unsigned int right_rank, const Perm &perm={}, ElemMultAddOp &&elem_muladd_op={})
	Construct contract/reduce functor. More...

const math::GemmHelper &	gemm_helper () const
	Gemm meta data accessor. More...

const BipartitePermutation &	perm () const
	Permutation accessor. More...

scalar_type	factor () const
	Scaling factor accessor. More...

const auto &	elem_muladd_op () const
	Element multiply-add op accessor. More...

unsigned int	num_contract_ranks () const
	Compute the number of contracted ranks. More...

unsigned int	result_rank () const
	Result rank accessor. More...

unsigned int	left_rank () const
	Left-hand argument rank accessor. More...

unsigned int	right_rank () const
	Right-hand argument rank accessor. More...

Additional Inherited Members
Static Public Attributes inherited from TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >
static constexpr bool	plain_tensors

Member Typedef Documentation

◆ ContractReduce_

template<typename Result , typename Left , typename Right , typename Scalar >

typedef ContractReduce<Result, Left, Right, Scalar> TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduce_

This class type.

Definition at line 235 of file contract_reduce.h.

◆ ContractReduceBase_

template<typename Result , typename Left , typename Right , typename Scalar >

typedef ContractReduceBase<Result, Left, Right, Scalar> TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduceBase_

This class type.

Definition at line 237 of file contract_reduce.h.

◆ elem_muladd_op_type

template<typename Result , typename Left , typename Right , typename Scalar >

using TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >::elem_muladd_op_type = void(result_value_type&, const left_value_type&, const right_value_type&)

Definition at line 64 of file contract_reduce.h.

◆ first_argument_type

template<typename Result , typename Left , typename Right , typename Scalar >

typedef ContractReduceBase_::first_argument_type TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::first_argument_type

The left tile type.

Definition at line 239 of file contract_reduce.h.

◆ left_value_type

template<typename Result , typename Left , typename Right , typename Scalar >

using TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >::left_value_type = typename Left::value_type

Definition at line 61 of file contract_reduce.h.

◆ result_type

template<typename Result , typename Left , typename Right , typename Scalar >

typedef Result TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::result_type

The result tile type.

Definition at line 242 of file contract_reduce.h.

◆ result_value_type

template<typename Result , typename Left , typename Right , typename Scalar >

using TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >::result_value_type = typename Result::value_type

Definition at line 63 of file contract_reduce.h.

◆ right_value_type

template<typename Result , typename Left , typename Right , typename Scalar >

using TiledArray::detail::ContractReduceBase< Result, Left, Right, Scalar >::right_value_type = typename Right::value_type

Definition at line 62 of file contract_reduce.h.

◆ scalar_type

template<typename Result , typename Left , typename Right , typename Scalar >

typedef Scalar TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::scalar_type

Definition at line 243 of file contract_reduce.h.

◆ second_argument_type

template<typename Result , typename Left , typename Right , typename Scalar >

typedef ContractReduceBase_::second_argument_type TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::second_argument_type

The right tile type.

Definition at line 241 of file contract_reduce.h.

Constructor & Destructor Documentation

◆ ContractReduce() [1/4]

template<typename Result , typename Left , typename Right , typename Scalar >

TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduce ( )

default

◆ ContractReduce() [2/4]

template<typename Result , typename Left , typename Right , typename Scalar >

TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduce ( const ContractReduce_ & )

default

◆ ContractReduce() [3/4]

template<typename Result , typename Left , typename Right , typename Scalar >

TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduce ( ContractReduce_ && )

default

◆ ~ContractReduce()

template<typename Result , typename Left , typename Right , typename Scalar >

TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::~ContractReduce ( )

default

◆ ContractReduce() [4/4]

template<typename Result , typename Left , typename Right , typename Scalar >

template<typename Perm = BipartitePermutation, typename ElemMultAddOp = TiledArray::function_ref<elem_muladd_op_type>, typename = std::enable_if_t< TiledArray::detail::is_permutation_v<Perm> && std::is_invocable_r_v<void, std::remove_reference_t<ElemMultAddOp>, result_value_type&, const left_value_type&, const right_value_type&>>>

TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::ContractReduce	(	const math::blas::Op	left_op,
		const math::blas::Op	right_op,
		const scalar_type	alpha,
		const unsigned int	result_rank,
		const unsigned int	left_rank,
		const unsigned int	right_rank,
		const Perm &	perm = `{}`,
		ElemMultAddOp &&	elem_muladd_op = `{}`
	)

inline

Construct contract/reduce functor.

Template Parameters

Perm	a permutation type
ElemMultAddOp	a callable with signature elem_muladd_op_type

Parameters

left_op	The left-hand BLAS matrix operation
right_op	The right-hand BLAS matrix operation
alpha	The scaling factor applied to the contracted tiles
result_rank	The rank of the result tensor
left_rank	The rank of the left-hand tensor
right_rank	The rank of the right-hand tensor
perm	The permutation to be applied to the result tensor (default = no permute)
elem_muladd_op	The element multiply-add op

Definition at line 280 of file contract_reduce.h.

Member Function Documentation

◆ operator()() [1/4]

template<typename Result , typename Left , typename Right , typename Scalar >

result_type TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator() ( ) const

inline

Create a result type object.

Initialize a result object for subsequent reductions

Definition at line 291 of file contract_reduce.h.

◆ operator()() [2/4]

template<typename Result , typename Left , typename Right , typename Scalar >

result_type TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator() ( const result_type & temp ) const

inline

Post processing step.

Definition at line 294 of file contract_reduce.h.

◆ operator()() [3/4]

template<typename Result , typename Left , typename Right , typename Scalar >

void TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator()	(	result_type &	result,
		const first_argument_type &	left,
		const second_argument_type &	right
	)		const

inline

Contract a pair of tiles and add to a target tile.

Contract left and right and add the result to result.

Parameters

[in,out]	result	The result object that will be the reduction target
[in]	left	The left-hand tile to be contracted
[in]	right	The right-hand tile to be contracted

Definition at line 322 of file contract_reduce.h.

◆ operator()() [4/4]

template<typename Result , typename Left , typename Right , typename Scalar >

void TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator()	(	result_type &	result,
		const result_type &	arg
	)		const

inline

Reduce two result objects.

Add arg to result .

Parameters

[in,out]	result	The result object that will be the reduction target
[in]	arg	The argument that will be added to `result`

Definition at line 310 of file contract_reduce.h.

◆ operator=() [1/2]

template<typename Result , typename Left , typename Right , typename Scalar >

ContractReduce_& TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator= ( const ContractReduce_ & )

default

◆ operator=() [2/2]

template<typename Result , typename Left , typename Right , typename Scalar >

ContractReduce_& TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >::operator= ( ContractReduce_ && )

default

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

TiledArray/tile_op/contract_reduce.h

Documentation

template<typename Result, typename Left, typename Right, typename Scalar> class TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ContractReduce_

◆ ContractReduceBase_

◆ elem_muladd_op_type

◆ first_argument_type

◆ left_value_type

◆ result_type

◆ result_value_type

◆ right_value_type

◆ scalar_type

◆ second_argument_type

Constructor & Destructor Documentation

◆ ContractReduce() [1/4]

◆ ContractReduce() [2/4]

◆ ContractReduce() [3/4]

◆ ~ContractReduce()

◆ ContractReduce() [4/4]

Member Function Documentation

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

template<typename Result, typename Left, typename Right, typename Scalar>
class TiledArray::detail::ContractReduce< Result, Left, Right, Scalar >