culebra.solution.feature_selection.BinarySolution class

class BinarySolution(species: Species, fitness_cls: type[Fitness], features: Sequence[int] | None = None)

Bases: Solution

Construct a default solution.

Parameters:

• species (Species) – The species the solution will belong to

• fitness_cls (type[Fitness]) – The solution’s fitness class

• features (Sequence[int]) – Initial features

Raises:

• TypeError – If species is not a valid species

• TypeError – If fitness_cls is not a valid fitness class

Class attributes

BinarySolution.species_cls = <class 'culebra.solution.feature_selection.Species'>

Class for the species used by the Solution class to constrain all its instances.

Class methods

classmethod BinarySolution.load(filename: str) → Base

Load a serialized object from a file.

Parameters:

filename (str) – The file name.

Returns:

The loaded object

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not SERIALIZED_FILE_EXTENSION

Properties

property BinarySolution.features: ndarray[int]

Features selected by the solution

Returns:

Return an ordered sequence with the indices of the selected features

Return type:

ndarray[int]

Setter:

Set a new set of selected features

Parameters:

values (Sequence[int]) – The indices of the new features

Raises:

ValueError – If set to new feature indices values which do not meet the species constraints.

property BinarySolution.fitness: Fitness

Solution’s fitness.

Return type:

Fitness

Setter:

Set a new Fitness

Parameters:

value (Fitness) – The new fitness

property BinarySolution.max_feat: int | None

Maximum feature index selected by the solution.

Returns:

The maximum feature index or None if no feature has been selected

Return type:

int

property BinarySolution.min_feat: int | None

Minimum feature index selected by the solution.

Returns:

The minimum feature index or None if no feature has been selected

Return type:

int

property BinarySolution.num_feats: int

Number of features selected by the solution.

Return type:

int

property BinarySolution.species: Species

Solution’s species.

Return type:

Species

Methods

BinarySolution.delete_fitness() → None

Delete the solution’s fitness.

BinarySolution.dominates(other: Solution) → bool

Dominate operator.

Parameters:

other (Solution) – Other solution

Returns:

True if each objective of the solution is not strictly worse than the corresponding objective of other and at least one objective is strictly better.

Return type:

bool

BinarySolution.dump(filename: str) → None

Serialize this object and save it to a file.

Parameters:

filename (str) – The file name.

Raises:

• TypeError – If filename is not a valid file name

• ValueError – If the filename extension is not SERIALIZED_FILE_EXTENSION

Private methods

BinarySolution._setup() → None

Init the features of this solution randomly.

Dunder methods

Intended to compare (lexicographically) two solutions according to their fitness.

BinarySolution.__eq__(other: Solution) → bool

Equality test.

Parameters:

other (Solution) – Other solution

Returns:

True if other codes the same solution, or False otherwise

Return type:

bool

BinarySolution.__ge__(other: Solution) → bool

Greater than or equal to operator.

Parameters:

other (Solution) – Other solution

Returns:

True if the solution’s fitness is greater than or equal to the other’s fitness

Return type:

bool

BinarySolution.__gt__(other: Solution) → bool

Greater than operator.

Parameters:

other (Solution) – Other solution

Returns:

True if the solution’s fitness is greater than the other’s fitness

Return type:

bool

BinarySolution.__hash__() → int

Return the hash number for this solution.

The hash number is used for equality comparisons. Currently is implemented as the hash of the solution’s string representation.

Return type:

int

BinarySolution.__le__(other: Solution) → bool

Less than or equal to operator.

Parameters:

other (Solution) – Other solution

Returns:

True if the solution’s fitness is less than or equal to the other’s fitness

Return type:

bool

BinarySolution.__lt__(other: Solution) → bool

Less than operator.

Parameters:

other (Solution) – Other solution

Returns:

True if the solution’s fitness is less than the other’s fitness

Return type:

bool

BinarySolution.__ne__(other: Solution) → bool

Not equality test.

Parameters:

other (Solution) – Other solution

Returns:

False if other codes the same solutions, or True otherwise

Return type:

bool

BinarySolution.__str__() → str

Solution as a string.

Return type:

str