60 lines
1.5 KiB
Plaintext
60 lines
1.5 KiB
Plaintext
---
|
||
title: Oracle
|
||
description: API reference for qiskit.aqua.components.oracles.Oracle
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.oracles.Oracle
|
||
---
|
||
|
||
# Oracle
|
||
|
||
<Class id="qiskit.aqua.components.oracles.Oracle" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/oracles/oracle.py" signature="Oracle(*args, **kwargs)" modifiers="class">
|
||
Bases: `abc.ABC`
|
||
|
||
Base class for oracles.
|
||
|
||
This method should initialize the module and use an exception if a component of the module is not available.
|
||
|
||
**Parameters**
|
||
|
||
* **args** (*list*) – args
|
||
* **kwargs** (*dict*) – kwargs
|
||
|
||
## Methods
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.construct_circuit" signature="Oracle.construct_circuit()" modifiers="abstract">
|
||
Construct the oracle circuit.
|
||
|
||
**Returns**
|
||
|
||
A quantum circuit for the oracle.
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### ancillary\_register
|
||
|
||
<Attribute id="qiskit.aqua.components.oracles.Oracle.ancillary_register">
|
||
returns ancillary register
|
||
</Attribute>
|
||
|
||
### circuit
|
||
|
||
<Attribute id="qiskit.aqua.components.oracles.Oracle.circuit" />
|
||
|
||
### output\_register
|
||
|
||
<Attribute id="qiskit.aqua.components.oracles.Oracle.output_register">
|
||
returns output register
|
||
</Attribute>
|
||
|
||
### variable\_register
|
||
|
||
<Attribute id="qiskit.aqua.components.oracles.Oracle.variable_register">
|
||
returns variable register
|
||
</Attribute>
|
||
</Class>
|
||
|