Returns all common ancestors of id1 and id2. If either id1 or id2 are not found in the ancestry an error is thrown.
Returns the id of the closest ancestor of id1 and id2. If either id1 or id2 are not found in the ancestry an error is thrown.
When using the predicate a return value of false
will cause grama to look
for the next closest common ancestor, i.e. the returned id is not of the actual
closest ancestor, but the closest one that matches the predicate.
(String | Number)
:
the id of the closest common ancestor or
null
if it doesn't exist
Returns the id of the furthest ancestor of id1 and id2. If either id1 or id2 are not found in the ancestry an error is thrown.
When using the predicate a return value of false
will cause grama to look
for the next furthest common ancestor, i.e. the returned id is not of the actual
furthest ancestor, but the furthest one that matches the predicate.
(String | Number)
:
the id of the furthest common ancestor or
null
if it doesn't exist
Finds the closes ancestor that matches the predicate. If two ancestors match the predicate and have the same distance, the first one found is returned.
Therefore this function is non-deterministic since it depends on the order in which ancestors were added.
(String | Number)
:
the id of the first ancestor matching the predicate
Finds all ancestors that match the predicate.
Set<(String | Number)>
:
the ids of all ancestors matching the predicate
Finds the closes descendant that matches the predicate. If two descendants match the predicate and have the same distance, the first one found is returned.
Therefore this function is non-deterministic since it depends on the order in which descendants were added.
(String | Number)
:
the id of the first descendant matching the predicate
Finds all descendants that match the predicate.
Set<(String | Number)>
:
the ids of all descendants matching the predicate
Finds the closest sibling to the node with the provided id that matches the predicate.
It's not exactly a sibling but any node that is a descendant of an
ancestor of the node with the provided id
.
We consider the siblings closest if the distance from the node at id
to
the common ancestor is shortest.
For instance in the example below we are trying to find the closest sibling of WriteStream:Close.
Our predicate looks for anything that is a WriteStream:Write
.
WriteStream:Write2
is considered a closer sibling since the common ancestor Read2
is at a shorter
distance to WriteStream:Close
than Read1
which is the ancestor of the other WriteStream:Write1
.
-- ReadStream:Open -- Read1 -- Read2 -- Read3 -- WriteStream:Close
/ \ \
Parent \ -- WriteStream:Write2
\ -- WriteStream:Write1
-- WriteStream:Open
(Function)
needs to return
true
in order to determine a node as a sibling,
it is invoked with
({ descendantId, descendantDistance, ancestorId, ancestorDistance })
.
(String | Number)
:
the id of the closest sibling matching the predicate
Finds the all siblings to the node with the provided id that match the predicate.
It's not exactly a sibling but any node that is a descendant of an
ancestor of the node with the provided id
.
For instance in the example below we are trying to find all siblings to
WriteStream:Close
that start with WriteStream
.
The result would include WriteStream:Write2
, WriteStream:Write1
and WriteStream:Open
.
-- ReadStream:Open -- Read1 -- Read2 -- Read3 -- WriteStream:Close
/ \ \
Parent \ -- WriteStream:Write2
\ -- WriteStream:Write1
-- WriteStream:Open
(Function)
needs to return
true
in order to determine a node as a sibling,
it is invoked with
({ descendantId, descendantDistance, ancestorId, ancestorDistance })
.
Set<(String | Number)>
:
the ids of the siblings matching the predicate
Determines if the given id is part of the nodes that were passed to grama.
Boolean
:
true
if so otherwise
false
Retrieves the node with the given id from the nodes that were passed to grama.
Object
:
the node with the supplied id or
null
if not found
Creates grama who will tell you about the ancestry of the nodes you passed.
Object
:
an instance of Grama