76 lines
3.6 KiB
Plaintext
76 lines
3.6 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
|
||
---
|
||
|
||
# qiskit.aqua.components.oracles.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">
|
||
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
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.__init__" signature="__init__(*args, **kwargs)" modifiers="abstract">
|
||
Initialize self. See help(type(self)) for accurate signature.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
||
| [`__init__`](#qiskit.aqua.components.oracles.Oracle.__init__ "qiskit.aqua.components.oracles.Oracle.__init__")(\*args, \*\*kwargs) | Initialize self. |
|
||
| [`construct_circuit`](#qiskit.aqua.components.oracles.Oracle.construct_circuit "qiskit.aqua.components.oracles.Oracle.construct_circuit")() | Construct the oracle circuit. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
|
||
| [`ancillary_register`](#qiskit.aqua.components.oracles.Oracle.ancillary_register "qiskit.aqua.components.oracles.Oracle.ancillary_register") | returns ancillary register |
|
||
| [`circuit`](#qiskit.aqua.components.oracles.Oracle.circuit "qiskit.aqua.components.oracles.Oracle.circuit") | |
|
||
| [`output_register`](#qiskit.aqua.components.oracles.Oracle.output_register "qiskit.aqua.components.oracles.Oracle.output_register") | returns output register |
|
||
| [`variable_register`](#qiskit.aqua.components.oracles.Oracle.variable_register "qiskit.aqua.components.oracles.Oracle.variable_register") | returns variable register |
|
||
|
||
### ancillary\_register
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.ancillary_register" signature="ancillary_register" modifiers="abstract property">
|
||
returns ancillary register
|
||
</Function>
|
||
|
||
### circuit
|
||
|
||
<Attribute id="qiskit.aqua.components.oracles.Oracle.circuit" />
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.construct_circuit" signature="construct_circuit()" modifiers="abstract">
|
||
Construct the oracle circuit.
|
||
|
||
**Returns**
|
||
|
||
A quantum circuit for the oracle.
|
||
</Function>
|
||
|
||
### output\_register
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.output_register" signature="output_register" modifiers="abstract property">
|
||
returns output register
|
||
</Function>
|
||
|
||
### variable\_register
|
||
|
||
<Function id="qiskit.aqua.components.oracles.Oracle.variable_register" signature="variable_register" modifiers="abstract property">
|
||
returns variable register
|
||
</Function>
|
||
</Class>
|
||
|