Skip to content

chain

Bases: base_topology

Represents a chain topology, a linear sequence of connected nodes.

Parameters:

Name Type Description Default
length int

The number of nodes in the chain. Must be a positive integer.

 required
name str

The name of the topology, by default 'chain'.

 'chain'
bi_directional bool

Specifies whether the chain is bidirectional. If True, links between nodes are bidirectional. By default, False (unidirectional).

 False
*args tuple

Additional positional arguments to be passed to the base_topology class.

 ()
**kwargs dict

Additional keyword arguments to be passed to the base_topology class.

 {}

Raises:

Type Description
ValueError

If length is not provided or is less than 1.
Inherits From

base_topology The base class for topological structures.

Source code in tinybig/koala/topology/chain.py 
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
70
71
72
73
74
75
76
77
78
class chain(base_topology):
    """
    Represents a chain topology, a linear sequence of connected nodes.

    Parameters
    ----------
    length : int
        The number of nodes in the chain. Must be a positive integer.
    name : str, optional
        The name of the topology, by default 'chain'.
    bi_directional : bool, optional
        Specifies whether the chain is bidirectional. If True, links between nodes are bidirectional.
        By default, False (unidirectional).
    *args : tuple
        Additional positional arguments to be passed to the `base_topology` class.
    **kwargs : dict
        Additional keyword arguments to be passed to the `base_topology` class.

    Raises
    ------
    ValueError
        If `length` is not provided or is less than 1.

    Inherits From
    -------------
    base_topology
        The base class for topological structures.
    """
    def __init__(self, length: int, name: str = 'chain', bi_directional: bool = False, *args, **kwargs):
        """
        Initializes the chain topology.

        Parameters
        ----------
        length : int
            The number of nodes in the chain. Must be a positive integer.
        name : str, optional
            The name of the topology, by default 'chain'.
        bi_directional : bool, optional
            Specifies whether the chain is bidirectional. If True, links between nodes are bidirectional.
            By default, False (unidirectional).
        *args : tuple
            Additional positional arguments to be passed to the `base_topology` class.
        **kwargs : dict
            Additional keyword arguments to be passed to the `base_topology` class.

        Raises
        ------
        ValueError
            If `length` is not provided or is less than 1.
        """
        if length is None or length < 1:
            raise ValueError('A positive length needs to be specified')
        nodes = list(range(length))
        links = [(i, i + 1) for i in range(length-1)]
        super().__init__(name=name, nodes=nodes, links=links, directed=not bi_directional, *args, **kwargs)

    def length(self):
        """
        Returns the number of links in the chain, which corresponds to the size of the topology.

        Returns
        -------
        int
            The number of links in the chain.
        """
        return self.size()

__init__(length, name='chain', bi_directional=False, *args, **kwargs)

Initializes the chain topology.

Parameters:

Name Type Description Default
length int

The number of nodes in the chain. Must be a positive integer.

 required
name str

The name of the topology, by default 'chain'.

 'chain'
bi_directional bool

Specifies whether the chain is bidirectional. If True, links between nodes are bidirectional. By default, False (unidirectional).

 False
*args tuple

Additional positional arguments to be passed to the base_topology class.

 ()
**kwargs dict

Additional keyword arguments to be passed to the base_topology class.

 {}

Raises:

Type Description
ValueError

If length is not provided or is less than 1.
Source code in tinybig/koala/topology/chain.py 
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
def __init__(self, length: int, name: str = 'chain', bi_directional: bool = False, *args, **kwargs):
    """
    Initializes the chain topology.

    Parameters
    ----------
    length : int
        The number of nodes in the chain. Must be a positive integer.
    name : str, optional
        The name of the topology, by default 'chain'.
    bi_directional : bool, optional
        Specifies whether the chain is bidirectional. If True, links between nodes are bidirectional.
        By default, False (unidirectional).
    *args : tuple
        Additional positional arguments to be passed to the `base_topology` class.
    **kwargs : dict
        Additional keyword arguments to be passed to the `base_topology` class.

    Raises
    ------
    ValueError
        If `length` is not provided or is less than 1.
    """
    if length is None or length < 1:
        raise ValueError('A positive length needs to be specified')
    nodes = list(range(length))
    links = [(i, i + 1) for i in range(length-1)]
    super().__init__(name=name, nodes=nodes, links=links, directed=not bi_directional, *args, **kwargs)

length()

Returns the number of links in the chain, which corresponds to the size of the topology.

Returns:

Type Description
int

The number of links in the chain.
Source code in tinybig/koala/topology/chain.py 
69
70
71
72
73
74
75
76
77
78
def length(self):
    """
    Returns the number of links in the chain, which corresponds to the size of the topology.

    Returns
    -------
    int
        The number of links in the chain.
    """
    return self.size()