A conditional random generator. More...

#include <Conditional.h>

Inheritance diagram for Circuits::ConditionalRandomGen< Time >:

Collaboration diagram for Circuits::ConditionalRandomGen< Time >:

Public Member Functions
	ConditionalRandomGen (const std::shared_ptr< Random< Time > > &operation, const std::shared_ptr< ICondition > &condition, Time delay=0)
	Construct a new ConditionalRandomGen object.
std::vector< size_t >	AffectedBits () const override
	Get bits that are involved in the condition.
Types::qubits_vector	AffectedQubits () const override
	Get the quantum bits affected by the 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.
std::shared_ptr< ICondition >	GetCondition () const
	Get the condition for the conditional operation.
Types::time_type	GetDelay () const
	Get the delay of the operation.
std::shared_ptr< IOperation< Types::time_type > >	GetOperation () const
	Get the operation for the conditional operation.
std::shared_ptr< IOperation< Types::time_type > >	getptr ()
	Get a shared pointer to this object.
OperationType	GetType () const override
	Get the type of the operation.
bool	IsBranching () const override
	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.
bool	IsNoiseless () const
	Whether noise models skip this 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	SetCondition (const std::shared_ptr< ICondition > &cond)
	Set the condition for the conditional operation.
virtual void	SetDelay (Types::time_type d)
	Set the delay of the operation.
void	SetNoiseless (bool value=true)
	Mark the operation as exempt from injected gate noise.
void	SetOperation (const std::shared_ptr< IOperation< Types::time_type > > &op)
	Set the operation for the conditional operation.

Detailed Description

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

A conditional random generator.

A random generator that is executed only if a condition is met.

Template Parameters

Time	The type of the time parameter that is used for operations timing.

See also: IConditionalOperation

Definition at line 542 of file Conditional.h.

Constructor & Destructor Documentation

◆ ConditionalRandomGen()

template<typename Time = Types::time_type>

Circuits::ConditionalRandomGen< Time >::ConditionalRandomGen	(	const std::shared_ptr< Random< Time > > &	operation,
		const std::shared_ptr< ICondition > &	condition,
		Time	delay = 0 )

inline

Construct a new ConditionalRandomGen object.

Construct a new ConditionalRandomGen object with the given random generator, condition and delay.

Parameters

operation	The random generator to execute if the condition is met.
condition	The condition to check.
delay	The time required for the operation to complete.

See also: IConditionalOperation; Random; ICondition

Definition at line 557 of file Conditional.h.

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

Member Function Documentation

◆ AffectedBits()

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

inlineoverridevirtualinherited

Get bits that are involved in the condition.

Get the classical bits that are involved in the condition.

Returns: The bits involved.

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

Definition at line 341 of file Conditional.h.

◆ AffectedQubits()

template<typename Time = Types::time_type>

Types::qubits_vector Circuits::ConditionalRandomGen< Time >::AffectedQubits ( ) const

inlineoverridevirtual

Get the quantum bits affected by the operation.

Get the quantum bits affected by the operation. Returns an empty vector as the operation is not affecting any qubit. Implementation is required by the interface.

Returns: An empty vector as the operation is not affecting any qubit.

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

Definition at line 595 of file Conditional.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 >, Circuits::Circuit< Types::time_type >, Circuits::Delay< Time >, and Circuits::QuantumChannelOperation< Time >.

Definition at line 473 of file Operations.h.

◆ Clone()

template<typename Time = Types::time_type>

std::shared_ptr< IOperation< Time > > Circuits::ConditionalRandomGen< 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 580 of file Conditional.h.

References Clone(), Circuits::IConditionalOperation< Time >::GetCondition(), Circuits::IOperation< Time >::GetDelay(), and Circuits::IConditionalOperation< Time >::GetOperation().

Referenced by Clone().

◆ Execute()

void Circuits::IConditionalOperation< Types::time_type >::Execute	(	const std::shared_ptr< Simulators::ISimulator > &	sim,
		OperationState &	state ) const

inlineoverridevirtualinherited

Execute the operation.

Execute the operation if the condition is met with the specified classical state, in the specified simulator.

Parameters

sim	The simulator to execute the operation on.
state	The classical state to execute the operation on (check condition against it and if it has a classical result, put the results there).

See also: ISimulator; OperationState

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

Definition at line 267 of file Conditional.h.

◆ GetCondition()

std::shared_ptr< ICondition > Circuits::IConditionalOperation< Types::time_type >::GetCondition ( ) const

inlineinherited

Get the condition for the conditional operation.

Get the condition to check.

Returns: The condition to check.

See also: ICondition

Definition at line 330 of file Conditional.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 546 of file Operations.h.

Referenced by Circuits::NoOperation< Time >::Clone().

◆ GetOperation()

std::shared_ptr< IOperation< Types::time_type > > Circuits::IConditionalOperation< Types::time_type >::GetOperation ( ) const

inlineinherited

Get the operation for the conditional operation.

Get the operation to execute if the condition is met.

Returns: The operation to execute if the condition is met.

See also: IOperation

Definition at line 306 of file Conditional.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 535 of file Operations.h.

◆ GetType()

template<typename Time = Types::time_type>

OperationType Circuits::ConditionalRandomGen< Time >::GetType ( ) const

inlineoverridevirtual

Get the type of the operation.

Returns the type of the operation.

Returns: The type of the operation.

See also: OperationType

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

Definition at line 569 of file Conditional.h.

References Circuits::kConditionalRandomGen.

◆ IsBranching()

bool Circuits::IConditionalOperation< Types::time_type >::IsBranching ( ) const

inlineoverridevirtualinherited

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.

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

Definition at line 409 of file Conditional.h.

◆ IsClifford()

bool Circuits::IConditionalOperation< Types::time_type >::IsClifford ( ) const

inlineoverridevirtualinherited

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

◆ IsNoiseless()

bool Circuits::IOperation< Types::time_type >::IsNoiseless ( ) const

inlineinherited

Whether noise models skip this operation.

Returns: True if no gate noise is injected after this operation.

Definition at line 580 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 >, Circuits::Circuit< Types::time_type >, and Circuits::QuantumChannelOperation< Time >.

Definition at line 488 of file Operations.h.

◆ Remap()

std::shared_ptr< IOperation< Types::time_type > > Circuits::IConditionalOperation< 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 373 of file Conditional.h.

◆ SetCondition()

void Circuits::IConditionalOperation< Types::time_type >::SetCondition ( const std::shared_ptr< ICondition > & cond )

inlineinherited

Set the condition for the conditional operation.

Assigns the condition to check.

Parameters

cond	The assigned condition.

See also: ICondition

Definition at line 318 of file Conditional.h.

◆ SetDelay()

virtual void Circuits::IOperation< Types::time_type >::SetDelay ( Types::time_type d )

inlinevirtualinherited

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

◆ SetNoiseless()

void Circuits::IOperation< Types::time_type >::SetNoiseless ( bool value = true )

inlineinherited

Mark the operation as exempt from injected gate noise.

Noise models add no noise after a noiseless operation. This is for basis changes that belong to a non-Z measurement or reset rather than being gates in their own right. Gate copies (Clone, Remap) keep the mark.

Parameters

value True to exempt the operation from gate noise.

Definition at line 570 of file Operations.h.

◆ SetOperation()

void Circuits::IConditionalOperation< Types::time_type >::SetOperation ( const std::shared_ptr< IOperation< Types::time_type > > & op )

inlineinherited

Set the operation for the conditional operation.

Assigns the operation to execute if the condition is met.

Parameters

op	The assigned operation.

Definition at line 284 of file Conditional.h.

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

Conditional.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ConditionalRandomGen()

Member Function Documentation

◆ AffectedBits()

◆ AffectedQubits()

◆ CanAffectQuantumState()

◆ Clone()

◆ Execute()

◆ GetCondition()

◆ GetDelay()

◆ GetOperation()

◆ getptr()

◆ GetType()

◆ IsBranching()

◆ IsClifford()

◆ IsConditional()

◆ IsNoiseless()

◆ NeedsEntanglementForDistribution()

◆ Remap()

◆ SetCondition()

◆ SetDelay()

◆ SetNoiseless()

◆ SetOperation()