The S gate. More...

#include <QuantumGates.h>

Inheritance diagram for Circuits::SGate< Time >:

Collaboration diagram for Circuits::SGate< Time >:

Public Member Functions
	SGate (Types::qubit_t qubit=0, Time delay=0)
	SGate 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.
Types::time_type	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< Types::time_type > >	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	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< Types::time_type > >	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	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::SGate< Time >

The S gate.

Template Parameters

Time	The type of the execution delay.

See also: SingleQubitGate

Definition at line 883 of file QuantumGates.h.

Constructor & Destructor Documentation

◆ SGate()

template<typename Time = Types::time_type>

Circuits::SGate< Time >::SGate	(	Types::qubit_t	qubit = 0,
		Time	delay = 0 )

inline

SGate constructor.

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

Parameters

qubit	The qubit the quantum gate is applied to.
delay	The time the quantum gate takes to execute.

See also: SingleQubitGate

Definition at line 894 of file QuantumGates.h.

References Circuits::SingleQubitGate< Types::time_type >::SingleQubitGate().

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()

Types::qubits_vector Circuits::SingleQubitGate< Types::time_type >::AffectedQubits ( ) const

inlineoverridevirtualinherited

Get the qubits the quantum gate is applied to.

Returns the qubits the quantum gate is applied to, in this case a single qubit.

Returns: The qubits the quantum gate is applied to.

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

Definition at line 176 of file QuantumGates.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::SGate< 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 929 of file QuantumGates.h.

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

◆ Execute()

template<typename Time = Types::time_type>

void Circuits::SGate< 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

sim	The simulator to execute the quantum gate on.
state	The classical state to execute the quantum gate with.

See also: ISimulator; ClassicalState

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

Definition at line 907 of file QuantumGates.h.

References Circuits::SingleQubitGate< Time >::GetQubit().

◆ 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().

◆ GetGateType()

template<typename Time = Types::time_type>

QuantumGateType Circuits::SGate< 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< Types::time_type >.

Definition at line 919 of file QuantumGates.h.

References Circuits::kSGateType.

◆ GetNumQubits()

unsigned int Circuits::SingleQubitGate< Types::time_type >::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 1.

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

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

Definition at line 142 of file QuantumGates.h.

◆ GetParams()

virtual std::vector< double > Circuits::IQuantumGate< Types::time_type >::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::ControlledRotationGate< Time >, Circuits::ControlledRotationGate< Types::time_type >, Circuits::CPGate< Time >, Circuits::CUGate< Time >, Circuits::PhaseGate< Time >, Circuits::RotationGate< Time >, Circuits::RotationGate< Types::time_type >, and Circuits::UGate< Time >.

Definition at line 99 of file QuantumGates.h.

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

◆ GetQubit()

Types::qubit_t Circuits::SingleQubitGate< Types::time_type >::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 for the index or leave it default. The parameter value is ignored anyway.

Parameters

index The index of the qubit to get (ignored, default 0).

Returns: The qubit the quantum gate is applied to.

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

Definition at line 165 of file QuantumGates.h.

◆ GetType()

OperationType Circuits::IGateOperation< Types::time_type >::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< Types::time_type >.

Definition at line 631 of file Operations.h.

◆ 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::SGate< 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 943 of file QuantumGates.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()

std::shared_ptr< IOperation< Types::time_type > > Circuits::SingleQubitGate< Types::time_type >::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

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 188 of file QuantumGates.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()

void Circuits::SingleQubitGate< Types::time_type >::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 for the index or leave it default.

Parameters

q	The qubit the quantum gate is applied to.
index	The index of the qubit to set (ignored, default 0).

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

Definition at line 152 of file QuantumGates.h.

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

QuantumGates.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SGate()

Member Function Documentation

◆ AffectedBits()

◆ AffectedQubits()

◆ CanAffectQuantumState()

◆ Clone()

◆ Execute()

◆ GetDelay()

◆ GetGateType()

◆ GetNumQubits()

◆ GetParams()

◆ getptr()

◆ GetQubit()

◆ GetType()

◆ IsBranching()

◆ IsClifford()

◆ IsConditional()

◆ NeedsEntanglementForDistribution()

◆ Remap()

◆ SetDelay()

◆ SetQubit()