ribs.archives.AddStatus¶

class ribs.archives.AddStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Semantic meaning for statuses returned by add().

Statuses returned by the add() method of many archives are defined as integers. This class is an IntEnum that provides a slightly more meaningful value with the following items:

NOT_ADDED (0): The solution given to add() was not added to the archive.
IMPROVE_EXISTING (1): The solution given to add() improved over an elite already in the archive.
NEW (2): The solution given to add() created a new elite in the archive.

Example

Check the status of an add operation as follows (note that these examples use add_single() rather than add()):

from ribs.archives import AddStatus
add_info = archive.add_single(solution, objective, measures)
if add_info["status"] == AddStatus.NEW:
    # Do something if the solution made a new elite in the archive.

To check whether the solution was added to the archive, the status can act like a bool:

from ribs.archives import AddStatus
add_info = archive.add_single(solution, objective, measures)
if add_info["status"]:
    # Do something if the solution was added to the archive.

Finally, there is an ordering on statuses:

AddStatus.NEW > AddStatus.IMPROVE_EXISTING > AddStatus.NOT_ADDED

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`([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.
`__getitem__`(name)	Return the member matching name.
`__iter__`()	Return members in definition order.
`__len__`()	Return the number of members (no aliases)

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
`NOT_ADDED`
`IMPROVE_EXISTING`
`NEW`

classmethod __contains__(value)¶

Return True if value is in cls.

value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members. 3) value is a pseudo-member (flags)

__dir__()¶: Returns public methods and other interesting attributes.

classmethod __getitem__(name)¶: Return the member matching name.

classmethod __iter__()¶: Return members in definition order.

classmethod __len__()¶: Return the number of members (no aliases)

as_integer_ratio()¶

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

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()¶

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

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()¶

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()¶: Returns self, the complex conjugate of any int.

from_bytes(byteorder='big', *, signed=False)¶

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Indicates whether two’s complement is used to represent the integer.

is_integer()¶: Returns True. Exists for duck type compatibility with float.is_integer.

to_bytes(length=1, byteorder='big', *, signed=False)¶

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

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