pylinkage.collections package

Submodules

pylinkage.collections.agent module

Agent class for optimization results.

pylinkage.collections.mutable_agent module

MutableAgent class for optimization results.

Module contents

Package for collection objects.

class pylinkage.collections.Agent(score: float, dimensions: Any, init_positions: Sequence[tuple[float | None, float | None]])

Bases: NamedTuple

A class that uniformizes a linkage optimization.

It is roughly a namedtuple with preassigned fields.

dimensions: Any

Alias for field number 1

init_positions: Sequence[tuple[float | None, float | None]]

Alias for field number 2

score: float

Alias for field number 0

class pylinkage.collections.MutableAgent(score: float | None = None, dimensions: Sequence[float] | None = None, init_position: Sequence[tuple[float | None, float | None]] | None = None)

Bases: object

A custom class that is mutable, subscriptable, and supports index assignment.

You should only use it as a dictionary of 3 elements. No backward compatibility guaranty on other use cases.

dimensions: Sequence[float] | None

init_positions: Sequence[tuple[float | None, float | None]] | None

score: float | None