Skip to content

foapy.binding

binding

Binding enumeration used to determinate the direction of interval extraction.

start = 1

To sequence start (left-to-right direction).

end = 2

To sequence end (right-to-left direction).

Examples:

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

b a b c b
b 1 -> 2 -> 2
a -> 2
c -> -> -> 4
result 1 2 2 4 2
b a b c b
b 2 <- 2 <- 1
a 4 <- <- <-
c 2 <-
result 2 4 2 2 1
Source code in .tox/docs-deploy/lib/python3.11/site-packages/foapy/core/_binding.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
class binding:
    """
    Binding enumeration used to determinate the direction of interval extraction.

    Examples
    ----------

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

    === "binding.start"

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

    === "binding.end"

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


    """  # noqa: E501

    start: int = 1
    """
    To sequence start (left-to-right direction).
    """

    end: int = 2
    """
    To  sequence end (right-to-left direction).
    """