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

The controlled Sx gate. More...

#include <QuantumGates.h>

+ Inheritance diagram for Circuits::CSxGate< Time >:
+ Collaboration diagram for Circuits::CSxGate< Time >:

Public Member Functions

 CSxGate (Types::qubit_t ctrl=0, Types::qubit_t target=1, Time delay=0)
 CSxGate constructor.
 
virtual std::vector< size_t > AffectedBits () const
 Returns the affected bits.
 
Types::qubits_vector AffectedQubits () const override
 Get the qubits the quantum gate is applied to.
 
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 quantum gate.
 
Time GetDelay () const
 Get the delay of the operation.
 
QuantumGateType GetGateType () const override
 Get the type of the quantum gate.
 
unsigned int GetNumQubits () const override
 Get the number of qubits the quantum gate is applied to.
 
virtual std::vector< double > GetParams () const
 Get the gate parameters.
 
std::shared_ptr< IOperation< Time > > getptr ()
 Get a shared pointer to this object.
 
Types::qubit_t GetQubit (unsigned int index=0) const override
 Get the qubit the quantum gate is applied to.
 
OperationType GetType () const override
 Get the type of the operation.
 
virtual bool IsClifford () const
 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 (Time d)
 Set the delay of the operation.
 
void SetQubit (Types::qubit_t q, unsigned long index=0) override
 Set the qubit the quantum gate is applied to.
 

Detailed Description

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

The controlled Sx gate.

The controlled Sx gate.

Template Parameters
TimeThe type of the execution delay.
See also
TwoQubitsGate

Definition at line 2484 of file QuantumGates.h.

Constructor & Destructor Documentation

◆ CSxGate()

template<typename Time = Types::time_type>
Circuits::CSxGate< Time >::CSxGate ( Types::qubit_t  ctrl = 0,
Types::qubit_t  target = 1,
Time  delay = 0 
)
inline

CSxGate constructor.

Constructs the controlled Sx gate object. If specified, the delay is the time the quantum gate takes to execute.

Parameters
ctrlThe control qubit the quantum gate is applied to.
targetThe target qubit the quantum gate is applied to.
delayThe time the quantum gate takes to execute.
See also
TwoQubitsGate

Definition at line 2496 of file QuantumGates.h.

Member Function Documentation

◆ AffectedBits()

template<typename Time = Types::time_type>
virtual std::vector< size_t > Circuits::IOperation< Time >::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::TwoQubitsGate< Time >::AffectedQubits ( ) const
inlineoverridevirtualinherited

Get the qubits the quantum gate is applied to.

Returns the qubits the quantum gate is applied to, in this case two qubits.

Returns
The qubits the quantum gate is applied to.

Reimplemented from Circuits::IOperation< Time >.

Definition at line 291 of file QuantumGates.h.

◆ CanAffectQuantumState()

template<typename Time = Types::time_type>
virtual bool Circuits::IOperation< Time >::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.

References Circuits::IOperation< Time >::GetType(), Circuits::kComposite, Circuits::kConditionalGate, Circuits::kConditionalMeasurement, Circuits::kGate, Circuits::kMeasurement, and Circuits::kReset.

◆ Clone()

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

Definition at line 2532 of file QuantumGates.h.

References Circuits::IOperation< Time >::GetDelay(), and Circuits::TwoQubitsGate< Time >::GetQubit().

◆ Execute()

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

Execute the quantum gate.

Executes the quantum gate on the given simulator with the given classical state.

Parameters
simThe simulator to execute the quantum gate on.
stateThe classical state to execute the quantum gate with.
See also
ISimulator
ClassicalState

Implements Circuits::IOperation< Time >.

Definition at line 2509 of file QuantumGates.h.

◆ GetDelay()

template<typename Time = Types::time_type>
Time Circuits::IOperation< Time >::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::ConditionalGate< Time >::Clone(), Circuits::MeasurementOperation< Time >::Clone(), Circuits::NoOperation< Time >::Clone(), Circuits::PhaseGate< Time >::Clone(), Circuits::XGate< Time >::Clone(), Circuits::YGate< Time >::Clone(), Circuits::ZGate< Time >::Clone(), Circuits::HadamardGate< Time >::Clone(), Circuits::SGate< Time >::Clone(), Circuits::SdgGate< Time >::Clone(), Circuits::TGate< Time >::Clone(), Circuits::TdgGate< Time >::Clone(), Circuits::SxGate< Time >::Clone(), Circuits::SxDagGate< Time >::Clone(), Circuits::KGate< Time >::Clone(), Circuits::RxGate< Time >::Clone(), Circuits::RyGate< Time >::Clone(), Circuits::RzGate< Time >::Clone(), Circuits::UGate< Time >::Clone(), Circuits::SwapGate< Time >::Clone(), Circuits::CXGate< Time >::Clone(), Circuits::CYGate< Time >::Clone(), Circuits::CZGate< Time >::Clone(), Circuits::CPGate< Time >::Clone(), Circuits::CRxGate< Time >::Clone(), Circuits::CRyGate< Time >::Clone(), Circuits::CRzGate< Time >::Clone(), Circuits::CHGate< Time >::Clone(), Circuits::CSxGate< Time >::Clone(), Circuits::CSxDagGate< Time >::Clone(), Circuits::CUGate< Time >::Clone(), Circuits::CCXGate< Time >::Clone(), Circuits::CSwapGate< Time >::Clone(), Circuits::Random< Time >::Clone(), Circuits::Reset< Time >::Clone(), and Circuits::ComparableCircuit< Time >::operator==().

◆ GetGateType()

template<typename Time = Types::time_type>
QuantumGateType Circuits::CSxGate< Time >::GetGateType ( ) const
inlineoverridevirtual

Get the type of the quantum gate.

Returns the type of the quantum gate.

Returns
The type of the quantum gate.
See also
QuantumGateType

Implements Circuits::IQuantumGate< Time >.

Definition at line 2522 of file QuantumGates.h.

References Circuits::kCSxGateType.

◆ GetNumQubits()

template<typename Time = Types::time_type>
unsigned int Circuits::TwoQubitsGate< Time >::GetNumQubits ( ) const
inlineoverridevirtualinherited

Get the number of qubits the quantum gate is applied to.

Returns the number of qubits the quantum gate is applied to, in this case 2.

Returns
The number of qubits the quantum gate is applied to: 2.

Implements Circuits::IGateOperation< Time >.

Definition at line 250 of file QuantumGates.h.

◆ GetParams()

template<typename Time = Types::time_type>
virtual std::vector< double > Circuits::IQuantumGate< Time >::GetParams ( ) const
inlinevirtualinherited

Get the gate parameters.

Returns the parameters of the gate.

Returns
A vector with the parameters of the gate, empty if there are no parameters.

Reimplemented in Circuits::PhaseGate< Time >, Circuits::RotationGate< Time >, Circuits::RotationGate< Types::time_type >, Circuits::UGate< Time >, Circuits::CPGate< Time >, Circuits::ControlledRotationGate< Time >, Circuits::ControlledRotationGate< Types::time_type >, and Circuits::CUGate< Time >.

Definition at line 99 of file QuantumGates.h.

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

◆ getptr()

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

◆ GetQubit()

template<typename Time = Types::time_type>
Types::qubit_t Circuits::TwoQubitsGate< Time >::GetQubit ( unsigned int  index = 0) const
inlineoverridevirtualinherited

Get the qubit the quantum gate is applied to.

Returns the qubit the quantum gate is applied to. Either specify zero or one for the index or leave it default (0). If anything else is used, it will return UINT_MAX.

Parameters
indexThe index of the qubit to get (0 or 1, default value 0).
Returns
The qubit the quantum gate is applied to.

Implements Circuits::IGateOperation< Time >.

Definition at line 276 of file QuantumGates.h.

Referenced by Circuits::SwapGate< Time >::Clone(), Circuits::CXGate< Time >::Clone(), Circuits::CYGate< Time >::Clone(), Circuits::CZGate< Time >::Clone(), Circuits::CPGate< Time >::Clone(), Circuits::CRxGate< Time >::Clone(), Circuits::CRyGate< Time >::Clone(), Circuits::CRzGate< Time >::Clone(), Circuits::CHGate< Time >::Clone(), Circuits::CSxGate< Time >::Clone(), Circuits::CSxDagGate< Time >::Clone(), and Circuits::CUGate< Time >::Clone().

◆ GetType()

template<typename Time = Types::time_type>
OperationType Circuits::IGateOperation< Time >::GetType ( ) const
inlineoverridevirtualinherited

Get the type of the operation.

Get the type of the operation, in this case, gate.

Returns
The type of the operation, gate in this case.
See also
OperationType

Reimplemented from Circuits::IOperation< Time >.

Definition at line 621 of file Operations.h.

References Circuits::kGate.

◆ IsClifford()

◆ IsConditional()

template<typename Time = Types::time_type>
virtual bool Circuits::IOperation< Time >::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.

References Circuits::IOperation< Time >::GetType(), Circuits::kConditionalGate, Circuits::kConditionalMeasurement, and Circuits::kConditionalRandomGen.

◆ NeedsEntanglementForDistribution()

template<typename Time = Types::time_type>
virtual bool Circuits::IOperation< Time >::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.

References Circuits::IOperation< Time >::AffectedQubits(), Circuits::IOperation< Time >::GetType(), Circuits::kConditionalGate, and Circuits::kGate.

◆ Remap()

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

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

Definition at line 305 of file QuantumGates.h.

◆ SetDelay()

template<typename Time = Types::time_type>
void Circuits::IOperation< Time >::SetDelay ( Time  d)
inlineinherited

Set the delay of the operation.

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

Parameters
dThe delay of the operation.

Definition at line 505 of file Operations.h.

◆ SetQubit()

template<typename Time = Types::time_type>
void Circuits::TwoQubitsGate< Time >::SetQubit ( Types::qubit_t  q,
unsigned long  index = 0 
)
inlineoverridevirtualinherited

Set the qubit the quantum gate is applied to.

Sets the qubit the quantum gate is applied to. Either specify zero or one for the index or leave it default (0).

Parameters
qThe qubit the quantum gate is applied to.
indexThe index of the qubit to set (0 or 1, default value 0).

Implements Circuits::IGateOperation< Time >.

Definition at line 260 of file QuantumGates.h.


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