Circuit class for holding the sequence of operations. More...

#include <Circuit.h>

Inheritance diagram for Circuits::Circuit< Time >:

Collaboration diagram for Circuits::Circuit< Time >:

Public Types
using	allocator_type = typename OperationsVector::allocator_type
using	BitMapping
	The (qu)bit mapping for remapping.
using	const_iterator = typename OperationsVector::const_iterator
using	const_pointer = typename OperationsVector::const_pointer
using	const_reference = typename OperationsVector::const_reference
using	const_reverse_iterator
using	difference_type = typename OperationsVector::difference_type
using	ExecuteResults
	The results of the execution of the circuit.
using	iterator = typename OperationsVector::iterator
using	Operation = IOperation<Time>
	The operation type.
using	OperationPtr = std::shared_ptr<Operation>
	The shared pointer to the operation type.
using	OperationsVector
	The vector of operations.
using	pointer = typename OperationsVector::pointer
using	reference = typename OperationsVector::reference
using	reverse_iterator = typename OperationsVector::reverse_iterator
using	size_type = typename OperationsVector::size_type
using	value_type = typename OperationsVector::value_type

Public Member Functions
	Circuit (const OperationsVector &ops={})
	Construct a new Circuit object.
bool	ActsOnlyOnAdjacentQubits () const
	Checks if the circuit has only operations that act on adjacent qubits.
void	AddCircuit (const std::shared_ptr< Circuit< Time > > &circuit)
	Adds operations from another circuit to the circuit.
void	AddOperation (const OperationPtr &op)
	Adds an operation to the circuit.
void	AddOperations (const OperationsVector &ops)
	Adds operations to the circuit.
void	AddResetsAtBeginningIfNeeded (Time delay=0)
	Add resets at the beginning of the circuit.
void	AddResetsIfNeeded (Time delay=0)
	Add resets at the end of the circuit.
std::vector< size_t >	AffectedBits () const override
	Returns the affected bits.
Types::qubits_vector	AffectedQubits () const override
	Returns the affected qubits.
iterator	begin () noexcept
	Get the begin iterator for the operations.
bool	CanAffectQuantumState () const override
	Find if the circuit can affect the quantum state.
const_iterator	cbegin () const noexcept
	Get the const begin iterator for the operations.
const_iterator	cend () const noexcept
	Get the const end iterator for the operations.
void	Clear ()
	Clears the operations from the circuit.
double	CliffordPercentage () const
	Get the percentage of Clifford operations in the circuit.
OperationPtr	Clone () const override
	Get a shared pointer to a clone of this object.
OperationPtr	CloneFlyweight () const
	Get a shared pointer to a clone of this object, but without cloning the operations.
void	ConvertForCutting ()
	Converts the circuit for distributed computing.
void	ConvertForDistribution ()
	Converts the circuit for distributed computing.
const_reverse_iterator	crbegin () const noexcept
	Get the const reverse begin iterator for the operations.
const_reverse_iterator	crend () const noexcept
	Get the const reverse end iterator for the operations.
auto	empty () const
	Check if the circuit is empty.
iterator	end () noexcept
	Get the end iterator for the operations.
void	EnsureProperOrderForMeasurements ()
void	Execute (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state) const override
	Execute the circuit on the given simulator.
void	ExecuteMeasurements (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state, const std::vector< bool > &executedOps) const
	Execute the measurement operations from the circuit on the given simulator.
std::vector< bool >	ExecuteNonMeasurements (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state) const
	Execute the non-measurements operations from the circuit on the given simulator.
std::set< size_t >	GetBits () const
	Returns the classical bits affected by the operations.
std::shared_ptr< Circuit< Time > >	GetCircuitCut (Types::qubit_t startQubit, Types::qubit_t endQubit) const
	Get the circuit cut.
std::unordered_set< Types::qubit_t >	GetCliffordQubits () const
	Get the qubits that are acted on by Clifford operations.
Types::time_type	GetDelay () const
	Get the delay of the operation.
std::pair< std::vector< size_t >, std::vector< Time > >	GetDepth () const
	Get circuit depth.
std::unordered_map< size_t, OperationPtr >	GetFirstOperationsOnQubits () const
	Returns the first operations on circuit's qubits.
std::shared_ptr< MeasurementOperation< Time > >	GetLastMeasurements (const std::vector< bool > &executedOps, bool sort=true) const
std::unordered_map< size_t, OperationPtr >	GetLastOperationsOnQubits () const
	Returns the last operations on circuit's qubits.
size_t	GetMaxCbitIndex () const
	Returns the max classical bit id for all operations.
std::pair< size_t, Time >	GetMaxDepth () const
	Get max circuit depth.
size_t	GetMaxQubitIndex () const
	Returns the max qubit id for all operations.
size_t	GetMinCbitIndex () const
	Returns the min classical bit id for all operations.
size_t	GetMinQubitIndex () const
	Returns the min qubit id for all operations.
size_t	GetNumberOfOperations () const
	Get the number of operations in the circuit.
OperationPtr	GetOperation (size_t pos) const
	Get an operation at a given position.
const OperationsVector &	GetOperations () const
	Get the operations in the circuit.
std::shared_ptr< IOperation< Types::time_type > >	getptr ()
	Get a shared pointer to this object.
std::set< size_t >	GetQubits () const
	Returns the qubits affected by the operations.
OperationType	GetType () const override
	Get the type of the circuit.
bool	HasConditionalOperations () const
	Checks if the circuit has clasically conditional operations.
bool	HasOpsAfterMeasurements () const
	Checks if the circuit has measurements that are followed by operations that affect the measured qubits.
bool	IsBranching () const override
	Checks if any operation is a branching one.
bool	IsClifford () const override
	Checks if the circuit is a Clifford circuit.
virtual bool	IsConditional () const
	Find if the operation is a conditional operation.
bool	IsForest () const
	Checks if the circuit is a forest circuit.
void	MoveMeasurementsAndResets ()
	Move the measurements and resets closer to the beginning of the circuit.
bool	NeedsEntanglementForDistribution () const override
	Find if the circuit needs entanglement for distribution.
auto &	operator[] (size_t pos)
	Get the operation at a given position.
const auto &	operator[] (size_t pos) const
	Get the operation at a given position.
void	Optimize (bool optimizeRotationGates=true)
	Circuit optimization.
reverse_iterator	rbegin () noexcept
	Get the reverse begin iterator for the operations.
OperationPtr	Remap (const BitMapping &qubitsMap, const BitMapping &bitsMap={}) const override
	Get a shared pointer to a circuit remapped.
virtual std::shared_ptr< IOperation< Types::time_type > >	Remap (const std::unordered_map< Types::qubit_t, Types::qubit_t > &qubitsMap, const std::unordered_map< Types::qubit_t, Types::qubit_t > &bitsMap={}) const=0
	Get a shared pointer to a remapped operation.
std::shared_ptr< Circuit< Time > >	RemapToContinuous (BitMapping &newQubitsMap, BitMapping &reverseBitsMap, size_t &nrQubits, size_t &nrCbits) const
	Get a shared pointer to a circuit remapped to a continuous interval starting from zero.
std::shared_ptr< Circuits::Circuit< Time > >	RemoveExecutedOperations (std::vector< bool > &executedOps) const
	Returns a new circuit with the operations that were not yet executed.
reverse_iterator	rend () noexcept
	Get the reverse end iterator for the operations.
void	ReplaceOperation (size_t index, const OperationPtr &op)
	Replaces an operation in the circuit.
void	resize (size_t size)
	Resizes the circuit.
void	SetDelay (Types::time_type d)
	Set the delay of the operation.
void	SetOperations (const OperationsVector &ops)
	Set the operations in the circuit.
auto	size () const
	Get the number of operations in the circuit.
std::vector< std::shared_ptr< Circuit< Time > > >	SplitCircuit () const
	Splits a circuit that has disjoint subcircuits in it into separate circuits.
std::vector< std::shared_ptr< Circuits::Circuit< Time > > >	ToLayers () const
	Converts the circuit to layers.
std::vector< std::shared_ptr< Circuits::Circuit< Time > > >	ToLayersNoClone () const
	Converts the circuit to layers.
std::vector< std::shared_ptr< Circuits::Circuit< Time > > >	ToMultipleQubitsLayers () const
	Converts the circuit to layers oriented on multiple qubit gates.
std::vector< std::shared_ptr< Circuits::Circuit< Time > > >	ToMultipleQubitsLayersNoClone () const
	Converts the circuit to layers oriented on multiple qubit gates.

Static Public Member Functions
static void	AccumulateResults (ExecuteResults &results, const ExecuteResults &newResults)
	Accumulate the results of a circuit execution to already existing results.
static void	AccumulateResultsWithRemapBack (ExecuteResults &results, const ExecuteResults &newResults, const BitMapping &bitsMap={}, bool ignoreNotMapped=true, size_t sz=0)
	Accumulate the results of a circuit execution to already existing results with remapping.
static std::shared_ptr< Circuits::Circuit< Time > >	LayersToCircuit (const std::vector< std::shared_ptr< Circuits::Circuit< Time > > > &layers)
	Converts the layers back to a circuit.
static ExecuteResults	RemapResultsBack (const ExecuteResults &results, const BitMapping &bitsMap={}, bool ignoreNotMapped=false, size_t sz=0)
	Map back the results for a remapped circuit.

Detailed Description

template<typename Time = Types::time_type>
class Circuits::Circuit< Time >

Circuit class for holding the sequence of operations.

Contains a sequence of operations that can be executed, supplying a function that allows executing them in a simulator. Allows adding operations and converting them to prepare the circuit for distributed computing.

Template Parameters

Time	The time type used for operation timing.

See also: IOperation; ISimulator

Definition at line 46 of file Circuit.h.

Member Typedef Documentation

◆ allocator_type

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::allocator_type = typename OperationsVector::allocator_type

Definition at line 64 of file Circuit.h.

◆ BitMapping

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::BitMapping

Initial value:

 
std::unordered_map<Types::qubit_t,
                   Types::qubit_t>

The (qu)bit mapping for remapping.

Definition at line 52 of file Circuit.h.

◆ const_iterator

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::const_iterator = typename OperationsVector::const_iterator

Definition at line 73 of file Circuit.h.

◆ const_pointer

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::const_pointer = typename OperationsVector::const_pointer

Definition at line 66 of file Circuit.h.

◆ const_reference

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::const_reference = typename OperationsVector::const_reference

Definition at line 68 of file Circuit.h.

◆ const_reverse_iterator

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::const_reverse_iterator

Initial value:

typename OperationsVector::const_reverse_iterator

Definition at line 75 of file Circuit.h.

◆ difference_type

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::difference_type = typename OperationsVector::difference_type

Definition at line 70 of file Circuit.h.

◆ ExecuteResults

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::ExecuteResults

Initial value:

 
std::unordered_map<std::vector<bool>,
                   size_t>

The results of the execution of the circuit.

Definition at line 48 of file Circuit.h.

◆ iterator

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::iterator = typename OperationsVector::iterator

Definition at line 72 of file Circuit.h.

◆ Operation

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::Operation = IOperation<Time>

The operation type.

Definition at line 57 of file Circuit.h.

◆ OperationPtr

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::OperationPtr = std::shared_ptr<Operation>

The shared pointer to the operation type.

Definition at line 58 of file Circuit.h.

◆ OperationsVector

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::OperationsVector

Initial value:

std::vector<OperationPtr>

The vector of operations.

Definition at line 60 of file Circuit.h.

◆ pointer

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::pointer = typename OperationsVector::pointer

Definition at line 65 of file Circuit.h.

◆ reference

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::reference = typename OperationsVector::reference

Definition at line 67 of file Circuit.h.

◆ reverse_iterator

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::reverse_iterator = typename OperationsVector::reverse_iterator

Definition at line 74 of file Circuit.h.

◆ size_type

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::size_type = typename OperationsVector::size_type

Definition at line 69 of file Circuit.h.

◆ value_type

template<typename Time = Types::time_type>

using Circuits::Circuit< Time >::value_type = typename OperationsVector::value_type

Definition at line 63 of file Circuit.h.

Constructor & Destructor Documentation

◆ Circuit()

template<typename Time = Types::time_type>

Circuits::Circuit< Time >::Circuit ( const OperationsVector & ops = {} )

inline

Construct a new Circuit object.

Constructs a new Circuit object with the given operations.

Parameters

ops	The operations to add to the circuit.

See also: IOperation

Definition at line 85 of file Circuit.h.

Member Function Documentation

◆ AccumulateResults()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AccumulateResults	(	ExecuteResults &	results,
		const ExecuteResults &	newResults )

inlinestatic

Accumulate the results of a circuit execution to already existing results.

Accumulates the results of a circuit execution to already existing results.

Parameters

results	The existing results to accumulate to.
newResults	The new results to add to the existing results.

Definition at line 326 of file Circuit.h.

◆ AccumulateResultsWithRemapBack()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AccumulateResultsWithRemapBack	(	ExecuteResults &	results,
		const ExecuteResults &	newResults,
		const BitMapping &	bitsMap = {},
		bool	ignoreNotMapped = true,
		size_t	sz = 0 )

inlinestatic

Accumulate the results of a circuit execution to already existing results with remapping.

Accumulates the results of a circuit execution to already existing results with remapping back.

Parameters

results	The existing results to accumulate to.
newResults	The new results to add to the existing results.
bitsMap	The map of classical bits to remap.
ignoreNotMapped	If true, the results that are not in the map will be ignored.
sz	The size of the results vector.

Definition at line 345 of file Circuit.h.

◆ ActsOnlyOnAdjacentQubits()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::ActsOnlyOnAdjacentQubits ( ) const

inline

Checks if the circuit has only operations that act on adjacent qubits.

Checks if the circuit has only operations that act on adjacent qubits. Can be useful in picking up a tensor network contractor, for example. Also such a circuit is easier to simulate in a MPS simulator, since swap gates are not needed to be added to bring up the qubits next to each other before applying a two qubits gate.

Returns: True if the circuit has operations that are not gates, false otherwise.

Definition at line 1890 of file Circuit.h.

◆ AddCircuit()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AddCircuit ( const std::shared_ptr< Circuit< Time > > & circuit )

inline

Adds operations from another circuit to the circuit.

Parameters

circuit The circuit to add operations from.

Definition at line 162 of file Circuit.h.

◆ AddOperation()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AddOperation ( const OperationPtr & op )

inline

Adds an operation to the circuit.

Parameters

op	The operation to add.

See also: IOperation

Definition at line 121 of file Circuit.h.

Referenced by Circuits::ComparableCircuit< Time >::operator==().

◆ AddOperations()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AddOperations ( const OperationsVector & ops )

inline

Adds operations to the circuit.

Parameters

ops	The operations to add.

See also: IOperation

Definition at line 152 of file Circuit.h.

Referenced by AddCircuit().

◆ AddResetsAtBeginningIfNeeded()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AddResetsAtBeginningIfNeeded ( Time delay = 0 )

inline

Add resets at the beginning of the circuit.

Adds resets at the beginning of the circuit, on the qubits that don't have a reset operation already.

Parameters

delay The delay for the reset operation

Definition at line 737 of file Circuit.h.

◆ AddResetsIfNeeded()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::AddResetsIfNeeded ( Time delay = 0 )

inline

Add resets at the end of the circuit.

Adds resets at the end of the circuit, on the qubits that don't have a reset operation already.

Parameters

delay The delay for the reset operation

Definition at line 718 of file Circuit.h.

◆ AffectedBits()

template<typename Time = Types::time_type>

std::vector< size_t > Circuits::Circuit< Time >::AffectedBits ( ) const

inlineoverridevirtual

Returns the affected bits.

Returns the affected classical bits.

Returns: The affected bits.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 631 of file Circuit.h.

◆ AffectedQubits()

template<typename Time = Types::time_type>

Types::qubits_vector Circuits::Circuit< Time >::AffectedQubits ( ) const

inlineoverridevirtual

Returns the affected qubits.

Returns the affected qubits by the operation.

Returns: A vector with the affected qubits.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 614 of file Circuit.h.

◆ begin()

template<typename Time = Types::time_type>

iterator Circuits::Circuit< Time >::begin ( )

inlinenoexcept

Get the begin iterator for the operations.

Returns the begin iterator for the operations.

Returns: The begin iterator for the operations.

Definition at line 2448 of file Circuit.h.

Referenced by SplitCircuit().

◆ CanAffectQuantumState()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::CanAffectQuantumState ( ) const

inlineoverridevirtual

Find if the circuit can affect the quantum state.

Returns true if the circuit can affect the quantum state, false otherwise.

Returns: True if the circuit can affect the quantum state, false otherwise.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 665 of file Circuit.h.

◆ cbegin()

template<typename Time = Types::time_type>

const_iterator Circuits::Circuit< Time >::cbegin ( ) const

inlinenoexcept

Get the const begin iterator for the operations.

Returns the const begin iterator for the operations.

Returns: The const begin iterator for the operations.

Definition at line 2464 of file Circuit.h.

◆ cend()

template<typename Time = Types::time_type>

const_iterator Circuits::Circuit< Time >::cend ( ) const

inlinenoexcept

Get the const end iterator for the operations.

Returns the const end iterator for the operations.

Returns: The const end iterator for the operations.

Definition at line 2472 of file Circuit.h.

◆ Clear()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::Clear ( )

inline

Clears the operations from the circuit.

Removes all operations from the circuit.

Definition at line 180 of file Circuit.h.

◆ CliffordPercentage()

template<typename Time = Types::time_type>

double Circuits::Circuit< Time >::CliffordPercentage ( ) const

inline

Get the percentage of Clifford operations in the circuit.

Returns the percentage of Clifford operations in the circuit. Considers gates as Clifford if they are supported by the Clifford simulator.

Returns: The percentage of Clifford operations in the circuit.

Definition at line 1991 of file Circuit.h.

◆ Clone()

template<typename Time = Types::time_type>

OperationPtr Circuits::Circuit< Time >::Clone ( ) const

inlineoverridevirtual

Get a shared pointer to a clone of this object.

Returns a shared pointer to a copy of this object.

Returns: A shared pointer to this object.

Implements Circuits::IOperation< Types::time_type >.

Definition at line 188 of file Circuit.h.

◆ CloneFlyweight()

template<typename Time = Types::time_type>

OperationPtr Circuits::Circuit< Time >::CloneFlyweight ( ) const

inline

Get a shared pointer to a clone of this object, but without cloning the operations.

Returns a shared pointer to a copy of this object, flyweight stype.

Returns: A shared pointer to this object.

Definition at line 203 of file Circuit.h.

◆ ConvertForCutting()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::ConvertForCutting ( )

inline

Converts the circuit for distributed computing.

Converts the circuit for distributed computing using circuit cutting. Converts the three qubit gates to prepare the circuit for distributed computing.

Definition at line 401 of file Circuit.h.

◆ ConvertForDistribution()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::ConvertForDistribution ( )

inline

Converts the circuit for distributed computing.

Converts the circuit for distributed computing using quantum entanglement between hosts. Converts the swap gates and three qubit gates to prepare the circuit for distributed computing.

Definition at line 386 of file Circuit.h.

◆ crbegin()

template<typename Time = Types::time_type>

const_reverse_iterator Circuits::Circuit< Time >::crbegin ( ) const

inlinenoexcept

Get the const reverse begin iterator for the operations.

Returns the const reverse begin iterator for the operations.

Returns: The const reverse begin iterator for the operations.

Definition at line 2496 of file Circuit.h.

◆ crend()

template<typename Time = Types::time_type>

const_reverse_iterator Circuits::Circuit< Time >::crend ( ) const

inlinenoexcept

Get the const reverse end iterator for the operations.

Returns the const reverse end iterator for the operations.

Returns: The const reverse end iterator for the operations.

Definition at line 2506 of file Circuit.h.

◆ empty()

template<typename Time = Types::time_type>

auto Circuits::Circuit< Time >::empty ( ) const

inline

Check if the circuit is empty.

Returns true if the circuit is empty, false otherwise.

Returns: True if the circuit is empty, false otherwise.

Definition at line 2522 of file Circuit.h.

◆ end()

template<typename Time = Types::time_type>

iterator Circuits::Circuit< Time >::end ( )

inlinenoexcept

Get the end iterator for the operations.

Returns the end iterator for the operations.

Returns: The end iterator for the operations.

Definition at line 2456 of file Circuit.h.

Referenced by SplitCircuit().

◆ EnsureProperOrderForMeasurements()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::EnsureProperOrderForMeasurements ( )

inline

Definition at line 420 of file Circuit.h.

◆ Execute()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::Execute	(	const std::shared_ptr< Simulators::ISimulator > &	sim,
		OperationState &	state ) const

inlineoverridevirtual

Execute the circuit on the given simulator.

Executes the circuit on the given simulator.

Parameters

sim	The simulator to execute the circuit on.
state	The classical state containing the classical bits.

See also: ISimulator; OperationState

Implements Circuits::IOperation< Types::time_type >.

Definition at line 96 of file Circuit.h.

◆ ExecuteMeasurements()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::ExecuteMeasurements	(	const std::shared_ptr< Simulators::ISimulator > &	sim,
		OperationState &	state,
		const std::vector< bool > &	executedOps ) const

inline

Execute the measurement operations from the circuit on the given simulator.

Execute the measurements operations from the circuit on the given simulator.

Parameters

sim	The simulator to execute the circuit on.
state	The classical state containing the classical bits.

See also: ISimulator; OperationState

Definition at line 1781 of file Circuit.h.

◆ ExecuteNonMeasurements()

template<typename Time = Types::time_type>

std::vector< bool > Circuits::Circuit< Time >::ExecuteNonMeasurements	(	const std::shared_ptr< Simulators::ISimulator > &	sim,
		OperationState &	state ) const

inline

Execute the non-measurements operations from the circuit on the given simulator.

Parameters

sim	The simulator to execute the circuit on.
state	The classical state containing the classical bits.

Returns: A bool vector with the executed operations marked.

See also: ISimulator; OperationState

Definition at line 1677 of file Circuit.h.

◆ GetBits()

template<typename Time = Types::time_type>

std::set< size_t > Circuits::Circuit< Time >::GetBits ( ) const

inline

Returns the classical bits affected by the operations.

Returns: The bits affected by the operations

Definition at line 598 of file Circuit.h.

Referenced by AffectedBits().

◆ GetCircuitCut()

template<typename Time = Types::time_type>

std::shared_ptr< Circuit< Time > > Circuits::Circuit< Time >::GetCircuitCut	(	Types::qubit_t	startQubit,
		Types::qubit_t	endQubit ) const

inline

Get the circuit cut.

Cuts out a circuit from the current circuit, starting from the startQubit and ending at the endQubit. Throws an exception if there is an operation that affects both qubits inside and outside of the specified interval. The returned circuit contains only operations that act on the qubits in the specified interval.

Parameters

startQubit	The start qubit of the interval.
endQubit	The end qubit of the interval.

Returns: The circuit cut.

Definition at line 1562 of file Circuit.h.

◆ GetCliffordQubits()

template<typename Time = Types::time_type>

std::unordered_set< Types::qubit_t > Circuits::Circuit< Time >::GetCliffordQubits ( ) const

inline

Get the qubits that are acted on by Clifford operations.

Returns the qubits that are acted on only by Clifford operations. Considers gates as Clifford if they are supported by the Clifford simulator.

Returns: The qubits that are acted on only by Clifford operations.

Definition at line 2008 of file Circuit.h.

◆ GetDelay()

Types::time_type Circuits::IOperation< Types::time_type >::GetDelay ( ) const

inlineinherited

Get the delay of the operation.

Returns the delay due of the execution time of the operation.

Returns: The delay of the operation.

Definition at line 497 of file Operations.h.

Referenced by Circuits::NoOperation< Time >::Clone().

◆ GetDepth()

template<typename Time = Types::time_type>

std::pair< std::vector< size_t >, std::vector< Time > > Circuits::Circuit< Time >::GetDepth ( ) const

inline

Get circuit depth.

Returns the depth of the circuit as a pair of the depth and an estimate of time cost for each qubit. Should be considered only as an estimate.

Returns: The depth of the circuit as a pair of the depth and an estimate of time cost for each qubit.

Definition at line 1414 of file Circuit.h.

Referenced by GetMaxDepth().

◆ GetFirstOperationsOnQubits()

template<typename Time = Types::time_type>

std::unordered_map< size_t, OperationPtr > Circuits::Circuit< Time >::GetFirstOperationsOnQubits ( ) const

inline

Returns the first operations on circuit's qubits.

Returns: The first operations on circuit's qubits

Definition at line 697 of file Circuit.h.

Referenced by AddResetsAtBeginningIfNeeded().

◆ GetLastMeasurements()

template<typename Time = Types::time_type>

std::shared_ptr< MeasurementOperation< Time > > Circuits::Circuit< Time >::GetLastMeasurements	(	const std::vector< bool > &	executedOps,
		bool	sort = true ) const

inline

Definition at line 1832 of file Circuit.h.

◆ GetLastOperationsOnQubits()

template<typename Time = Types::time_type>

std::unordered_map< size_t, OperationPtr > Circuits::Circuit< Time >::GetLastOperationsOnQubits ( ) const

inline

Returns the last operations on circuit's qubits.

Returns: The last operations on circuit's qubits

Definition at line 679 of file Circuit.h.

Referenced by AddResetsIfNeeded().

◆ GetMaxCbitIndex()

template<typename Time = Types::time_type>

size_t Circuits::Circuit< Time >::GetMaxCbitIndex ( ) const

inline

Returns the max classical bit id for all operations.

Returns: The max classical bit id for all operations

Definition at line 543 of file Circuit.h.

Referenced by MoveMeasurementsAndResets().

◆ GetMaxDepth()

template<typename Time = Types::time_type>

std::pair< size_t, Time > Circuits::Circuit< Time >::GetMaxDepth ( ) const

inline

Get max circuit depth.

Returns the max depth of the circuit as a pair of the max depth and an estimate of max time cost. Should be considered only as an estimate.

Returns: The max depth of the circuit as a pair of the max depth and an estimate of time cost.

Definition at line 1514 of file Circuit.h.

◆ GetMaxQubitIndex()

template<typename Time = Types::time_type>

size_t Circuits::Circuit< Time >::GetMaxQubitIndex ( ) const

inline

Returns the max qubit id for all operations.

Returns: The max qubit id for all operations

Definition at line 507 of file Circuit.h.

Referenced by GetDepth(), and MoveMeasurementsAndResets().

◆ GetMinCbitIndex()

template<typename Time = Types::time_type>

size_t Circuits::Circuit< Time >::GetMinCbitIndex ( ) const

inline

Returns the min classical bit id for all operations.

Returns: The min classical bit id for all operations

Definition at line 561 of file Circuit.h.

◆ GetMinQubitIndex()

template<typename Time = Types::time_type>

size_t Circuits::Circuit< Time >::GetMinQubitIndex ( ) const

inline

Returns the min qubit id for all operations.

Returns: The min qubit id for all operations

Definition at line 525 of file Circuit.h.

◆ GetNumberOfOperations()

template<typename Time = Types::time_type>

size_t Circuits::Circuit< Time >::GetNumberOfOperations ( ) const

inline

Get the number of operations in the circuit.

Returns the number of operations in the circuit.

Returns: The number of operations in the circuit.

Definition at line 1533 of file Circuit.h.

◆ GetOperation()

template<typename Time = Types::time_type>

OperationPtr Circuits::Circuit< Time >::GetOperation ( size_t pos ) const

inline

Get an operation at a given position.

Returns the operation at the given position.

Parameters

pos	The position of the operation to get.

Returns: The operation at the given position.

Definition at line 1543 of file Circuit.h.

◆ GetOperations()

template<typename Time = Types::time_type>

const OperationsVector & Circuits::Circuit< Time >::GetOperations ( ) const

inline

Get the operations in the circuit.

Returns the operations in the circuit.

Returns: The operations in the circuit.

See also: IOperation

Definition at line 173 of file Circuit.h.

Referenced by IsBranching(), Circuits::ComparableCircuit< Time >::operator=(), Circuits::ComparableCircuit< Time >::operator==(), ToLayers(), ToLayersNoClone(), ToMultipleQubitsLayers(), and ToMultipleQubitsLayersNoClone().

◆ getptr()

std::shared_ptr< IOperation< Types::time_type > > Circuits::IOperation< Types::time_type >::getptr ( )

inlineinherited

Get a shared pointer to this object.

Returns a shared pointer to this object. The object needs to be already wrapped in a shared pointer.

Returns: A shared pointer to this object.

Definition at line 487 of file Operations.h.

◆ GetQubits()

template<typename Time = Types::time_type>

std::set< size_t > Circuits::Circuit< Time >::GetQubits ( ) const

inline

Returns the qubits affected by the operations.

Returns the qubits affected by the operations. They might not cover all qubits, there might be gaps. In such cases a remapping might be needed, for example in a scheduler.

Returns: The qubits affected by the operations

Definition at line 581 of file Circuit.h.

Referenced by AffectedQubits(), and SplitCircuit().

◆ GetType()

template<typename Time = Types::time_type>

OperationType Circuits::Circuit< Time >::GetType ( ) const

inlineoverridevirtual

Get the type of the circuit.

Returns the type of the circuit.

Returns: The type of the circuit.

See also: OperationType

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 112 of file Circuit.h.

Referenced by GetLastMeasurements().

◆ HasConditionalOperations()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::HasConditionalOperations ( ) const

inline

Checks if the circuit has clasically conditional operations.

Returns: True if the circuit has clasically conditional operations, false otherwise.

Definition at line 1867 of file Circuit.h.

◆ HasOpsAfterMeasurements()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::HasOpsAfterMeasurements ( ) const

inline

Checks if the circuit has measurements that are followed by operations that affect the measured qubits.

Returns: True if the circuit has measurements that are followed by operations that affect the measured qubits, false otherwise.

Definition at line 1602 of file Circuit.h.

◆ IsBranching()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::IsBranching ( ) const

inlineoverridevirtual

Checks if any operation is a branching one.

Checks if any operation is a branching one, meaning that it can lead to splitting paths (relevant for the path integral simulator).

Returns: True if it branches a path, false otherwise.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 2435 of file Circuit.h.

◆ IsClifford()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::IsClifford ( ) const

inlineoverridevirtual

Checks if the circuit is a Clifford circuit.

Checks if the circuit is a Clifford circuit. Considers gates as Clifford if they are supported by the Clifford simulator.

Returns: True if the circuit is a Clifford circuit, false otherwise.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 1975 of file Circuit.h.

◆ IsConditional()

virtual bool Circuits::IOperation< Types::time_type >::IsConditional ( ) const

inlinevirtualinherited

Find if the operation is a conditional operation.

Returns true if the operation is conditional, false otherwise.

Returns: True if the operation is conditional, false otherwise.

Definition at line 458 of file Operations.h.

◆ IsForest()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::IsForest ( ) const

inline

Checks if the circuit is a forest circuit.

Returns: True if the circuit is a forest circuit, false otherwise.

Definition at line 1922 of file Circuit.h.

◆ LayersToCircuit()

template<typename Time = Types::time_type>

std::shared_ptr< Circuits::Circuit< Time > > Circuits::Circuit< Time >::LayersToCircuit ( const std::vector< std::shared_ptr< Circuits::Circuit< Time > > > & layers )

inlinestatic

Converts the layers back to a circuit.

The layers are converted back to a circuit by joining the individual circuits into a single one.

Parameters

layers The layers to convert.

Returns: The circuit.

See also: Circuits::Circuit

Definition at line 2417 of file Circuit.h.

Referenced by Network::SimpleDisconnectedNetwork< Time, Controller >::OptimizeMPSInitialQubitsMap().

◆ MoveMeasurementsAndResets()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::MoveMeasurementsAndResets ( )

inline

Move the measurements and resets closer to the beginning of the circuit.

Moves the measurements and resets closer to the beginning of the circuit.

Definition at line 1278 of file Circuit.h.

◆ NeedsEntanglementForDistribution()

template<typename Time = Types::time_type>

bool Circuits::Circuit< Time >::NeedsEntanglementForDistribution ( ) const

inlineoverridevirtual

Find if the circuit needs entanglement for distribution.

Returns true if the circuit needs entanglement for distribution, false otherwise.

Returns: True if the circuit needs entanglement for distribution, false otherwise.

Reimplemented from Circuits::IOperation< Types::time_type >.

Definition at line 651 of file Circuit.h.

◆ operator[]() [1/2]

template<typename Time = Types::time_type>

auto & Circuits::Circuit< Time >::operator[] ( size_t pos )

inline

Get the operation at a given position.

Returns the operation at the given position.

Parameters

pos	The position of the operation to get.

Returns: The operation at the given position.

Definition at line 2531 of file Circuit.h.

◆ operator[]() [2/2]

template<typename Time = Types::time_type>

const auto & Circuits::Circuit< Time >::operator[] ( size_t pos ) const

inline

Get the operation at a given position.

Returns the operation at the given position.

Parameters

pos	The position of the operation to get.

Returns: The operation at the given position.

Definition at line 2540 of file Circuit.h.

◆ Optimize()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::Optimize ( bool optimizeRotationGates = true )

inline

Circuit optimization.

Optimizes the circuit. See qisikit aer for 'transpilling' when the circuit is flushed for some ideas.

Definition at line 756 of file Circuit.h.

◆ rbegin()

template<typename Time = Types::time_type>

reverse_iterator Circuits::Circuit< Time >::rbegin ( )

inlinenoexcept

Get the reverse begin iterator for the operations.

Returns the reverse begin iterator for the operations.

Returns: The reverse begin iterator for the operations.

Definition at line 2480 of file Circuit.h.

◆ Remap() [1/2]

template<typename Time = Types::time_type>

OperationPtr Circuits::Circuit< Time >::Remap	(	const BitMapping &	qubitsMap,
		const BitMapping &	bitsMap = {} ) const

inlineoverride

Get a shared pointer to a circuit remapped.

Returns a shared pointer to a copy of the circuit with qubits and classical bits changed according to the provided maps.

Parameters

qubitsMap	The map of qubits to remap.
bitsMap	The map of classical bits to remap.

Returns: A shared pointer to the remapped circuit.

Definition at line 221 of file Circuit.h.

◆ Remap() [2/2]

virtual std::shared_ptr< IOperation< Types::time_type > > Circuits::IOperation< Types::time_type >::Remap	(	const std::unordered_map< Types::qubit_t, Types::qubit_t > &	qubitsMap,
		const std::unordered_map< Types::qubit_t, Types::qubit_t > &	bitsMap = {} ) const

pure virtualinherited

Get a shared pointer to a remapped operation.

Returns a shared pointer to a copy of the operation with qubits and classical bits changed according to the provided maps.

Parameters

qubitsMap	The map of qubits to remap.
bitsMap	The map of classical bits to remap.

Returns: A shared pointer to the remapped object.

Implemented in Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::MeasurementOperation< Time >, Circuits::NoOperation< Time >, Circuits::Random< Time >, Circuits::Reset< Time >, Circuits::SingleQubitGate< Time >, Circuits::SingleQubitGate< Types::time_type >, Circuits::ThreeQubitsGate< Time >, Circuits::ThreeQubitsGate< Types::time_type >, Circuits::TwoQubitsGate< Time >, and Circuits::TwoQubitsGate< Types::time_type >.

◆ RemapResultsBack()

template<typename Time = Types::time_type>

ExecuteResults Circuits::Circuit< Time >::RemapResultsBack	(	const ExecuteResults &	results,
		const BitMapping &	bitsMap = {},
		bool	ignoreNotMapped = false,
		size_t	sz = 0 )

inlinestatic

Map back the results for a remapped circuit.

Maps back the results for a remapped circuit, using the provided map. The results are the results of the execution of the circuit without remapping.

Parameters

results	The results to map back.
bitsMap	The map of classical bits to remap.
ignoreNotMapped	If true, the results that are not in the map will be ignored.
sz	The size of the results vector.

Returns: The mapped back results.

See also: Circuit::Remap

Definition at line 294 of file Circuit.h.

◆ RemapToContinuous()

template<typename Time = Types::time_type>

std::shared_ptr< Circuit< Time > > Circuits::Circuit< Time >::RemapToContinuous	(	BitMapping &	newQubitsMap,
		BitMapping &	reverseBitsMap,
		size_t &	nrQubits,
		size_t &	nrCbits ) const

inline

Get a shared pointer to a circuit remapped to a continuous interval starting from zero.

Returns a shared pointer to a copy of the circuit with qubits and classical bits changed according to the provided maps.

Parameters

bitsMap The map of classical bits, to allow remapping the results back to the original circuit results.

Returns: A shared pointer to the remapped circuit.

Definition at line 242 of file Circuit.h.

◆ RemoveExecutedOperations()

template<typename Time = Types::time_type>

std::shared_ptr< Circuits::Circuit< Time > > Circuits::Circuit< Time >::RemoveExecutedOperations ( std::vector< bool > & executedOps ) const

inline

Returns a new circuit with the operations that were not yet executed.

The parameter is modified to reflect the newly created circuit, which contains only the operations that were not yet executed.

Parameters

executedOps A vector of bools indicating which operations were executed.

Returns: A new circuit with the operations that were not yet executed.

Definition at line 1808 of file Circuit.h.

◆ rend()

template<typename Time = Types::time_type>

reverse_iterator Circuits::Circuit< Time >::rend ( )

inlinenoexcept

Get the reverse end iterator for the operations.

Returns the reverse end iterator for the operations.

Returns: The reverse end iterator for the operations.

Definition at line 2488 of file Circuit.h.

◆ ReplaceOperation()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::ReplaceOperation	(	size_t	index,
		const OperationPtr &	op )

inline

Replaces an operation in the circuit.

Parameters

index	The index of the operation to replace.
op	The operation to replace with.

See also: IOperation

Definition at line 131 of file Circuit.h.

◆ resize()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::resize ( size_t size )

inline

Resizes the circuit.

Resizes the circuit, but it cannot make it larger, only smaller, by removing the last operations.

Parameters

size	The new size of the circuit.

Definition at line 2549 of file Circuit.h.

◆ SetDelay()

void Circuits::IOperation< Types::time_type >::SetDelay ( Types::time_type d )

inlineinherited

Set the delay of the operation.

Sets the delay due of the execution time of the operation.

Parameters

d	The delay of the operation.

Definition at line 505 of file Operations.h.

◆ SetOperations()

template<typename Time = Types::time_type>

void Circuits::Circuit< Time >::SetOperations ( const OperationsVector & ops )

inline

Set the operations in the circuit.

Sets the operations in the circuit.

Parameters

ops	The operations to set.

See also: IOperation

Definition at line 143 of file Circuit.h.

◆ size()

template<typename Time = Types::time_type>

auto Circuits::Circuit< Time >::size ( ) const

inline

Get the number of operations in the circuit.

Returns the number of operations in the circuit.

Returns: The number of operations in the circuit.

Definition at line 2514 of file Circuit.h.

Referenced by MoveMeasurementsAndResets(), and RemoveExecutedOperations().

◆ SplitCircuit()

template<typename Time = Types::time_type>

std::vector< std::shared_ptr< Circuit< Time > > > Circuits::Circuit< Time >::SplitCircuit ( ) const

inline

Splits a circuit that has disjoint subcircuits in it into separate circuits.

Returns: A vector of shared pointers to the separate circuits.

Definition at line 2035 of file Circuit.h.

◆ ToLayers()

template<typename Time = Types::time_type>

std::vector< std::shared_ptr< Circuits::Circuit< Time > > > Circuits::Circuit< Time >::ToLayers ( ) const

inline

Converts the circuit to layers.

The circuit is split in layers, each layer being a separate circuit. Operations are cloned.

Returns: The layers.

Definition at line 2133 of file Circuit.h.

◆ ToLayersNoClone()

template<typename Time = Types::time_type>

std::vector< std::shared_ptr< Circuits::Circuit< Time > > > Circuits::Circuit< Time >::ToLayersNoClone ( ) const

inline

Converts the circuit to layers.

The circuit is split in layers, each layer being a separate circuit. Operations are not cloned, the shared pointers point to the same operations as the ones from the circuit.

Returns: The layers.

Definition at line 2200 of file Circuit.h.

◆ ToMultipleQubitsLayers()

template<typename Time = Types::time_type>

std::vector< std::shared_ptr< Circuits::Circuit< Time > > > Circuits::Circuit< Time >::ToMultipleQubitsLayers ( ) const

inline

Converts the circuit to layers oriented on multiple qubit gates.

The circuit is split in layers, each layer being a separate circuit. Operations are cloned. It's not as ToLayers above, the order of the operations in a layer matters. If the one qubit gates would be contracted into the ones on more than one qubit, then it would be the situation of normal layers.

Returns: The layers.

Definition at line 2270 of file Circuit.h.

◆ ToMultipleQubitsLayersNoClone()

template<typename Time = Types::time_type>

std::vector< std::shared_ptr< Circuits::Circuit< Time > > > Circuits::Circuit< Time >::ToMultipleQubitsLayersNoClone ( ) const

inline

Converts the circuit to layers oriented on multiple qubit gates.

The circuit is split in layers, each layer being a separate circuit. Operations are not cloned. It's not as ToLayers above, the order of the operations in a layer matters. If the one qubit gates would be contracted into the ones on more than one qubit, then it would be the situation of normal layers.

Returns: The layers.

Definition at line 2341 of file Circuit.h.

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

Circuit.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ allocator_type

◆ BitMapping

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ difference_type

◆ ExecuteResults

◆ iterator

◆ Operation

◆ OperationPtr

◆ OperationsVector

◆ pointer

◆ reference

◆ reverse_iterator

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ Circuit()

Member Function Documentation

◆ AccumulateResults()

◆ AccumulateResultsWithRemapBack()

◆ ActsOnlyOnAdjacentQubits()

◆ AddCircuit()

◆ AddOperation()

◆ AddOperations()

◆ AddResetsAtBeginningIfNeeded()

◆ AddResetsIfNeeded()

◆ AffectedBits()

◆ AffectedQubits()

◆ begin()

◆ CanAffectQuantumState()

◆ cbegin()

◆ cend()

◆ Clear()

◆ CliffordPercentage()

◆ Clone()

◆ CloneFlyweight()

◆ ConvertForCutting()

◆ ConvertForDistribution()

◆ crbegin()

◆ crend()

◆ empty()

◆ end()

◆ EnsureProperOrderForMeasurements()

◆ Execute()

◆ ExecuteMeasurements()

◆ ExecuteNonMeasurements()

◆ GetBits()

◆ GetCircuitCut()

◆ GetCliffordQubits()

◆ GetDelay()

◆ GetDepth()

◆ GetFirstOperationsOnQubits()

◆ GetLastMeasurements()

◆ GetLastOperationsOnQubits()

◆ GetMaxCbitIndex()

◆ GetMaxDepth()

◆ GetMaxQubitIndex()

◆ GetMinCbitIndex()

◆ GetMinQubitIndex()

◆ GetNumberOfOperations()

◆ GetOperation()

◆ GetOperations()

◆ getptr()

◆ GetQubits()

◆ GetType()

◆ HasConditionalOperations()

◆ HasOpsAfterMeasurements()

◆ IsBranching()

◆ IsClifford()

◆ IsConditional()

◆ IsForest()

◆ LayersToCircuit()

◆ MoveMeasurementsAndResets()