The Lookahead Tensor Contractor. More...

#include <LookaheadContractor.h>

Inheritance diagram for TensorNetworks::LookaheadContractor:

Collaboration diagram for TensorNetworks::LookaheadContractor:

Public Types
using	DummyTensorsMap = std::map< Eigen::Index, std::shared_ptr< TensorNode > >

using	TensorPair = std::pair< Eigen::Index, Eigen::Index >

using	TensorsMap = ITensorContractor::TensorsMap

using	VisitedPairType = std::unordered_set< TensorPair, boost::hash< TensorPair > >

Public Member Functions
std::shared_ptr< ITensorContractor >	Clone () const override
	Clone the tensor contractor.

double	Contract (const TensorNetwork &network, Types::qubit_t qubit) override
	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.

size_t	GetNumberOfLevels () const

bool	GetUseMaxRankCost () const

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.

void	SetNumberOfLevels (size_t levels)

void	SetUseMaxRankCost (bool val=true)

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

Protected Attributes
bool	enableMultithreading
	A flag to indicate if multithreading should be enabled.

size_t	maxTensorRank
	The maximum rank of the tensors in the network.

Detailed Description

The Lookahead Tensor Contractor.

Tensor contractions using the Lookahead contraction method.

Definition at line 30 of file LookaheadContractor.h.

Member Typedef Documentation

◆ DummyTensorsMap

using TensorNetworks::LookaheadContractor::DummyTensorsMap = std::map<Eigen::Index, std::shared_ptr<TensorNode> >

Definition at line 35 of file LookaheadContractor.h.

◆ TensorPair

using TensorNetworks::LookaheadContractor::TensorPair = std::pair<Eigen::Index, Eigen::Index>

Definition at line 32 of file LookaheadContractor.h.

◆ TensorsMap

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

inherited

Definition at line 31 of file BaseContractor.h.

◆ VisitedPairType

using TensorNetworks::LookaheadContractor::VisitedPairType = std::unordered_set<TensorPair, boost::hash<TensorPair> >

Definition at line 33 of file LookaheadContractor.h.

Member Function Documentation

◆ Clone()

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

inlineoverridevirtual

Clone the tensor contractor.

Returns: A shared pointer to the cloned tensor contractor.

Implements TensorNetworks::ITensorContractor.

Definition at line 103 of file LookaheadContractor.h.

References TensorNetworks::BaseContractor::enableMultithreading, and TensorNetworks::BaseContractor::maxTensorRank.

◆ Contract()

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

inlineoverridevirtual

Contract the tensor network.

Parameters

network The tensor network to contract.

Returns: The result of the contraction.

Implements TensorNetworks::ITensorContractor.

Definition at line 43 of file LookaheadContractor.h.

References TensorNetworks::BaseContractor::ContractNodes(), TensorNetworks::BaseContractor::GetResultRank(), TensorNetworks::BaseContractor::InitializeTensors(), and TensorNetworks::BaseContractor::maxTensorRank.

◆ 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
	)

inlineinherited

Definition at line 122 of file BaseContractor.h.

References TensorNetworks::BaseContractor::enableMultithreading, and TensorNetworks::BaseContractor::maxTensorRank.

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

◆ GetMaxTensorRank()

size_t TensorNetworks::BaseContractor::GetMaxTensorRank ( ) const

inlineoverridevirtualinherited

Implements TensorNetworks::ITensorContractor.

Definition at line 236 of file BaseContractor.h.

References TensorNetworks::BaseContractor::maxTensorRank.

◆ GetMultithreading()

bool TensorNetworks::BaseContractor::GetMultithreading ( ) const

inlineoverridevirtualinherited

Get the multithreading flag.

Returns the multithreading flag.

Returns: The multithreading flag.

Implements TensorNetworks::ITensorContractor.

Definition at line 257 of file BaseContractor.h.

References TensorNetworks::BaseContractor::enableMultithreading.

◆ GetNumberOfLevels()

size_t TensorNetworks::LookaheadContractor::GetNumberOfLevels ( ) const

inline

Definition at line 90 of file LookaheadContractor.h.

◆ GetResultRank()

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

inlinestaticinherited

Definition at line 215 of file BaseContractor.h.

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

◆ GetUseMaxRankCost()

bool TensorNetworks::LookaheadContractor::GetUseMaxRankCost ( ) const

inline

Definition at line 94 of file LookaheadContractor.h.

◆ 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`
	)

inlineoverridevirtualinherited

Implements TensorNetworks::ITensorContractor.

Definition at line 33 of file BaseContractor.h.

References TensorNetworks::BaseContractor::ContractNodes(), TensorNetworks::TensorNetwork::GetQubitGroup(), TensorNetworks::BaseContractor::GetResultRank(), TensorNetworks::TensorNetwork::GetTensors(), and TensorNetworks::BaseContractor::maxTensorRank.

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

◆ SetMultithreading()

void TensorNetworks::BaseContractor::SetMultithreading ( bool multithreading = true )

inlineoverridevirtualinherited

Enable/disable multithreading.

Enable/disable multithreading. Default is enabled.

Parameters

multithreading A flag to indicate if multithreading should be enabled.

Implements TensorNetworks::ITensorContractor.

Definition at line 246 of file BaseContractor.h.

References TensorNetworks::BaseContractor::enableMultithreading.

◆ SetNumberOfLevels()

void TensorNetworks::LookaheadContractor::SetNumberOfLevels ( size_t levels )

inline

Definition at line 92 of file LookaheadContractor.h.

◆ SetUseMaxRankCost()

void TensorNetworks::LookaheadContractor::SetUseMaxRankCost ( bool val = true )

inline

Definition at line 96 of file LookaheadContractor.h.

Member Data Documentation

◆ enableMultithreading

bool TensorNetworks::BaseContractor::enableMultithreading

protectedinherited

Initial value:

=

true

A flag to indicate if multithreading should be enabled.

Definition at line 262 of file BaseContractor.h.

Referenced by TensorNetworks::DumbContractor::Clone(), TensorNetworks::ForestContractor::Clone(), Clone(), TensorNetworks::StochasticContractor::Clone(), TensorNetworks::VerticalContractor::Clone(), TensorNetworks::BaseContractor::ContractNodes(), TensorNetworks::BaseContractor::GetMultithreading(), and TensorNetworks::BaseContractor::SetMultithreading().

◆ maxTensorRank

size_t TensorNetworks::BaseContractor::maxTensorRank

protectedinherited

Initial value:

=

0

The maximum rank of the tensors in the network.

Definition at line 260 of file BaseContractor.h.

Referenced by TensorNetworks::DumbContractor::Clone(), TensorNetworks::ForestContractor::Clone(), Clone(), TensorNetworks::StochasticContractor::Clone(), TensorNetworks::VerticalContractor::Clone(), Contract(), TensorNetworks::BaseContractor::ContractNodes(), TensorNetworks::BaseContractor::GetMaxTensorRank(), and TensorNetworks::BaseContractor::InitializeTensors().

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

LookaheadContractor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DummyTensorsMap

◆ TensorPair

◆ TensorsMap

◆ VisitedPairType

Member Function Documentation

◆ Clone()

◆ Contract()

◆ ContractNodes()

◆ GetMaxTensorRank()

◆ GetMultithreading()

◆ GetNumberOfLevels()

◆ GetResultRank()

◆ GetUseMaxRankCost()

◆ InitializeTensors()

◆ SetMultithreading()

◆ SetNumberOfLevels()

◆ SetUseMaxRankCost()

Member Data Documentation

◆ enableMultithreading

◆ maxTensorRank