Coverage for src/braket/task_result/annealing_task_result.py : 100%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# Copyright 2019-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
2#
3# Licensed under the Apache License, Version 2.0 (the "License"). You
4# may not use this file except in compliance with the License. A copy of
5# the License is located at
6#
7# http://aws.amazon.com/apache2.0/
8#
9# or in the "license" file accompanying this file. This file is
10# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
11# ANY KIND, either express or implied. See the License for the specific
12# language governing permissions and limitations under the License
14from typing import List, Optional
16from pydantic import conint, conlist
18from braket.ir.annealing import ProblemType
19from braket.schema_common.schema_base import BraketSchemaBase
20from braket.task_result.additional_metadata import AdditionalMetadata
21from braket.task_result.task_metadata import TaskMetadata
24class AnnealingTaskResult(BraketSchemaBase):
25 """
26 The annealing task result schema.
28 Attributes:
29 solutions (List[int]): solutions of task result
30 solutionCounts (List[int]): the number of times the solutions occurred.
31 Default is None
32 values (List[float]): output or energy of the solutions
33 variableCount (int): the number of variables
34 taskMetadata (TaskMetadata): the task metadata
35 additionalMetadata (AdditionalMetadata): additional metadata of the task
37 """
39 solutions: List[conlist(conint(ge=-1, le=3), min_items=1)]
40 solutionCounts: Optional[List[conint(ge=0)]]
41 values: List[float]
42 variableCount: conint(ge=0)
43 problemType: ProblemType
44 taskMetadata: TaskMetadata
45 additionalMetadata: AdditionalMetadata