The operation interface. More...

#include <Operations.h>

Inheritance diagram for Circuits::IOperation< Time >:

Collaboration diagram for Circuits::IOperation< Time >:

Public Member Functions
	IOperation (Time delay=0)
	Construct a new IOperation object.
virtual	~IOperation ()=default
	Destroy the IOperation object.
virtual std::vector< size_t >	AffectedBits () const
	Returns the affected bits.
virtual Types::qubits_vector	AffectedQubits () const
	Returns the affected qubits.
virtual bool	CanAffectQuantumState () const
	Find if the operation can affect the quantum state.
virtual std::shared_ptr< IOperation< Time > >	Clone () const =0
	Get a shared pointer to a clone of this object.
virtual void	Execute (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state) const =0
	Execute the operation.
Time	GetDelay () const
	Get the delay of the operation.
std::shared_ptr< IOperation< Time > >	getptr ()
	Get a shared pointer to this object.
virtual OperationType	GetType () const
	Get the type of the operation.
virtual bool	IsBranching () const
	Checks if the operation is a branching one.
virtual bool	IsClifford () const
	Checks if the operation is a Clifford one.
virtual bool	IsConditional () const
	Find if the operation is a conditional operation.
bool	IsNoiseless () const
	Whether noise models skip this operation.
virtual bool	NeedsEntanglementForDistribution () const
	Find if the operation needs entanglement for distribution.
virtual std::shared_ptr< IOperation< Time > >	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.
virtual void	SetDelay (Time d)
	Set the delay of the operation.
void	SetNoiseless (bool value=true)
	Mark the operation as exempt from injected gate noise.

Detailed Description

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

The operation interface.

The operation interface along with implementation of some generic functions that apply to all operations.

Template Parameters

Time	The type of the time parameter.

See also: IOperation

Definition at line 401 of file Operations.h.

Constructor & Destructor Documentation

◆ IOperation()

template<typename Time = Types::time_type>

Circuits::IOperation< Time >::IOperation ( Time delay = 0 )

inline

Construct a new IOperation object.

Construct a new IOperation object with the specified execution time.

Parameters

delay The execution time of the operation.

Definition at line 410 of file Operations.h.

Referenced by Simulators::FusionRoutingOperation::FusionRoutingOperation().

◆ ~IOperation()

template<typename Time = Types::time_type>

virtual Circuits::IOperation< Time >::~IOperation ( )

virtualdefault

Destroy the IOperation object.

Destroy the IOperation object. It's a virtual destructor because this class is an abstract class that needs to be derived from.

Member Function Documentation

◆ AffectedBits()

template<typename Time = Types::time_type>

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

inlinevirtual

Returns the affected bits.

Returns the affected classical bits.

Returns: The affected bits.

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::MeasurementOperation< Time >, and Circuits::Random< Time >.

Definition at line 523 of file Operations.h.

◆ AffectedQubits()

template<typename Time = Types::time_type>

virtual Types::qubits_vector Circuits::IOperation< Time >::AffectedQubits ( ) const

inlinevirtual

Returns the affected qubits.

Returns the affected qubits by the operation.

Returns: A vector with the affected qubits.

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::ConditionalRandomGen< Time >, Circuits::Delay< Time >, Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::MeasurementOperation< Time >, Circuits::QuantumChannelOperation< Time >, Circuits::Reset< Time >, Circuits::SingleQubitGate< Time >, Circuits::SingleQubitGate< Types::time_type >, Circuits::ThreeQubitsGate< Time >, Circuits::ThreeQubitsGate< Types::time_type >, Circuits::TwoQubitsGate< Time >, Circuits::TwoQubitsGate< Types::time_type >, and Simulators::FusionRoutingOperation.

Definition at line 512 of file Operations.h.

Referenced by Circuits::Circuit< Time >::MoveMeasurementsAndResets(), and NeedsEntanglementForDistribution().

◆ CanAffectQuantumState()

template<typename Time = Types::time_type>

virtual bool Circuits::IOperation< Time >::CanAffectQuantumState ( ) const

inlinevirtual

Find if the operation can affect the quantum state.

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

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

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::Delay< Time >, and Circuits::QuantumChannelOperation< Time >.

Definition at line 473 of file Operations.h.

◆ Clone()

template<typename Time = Types::time_type>

virtual std::shared_ptr< IOperation< Time > > Circuits::IOperation< Time >::Clone ( ) const

pure virtual

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.

◆ Execute()

template<typename Time = Types::time_type>

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

pure virtual

Execute the operation.

Execute the operation on the specified simulator.

Parameters

sim	The simulator to execute the operation on.
state	The state of the operation.

See also: ISimulator; OperationState

◆ GetDelay()

template<typename Time = Types::time_type>

Time Circuits::IOperation< Time >::GetDelay ( ) const

inline

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 546 of file Operations.h.

Referenced by Circuits::ConditionalGate< Time >::Clone(), Circuits::ConditionalMeasurement< Time >::Clone(), Circuits::ConditionalRandomGen< Time >::Clone(), Circuits::MeasurementOperation< Time >::Clone(), Circuits::QuantumChannelOperation< Time >::Clone(), Circuits::Random< Time >::Clone(), Circuits::Reset< Time >::Clone(), and Circuits::Delay< Time >::GetDuration().

◆ getptr()

template<typename Time = Types::time_type>

std::shared_ptr< IOperation< Time > > Circuits::IOperation< Time >::getptr ( )

inline

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 535 of file Operations.h.

◆ GetType()

template<typename Time = Types::time_type>

virtual OperationType Circuits::IOperation< Time >::GetType ( ) const

inlinevirtual

Get the type of the operation.

Returns: The type of the operation.

See also: OperationType

Definition at line 439 of file Operations.h.

Referenced by CanAffectQuantumState(), IsConditional(), and NeedsEntanglementForDistribution().

◆ IsBranching()

template<typename Time = Types::time_type>

virtual bool Circuits::IOperation< Time >::IsBranching ( ) const

inlinevirtual

Checks if the operation is a branching one.

Checks if the 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.

Definition at line 607 of file Operations.h.

◆ IsClifford()

template<typename Time = Types::time_type>

virtual bool Circuits::IOperation< Time >::IsClifford ( ) const

inlinevirtual

Checks if the operation is a Clifford one.

Checks if the operation is a Clifford one, allowing to be simulated in a stabilizers simulator.

Returns: True if it can be applied in a stabilizers simulator, false otherwise.

Definition at line 594 of file Operations.h.

◆ IsConditional()

template<typename Time = Types::time_type>

virtual bool Circuits::IOperation< Time >::IsConditional ( ) const

inlinevirtual

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 500 of file Operations.h.

◆ IsNoiseless()

template<typename Time = Types::time_type>

bool Circuits::IOperation< Time >::IsNoiseless ( ) const

inline

Whether noise models skip this operation.

Returns: True if no gate noise is injected after this operation.

Definition at line 580 of file Operations.h.

◆ NeedsEntanglementForDistribution()

template<typename Time = Types::time_type>

virtual bool Circuits::IOperation< Time >::NeedsEntanglementForDistribution ( ) const

inlinevirtual

Find if the operation needs entanglement for distribution.

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

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

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, and Circuits::QuantumChannelOperation< Time >.

Definition at line 488 of file Operations.h.

◆ Remap()

template<typename Time = Types::time_type>

virtual std::shared_ptr< IOperation< Time > > Circuits::IOperation< Time >::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 virtual

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::Delay< Time >, Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::MeasurementOperation< Time >, Circuits::NoOperation< Time >, Circuits::QuantumChannelOperation< 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 >, Circuits::TwoQubitsGate< Types::time_type >, and Simulators::FusionRoutingOperation.

◆ SetDelay()

template<typename Time = Types::time_type>

virtual void Circuits::IOperation< Time >::SetDelay ( Time d )

inlinevirtual

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 557 of file Operations.h.

Referenced by Circuits::Delay< Time >::SetDuration().

◆ SetNoiseless()

template<typename Time = Types::time_type>

void Circuits::IOperation< Time >::SetNoiseless ( bool value = true )

inline

Mark the operation as exempt from injected gate noise.

Noise models add no noise after a noiseless operation. This is for basis changes that belong to a non-Z measurement or reset rather than being gates in their own right. Gate copies (Clone, Remap) keep the mark.

Parameters

value True to exempt the operation from gate noise.

Definition at line 570 of file Operations.h.

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

Operations.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IOperation()

◆ ~IOperation()

Member Function Documentation

◆ AffectedBits()

◆ AffectedQubits()

◆ CanAffectQuantumState()

◆ Clone()

◆ Execute()

◆ GetDelay()

◆ getptr()

◆ GetType()

◆ IsBranching()

◆ IsClifford()

◆ IsConditional()

◆ IsNoiseless()

◆ NeedsEntanglementForDistribution()

◆ Remap()

◆ SetDelay()

◆ SetNoiseless()