# Copyright 2019-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
from enum import Enum
from typing import Dict
from pydantic import BaseModel, conint
[docs]class ProblemType(str, Enum):
""" The type of annealing problem.
QUBO: Quadratic Unconstrained Binary Optimization, with values 1 and 0
ISING: Ising model, with values +/-1
"""
QUBO = "QUBO"
ISING = "ISING"
[docs]class Problem(BaseModel):
""" Specifies a quantum annealing problem.
Attributes:
- type: The type of problem; can be either "QUBO" or "ISING"
- linear: Linear terms of the model.
- quadratic: Quadratic terms of the model, keyed on comma-separated
variables as strings
Examples:
>>> Problem(type=ProblemType.QUBO, linear={0: 0.3, 4: -0.3}, quadratic={"0,5": 0.667})
"""
type: ProblemType
linear: Dict[conint(ge=0), float]
quadratic: Dict[str, float]