QInt

qualtran.QInt

View source on GitHub

Signed Integer of a given width bitsize.

Inherits From: QDType, QCDType

qualtran.QInt(
    bitsize
)

A two’s complement representation is used for negative integers.

Here (and throughout Qualtran), we use a big-endian bit convention. The most significant bit is at index 0.

Attributes

bitsize

The number of qubits used to represent the integer.

num_bits

 

num_cbits

Number of classical bits required to represent a single instance of this data type.

num_qubits

Number of qubits required to represent a single instance of this data type.

Methods

is_symbolic

View source

is_symbolic() -> bool

Returns True if this dtype is parameterized with symbolic objects.

get_classical_domain

View source

get_classical_domain() -> Iterable[int]

Yields all possible classical (computational basis state) values representable by this type.

to_bits

View source

to_bits(
    x: int
) -> List[int]

Yields individual bits corresponding to binary representation of x

from_bits

View source

from_bits(
    bits: Sequence[int]
) -> int

Combine individual bits to form x

assert_valid_classical_val

View source

assert_valid_classical_val(
    val: int, debug_str: str = 'val'
)

Raises an exception if val is not a valid classical value for this type.

Args

val

A classical value that should be in the domain of this QDType.

debug_str

Optional debugging information to use in exception messages.

assert_valid_classical_val_array

View source

assert_valid_classical_val_array(
    val_array: NDArray[np.integer], debug_str: str = 'val'
)

Raises an exception if val_array is not a valid array of classical values for this type.

Often, validation on an array can be performed faster than validating each element individually.

Args

val_array

A numpy array of classical values. Each value should be in the domain of this QDType.

debug_str

Optional debugging information to use in exception messages.

__ne__

__ne__(
    other
)

Check equality and either forward a NotImplemented or return the result negated.

__eq__

__eq__(
    other
)

Method generated by attrs for class QInt.