stream_graph.ABC.NodeSet

class stream_graph.ABC.NodeSet

NodeSet Object API Specification.

A NodeSet can be abstractly be defined as a set of node u.

Attributes

size

Returns the size of the NodeSet.

Methods

copy(self[, deep])	Returns a deep or shallow copy of the current NodeSet.
issuperset(self, ns)	Check if a NodeSet contains another NodeSet.

abstract __and__(self, ns)

Implementation of the & operator for a NodeSet object.

Parameters

nsNodeSet

Returns

outNodeSet

Returns the intersection of Nodes.

abstract __bool__(self)

Implementation of the bool casting of a NodeSet object.

Parameters

None.

Returns

outBool

Return True if an object is both initialized and contains information.

__class__

alias of abc.ABCMeta

abstract __contains__(self, n)

Implementation of the in operator for NodeSet.

Parameters

uNode_Id

Returns

containsBool

Returns True if the u appears inside the NodeSet.

__delattr__(self, name, /)

Implement delattr(self, name).

__dir__()

default dir() implementation

__eq__(self, value, /)

Return self==value.

__format__()

default object formatter

__ge__(self, value, /)

Return self>=value.

__getattribute__(self, name, /)

Return getattr(self, name).

__gt__(self, value, /)

Return self>value.

__hash__(self, /)

Return hash(self).

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

abstract __iter__(self)

Implementation of the iter function for a NodeSet object.

Parameters

None

Returns

outIterator of Node_Id

__le__(self, value, /)

Return self<=value.

__lt__(self, value, /)

Return self<value.

__ne__(self, value, /)

Return self!=value.

__new__(*args, **kwargs)

Create and return a new object. See help(type) for accurate signature.

abstract __or__(self, ns)

Implementation of the | operator for a NodeSet object.

Parameters

nsNodeSet

Returns

outNodeSet

Returns the union of Nodes.

__reduce__()

helper for pickle

__reduce_ex__()

helper for pickle

__repr__(self, /)

Return repr(self).

__setattr__(self, name, value, /)

Implement setattr(self, name, value).

__sizeof__()

size of object in memory, in bytes

abstract __sub__(self, ns)

Implementation of the - operator for a NodeSet object.

Parameters

nsNodeSet

Returns

outNodeSet

Returns the difference of Nodes.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

copy(self, deep=True)

Returns a deep or shallow copy of the current NodeSet.

Parameters

deepBool

Returns

nodeset_copyNodeSet

Returns a deep or shallow copy of the current NodeSet.

abstract issuperset(self, ns)

Check if a NodeSet contains another NodeSet.

Parameters

nsNodeSet

Returns

issuperset_fBool

True if all links of ns appear in this NodeSet.

abstract property size

Returns the size of the NodeSet.

Parameters

None. Property.

Returns

sizeReal

The number of node.