Contents

Python API

This is the documentation of unreleased changes. The latest release is v0.11.0.

Classes

Amazons

class Amazons(position: str)
property canonical_form: CanonicalForm
read-only
property grid: Grid
read-only
property left_options: list[Amazons]
read-only
property right_options: list[Amazons]
read-only
property sensible_left_options: list[Amazons]
read-only
property sensible_right_options: list[Amazons]
read-only
__repr__() -> str
_repr_svg_() -> str

BipartiteSnort

class BipartiteSnort(
    blue: int,
    red: int,
    edges: Sequence[tuple[int, int]],
)
property blue: int
read-only
property canonical_form: CanonicalForm
read-only
property edges: list[tuple[int, int]]
read-only
property graph: Graph
read-only
property left_options: list[BipartiteSnort]
read-only
property red: int
read-only
property right_options: list[BipartiteSnort]
read-only
property sensible_left_options: list[BipartiteSnort]
read-only
property sensible_right_options: list[BipartiteSnort]
read-only
__repr__() -> str
_repr_svg_() -> str

CanonicalForm

class CanonicalForm(value: Any)
property birthday: int
read-only
property left_options: list[CanonicalForm]
read-only
property left_stop: DyadicRationalNumber
read-only
property reduced: CanonicalForm
read-only
property right_options: list[CanonicalForm]
read-only
property right_stop: DyadicRationalNumber
read-only
property temperature: DyadicRationalNumber
read-only
property thermograph: Thermograph
read-only
__add__(other: CanonicalForm) -> CanonicalForm
__neg__() -> CanonicalForm
__repr__() -> str
__richcmp__(other: CanonicalForm, op: int) -> bool
__sub__(other: CanonicalForm) -> CanonicalForm
cool(temperature: Any) -> CanonicalForm

Cool the position by temperature, given as an integer, a string, or a DyadicRationalNumber

Col

class Col(
    graph: Any,
    edges: Optional[Sequence[tuple[int, int]]] = None,
    white: Optional[Sequence[int]] = None,
    blue: Optional[Sequence[int]] = None,
    red: Optional[Sequence[int]] = None,
    green: Optional[Sequence[int]] = None,
)
property canonical_form: CanonicalForm
read-only
property graph: Graph
read-only
property left_options: list[Col]
read-only
property right_options: list[Col]
read-only
property sensible_left_options: list[Col]
read-only
property sensible_right_options: list[Col]
read-only
__repr__() -> str
_repr_svg_() -> str

DigraphPlacement

class DigraphPlacement(
    graph: Any,
    edges: Optional[Sequence[tuple[int, int]]] = None,
    blue: Optional[Sequence[int]] = None,
    red: Optional[Sequence[int]] = None,
)
property canonical_form: CanonicalForm
read-only
property graph: Graph
read-only
property left_options: list[DigraphPlacement]
read-only
property right_options: list[DigraphPlacement]
read-only
property sensible_left_options: list[DigraphPlacement]
read-only
property sensible_right_options: list[DigraphPlacement]
read-only
__repr__() -> str
_repr_svg_() -> str

Domineering

class Domineering(position: str)
property canonical_form: CanonicalForm
read-only
property grid: Grid
read-only
property left_options: list[Domineering]
read-only
property right_options: list[Domineering]
read-only
property sensible_left_options: list[Domineering]
read-only
property sensible_right_options: list[Domineering]
read-only
__repr__() -> str
_repr_svg_() -> str

DyadicRationalNumber

class DyadicRationalNumber(
    numerator: Any,
    denominator_exponent: Optional[int] = None,
)
__float__() -> float
__repr__() -> str
__richcmp__(other: DyadicRationalNumber, op: int) -> bool

Fission

class Fission(position: str)
property canonical_form: CanonicalForm
read-only
property grid: Grid
read-only
property left_options: list[Fission]
read-only
property right_options: list[Fission]
read-only
property sensible_left_options: list[Fission]
read-only
property sensible_right_options: list[Fission]
read-only
__repr__() -> str
_repr_svg_() -> str

Graph

class Graph(
    vertices: int,
    edges: Sequence[tuple[int, int]],
    directed: bool = ...,
    white: Optional[Sequence[int]] = None,
    blue: Optional[Sequence[int]] = None,
    red: Optional[Sequence[int]] = None,
    green: Optional[Sequence[int]] = None,
)
property bipartite_snort: BipartiteSnort
read-only
property col: Col
read-only
property colors: VertexColors
read-only
property digraph_placement: DigraphPlacement
read-only
property directed: bool
read-only

Whether the edges of the graph point one way. Undirected edges are stored as a pair of opposite arcs, so this only decides how edges are added and reported back

property edges: list[tuple[int, int]]
read-only
property game: Any
read-only
property snort: Snort
read-only
property vertices: int
read-only
__eq__(other: object) -> bool
__repr__() -> str
_repr_svg_() -> str
decode_from_traitlet(preset_bits: int, raw_graph: str) -> Graph
encode_to_traitlet() -> str

Grid

class Grid
property amazons: Amazons
read-only
property domineering: Domineering
read-only
property fission: Fission
read-only
property game: Any
read-only
property konane: Konane
read-only
__eq__(other: object) -> bool
decode_from_traitlet(preset_bits: int, raw_grid: str) -> Grid
encode_to_traitlet() -> str

Konane

class Konane(position: str)
property canonical_form: CanonicalForm
read-only
property grid: Grid
read-only
property left_options: list[Konane]
read-only
property right_options: list[Konane]
read-only
property sensible_left_options: list[Konane]
read-only
property sensible_right_options: list[Konane]
read-only
__repr__() -> str
_repr_svg_() -> str

Snort

class Snort(
    graph: Any,
    edges: Optional[Sequence[tuple[int, int]]] = None,
    white: Optional[Sequence[int]] = None,
    blue: Optional[Sequence[int]] = None,
    red: Optional[Sequence[int]] = None,
    green: Optional[Sequence[int]] = None,
)
property canonical_form: CanonicalForm
read-only
property graph: Graph
read-only
property left_options: list[Snort]
read-only
property right_options: list[Snort]
read-only
property sensible_left_options: list[Snort]
read-only
property sensible_right_options: list[Snort]
read-only
__repr__() -> str
_repr_svg_() -> str

Thermograph

class Thermograph
__repr__() -> str
_repr_svg_() -> str

VertexColors

class VertexColors
property blue: list[int]
read-only
property green: list[int]
read-only
property red: list[int]
read-only
property white: list[int]
read-only
__repr__() -> str

Functions

AmazonsWidget

AmazonsWidget(position: Optional[Any] = None) -> Any

BipartiteSnortWidget

BipartiteSnortWidget(position: Optional[Any] = None) -> Any

ColWidget

ColWidget(position: Optional[Any] = None) -> Any

DigraphPlacementWidget

DigraphPlacementWidget(position: Optional[Any] = None) -> Any

DomineeringWidget

DomineeringWidget(position: Optional[Any] = None) -> Any

FissionWidget

FissionWidget(position: Optional[Any] = None) -> Any

KonaneWidget

KonaneWidget(position: Optional[Any] = None) -> Any

SnortWidget

SnortWidget(position: Optional[Any] = None) -> Any