pcdsutils.enum.HelpfulIntEnum

class pcdsutils.enum.HelpfulIntEnum(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

IntEnum subclass with some utility extensions and case insensitivity.

Attributes:
denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

Methods

as_integer_ratio(/)

Return a pair of integers, whose ratio is equal to the original int.

bit_count(/)

Number of ones in the binary representation of the absolute value of self.

bit_length(/)

Number of bits necessary to represent self in binary.

conjugate

Returns self, the complex conjugate of any int.

from_bytes(/, bytes[, byteorder, signed])

Return the integer represented by the given array of bytes.

is_integer(/)

Returns True.

to_bytes(/[, length, byteorder, signed])

Return an array of bytes representing an integer.

__init__(*args, **kwds)

Methods

conjugate

Returns self, the complex conjugate of any int.

bit_length(/)

Number of bits necessary to represent self in binary.

bit_count(/)

Number of ones in the binary representation of the absolute value of self.

to_bytes(/[, length, byteorder, signed])

Return an array of bytes representing an integer.

from_bytes(/, bytes[, byteorder, signed])

Return the integer represented by the given array of bytes.

as_integer_ratio(/)

Return a pair of integers, whose ratio is equal to the original int.

is_integer(/)

Returns True.

from_any(identifier)

Try all the ways to interpret identifier as the enum.

include(identifiers)

Returns all enum values matching the identifiers given.

exclude(identifiers)

Return all enum values other than the ones given.

__init__(*args, **kwds)

Attributes

real

the real part of a complex number

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

denominator

the denominator of a rational number in lowest terms