Skip to content

foapy.tuple_mode

tuple_mode

Tuple mode enumeration controlling how intervals_tuple shapes the boundary intervals in an intervals chain into the final intervals tuple.

lossy = 1

Drop all boundary intervals (first/last-occurrence distances).

normal = 2

Keep all intervals as-is (one boundary interval per element).

redundant = 3

Expand boundary intervals into leading + trailing components.

Examples:

1
2
3
4
5
import foapy

print(foapy.tuple_mode.lossy)      # 1
print(foapy.tuple_mode.normal)     # 2
print(foapy.tuple_mode.redundant)  # 3
Source code in .tox/docs-deploy/lib/python3.11/site-packages/foapy/core/_tuple_mode.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class tuple_mode:
    """
    Tuple mode enumeration controlling how ``intervals_tuple`` shapes the boundary
    intervals in an intervals chain into the final intervals tuple.

    Examples
    --------

    ``` py linenums="1"
    import foapy

    print(foapy.tuple_mode.lossy)      # 1
    print(foapy.tuple_mode.normal)     # 2
    print(foapy.tuple_mode.redundant)  # 3
    ```
    """

    lossy: int = 1
    """Drop all boundary intervals (first/last-occurrence distances)."""

    normal: int = 2
    """Keep all intervals as-is (one boundary interval per element)."""

    redundant: int = 3
    """Expand boundary intervals into leading + trailing components."""

    def __new__(cls, *args, **kwargs):
        raise TypeError(cls.__name__ + " cannot be instantiated.")