Skip to content

foapy.mode

mode

Mode enumeration used to determinate handling the intervals at the sequence boundaries.

lossy = 1

Ignore boundary intervals

normal = 2

Include first/last boundary interval based on binding

cycle = 3

Sumarize boundary intervals as one cyclic interval

redundant = 4

Include both (first and last) boundary intervals

Examples:

See foapy.intervals() function for code examples using modes.

Example how different modes handle intervals are extracted when binding.start

b a b c b
b 1 -> 2 -> 2
a -> 2
c -> -> -> 4
result 1 2 2 4 2
transition a b c b b transition
b (1) 1 -> 2 -> 2 (1)
a (2) -> 5 -> -> -> (2)
c (3) -> -> -> 5 -> (3)
result 1 5 2 5 2
b a b c b
b x -> 2 -> 2
a -> x
c -> -> -> x
result 2 2
a b c b b end
b 1 -> 2 -> 2 1
a -> 2 -> -> -> 4
c -> -> -> 4 -> 2
result 1 2 2 4 2 1 4 2
Source code in .tox/docs-deploy/lib/python3.11/site-packages/foapy/core/_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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class mode:
    """
    Mode enumeration used to determinate handling the intervals at the sequence boundaries.

    Examples
    ----------

    See [foapy.intervals()][foapy.intervals] function for code examples using modes.

    Example how different modes handle intervals are extracted when binding.start

    === "mode.normal"

        |        |  b |  a |  b |  c |  b |
        |:------:|:--:|:--:|:--:|:--:|:--:|
        | b      |  1 | -> |  2 | -> |  2 |
        | a      | -> |  2 |    |    |    |
        | c      | -> | -> | -> |  4 |    |
        | result |  1 |  2 |  2 |  4 |  2 |

    === "mode.cycle"

        |        | transition |  a |  b |  c |  b |  b | transition |
        |:------:|:----------:|:--:|:--:|:--:|:--:|:--:|:----------:|
        | b      |     (1)    |  1 | -> |  2 | -> |  2 |     (1)    |
        | a      |     (2)    | -> |  5 | -> | -> | -> |     (2)    |
        | c      |     (3)    | -> | -> | -> |  5 | -> |     (3)    |
        | result |            |  1 |  5 |  2 |  5 |  2 |            |

    === "mode.lossy"

        |        |  b |  a |  b |  c |  b |
        |:------:|:--:|:--:|:--:|:--:|:--:|
        | b      |  x | -> |  2 | -> |  2 |
        | a      | -> |  x |    |    |    |
        | c      | -> | -> | -> |  x |    |
        | result |    |    |  2 |    |  2 |

    === "mode.redundant"

        |        |  a |  b |  c |  b |  b | end   |
        |:------:|:--:|:--:|:--:|:--:|:--:|:-----:|
        | b      |  1 | -> |  2 | -> |  2 | 1     |
        | a      | -> |  2 | -> | -> | -> | 4     |
        | c      | -> | -> | -> |  4 | -> | 2     |
        | result |  1 |  2 |  2 |  4 |  2 | 1 4 2 |


    """  # noqa: E501

    lossy: int = 1
    """
    Ignore boundary intervals
    """

    normal: int = 2
    """
    Include first/last boundary interval based on binding
    """

    cycle: int = 3
    """
    Sumarize boundary intervals as one cyclic interval
    """

    redundant: int = 4
    """
    Include both (first and last) boundary intervals
    """