Class: MotifGroup

MotifGroup

A MotifGroup is simple a group of motifs with methods to add/remove motifs to the group, etc. Note that all motifs contained in a MotifGroup are guaranteed not to be empty - they will all have at least one node or edge.

Constructor

new MotifGroup(motifsopt, nullable)

Constructs a new MotifGroup with the specified initial list of motifs
Parameters:
Name Type Attributes Description
motifs Array.<Motif> <optional>
<nullable>
 the initial array of motifs
Source:

Methods

addMotif(motif)

Adds a motif to this motifGroup. If the motif is "empty" (it contains no nodes or edges), this method does nothing, and the empty motif will NOT be added to this group.
Parameters:
Name Type Description
motif Motif the motif to add to this group.
Source:

addMotifGroup(motifGroup)

Adds all of the motifs in another MotifGroup this this group. the other MotifGroup will not be modified.
Parameters:
Name Type Description
motifGroup MotifGroup The motif group whose motifs are to be added to this group
Source:

getEdges() → {Array.<Array.<AbstractNode>>}

Gets all of the edges in all of the motifs in this motif group.
Source:
Returns:
all of the edges as an array. For information on how the edges are stored, see Motif#getEdges
Type
Array.<Array.<AbstractNode>>

getMotifs() → {Array.<Motif>}

Gets all of the motifs contained in this motif group
Source:
Returns:
the motifs in this motif group as an array
Type
Array.<Motif>

getNodes() → {Array.<AbstractNode>}

Gets all of the nodes in all of the motifs in this motif group.
Source:
Returns:
all of the nodes in all of the motifs in this motif group as an array
Type
Array.<AbstractNode>