loom.eka.utilities.enums

Copyright 2024 Entropica Labs Pte Ltd

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License 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.

class loom.eka.utilities.enums.BoolOp(*values)

Bases: str, Enum

BoolOp enum to specify operations on channels. Used in the “name” field of Circuit to indicate classical logic operations.

It is understood that AND, NAND, OR, NOR, and XOR can correspond to operations that reduce multiple bits to a single bit, while MATCH and NOT correspond to an operation on one bit only.

AND -> True when all channels are 1 NAND -> True when at least one channel is 0 OR -> True when at least one channel is 1 NOR -> True when all channels are 0 XOR -> True when an odd number of channels are 1

NOT -> True when the channel is 0 MATCH -> True when the channel is 1

AND = 'and'

MATCH = 'match'

NAND = 'nand'

NOR = 'nor'

NOT = 'not'

OR = 'or'

XOR = 'xor'

static mono_bit_list()

Return list of single-bit operations.

Return type:

list[BoolOp]

static multi_bit_list()

Return list of multi-bit operations.

Return type:

list[BoolOp]

class loom.eka.utilities.enums.DiagonalDirection(*values)

Bases: str, Enum

Diagonal direction indicator for Operations (e.g. Grow and Shrink).

BOTTOM_LEFT = 'bottom-left'

BOTTOM_RIGHT = 'bottom-right'

TOP_LEFT = 'top-left'

TOP_RIGHT = 'top-right'

property components

Return the two cardinal directions composing this diagonal.

direction_along_orientation(orientation)

Get the cardinal direction along the given orientation.

Return type:

Direction

classmethod from_directions(directions)

Get the diagonal direction from two cardinal directions. The two directions must be perpendicular.

Return type:

DiagonalDirection

classmethod from_vector(vector)

Get the diagonal direction from a 2D vector. The vector should have only two non-zero components in the first and the second dimension. The direction is determined by the sign of the components. The direction is returned as a DiagonalDirection enum.

Return type:

DiagonalDirection

mirror_across_orientation(orientation)

Get the mirrored diagonal direction across the given orientation.

Return type:

DiagonalDirection

opposite()

Get the opposite diagonal direction.

Return type:

DiagonalDirection

to_vector()

Convert the diagonal direction to a 2D vector.

Return type:

tuple[int, int]

class loom.eka.utilities.enums.Direction(*values)

Bases: str, Enum

Direction indicator for Operations (e.g. Grow and Shrink).

BOTTOM = 'bottom'

LEFT = 'left'

RIGHT = 'right'

TOP = 'top'

classmethod from_vector(vector, bottom_is_plus=True)

Get the direction from a 2D vector. The vector should have only one non-zero component in the first or the second dimension. The direction is determined by the non-zero component. The direction is returned as a Direction enum.

Return type:

Direction

mirror_across_orientation(orientation)

Get the mirrored direction across the given orientation.

Return type:

Direction

opposite()

Get the opposite direction.

Return type:

Direction

to_orientation()

Convert the direction to an orientation.

Return type:

Orientation

to_vector()

Convert the direction to a 2D vector.

Return type:

tuple[int, int]

class loom.eka.utilities.enums.Orientation(*values)

Bases: str, Enum

Orientation indicator for Operations (e.g. Split) and for Block initialization.

HORIZONTAL = 'horizontal'

VERTICAL = 'vertical'

classmethod from_direction(direction)

Get the orientation from a direction.

Return type:

Orientation

classmethod from_vector(vector)

Get the orientation from a 2D vector. The orientation is determined by the direction of the vector. The orientation is returned as an Orientation enum.

Return type:

Orientation

perpendicular()

Get the perpendicular orientation.

Return type:

Orientation

class loom.eka.utilities.enums.ResourceState(*values)

Bases: str, Enum

Supported states in state injection operations.

S = 's'

T = 't'

get_expectation_value(basis)

Get the expectation value of the state in the Pauli basis of the state.

Return type:

float

class loom.eka.utilities.enums.SingleQubitPauliEigenstate(*values)

Bases: str, Enum

Supported states in reset operations.

MINUS = '-'

MINUS_I = '-i'

ONE = '1'

PLUS = '+'

PLUS_I = '+i'

ZERO = '0'

property basis_expectation_value: int

Get the expectation value of the state in the Pauli basis of the state.

property pauli_basis: str

Get the Pauli basis of the state.

loom.eka.utilities.enums.enum_missing(cls, value)

This method is called when value is not found in the Enum. This could be the case when the input is not lower case but its lower case version is in the Enum. Therefore value is first converted to lower-case and then compared to the values in the Enum.

If no match is found, an exception is raised. Also note that the exception message is more informative than the default one since we here include the allowed values.