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: CanonicalFormread-onlyproperty grid: Gridread-onlyproperty left_options: list[Amazons]read-onlyproperty right_options: list[Amazons]read-onlyproperty sensible_left_options: list[Amazons]read-onlyproperty sensible_right_options: list[Amazons]read-only__repr__() -> str_repr_svg_() -> strBipartiteSnort
class BipartiteSnort(
blue: int,
red: int,
edges: Sequence[tuple[int, int]],
)property blue: intread-onlyproperty canonical_form: CanonicalFormread-onlyproperty edges: list[tuple[int, int]]read-onlyproperty graph: Graphread-onlyproperty left_options: list[BipartiteSnort]read-onlyproperty red: intread-onlyproperty right_options: list[BipartiteSnort]read-onlyproperty sensible_left_options: list[BipartiteSnort]read-onlyproperty sensible_right_options: list[BipartiteSnort]read-only__repr__() -> str_repr_svg_() -> strCanonicalForm
class CanonicalForm(value: Any)property birthday: intread-onlyproperty left_options: list[CanonicalForm]read-onlyproperty left_stop: DyadicRationalNumberread-onlyproperty reduced: CanonicalFormread-onlyproperty right_options: list[CanonicalForm]read-onlyproperty right_stop: DyadicRationalNumberread-onlyproperty temperature: DyadicRationalNumberread-onlyproperty thermograph: Thermographread-only__add__(other: CanonicalForm) -> CanonicalForm__neg__() -> CanonicalForm__repr__() -> str__richcmp__(other: CanonicalForm, op: int) -> bool__sub__(other: CanonicalForm) -> CanonicalFormcool(temperature: Any) -> CanonicalFormCool 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: CanonicalFormread-onlyproperty graph: Graphread-onlyproperty left_options: list[Col]read-onlyproperty right_options: list[Col]read-onlyproperty sensible_left_options: list[Col]read-onlyproperty sensible_right_options: list[Col]read-only__repr__() -> str_repr_svg_() -> strDigraphPlacement
class DigraphPlacement(
graph: Any,
edges: Optional[Sequence[tuple[int, int]]] = None,
blue: Optional[Sequence[int]] = None,
red: Optional[Sequence[int]] = None,
)property canonical_form: CanonicalFormread-onlyproperty graph: Graphread-onlyproperty left_options: list[DigraphPlacement]read-onlyproperty right_options: list[DigraphPlacement]read-onlyproperty sensible_left_options: list[DigraphPlacement]read-onlyproperty sensible_right_options: list[DigraphPlacement]read-only__repr__() -> str_repr_svg_() -> strDomineering
class Domineering(position: str)property canonical_form: CanonicalFormread-onlyproperty grid: Gridread-onlyproperty left_options: list[Domineering]read-onlyproperty right_options: list[Domineering]read-onlyproperty sensible_left_options: list[Domineering]read-onlyproperty sensible_right_options: list[Domineering]read-only__repr__() -> str_repr_svg_() -> strDyadicRationalNumber
class DyadicRationalNumber(
numerator: Any,
denominator_exponent: Optional[int] = None,
)__add__(other: DyadicRationalNumber) -> DyadicRationalNumber__float__() -> float__neg__() -> DyadicRationalNumber__repr__() -> str__richcmp__(other: DyadicRationalNumber, op: int) -> bool__sub__(other: DyadicRationalNumber) -> DyadicRationalNumberFission
class Fission(position: str)property canonical_form: CanonicalFormread-onlyproperty grid: Gridread-onlyproperty left_options: list[Fission]read-onlyproperty right_options: list[Fission]read-onlyproperty sensible_left_options: list[Fission]read-onlyproperty sensible_right_options: list[Fission]read-only__repr__() -> str_repr_svg_() -> strGraph
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: BipartiteSnortread-onlyproperty col: Colread-onlyproperty colors: VertexColorsread-onlyproperty digraph_placement: DigraphPlacementread-onlyproperty directed: boolread-onlyWhether 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-onlyproperty game: Anyread-onlyproperty snort: Snortread-onlyproperty vertices: intread-only__eq__(other: object) -> bool__repr__() -> str_repr_svg_() -> strdecode_from_traitlet(preset_bits: int, raw_graph: str) -> Graphencode_to_traitlet() -> strGrid
class Gridproperty amazons: Amazonsread-onlyproperty domineering: Domineeringread-onlyproperty fission: Fissionread-onlyproperty game: Anyread-onlyproperty konane: Konaneread-only__eq__(other: object) -> booldecode_from_traitlet(preset_bits: int, raw_grid: str) -> Gridencode_to_traitlet() -> strKonane
class Konane(position: str)property canonical_form: CanonicalFormread-onlyproperty grid: Gridread-onlyproperty left_options: list[Konane]read-onlyproperty right_options: list[Konane]read-onlyproperty sensible_left_options: list[Konane]read-onlyproperty sensible_right_options: list[Konane]read-only__repr__() -> str_repr_svg_() -> strSnort
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: CanonicalFormread-onlyproperty graph: Graphread-onlyproperty left_options: list[Snort]read-onlyproperty right_options: list[Snort]read-onlyproperty sensible_left_options: list[Snort]read-onlyproperty sensible_right_options: list[Snort]read-only__repr__() -> str_repr_svg_() -> strThermograph
class Thermograph__repr__() -> str_repr_svg_() -> strVertexColors
class VertexColorsproperty blue: list[int]read-onlyproperty green: list[int]read-onlyproperty red: list[int]read-onlyproperty white: list[int]read-only__repr__() -> strFunctions
AmazonsWidget
AmazonsWidget(position: Optional[Any] = None) -> AnyBipartiteSnortWidget
BipartiteSnortWidget(position: Optional[Any] = None) -> AnyColWidget
ColWidget(position: Optional[Any] = None) -> AnyDigraphPlacementWidget
DigraphPlacementWidget(position: Optional[Any] = None) -> AnyDomineeringWidget
DomineeringWidget(position: Optional[Any] = None) -> AnyFissionWidget
FissionWidget(position: Optional[Any] = None) -> AnyKonaneWidget
KonaneWidget(position: Optional[Any] = None) -> AnySnortWidget
SnortWidget(position: Optional[Any] = None) -> Any