"""Module containing the Loop Class.
This module defines the Loop class which represents individual loops in a knitting pattern.
Loops are the fundamental building blocks of knitted structures and maintain relationships with parent loops, yarn connections, and float positions.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from knit_graphs.Yarn import Yarn
[docs]
class Loop:
"""A class to represent a single loop structure for modeling a single loop in a knitting pattern.
The Loop class manages yarn relationships, parent-child connections for stitches, and float positioning for complex knitting structures.
Each loop maintains its position in the yarn sequence and its relationships to other loops through stitch connections and floating elements.
Attributes:
yarn (Yarn): The yarn that creates and holds this loop.
parent_loops (list[Loop]): The list of parent loops that this loop is connected to through stitch edges.
front_floats (dict[Loop, set[Loop]]): A dictionary tracking loops that this loop floats in front of.
back_floats (dict[Loop, set[Loop]]): A dictionary tracking loops that this loop floats behind.
"""
[docs]
def __init__(self, loop_id: int, yarn: Yarn) -> None:
"""Construct a Loop object with the specified identifier and yarn.
Args:
loop_id (int): A unique identifier for the loop, must be non-negative.
yarn (Yarn): The yarn that creates and holds this loop.
"""
if loop_id < 0:
raise ValueError(f"Loop identifier must be non-negative but got {loop_id}")
self._loop_id: int = loop_id
self.yarn: Yarn = yarn
self.parent_loops: list[Loop] = []
self.front_floats: dict[Loop, set[Loop]] = {}
self.back_floats: dict[Loop, set[Loop]] = {}
[docs]
def add_loop_in_front_of_float(self, u: Loop, v: Loop) -> None:
"""Set this loop to be in front of the float between loops u and v.
This method establishes that this loop passes in front of a floating yarn segment between two other loops.
Args:
u (Loop): The first loop in the float pair.
v (Loop): The second loop in the float pair.
Raises:
ValueError: If u and v are not on the same yarn.
"""
if u.yarn != v.yarn:
raise ValueError("Loops of a float must share a yarn.")
if u not in self.back_floats:
self.back_floats[u] = set()
if v not in self.back_floats:
self.back_floats[v] = set()
self.back_floats[u].add(v)
self.back_floats[v].add(u)
[docs]
def remove_loop_from_front_floats(self) -> None:
"""
Removes this loop from being in front of all marked floats. Mutates the yarns that own edges of those floats.
"""
visited: set[Loop] = set()
for u, v_loops in self.front_floats.items():
visited.add(u)
for v in v_loops:
if v not in visited and v in u.yarn: # float shares a yarn
u.yarn.loop_graph.edges[u, v]["Back_Loops"].remove(self)
self.front_floats = {}
[docs]
def add_loop_behind_float(self, u: Loop, v: Loop) -> None:
"""Set this loop to be behind the float between loops u and v.
This method establishes that this loop passes behind a floating yarn segment between two other loops.
Args:
u (Loop): The first loop in the float pair.
v (Loop): The second loop in the float pair.
Raises:
ValueError: If u and v are not on the same yarn.
"""
if u.yarn != v.yarn:
raise ValueError("Loops of a float must share a yarn.")
if u not in self.front_floats:
self.front_floats[u] = set()
if v not in self.front_floats:
self.front_floats[v] = set()
self.front_floats[u].add(v)
self.front_floats[v].add(u)
[docs]
def remove_loop_from_back_floats(self) -> None:
"""
Removes this loop from being behind of all marked floats. Mutates the yarns that own edges of those floats.
"""
visited = set()
for u, v_loops in self.back_floats.items():
visited.add(u)
for v in v_loops:
if v not in visited and v in u.yarn: # float shares a yarn
u.yarn.loop_graph.edges[u, v]["Front_Loops"].remove(self)
self.back_floats = {}
[docs]
def is_in_front_of_float(self, u: Loop, v: Loop) -> bool:
"""Check if this loop is positioned in front of the float between loops u and v.
Args:
u (Loop): The first loop in the float pair.
v (Loop): The second loop in the float pair.
Returns:
bool: True if the float between u and v passes behind this loop, False otherwise.
"""
return u in self.back_floats and v in self.back_floats and v in self.back_floats[u]
[docs]
def is_behind_float(self, u: Loop, v: Loop) -> bool:
"""Check if this loop is positioned behind the float between loops u and v.
Args:
u (Loop): The first loop in the float pair.
v (Loop): The second loop in the float pair.
Returns:
bool: True if the float between u and v passes in front of this loop, False otherwise.
"""
return u in self.front_floats and v in self.front_floats and v in self.front_floats[u]
[docs]
def prior_loop_on_yarn(self) -> Loop | None:
"""Get the loop that precedes this loop on the same yarn.
Returns:
Loop | None: The prior loop on the yarn, or None if this is the first loop on the yarn.
"""
return self.yarn.prior_loop(self)
[docs]
def next_loop_on_yarn(self) -> Loop | None:
"""Get the loop that follows this loop on the same yarn.
Returns:
Loop | None: The next loop on the yarn, or None if this is the last loop on the yarn.
"""
return self.yarn.next_loop(self)
[docs]
def remove_parent_loops(self) -> list[Loop]:
"""
Removes the list of parent loops from this loop.
Returns:
list[Loop]: The list of parent loops that were removed.
"""
parents = self.parent_loops
self.parent_loops = []
return parents
[docs]
def has_parent_loops(self) -> bool:
"""Check if this loop has any parent loops connected through stitch edges.
Returns:
bool: True if the loop has stitch-edge parents, False otherwise.
"""
return len(self.parent_loops) > 0
[docs]
def add_parent_loop(self, parent: Loop, stack_position: int | None = None) -> None:
"""Add a parent loop to this loop's parent stack.
Args:
parent (Loop): The loop to be added as a parent to this loop.
stack_position (int | None, optional): The position to insert the parent into the parent stack. If None, adds the parent on top of the stack. Defaults to None.
"""
if stack_position is not None:
self.parent_loops.insert(stack_position, parent)
else:
self.parent_loops.append(parent)
[docs]
def remove_parent(self, parent: Loop) -> None:
"""
Removes the given parent loop from the set of parents of this loop.
If the given loop is not a parent of this loop, nothing happens.
Args:
parent (Loop): The parent loop to remove.
"""
if parent in self.parent_loops:
self.parent_loops.remove(parent)
[docs]
def ancestor_loops(self) -> set[Loop]:
"""
Returns:
set[Loop]: The set of loops that initiate all wales that lead to this loop. The empty set if this loop has no parents.
"""
if not self.has_parent_loops():
return set()
ancestors = set()
for parent_loop in self.parent_loops:
if parent_loop.has_parent_loops():
ancestors.update(parent_loop.ancestor_loops())
else:
ancestors.add(parent_loop)
return ancestors
@property
def loop_id(self) -> int:
"""Get the unique identifier of this loop.
Returns:
int: The id of the loop.
"""
return self._loop_id
[docs]
def __hash__(self) -> int:
"""Return hash value based on loop_id for use in sets and dictionaries.
Returns:
int: Hash value of the loop_id.
"""
return self.loop_id
[docs]
def __int__(self) -> int:
"""Convert loop to integer representation using loop_id.
Returns:
int: The loop_id as an integer.
"""
return self.loop_id
[docs]
def __eq__(self, other: Loop) -> bool:
"""Check equality with another base loop based on loop_id and type.
Args:
other (Loop): The other loop to compare with.
Returns:
bool: True if both loops have the same class and loop_id, False otherwise.
"""
return isinstance(other, other.__class__) and self.loop_id == other.loop_id
[docs]
def __lt__(self, other: Loop | int) -> bool:
"""Compare loop_id with another loop or integer for ordering.
Args:
other (Loop | int): The other loop or integer to compare with.
Returns:
bool: True if this loop's id is less than the other's id.
"""
return int(self.loop_id) < int(other)
[docs]
def __repr__(self) -> str:
"""Return string representation of the loop.
Returns:
str: String representation showing "Loop {loop_id}".
"""
return f"Loop {self.loop_id}"