Circuits::IOperation< Time > Class Template Reference

The operation interface. More...

#include <Operations.h>

Inheritance 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 void	Execute (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state) const =0
	Execute the operation.
virtual OperationType	GetType () const
	Get the type of the operation.
virtual std::shared_ptr< IOperation< Time > >	Clone () const =0
	Get a shared pointer to a clone of this object.
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 bool	CanAffectQuantumState () const
	Find if the operation can affect the quantum state.
virtual bool	NeedsEntanglementForDistribution () const
	Find if the operation needs entanglement for distribution.
virtual bool	IsConditional () const
	Find if the operation is a conditional operation.
virtual Types::qubits_vector	AffectedQubits () const
	Returns the affected qubits.
virtual std::vector< size_t >	AffectedBits () const
	Returns the affected bits.
std::shared_ptr< IOperation< Time > >	getptr ()
	Get a shared pointer to this object.
Time	GetDelay () const
	Get the delay of the operation.
void	SetDelay (Time d)
	Set the delay of the operation.
virtual bool	IsClifford () const
	Checks if the operation is a Clifford one.

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

~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 481 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::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::MeasurementOperation< 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 >.

Definition at line 473 of file Operations.h.

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 >, and Circuits::Circuit< Types::time_type >.

Definition at line 432 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.

Implemented in Circuits::CCXGate< Time >, Circuits::CHGate< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::ConditionalGate< Time >, Circuits::ConditionalMeasurement< Time >, Circuits::ConditionalRandomGen< Time >, Circuits::CPGate< Time >, Circuits::CRxGate< Time >, Circuits::CRyGate< Time >, Circuits::CRzGate< Time >, Circuits::CSwapGate< Time >, Circuits::CSxDagGate< Time >, Circuits::CSxGate< Time >, Circuits::CUGate< Time >, Circuits::CXGate< Time >, Circuits::CYGate< Time >, Circuits::CZGate< Time >, Circuits::HadamardGate< Time >, Circuits::KGate< Time >, Circuits::MeasurementOperation< Time >, Circuits::NoOperation< Time >, Circuits::PhaseGate< Time >, Circuits::Random< Time >, Circuits::Reset< Time >, Circuits::RxGate< Time >, Circuits::RyGate< Time >, Circuits::RzGate< Time >, Circuits::SdgGate< Time >, Circuits::SGate< Time >, Circuits::SwapGate< Time >, Circuits::SxDagGate< Time >, Circuits::SxGate< Time >, Circuits::TdgGate< Time >, Circuits::TGate< Time >, Circuits::UGate< Time >, Circuits::XGate< Time >, Circuits::XGate< Types::time_type >, Circuits::YGate< Time >, and Circuits::ZGate< Time >.

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

Implemented in Circuits::CCXGate< Time >, Circuits::CHGate< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::CPGate< Time >, Circuits::CRxGate< Time >, Circuits::CRyGate< Time >, Circuits::CRzGate< Time >, Circuits::CSwapGate< Time >, Circuits::CSxDagGate< Time >, Circuits::CSxGate< Time >, Circuits::CUGate< Time >, Circuits::CXGate< Time >, Circuits::CYGate< Time >, Circuits::CZGate< Time >, Circuits::HadamardGate< Time >, Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::KGate< Time >, Circuits::MeasurementOperation< Time >, Circuits::NoOperation< Time >, Circuits::PhaseGate< Time >, Circuits::Random< Time >, Circuits::Reset< Time >, Circuits::RxGate< Time >, Circuits::RyGate< Time >, Circuits::RzGate< Time >, Circuits::SdgGate< Time >, Circuits::SGate< Time >, Circuits::SwapGate< Time >, Circuits::SxDagGate< Time >, Circuits::SxGate< Time >, Circuits::TdgGate< Time >, Circuits::TGate< Time >, Circuits::UGate< Time >, Circuits::XGate< Time >, Circuits::XGate< Types::time_type >, Circuits::YGate< Time >, and Circuits::ZGate< Time >.

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

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 490 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.

Get the type of the operation.

Returns

The type of the operation.

See also

OperationType

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::ConditionalGate< Time >, Circuits::ConditionalMeasurement< Time >, Circuits::ConditionalRandomGen< Time >, Circuits::IGateOperation< Time >, Circuits::IGateOperation< Types::time_type >, Circuits::MeasurementOperation< Time >, Circuits::Random< Time >, and Circuits::Reset< Time >.

Definition at line 399 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.

Reimplemented in Circuits::Circuit< Time >, Circuits::Circuit< Time >, Circuits::Circuit< Types::time_type >, Circuits::CXGate< Time >, Circuits::CYGate< Time >, Circuits::CZGate< Time >, Circuits::HadamardGate< Time >, Circuits::IConditionalOperation< Time >, Circuits::IConditionalOperation< Types::time_type >, Circuits::KGate< Time >, Circuits::MeasurementOperation< Time >, Circuits::NoOperation< Time >, Circuits::PhaseGate< Time >, Circuits::Random< Time >, Circuits::Reset< Time >, Circuits::SdgGate< Time >, Circuits::SGate< Time >, Circuits::SwapGate< Time >, Circuits::SxDagGate< Time >, Circuits::SxGate< Time >, Circuits::UGate< Time >, Circuits::XGate< Time >, Circuits::XGate< Types::time_type >, Circuits::YGate< Time >, and Circuits::ZGate< Time >.

Definition at line 519 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 461 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 >, and Circuits::Circuit< Types::time_type >.

Definition at line 449 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::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 >.

SetDelay()

template<typename Time = Types::time_type>

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

inline

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

---

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

• Operations.h