culebra.solution.abc.Ant class

class Ant(species: Species, fitness_cls: Type[Fitness])

Construct a default solution.

Parameters:

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

  • fitness (Any subclass of Fitness) – The solutions’s fitness class

Raises:

  • TypeError – If species is not a valid species

  • TypeError – If fitness_cls is not a valid fitness class

Class attributes

Ant.species_cls = <class 'culebra.abc.Species'>

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

Class methods

classmethod Ant.load_pickle(filename: str) → Base

Load a pickled object from a file.

Parameters:

filename (str) – The file name.

Raises:

Properties

property Ant.species: Species

Get the solution’s species.

Returns:

The species

Return type:

Species

property Ant.fitness: Fitness

Get and set the solution’s fitness.

Getter:

Return the current fitness

Setter:

Set a new Fitness

Type:

Fitness

abstract property Ant.path: Sequence[int]

Path traveled by the ant.

This property must be overridden by subclasses to return a correct value.

Raises:

NotImplementedError – if has not been overridden

Type:

Sequence

property Ant.current: int

Return the current node in the path.

Type:

int

abstract property Ant.discarded: Sequence[int]

Nodes discarded by the ant.

This property must be overridden by subclasses to return a correct value.

Raises:

NotImplementedError – if has not been overridden

Type:

Sequence

Methods

Ant.save_pickle(filename: str) → None

Pickle this object and save it to a file.

Parameters:

filename (str) – The file name.

Raises:
abstract Ant.append(node: int) → None

Append a new node to the ant’s path.

This method must be overridden by subclasses to return a correct value.

Parameters:

node (int) – The node

Raises:

NotImplementedError – if has not been overridden

abstract Ant.discard(node: int) → None

Discard a node.

The discarded node is not appended to the ant’s path.

This method must be overridden by subclasses to return a correct value.

Parameters:

node (int) – The node

Raises:

NotImplementedError – if has not been overridden

Ant.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

Ant.delete_fitness() → None

Delete the solution’s fitness.

Dunder methods

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

Ant.__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.

Ant.__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

Ant.__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

Ant.__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

Ant.__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

Ant.__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

Ant.__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