Maestro 0.1.0
Unified interface for quantum circuit simulation
Loading...
Searching...
No Matches
Circuits::Reset< Time > Class Template Reference

Reset operation class. More...

#include <Reset.h>

Inheritance diagram for Circuits::Reset< Time >:
Circuits::IOperation< Types::time_type >

Public Member Functions

 Reset (const Types::qubits_vector &qubits={}, Time delay=0, const std::vector< bool > &resetTargets={})
 Construct a new Reset object.
void Execute (const std::shared_ptr< Simulators::ISimulator > &sim, OperationState &state) const override
 Execute the operation.
OperationType GetType () const override
 Get the type of operation.
void SetQubits (const Types::qubits_vector &qs, const std::vector< bool > &resetTgts={})
 Set the qubits to reset and the values to reset them to.
const Types::qubits_vectorGetQubits () const
 Get the qubits to reset.
const std::vector< bool > & GetResetTargets () const
 Get the values to reset the qubits to.
std::shared_ptr< IOperation< Time > > Clone () const override
 Get a shared pointer to a clone of this object.
Types::qubits_vector AffectedQubits () const override
 Get the qubits affected by this operation.
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 override
 Get a shared pointer to a remapped operation.
bool IsClifford () const override
 Checks if the operation is a Clifford one.
Public Member Functions inherited from Circuits::IOperation< Types::time_type >
 IOperation (Types::time_type delay=0)
 Construct a new IOperation object.
virtual ~IOperation ()=default
 Destroy the IOperation object.
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 std::vector< size_t > AffectedBits () const
 Returns the affected bits.
std::shared_ptr< IOperation< Types::time_type > > getptr ()
 Get a shared pointer to this object.
Types::time_type GetDelay () const
 Get the delay of the operation.
void SetDelay (Types::time_type d)
 Set the delay of the operation.

Protected Member Functions

void SetQubit (size_t index, Types::qubit_t qubit)
 Set the qubit to reset.

Detailed Description

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

Reset operation class.

This operation can be used to reset qubits.

Template Parameters
TimeThe time type used for operation timing.
See also
IOperation

Definition at line 32 of file Reset.h.

Constructor & Destructor Documentation

◆ Reset()

template<typename Time = Types::time_type>
Circuits::Reset< Time >::Reset ( const Types::qubits_vector & qubits = {},
Time delay = 0,
const std::vector< bool > & resetTargets = {} )
inline

Construct a new Reset object.

This constructor creates a new Reset operation.

Parameters
qubitsThe qubits to reset.
delayThe execution time of the operation.
resetTargetsSpecifies what the qubits should be reset to (false |0>, true |1>, not specified |0>).

Definition at line 43 of file Reset.h.

Member Function Documentation

◆ AffectedQubits()

template<typename Time = Types::time_type>
Types::qubits_vector Circuits::Reset< Time >::AffectedQubits ( ) const
inlineoverridevirtual

Get the qubits affected by this operation.

This method returns the qubits affected by this operation, that is, the reset qubits.

Returns
The qubits affected by this operation.

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

Definition at line 130 of file Reset.h.

◆ Clone()

template<typename Time = Types::time_type>
std::shared_ptr< IOperation< Time > > Circuits::Reset< 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 118 of file Reset.h.

◆ Execute()

template<typename Time = Types::time_type>
void Circuits::Reset< Time >::Execute ( const std::shared_ptr< Simulators::ISimulator > & sim,
OperationState & state ) const
inlineoverridevirtual

Execute the operation.

This method executes the reset operation. It's done by a measurement that is then discarded, followed by an X gate applied if needed.

Parameters
simThe simulator to execute the operation on.
stateThe current classical state.
See also
ISimulator
OperationState

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

Definition at line 57 of file Reset.h.

◆ GetQubits()

template<typename Time = Types::time_type>
const Types::qubits_vector & Circuits::Reset< Time >::GetQubits ( ) const
inline

Get the qubits to reset.

This method returns the qubits to reset.

Returns
The qubits to reset.

Definition at line 101 of file Reset.h.

◆ GetResetTargets()

template<typename Time = Types::time_type>
const std::vector< bool > & Circuits::Reset< Time >::GetResetTargets ( ) const
inline

Get the values to reset the qubits to.

This method returns the values to reset the qubits to. false means |0>, true means |1>, not specified means |0>.

Returns
The values to reset the qubits to.

Definition at line 110 of file Reset.h.

◆ GetType()

template<typename Time = Types::time_type>
OperationType Circuits::Reset< Time >::GetType ( ) const
inlineoverridevirtual

Get the type of operation.

This method returns the type of operation.

Returns
The type of operation, reset type.
See also
OperationType

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

Definition at line 79 of file Reset.h.

◆ IsClifford()

template<typename Time = Types::time_type>
bool Circuits::Reset< Time >::IsClifford ( ) const
inlineoverridevirtual

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 from Circuits::IOperation< Types::time_type >.

Definition at line 167 of file Reset.h.

◆ Remap()

template<typename Time = Types::time_type>
std::shared_ptr< IOperation< Time > > Circuits::Reset< 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
inlineoverridevirtual

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
qubitsMapThe map of qubits to remap.
bitsMapThe map of classical bits to remap.
Returns
A shared pointer to the remapped object.

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

Definition at line 143 of file Reset.h.

◆ SetQubit()

template<typename Time = Types::time_type>
void Circuits::Reset< Time >::SetQubit ( size_t index,
Types::qubit_t qubit )
inlineprotected

Set the qubit to reset.

This method sets the qubit to reset at the specified index.

Parameters
indexThe index of the qubit to reset.
qubitThe qubit to reset.

Definition at line 177 of file Reset.h.

◆ SetQubits()

template<typename Time = Types::time_type>
void Circuits::Reset< Time >::SetQubits ( const Types::qubits_vector & qs,
const std::vector< bool > & resetTgts = {} )
inline

Set the qubits to reset and the values to reset them to.

This method sets the qubits to reset and the values to reset them to.

Parameters
qsThe qubits to reset.
resetTgtsSpecifies what the qubits should be reset to (false |0>, true |1>, not specified |0>).

Definition at line 89 of file Reset.h.


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