Source code for qiskit.aqua.components.uncertainty_problems.uncertainty_problem

# This code is part of Qiskit.
#
# (C) Copyright IBM 2018, 2020.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

"""
The abstract Uncertainty Problem component.
"""

import warnings
from abc import ABC
from qiskit.aqua.utils import CircuitFactory
from qiskit.aqua.utils.validation import validate_min

# pylint: disable=abstract-method


[docs]class UncertaintyProblem(CircuitFactory, ABC):
    """
    The abstract Uncertainty Problem component.
    """

    # pylint: disable=useless-super-delegation
[docs]    def __init__(self, num_qubits: int) -> None:
        warnings.warn('The {0} is deprecated as of Aqua 0.8.0 and will be removed no earlier than '
                      '3 months after the release date. Instead, you can construct the circuits '
                      'manually using the respective circuit components. See the tutorials for '
                      'examples: github.com/Qiskit/qiskit-tutorials/tree/master/tutorials/finance'
                      ''.format(self.__class__.__name__),
                      DeprecationWarning, stacklevel=3)
        validate_min('num_qubits', num_qubits, 1)

        with warnings.catch_warnings():
            warnings.filterwarnings('ignore', category=DeprecationWarning)
            super().__init__(num_qubits)

[docs]    def value_to_estimation(self, value):
        """ value to estimate """
        return value