Module `clu.phontools.alignment.parser.queue`

Expand source code

from __future__ import annotations
from .symbols import Symbol
from dataclasses import dataclass
from enum import Enum
from typing import List, Optional

__all__ = ["Queue"]


class Queue:
    """"""

    def __init__(self, symbols: Optional[List[Symbol]] = None):
        self._symbols: List[Symbol] = symbols or []

    def __len__(self) -> int:
        return len(self._symbols)

    def copy(self) -> Queue:
        """Creates a new Queue from the current state of this Queue"""
        # deep copy
        return Queue(symbols=self._symbols[:])

    def push(self, ps: Symbol) -> None:
        """pushes an element into the first position of the queue"""
        self._symbols = [ps] + self._symbols

    def pop(self) -> Optional[Symbol]:
        """pops off the first element in the queue
        and sets self._symbols to whatever remains"""
        # check if Queue is empty
        if self.is_empty():
            return None

        first = self._symbols[0]
        self._symbols = self._symbols[1:]
        return first

    def is_empty(self) -> bool:
        """returns true is Queue is empty otherwise false"""
        return True if len(self._symbols) == 0 else False

Classes

class Queue (symbols: Optional[List[Symbol]] = None)

Expand source code

class Queue:
    """"""

    def __init__(self, symbols: Optional[List[Symbol]] = None):
        self._symbols: List[Symbol] = symbols or []

    def __len__(self) -> int:
        return len(self._symbols)

    def copy(self) -> Queue:
        """Creates a new Queue from the current state of this Queue"""
        # deep copy
        return Queue(symbols=self._symbols[:])

    def push(self, ps: Symbol) -> None:
        """pushes an element into the first position of the queue"""
        self._symbols = [ps] + self._symbols

    def pop(self) -> Optional[Symbol]:
        """pops off the first element in the queue
        and sets self._symbols to whatever remains"""
        # check if Queue is empty
        if self.is_empty():
            return None

        first = self._symbols[0]
        self._symbols = self._symbols[1:]
        return first

    def is_empty(self) -> bool:
        """returns true is Queue is empty otherwise false"""
        return True if len(self._symbols) == 0 else False

Methods

def copy(self) ‑> Queue

Creates a new Queue from the current state of this Queue

Expand source code

def copy(self) -> Queue:
    """Creates a new Queue from the current state of this Queue"""
    # deep copy
    return Queue(symbols=self._symbols[:])

def is_empty(self) ‑> bool

returns true is Queue is empty otherwise false

Expand source code

def is_empty(self) -> bool:
    """returns true is Queue is empty otherwise false"""
    return True if len(self._symbols) == 0 else False

def pop(self) ‑> Union[Symbol, NoneType]

pops off the first element in the queue and sets self._symbols to whatever remains

Expand source code

def pop(self) -> Optional[Symbol]:
    """pops off the first element in the queue
    and sets self._symbols to whatever remains"""
    # check if Queue is empty
    if self.is_empty():
        return None

    first = self._symbols[0]
    self._symbols = self._symbols[1:]
    return first

def push(self, ps: Symbol) ‑> NoneType

pushes an element into the first position of the queue

Expand source code

def push(self, ps: Symbol) -> None:
    """pushes an element into the first position of the queue"""
    self._symbols = [ps] + self._symbols