Class Edge

numpy_ml/utils/graphs.py:12–42

class Edge(object):
    def __init__(self, fr, to, w=None):
        """
        A generic directed edge object.

        Parameters
        ----------
        fr: int
            The id of the vertex the edge goes from
        to: int
            The id of the vertex the edge goes to
        w: float, :class:`Object` instance, or None
            The edge weight, if applicable. If weight is an arbitrary Object it
            must have a method called 'sample' which takes no arguments and
            returns a random sample from the weight distribution. If `w` is
            None, no weight is assumed. Default is None.
        """
        self.fr = fr
        self.to = to
        self._w = w

    def __repr__(self):
        return "{} -> {}, weight: {}".format(self.fr, self.to, self._w)

    @property
    def weight(self):
        return self._w.sample() if hasattr(self._w, "sample") else self._w

    def reverse(self):
        """Reverse the edge direction"""
        return Edge(self.t, self.f, self.w)


#######################################################################