Reset operation class. More...

#include <Reset.h>

Inheritance diagram for Circuits::Reset< Time >:

Collaboration diagram for Circuits::Reset< Time >:

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

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

Time	The time type used for operation timing.

See also: IOperation

Definition at line 33 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

qubits	The qubits to reset.
delay	The execution time of the operation.
resetTargets	Specifies what the qubits should be reset to (false \|0>, true \|1>, not specified \|0>).

Definition at line 44 of file Reset.h.

Member Function Documentation

◆ AffectedBits()

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

inlinevirtualinherited

Returns the affected bits.

Returns the affected classical bits.

Returns: The affected bits.

Reimplemented in 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 478 of file Operations.h.

◆ 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 138 of file Reset.h.

◆ CanAffectQuantumState()

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

inlinevirtualinherited

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

Definition at line 429 of file Operations.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 126 of file Reset.h.

References Circuits::IOperation< Time >::GetDelay(), GetQubits(), and GetResetTargets().

◆ 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

sim	The simulator to execute the operation on.
state	The current classical state.

See also: ISimulator; OperationState

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

Definition at line 58 of file Reset.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().

◆ 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>

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 109 of file Reset.h.

Referenced by Clone().

◆ 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 118 of file Reset.h.

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

◆ 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 87 of file Reset.h.

References Circuits::kReset.

◆ IsBranching()

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

inlinevirtualinherited

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 526 of file Operations.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 175 of file Reset.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.

◆ NeedsEntanglementForDistribution()

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

inlinevirtualinherited

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

Definition at line 446 of file Operations.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

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

Returns: A shared pointer to the remapped object.

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

Definition at line 150 of file Reset.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.

◆ 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

index	The index of the qubit to reset.
qubit	The qubit to reset.

Definition at line 185 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

qs	The qubits to reset.
resetTgts	Specifies what the qubits should be reset to (false \|0>, true \|1>, not specified \|0>).

Definition at line 97 of file Reset.h.

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

Reset.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Reset()

Member Function Documentation

◆ AffectedBits()

◆ AffectedQubits()

◆ CanAffectQuantumState()

◆ Clone()

◆ Execute()

◆ GetDelay()

◆ getptr()

◆ GetQubits()

◆ GetResetTargets()

◆ GetType()

◆ IsBranching()

◆ IsClifford()

◆ IsConditional()

◆ NeedsEntanglementForDistribution()

◆ Remap()

◆ SetDelay()

◆ SetQubit()

◆ SetQubits()