The Base Class Tensor Contractor. More...

#include <BaseContractor.h>

Inheritance diagram for TensorNetworks::BaseContractor:

Collaboration diagram for TensorNetworks::BaseContractor:

Public Types
using	TensorsMap = ITensorContractor::TensorsMap

Public Member Functions
virtual std::shared_ptr< ITensorContractor >	Clone () const =0
	Clone the tensor contractor.
virtual double	Contract (const TensorNetwork &network, Types::qubit_t qubit)=0
	Contract the tensor network.
template<class PassedTensorsMap = TensorsMap>
Eigen::Index	ContractNodes (Types::qubit_t qubit, PassedTensorsMap &tensors, Eigen::Index tensor1Id, Eigen::Index tensor2Id, Eigen::Index resultRank)
size_t	GetMaxTensorRank () const override
bool	GetMultithreading () const override
	Get the multithreading flag.
TensorsMap	InitializeTensors (const TensorNetwork &network, Types::qubit_t qubit, std::vector< Eigen::Index > &keys, std::unordered_map< Eigen::Index, Eigen::Index > &keysKeys, bool fillKeys=true, bool contract=true) override
void	SetMultithreading (bool multithreading=true) override
	Enable/disable multithreading.

Static Public Member Functions
static size_t	GetResultRank (const std::shared_ptr< TensorNode > &tensor1, const std::shared_ptr< TensorNode > &tensor2)

Protected Attributes
bool	enableMultithreading = true
	A flag to indicate if multithreading should be enabled.
size_t	maxTensorRank = 0
	The maximum rank of the tensors in the network.

Detailed Description

The Base Class Tensor Contractor.

Tensor contractions common functionality.

Definition at line 30 of file BaseContractor.h.

Member Typedef Documentation

◆ TensorsMap

using TensorNetworks::BaseContractor::TensorsMap = ITensorContractor::TensorsMap

Definition at line 33 of file BaseContractor.h.

Member Function Documentation

◆ Clone()

virtual std::shared_ptr< ITensorContractor > TensorNetworks::ITensorContractor::Clone ( ) const

pure virtualinherited

Clone the tensor contractor.

Returns: A shared pointer to the cloned tensor contractor.

Implemented in TensorNetworks::DumbContractor, TensorNetworks::ForestContractor, TensorNetworks::LookaheadContractor, TensorNetworks::StochasticContractor, and TensorNetworks::VerticalContractor.

◆ Contract()

virtual double TensorNetworks::ITensorContractor::Contract	(	const TensorNetwork &	network,
		Types::qubit_t	qubit )

pure virtualinherited

Contract the tensor network.

Parameters

Distributed Quantum Computing The tensor network to contract.

Returns: The result of the contraction.

Implemented in TensorNetworks::DumbContractor, TensorNetworks::ForestContractor, TensorNetworks::LookaheadContractor, TensorNetworks::StochasticContractor, and TensorNetworks::VerticalContractor.

◆ ContractNodes()

template<class PassedTensorsMap = TensorsMap>

Eigen::Index TensorNetworks::BaseContractor::ContractNodes	(	Types::qubit_t	qubit,
		PassedTensorsMap &	tensors,
		Eigen::Index	tensor1Id,
		Eigen::Index	tensor2Id,
		Eigen::Index	resultRank )

inline

Definition at line 140 of file BaseContractor.h.

References enableMultithreading, and maxTensorRank.

Referenced by TensorNetworks::DumbContractor::Contract(), TensorNetworks::ForestContractor::Contract(), TensorNetworks::LookaheadContractor::Contract(), TensorNetworks::StochasticContractor::Contract(), TensorNetworks::VerticalContractor::Contract(), and InitializeTensors().

◆ GetMaxTensorRank()

size_t TensorNetworks::BaseContractor::GetMaxTensorRank ( ) const

inlineoverridevirtual

Implements TensorNetworks::ITensorContractor.

Definition at line 254 of file BaseContractor.h.

References maxTensorRank.

◆ GetMultithreading()

bool TensorNetworks::BaseContractor::GetMultithreading ( ) const

inlineoverridevirtual

Get the multithreading flag.

Returns the multithreading flag.

Returns: The multithreading flag.

Implements TensorNetworks::ITensorContractor.

Definition at line 279 of file BaseContractor.h.

References enableMultithreading.

◆ GetResultRank()

size_t TensorNetworks::BaseContractor::GetResultRank	(	const std::shared_ptr< TensorNode > &	tensor1,
		const std::shared_ptr< TensorNode > &	tensor2 )

inlinestatic

Definition at line 232 of file BaseContractor.h.

Referenced by TensorNetworks::DumbContractor::Contract(), TensorNetworks::LookaheadContractor::Contract(), TensorNetworks::StochasticContractor::Contract(), TensorNetworks::VerticalContractor::Contract(), and InitializeTensors().

◆ InitializeTensors()

TensorsMap TensorNetworks::BaseContractor::InitializeTensors	(	const TensorNetwork &	network,
		Types::qubit_t	qubit,
		std::vector< Eigen::Index > &	keys,
		std::unordered_map< Eigen::Index, Eigen::Index > &	keysKeys,
		bool	fillKeys = true,
		bool	contract = true )