#include <TensorChainRouting.h>

Inheritance diagram for Simulators::Private::TensorChainRouting< Backend >:

Collaboration diagram for Simulators::Private::TensorChainRouting< Backend >:

Classes
class	DecompositionScope

Public Member Functions
size_t	GetCurrentMaxBondDimension () const override
double	getGrowthFactorGate () const override
double	getGrowthFactorSwap () const override
bool	IsRoutingLookaheadEnabled () const override
void	setGrowthFactorGate (double factor) override
void	setGrowthFactorSwap (double factor) override
void	SetLookaheadDepth (int depth) override
void	SetLookaheadDepthWithHeuristic (int depth) override
bool	SwapGatesRelabelQubits () const override

Protected Member Functions
	TensorChainRouting (bool isOperatorChain, bool relabelSwaps=false)
std::vector< double >	CaptureDummyHistory () const
void	ClearDummySimulator ()
void	ConfigureDummy ()
virtual std::vector< double >	CurrentBondDimensions () const =0
virtual std::vector< long long >	CurrentRoutingMap () const =0
MPSDummySimulator::IndexType	EffectiveLookaheadMaxBondDimension (size_t nQ) const
MPSDummySimulator::IndexType	EffectiveLookaheadMaxBondDimension (size_t nQ, MPSDummySimulator::IndexType cap) const
void	EnsureDummySimulator (size_t nQ)
void	InvalidateDummyHistory () noexcept
const char *	MaxBondDimensionConfigKey () const
template<class Bond>
long long	PlanMeetingPosition (const Bond *bonds, size_t count)
void	RecordExecutedTwoQubitGate (Types::qubit_t q0, Types::qubit_t q1, bool isSwap, double schmidtRank) noexcept
void	RefreshRoutingSettings ()
void	ResetDummySimulator ()
void	RestoreDummyHistory (const std::vector< double > &bonds)
void	RestoreDummyState ()
void	SaveDummyState ()
void	SeedDummyHistory (const std::vector< long long > &map)
void	SetSwapGatesRelabelQubits (bool enabled)
bool	ShouldTrackVirtualBonds () const
void	ValidateDummyHistoryMap () noexcept

Static Protected Member Functions
static bool	IsExactSwapMatrix (const Eigen::Matrix4cd &gate)
template<class Gate>
static double	NativeGateSchmidtRank (const Gate &gate)

Protected Attributes
size_t	curMaxBondDim = 0
unsigned	decompositionDepth = 0
bool	dummyHistoryValid = false
std::unique_ptr< MPSDummySimulator >	dummySim
double	growthFactorGate = 0.7
double	growthFactorSwap = 1.
int	lookaheadDepth = 0
int	lookaheadDepthWithHeuristic = 0
const bool	operatorChain
MPSDummySimulator::IndexType	physicalBondCap = 0
std::vector< double >	savedDummyBondDims
bool	swapGatesRelabelQubits
bool	trackVirtualBonds = false
double	truncationWeight = 1.
bool	useOptimalMeetingPosition = true
bool	virtualBondsEnabled = false

Detailed Description

template<class Backend>
class Simulators::Private::TensorChainRouting< Backend >

Definition at line 9 of file TensorChainRouting.h.

Constructor & Destructor Documentation

◆ TensorChainRouting()

template<class Backend>

Simulators::Private::TensorChainRouting< Backend >::TensorChainRouting	(	bool	isOperatorChain,
		bool	relabelSwaps = false )

inlineexplicitprotected

Definition at line 18 of file TensorChainRouting.h.

References operatorChain, and swapGatesRelabelQubits.

Referenced by Simulators::Private::TensorChainRouting< Backend >::DecompositionScope::DecompositionScope().

Member Function Documentation

◆ CaptureDummyHistory()

template<class Backend>

std::vector< double > Simulators::Private::TensorChainRouting< Backend >::CaptureDummyHistory ( ) const

inlineprotected

Definition at line 289 of file TensorChainRouting.h.

References dummyHistoryValid, dummySim, and trackVirtualBonds.

Referenced by SaveDummyState().

◆ ClearDummySimulator()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::ClearDummySimulator ( )

inlineprotected

Definition at line 332 of file TensorChainRouting.h.

References dummySim, InvalidateDummyHistory(), and savedDummyBondDims.

◆ ConfigureDummy()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::ConfigureDummy ( )

inlineprotected

Definition at line 168 of file TensorChainRouting.h.

References dummySim, EffectiveLookaheadMaxBondDimension(), growthFactorGate, growthFactorSwap, physicalBondCap, swapGatesRelabelQubits, truncationWeight, and virtualBondsEnabled.

Referenced by EnsureDummySimulator(), RefreshRoutingSettings(), and SetSwapGatesRelabelQubits().

◆ CurrentBondDimensions()

template<class Backend>

virtual std::vector< double > Simulators::Private::TensorChainRouting< Backend >::CurrentBondDimensions ( ) const

protectedpure virtual

Referenced by SeedDummyHistory().

◆ CurrentRoutingMap()

template<class Backend>

virtual std::vector< long long > Simulators::Private::TensorChainRouting< Backend >::CurrentRoutingMap ( ) const

protectedpure virtual

Referenced by IsRoutingLookaheadEnabled(), PlanMeetingPosition(), RecordExecutedTwoQubitGate(), ResetDummySimulator(), RestoreDummyHistory(), and ValidateDummyHistoryMap().

◆ EffectiveLookaheadMaxBondDimension() [1/2]

template<class Backend>

MPSDummySimulator::IndexType Simulators::Private::TensorChainRouting< Backend >::EffectiveLookaheadMaxBondDimension ( size_t nQ ) const

inlineprotected

Definition at line 108 of file TensorChainRouting.h.

References EffectiveLookaheadMaxBondDimension(), and physicalBondCap.

◆ EffectiveLookaheadMaxBondDimension() [2/2]

template<class Backend>

MPSDummySimulator::IndexType Simulators::Private::TensorChainRouting< Backend >::EffectiveLookaheadMaxBondDimension	(	size_t	nQ,
		MPSDummySimulator::IndexType	cap ) const

inlineprotected

Definition at line 103 of file TensorChainRouting.h.

References Simulators::MPSDummySimulator::EffectiveLookaheadMaxBondDimension(), operatorChain, and virtualBondsEnabled.

Referenced by ConfigureDummy(), and EffectiveLookaheadMaxBondDimension().

◆ EnsureDummySimulator()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::EnsureDummySimulator ( size_t nQ )

inlineprotected

Definition at line 177 of file TensorChainRouting.h.

References ConfigureDummy(), dummySim, InvalidateDummyHistory(), and operatorChain.

Referenced by PlanMeetingPosition(), RecordExecutedTwoQubitGate(), and RestoreDummyHistory().

◆ GetCurrentMaxBondDimension()

template<class Backend>

size_t Simulators::Private::TensorChainRouting< Backend >::GetCurrentMaxBondDimension ( ) const

inlineoverride

Definition at line 91 of file TensorChainRouting.h.

References curMaxBondDim.

◆ getGrowthFactorGate()

template<class Backend>

double Simulators::Private::TensorChainRouting< Backend >::getGrowthFactorGate ( ) const

inlineoverride

Definition at line 72 of file TensorChainRouting.h.

References growthFactorGate.

◆ getGrowthFactorSwap()

template<class Backend>

double Simulators::Private::TensorChainRouting< Backend >::getGrowthFactorSwap ( ) const

inlineoverride

Definition at line 67 of file TensorChainRouting.h.

References growthFactorSwap.

◆ InvalidateDummyHistory()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::InvalidateDummyHistory ( )

inlineprotectednoexcept

Definition at line 138 of file TensorChainRouting.h.

References dummyHistoryValid.

Referenced by ClearDummySimulator(), EnsureDummySimulator(), RecordExecutedTwoQubitGate(), RefreshRoutingSettings(), ResetDummySimulator(), RestoreDummyHistory(), SeedDummyHistory(), SetSwapGatesRelabelQubits(), and ValidateDummyHistoryMap().

◆ IsExactSwapMatrix()

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::IsExactSwapMatrix ( const Eigen::Matrix4cd & gate )

inlinestaticprotected

Definition at line 24 of file TensorChainRouting.h.

◆ IsRoutingLookaheadEnabled()

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::IsRoutingLookaheadEnabled ( ) const

inlineoverride

Definition at line 47 of file TensorChainRouting.h.

References CurrentRoutingMap(), lookaheadDepth, and useOptimalMeetingPosition.

◆ MaxBondDimensionConfigKey()

template<class Backend>

const char * Simulators::Private::TensorChainRouting< Backend >::MaxBondDimensionConfigKey ( ) const

inlineprotected

Definition at line 97 of file TensorChainRouting.h.

References operatorChain.

Referenced by RefreshRoutingSettings().

◆ NativeGateSchmidtRank()

template<class Backend>

template<class Gate>

double Simulators::Private::TensorChainRouting< Backend >::NativeGateSchmidtRank ( const Gate & gate )

inlinestaticprotected

Definition at line 236 of file TensorChainRouting.h.

References Simulators::EffectiveSchmidtRank().

◆ PlanMeetingPosition()

template<class Backend>

template<class Bond>

long long Simulators::Private::TensorChainRouting< Backend >::PlanMeetingPosition	(	const Bond *	bonds,
		size_t	count )

inlineprotected

Definition at line 198 of file TensorChainRouting.h.

References CurrentRoutingMap(), decompositionDepth, dummyHistoryValid, dummySim, EnsureDummySimulator(), Circuits::kGate, lookaheadDepth, lookaheadDepthWithHeuristic, physicalBondCap, trackVirtualBonds, and useOptimalMeetingPosition.

◆ RecordExecutedTwoQubitGate()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::RecordExecutedTwoQubitGate	(	Types::qubit_t	q0,
		Types::qubit_t	q1,
		bool	isSwap,
		double	schmidtRank )

inlineprotectednoexcept

Definition at line 243 of file TensorChainRouting.h.

References CurrentRoutingMap(), dummyHistoryValid, dummySim, EnsureDummySimulator(), InvalidateDummyHistory(), SeedDummyHistory(), swapGatesRelabelQubits, and trackVirtualBonds.

◆ RefreshRoutingSettings()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::RefreshRoutingSettings ( )

inlineprotected

Definition at line 116 of file TensorChainRouting.h.

References ConfigureDummy(), dummySim, Simulators::MPSDummySimulator::EffectiveLookaheadMaxBondDimension(), InvalidateDummyHistory(), lookaheadDepth, MaxBondDimensionConfigKey(), operatorChain, physicalBondCap, trackVirtualBonds, Simulators::RoutingConfig::TruncationWeight(), truncationWeight, useOptimalMeetingPosition, Simulators::RoutingConfig::VirtualBondsEnabled(), and virtualBondsEnabled.

Referenced by SetLookaheadDepth().

◆ ResetDummySimulator()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::ResetDummySimulator ( )

inlineprotected

Definition at line 318 of file TensorChainRouting.h.

References CurrentRoutingMap(), dummyHistoryValid, dummySim, InvalidateDummyHistory(), and trackVirtualBonds.

◆ RestoreDummyHistory()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::RestoreDummyHistory ( const std::vector< double > & bonds )

inlineprotected

Definition at line 294 of file TensorChainRouting.h.

References CurrentRoutingMap(), dummyHistoryValid, dummySim, EnsureDummySimulator(), InvalidateDummyHistory(), and trackVirtualBonds.

Referenced by RestoreDummyState().

◆ RestoreDummyState()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::RestoreDummyState ( )

inlineprotected

Definition at line 313 of file TensorChainRouting.h.

References RestoreDummyHistory(), and savedDummyBondDims.

◆ SaveDummyState()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::SaveDummyState ( )

inlineprotected

Definition at line 308 of file TensorChainRouting.h.

References CaptureDummyHistory(), and savedDummyBondDims.

◆ SeedDummyHistory()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::SeedDummyHistory ( const std::vector< long long > & map )

inlineprotected

Definition at line 187 of file TensorChainRouting.h.

References CurrentBondDimensions(), dummyHistoryValid, dummySim, and InvalidateDummyHistory().

Referenced by RecordExecutedTwoQubitGate().

◆ setGrowthFactorGate()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::setGrowthFactorGate ( double factor )

inlineoverride

Definition at line 84 of file TensorChainRouting.h.

References dummySim, and growthFactorGate.

◆ setGrowthFactorSwap()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::setGrowthFactorSwap ( double factor )

inlineoverride

Definition at line 77 of file TensorChainRouting.h.

References dummySim, and growthFactorSwap.

◆ SetLookaheadDepth()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::SetLookaheadDepth ( int depth )

inlineoverride

Definition at line 53 of file TensorChainRouting.h.

References lookaheadDepth, and RefreshRoutingSettings().

Referenced by SetLookaheadDepthWithHeuristic().

◆ SetLookaheadDepthWithHeuristic()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::SetLookaheadDepthWithHeuristic ( int depth )

inlineoverride

Definition at line 60 of file TensorChainRouting.h.

References lookaheadDepth, lookaheadDepthWithHeuristic, and SetLookaheadDepth().

◆ SetSwapGatesRelabelQubits()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::SetSwapGatesRelabelQubits ( bool enabled )

inlineprotected

Definition at line 158 of file TensorChainRouting.h.

References ConfigureDummy(), dummySim, InvalidateDummyHistory(), and swapGatesRelabelQubits.

◆ ShouldTrackVirtualBonds()

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::ShouldTrackVirtualBonds ( ) const

inlineprotected

Definition at line 133 of file TensorChainRouting.h.

References trackVirtualBonds.

◆ SwapGatesRelabelQubits()

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::SwapGatesRelabelQubits ( ) const

inlineoverride

Definition at line 42 of file TensorChainRouting.h.

References swapGatesRelabelQubits.

◆ ValidateDummyHistoryMap()

template<class Backend>

void Simulators::Private::TensorChainRouting< Backend >::ValidateDummyHistoryMap ( )

inlineprotectednoexcept

Definition at line 143 of file TensorChainRouting.h.

References CurrentRoutingMap(), dummyHistoryValid, dummySim, InvalidateDummyHistory(), and trackVirtualBonds.

Member Data Documentation

◆ curMaxBondDim

template<class Backend>

size_t Simulators::Private::TensorChainRouting< Backend >::curMaxBondDim = 0

protected

Definition at line 371 of file TensorChainRouting.h.

Referenced by GetCurrentMaxBondDimension().

◆ decompositionDepth

template<class Backend>

unsigned Simulators::Private::TensorChainRouting< Backend >::decompositionDepth = 0

protected

Definition at line 375 of file TensorChainRouting.h.

Referenced by PlanMeetingPosition().

◆ dummyHistoryValid

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::dummyHistoryValid = false

protected

Definition at line 370 of file TensorChainRouting.h.

Referenced by CaptureDummyHistory(), InvalidateDummyHistory(), PlanMeetingPosition(), RecordExecutedTwoQubitGate(), ResetDummySimulator(), RestoreDummyHistory(), SeedDummyHistory(), and ValidateDummyHistoryMap().

◆ dummySim

template<class Backend>

std::unique_ptr<MPSDummySimulator> Simulators::Private::TensorChainRouting< Backend >::dummySim

protected

Definition at line 368 of file TensorChainRouting.h.

Referenced by CaptureDummyHistory(), ClearDummySimulator(), ConfigureDummy(), EnsureDummySimulator(), PlanMeetingPosition(), RecordExecutedTwoQubitGate(), RefreshRoutingSettings(), ResetDummySimulator(), RestoreDummyHistory(), SeedDummyHistory(), setGrowthFactorGate(), setGrowthFactorSwap(), SetSwapGatesRelabelQubits(), and ValidateDummyHistoryMap().

◆ growthFactorGate

template<class Backend>

double Simulators::Private::TensorChainRouting< Backend >::growthFactorGate = 0.7

protected

Definition at line 367 of file TensorChainRouting.h.

Referenced by ConfigureDummy(), getGrowthFactorGate(), and setGrowthFactorGate().

◆ growthFactorSwap

template<class Backend>

double Simulators::Private::TensorChainRouting< Backend >::growthFactorSwap = 1.

protected

Definition at line 367 of file TensorChainRouting.h.

Referenced by ConfigureDummy(), getGrowthFactorSwap(), and setGrowthFactorSwap().

◆ lookaheadDepth

template<class Backend>

int Simulators::Private::TensorChainRouting< Backend >::lookaheadDepth = 0

protected

Definition at line 365 of file TensorChainRouting.h.

Referenced by IsRoutingLookaheadEnabled(), PlanMeetingPosition(), RefreshRoutingSettings(), SetLookaheadDepth(), and SetLookaheadDepthWithHeuristic().

◆ lookaheadDepthWithHeuristic

template<class Backend>

int Simulators::Private::TensorChainRouting< Backend >::lookaheadDepthWithHeuristic = 0

protected

Definition at line 365 of file TensorChainRouting.h.

Referenced by PlanMeetingPosition(), and SetLookaheadDepthWithHeuristic().

◆ operatorChain

template<class Backend>

const bool Simulators::Private::TensorChainRouting< Backend >::operatorChain

protected

Definition at line 38 of file TensorChainRouting.h.

Referenced by TensorChainRouting(), EffectiveLookaheadMaxBondDimension(), EnsureDummySimulator(), MaxBondDimensionConfigKey(), and RefreshRoutingSettings().

◆ physicalBondCap

template<class Backend>

MPSDummySimulator::IndexType Simulators::Private::TensorChainRouting< Backend >::physicalBondCap = 0

protected

Definition at line 372 of file TensorChainRouting.h.

Referenced by ConfigureDummy(), EffectiveLookaheadMaxBondDimension(), PlanMeetingPosition(), and RefreshRoutingSettings().

◆ savedDummyBondDims

template<class Backend>

std::vector<double> Simulators::Private::TensorChainRouting< Backend >::savedDummyBondDims

protected

Definition at line 369 of file TensorChainRouting.h.

Referenced by ClearDummySimulator(), RestoreDummyState(), and SaveDummyState().

◆ swapGatesRelabelQubits

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::swapGatesRelabelQubits

protected

Definition at line 39 of file TensorChainRouting.h.

Referenced by TensorChainRouting(), ConfigureDummy(), RecordExecutedTwoQubitGate(), SetSwapGatesRelabelQubits(), and SwapGatesRelabelQubits().

◆ trackVirtualBonds

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::trackVirtualBonds = false

protected

Definition at line 373 of file TensorChainRouting.h.

Referenced by CaptureDummyHistory(), PlanMeetingPosition(), RecordExecutedTwoQubitGate(), RefreshRoutingSettings(), ResetDummySimulator(), RestoreDummyHistory(), ShouldTrackVirtualBonds(), and ValidateDummyHistoryMap().

◆ truncationWeight

template<class Backend>

double Simulators::Private::TensorChainRouting< Backend >::truncationWeight = 1.

protected

Definition at line 374 of file TensorChainRouting.h.

Referenced by ConfigureDummy(), and RefreshRoutingSettings().

◆ useOptimalMeetingPosition

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::useOptimalMeetingPosition = true

protected

Definition at line 366 of file TensorChainRouting.h.

Referenced by IsRoutingLookaheadEnabled(), PlanMeetingPosition(), and RefreshRoutingSettings().

◆ virtualBondsEnabled

template<class Backend>

bool Simulators::Private::TensorChainRouting< Backend >::virtualBondsEnabled = false

protected

Definition at line 373 of file TensorChainRouting.h.

Referenced by ConfigureDummy(), EffectiveLookaheadMaxBondDimension(), and RefreshRoutingSettings().

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

TensorChainRouting.h

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TensorChainRouting()

Member Function Documentation

◆ CaptureDummyHistory()

◆ ClearDummySimulator()

◆ ConfigureDummy()

◆ CurrentBondDimensions()

◆ CurrentRoutingMap()

◆ EffectiveLookaheadMaxBondDimension() [1/2]

◆ EffectiveLookaheadMaxBondDimension() [2/2]

◆ EnsureDummySimulator()

◆ GetCurrentMaxBondDimension()

◆ getGrowthFactorGate()

◆ getGrowthFactorSwap()

◆ InvalidateDummyHistory()

◆ IsExactSwapMatrix()

◆ IsRoutingLookaheadEnabled()

◆ MaxBondDimensionConfigKey()

◆ NativeGateSchmidtRank()

◆ PlanMeetingPosition()

◆ RecordExecutedTwoQubitGate()

◆ RefreshRoutingSettings()

◆ ResetDummySimulator()

◆ RestoreDummyHistory()

◆ RestoreDummyState()

◆ SaveDummyState()

◆ SeedDummyHistory()

◆ setGrowthFactorGate()

◆ setGrowthFactorSwap()

◆ SetLookaheadDepth()

◆ SetLookaheadDepthWithHeuristic()

◆ SetSwapGatesRelabelQubits()

◆ ShouldTrackVirtualBonds()

◆ SwapGatesRelabelQubits()

◆ ValidateDummyHistoryMap()

Member Data Documentation

◆ curMaxBondDim

◆ decompositionDepth

◆ dummyHistoryValid

◆ dummySim

◆ growthFactorGate

◆ growthFactorSwap

◆ lookaheadDepth

◆ lookaheadDepthWithHeuristic

◆ operatorChain

◆ physicalBondCap

◆ savedDummyBondDims

◆ swapGatesRelabelQubits

◆ trackVirtualBonds

◆ truncationWeight

◆ useOptimalMeetingPosition

◆ virtualBondsEnabled