culebra.solution.tsp.Solution class

class Solution(species: Species, fitness_cls: type[Fitness], path: 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

• path (Sequence[int]) – Initial path

Raises:

• TypeError – If species is not a valid species

• TypeError – If fitness_cls is not a valid fitness class

Class attributes

Solution.species_cls = <class 'culebra.solution.tsp.Species'>

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

Class methods

classmethod Solution.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 Solution.fitness: Fitness

Solution’s fitness.

Return type:

Fitness

Setter:

Set a new Fitness

Parameters:

value (Fitness) – The new fitness

property Solution.path: ndarray[int]

Path.

Return type:

ndarray[int]

Setter:

Set a new path

Parameters:

value (Sequence[int]) – The new path

Raises:

ValueError – If value does not meet the species constraints.

property Solution.species: Species

Solution’s species.

Return type:

Species

Methods

Solution.delete_fitness() → None

Delete the solution’s fitness.

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

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

abstract Solution._setup() → None

Init the nodes of this solution.

This method must be overridden by subclasses.

Raises:

NotImplementedError – If has not been overridden

Dunder methods

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

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

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

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

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

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

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

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

Solution.__str__() → str

Solution as a string.

A symmetric tsp problem is assumed. Thus, all rotations of paths [0, 1, …, n] and [n, …, 1, 0] are considered the same path.

The path is rolled to start with the node with smallest index.

Return type:

str