TensorNetworks::ITensorContractor Class Reference

Tensor Contractor interface. More...

#include <TensorContractor.h>

Inheritance diagram for TensorNetworks::ITensorContractor:

Public Types
using	TensorsMap = std::unordered_map< Eigen::Index, std::shared_ptr< TensorNode > >

Public Member Functions
virtual 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)=0
virtual double	Contract (const TensorNetwork &network, Types::qubit_t qubit)=0
	Contract the tensor network.
virtual size_t	GetMaxTensorRank () const =0
virtual void	SetMultithreading (bool multithreading=true)=0
	Enable/disable multithreading.
virtual bool	GetMultithreading () const =0
	Get the multithreading flag.
virtual std::shared_ptr< ITensorContractor >	Clone () const =0
	Clone the tensor contractor.

Detailed Description

Tensor Contractor interface.

Defines an interface for tensor contractions. There might be different implementations for different types of contractions.

Definition at line 33 of file TensorContractor.h.

Member Typedef Documentation

TensorsMap

using TensorNetworks::ITensorContractor::TensorsMap = std::unordered_map<Eigen::Index, std::shared_ptr<TensorNode> >

Definition at line 35 of file TensorContractor.h.

Member Function Documentation

Clone()

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

pure virtual

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 virtual

Contract the tensor network.

Parameters

network

The tensor network to contract.

Returns

The result of the contraction.

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

GetMaxTensorRank()

virtual size_t TensorNetworks::ITensorContractor::GetMaxTensorRank ( ) const

pure virtual

Implemented in TensorNetworks::BaseContractor.

GetMultithreading()

virtual bool TensorNetworks::ITensorContractor::GetMultithreading ( ) const

pure virtual

Get the multithreading flag.

Returns the multithreading flag.

Returns

The multithreading flag.

Implemented in TensorNetworks::BaseContractor.

InitializeTensors()

virtual TensorsMap TensorNetworks::ITensorContractor::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  )

pure virtual

Implemented in TensorNetworks::BaseContractor.

SetMultithreading()

virtual void TensorNetworks::ITensorContractor::SetMultithreading ( bool  multithreading = true )

pure virtual

Enable/disable multithreading.

Enable/disable multithreading. Default is enabled.

Parameters

multithreading

A flag to indicate if multithreading should be enabled.

Implemented in TensorNetworks::BaseContractor.

---

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

• TensorContractor.h