Skip to main contentIBM Quantum Documentation
This page is from an old version of Qiskit SDK and does not exist in the latest version. We recommend you migrate to the latest version. See the release notes for more information.

qiskit.aqua.algorithms.Simon

class Simon(oracle, quantum_instance=None)

GitHub

The Simon algorithm.

The Simon algorithm finds a hidden integer s{0,1}ns \in \{0,1\}^n from an oracle fsf_s that satisfies fs(x)=fs(y)f_s(x) = f_s(y) if and only if y=xsy=x \oplus s for all x{0,1}nx \in \{0,1\}^n. Thus, if s=00s = 0\ldots 0, i.e., the all-zero bitstring, then fsf_s is a 1-to-1 (or, permutation) function. Otherwise, if s00s \neq 0\ldots 0, then fsf_s is a 2-to-1 function.

Note: the TruthTableOracle may be the easiest to use to create one that can be used with the Simon algorithm.

Parameters

  • oracle (Oracle) – The oracle component
  • quantum_instance (Union[QuantumInstance, Backend, BaseBackend, None]) – Quantum Instance or Backend

__init__

__init__(oracle, quantum_instance=None)

Parameters

  • oracle (Oracle) – The oracle component
  • quantum_instance (Union[QuantumInstance, Backend, BaseBackend, None]) – Quantum Instance or Backend

Methods

__init__(oracle[, quantum_instance])type oracleOracle
construct_circuit([measurement])Construct the quantum circuit
run([quantum_instance])Execute the algorithm with selected backend.
set_backend(backend, **kwargs)Sets backend with configuration.

Attributes

backendReturns backend.
quantum_instanceReturns quantum instance.
randomReturn a numpy random.

backend

Returns backend.

Return type

Union[Backend, BaseBackend]

construct_circuit

construct_circuit(measurement=False)

Construct the quantum circuit

Parameters

measurement (bool) – Boolean flag to indicate if measurement should be included in the circuit.

Returns

the QuantumCircuit object for the constructed circuit

Return type

QuantumCircuit

quantum_instance

Returns quantum instance.

Return type

Optional[QuantumInstance]

random

Return a numpy random.

run

run(quantum_instance=None, **kwargs)

Execute the algorithm with selected backend.

Parameters

  • quantum_instance (Union[QuantumInstance, Backend, BaseBackend, None]) – the experimental setting.
  • kwargs (dict) – kwargs

Returns

results of an algorithm.

Return type

dict

Raises

AquaError – If a quantum instance or backend has not been provided

set_backend

set_backend(backend, **kwargs)

Sets backend with configuration.

Return type

None

Was this page helpful?
Report a bug or request content on GitHub.