braket.ir.jaqcd.shared_models module

class braket.ir.jaqcd.shared_models.SingleTarget(**data: Any)[source]

Bases: pydantic.main.BaseModel

Single target index.

target

The target index. This is an int >= 0.

Type

int

Examples

>>> SingleTarget(target=0)
target: conint(ge=0) = None
class braket.ir.jaqcd.shared_models.DoubleTarget(**data: Any)[source]

Bases: pydantic.main.BaseModel

Target indices of length 2.

targets

A list with two items and all items are int >= 0.

Type

List[int]

Examples

>>> DoubleTarget(targets=[0, 1])
targets: conlist(conint(ge=0), min_items=2, max_items=2) = None
class braket.ir.jaqcd.shared_models.MultiTarget(**data: Any)[source]

Bases: pydantic.main.BaseModel

Variable length target indices.

targets

A list with items that are all int >= 0.

Type

List[int]

Examples

>>> MultiTarget(targets=[0, 1])
targets: conlist(conint(ge=0), min_items=1) = None
class braket.ir.jaqcd.shared_models.OptionalMultiTarget(**data: Any)[source]

Bases: pydantic.main.BaseModel

Optional variable length target indices

targets

A list with items that are all int >= 0.

Type

Optional[List[int]]

Examples

>>> OptionalMultiTarget(targets=[0, 1])
targets: Optional[conlist(conint(ge=0), min_items=1)] = None
class braket.ir.jaqcd.shared_models.MultiControl(**data: Any)[source]

Bases: pydantic.main.BaseModel

Variable length control indices.

controls

A list with at least two items and all items are int >= 0.

Type

List[int]

Examples

>>> MultiControl(controls=[0, 1])
controls: conlist(conint(ge=0), min_items=1) = None
class braket.ir.jaqcd.shared_models.DoubleControl(**data: Any)[source]

Bases: pydantic.main.BaseModel

Control indices of length 2.

controls

A list with two items and all items are int >= 0.

Type

List[int]

Examples

>>> DoubleControl(targets=[0, 1])
controls: conlist(conint(ge=0), min_items=2, max_items=2) = None
class braket.ir.jaqcd.shared_models.SingleControl(**data: Any)[source]

Bases: pydantic.main.BaseModel

Single control index.

control

The control index. This is an int >= 0.

Type

int

Examples

>>> SingleControl(control=0)
control: conint(ge=0) = None
class braket.ir.jaqcd.shared_models.Angle(**data: Any)[source]

Bases: pydantic.main.BaseModel

Single angle in radians (floating point).

angle

The angle in radians. inf, -inf, and NaN are not allowable inputs.

Type

float

Examples

>>> Angle(angle=0.15)
angle: confloat(gt=float('-inf'), lt=float('inf')) = None
class braket.ir.jaqcd.shared_models.TwoDimensionalMatrix(**data: Any)[source]

Bases: pydantic.main.BaseModel

Two dimensional non-empty matrix.

matrix

Two dimensional matrix with complex entries. Each complex number is represented using a List[float] of size 2, with element[0] being the real part and element[1] imaginary. inf, -inf, and NaN are not allowable inputs for the element.

Type

List[List[List[float]]]

Examples

>>> TwoDimensionalMatrix(matrix=[[[0, 0], [1, 0]], [[1, 0], [0, 0]]])
matrix: conlist(conlist(conlist(confloat(gt=float('-inf'), lt=float('inf')), min_items=2, max_items=2), min_items=1), min_items=1) = None
class braket.ir.jaqcd.shared_models.Observable(**data: Any)[source]

Bases: pydantic.main.BaseModel

An observable. If given list is more than one element, this is the tensor product of each operator in the list.

observable

A list with at least one item and items are strings matching the observable regex or a two dimensional hermitian matrix with complex entries. Each complex number is represented using a List[float] of size 2, with element[0] being the real part and element[1] imaginary. inf, -inf, and NaN are not allowable inputs for the element.

Type

List[Union[str, List[List[List[float]]]]

Examples

>>> Observable(observable=["x"])
>>> Observable(observable=[[[0, 0], [1, 0]], [[1, 0], [0, 0]]])
observable: conlist(Union[constr(regex='(x|y|z|h|i)'), conlist(conlist(conlist(confloat(gt=float('-inf'), lt=float('inf')), min_items=2, max_items=2), min_items=2), min_items=2)], min_items=1) = None
class braket.ir.jaqcd.shared_models.MultiState(**data: Any)[source]

Bases: pydantic.main.BaseModel

A list of states in bitstring form.

states

Variable length list with all strings matching the state regex

Type

List[string]

Examples

>>> lMultiState(states=["10", "10"])
states: conlist(constr(regex='^[01]+$', min_length=1), min_items=1) = None