Class Class<D, S>

The class with functionality for the base node type.

Type Parameters

D extends FunctionNode.Data = FunctionNode.Data
S extends FunctionNode.ScratchData = FunctionNode.ScratchData

Hierarchy (View Summary)

BaseNode.Class<D, S>
- Class
  - ClavaFunctionNode.Class

Accessors

adjacentEdges

get adjacentEdges(): EdgeCollection<
BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>,
>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges that are adjacent to this node.
Inherited from BaseNode.Class.adjacentEdges
- Defined in flow/src/graph/BaseNode.ts:417

adjacentNodes

get adjacentNodes(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The nodes that are adjacent to this node.
Inherited from BaseNode.Class.adjacentNodes
- Defined in flow/src/graph/BaseNode.ts:424

ancestors

get ancestors(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The ancestors (parents, parents' parents, etc.) of this node.
Inherited from BaseNode.Class.ancestors
- Defined in flow/src/graph/BaseNode.ts:108

cfgEntryNode

get cfgEntryNode(): | ControlFlowNode.Class<
ControlFlowNode.Data,
ControlFlowNode.ScratchData,
>
| undefined
Returns
    | ControlFlowNode.Class<
        ControlFlowNode.Data,
        ControlFlowNode.ScratchData,
    >
    | undefined
The initial node of the function's CFG. This is the entry point of the function.
- Defined in flow/src/flow/FunctionNode.ts:68
set cfgEntryNode(
    node:
        | ControlFlowNode.Class<
            ControlFlowNode.Data,
            ControlFlowNode.ScratchData,
        >
        | undefined,
): void
Sets the initial node of the function's CFG. This is the entry point of the function.
Parameters
- node:
      | ControlFlowNode.Class<
          ControlFlowNode.Data,
          ControlFlowNode.ScratchData,
      >
      | undefined
  The new entry node.
Returns void
- Defined in flow/src/flow/FunctionNode.ts:80

children

get children(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The children of this node.
Inherited from BaseNode.Class.children
- Defined in flow/src/graph/BaseNode.ts:120

controlFlowNodes

get controlFlowNodes(): NodeCollection<
ControlFlowNode.Class<ControlFlowNode.Data, ControlFlowNode.ScratchData>,
>
Returns NodeCollection<
ControlFlowNode.Class<ControlFlowNode.Data, ControlFlowNode.ScratchData>,
>
The control flow nodes that belong to this function.
- Defined in flow/src/flow/FunctionNode.ts:58

data

get data(): D
Use the data object for JSON serializable data. For temporary or non-serializable data, use BaseNode.Class.scratchData.

Returns D
the data object associated with this node.
Inherited from BaseNode.Class.data
- Defined in flow/src/graph/BaseNode.ts:58

degree

get degree(): number
Returns the number of edges connected to this node. Loop edges are counted twice.

Returns number
the degree of this node.
Inherited from BaseNode.Class.degree
- Defined in flow/src/graph/BaseNode.ts:312

degreeWithoutLoops

get degreeWithoutLoops(): number
Returns the number of edges connected to this node. Loop edges are not counted.

Returns number
the degree of this node, excluding loop edges.
Inherited from BaseNode.Class.degreeWithoutLoops
- Defined in flow/src/graph/BaseNode.ts:322

descendants

get descendants(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The descendants (children, children's children, etc.) of this node.
Inherited from BaseNode.Class.descendants
- Defined in flow/src/graph/BaseNode.ts:127

functionName

get functionName(): string
Returns string
The name of the function. This name must be unique in the graph, so it should be mangled if the use case permits overloading.
- Defined in flow/src/flow/FunctionNode.ts:28

graph

get graph(): BaseGraph.Class
Returns BaseGraph.Class
the graph that this node is a part of.
Inherited from BaseNode.Class.graph
- Defined in flow/src/graph/BaseNode.ts:571

id

get id(): string
Returns string
the unique identifier of this node.
Inherited from BaseNode.Class.id
- Defined in flow/src/graph/BaseNode.ts:80

incomers

get incomers(): EdgeCollection<
BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>,
>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges that connect to this node.
Inherited from BaseNode.Class.incomers
- Defined in flow/src/graph/BaseNode.ts:367

indegree

get indegree(): number
Returns the number of edges that are directed towards this node.

Returns number
the indegree of this node.
Inherited from BaseNode.Class.indegree
- Defined in flow/src/graph/BaseNode.ts:331

indegreeWithoutLoops

get indegreeWithoutLoops(): number
Returns the number of edges that are directed towards this node. Loop edges are not counted.

Returns number
the indegree of this node, excluding loop edges.
Inherited from BaseNode.Class.indegreeWithoutLoops
- Defined in flow/src/graph/BaseNode.ts:341

isChild

get isChild(): boolean
Returns boolean
whether this node is a child node.
Inherited from BaseNode.Class.isChild
- Defined in flow/src/graph/BaseNode.ts:146

isParent

get isParent(): boolean
Returns boolean
whether this node is a parent node.
Inherited from BaseNode.Class.isParent
- Defined in flow/src/graph/BaseNode.ts:139

isRemoved

get isRemoved(): boolean
Returns boolean
whether this node has been removed from the graph.
Inherited from BaseNode.Class.isRemoved
- Defined in flow/src/graph/BaseNode.ts:545

outdegree

get outdegree(): number
Returns the number of edges that are directed away from this node.

Returns number
the outdegree of this node.
Inherited from BaseNode.Class.outdegree
- Defined in flow/src/graph/BaseNode.ts:350

outdegreeWithoutLoops

get outdegreeWithoutLoops(): number
Returns the number of edges that are directed away from this node. Loop edges are not counted.

Returns number
the outdegree of this node, excluding loop edges.
Inherited from BaseNode.Class.outdegreeWithoutLoops
- Defined in flow/src/graph/BaseNode.ts:360

outgoers

get outgoers(): EdgeCollection<
BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>,
>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges that connect from this node.
Inherited from BaseNode.Class.outgoers
- Defined in flow/src/graph/BaseNode.ts:392

parent

get parent(): BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined
Returns BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined
the parent node of this node.
Inherited from BaseNode.Class.parent
- Defined in flow/src/graph/BaseNode.ts:87
set parent(
node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined,
): void
Changes the parent node of this node.
Parameters
- node: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined
  The new parent node. If undefined, the node becomes orphan.
Returns void
Inherited from BaseNode.Class.parent
- Defined in flow/src/graph/BaseNode.ts:101

predecessors

get predecessors(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The predecessors of this node. This repeatedly follows the sources of incoming edges.
Inherited from BaseNode.Class.predecessors
- Defined in flow/src/graph/BaseNode.ts:380

scratchData

get scratchData(): S
Use the scratch data object for temporary or non-serializable data. For JSON serializable data, use BaseEdge.Class.data.

The scratch data is stored under the @specs-feup/flow namespace.

Returns S
the scratch data object associated with this node.
Inherited from BaseNode.Class.scratchData
- Defined in flow/src/graph/BaseNode.ts:70

successors

get successors(): NodeCollection<
BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
The successors of this node. This repeatedly follows the targets of outgoing edges.
Inherited from BaseNode.Class.successors
- Defined in flow/src/graph/BaseNode.ts:405

Methods

as

as<N2 extends BaseNode.Class<D, S>>(
NodeType: { Class: Node.Class<D, S, N2> },
): N2
Changes the functionality class of the current node. This is only possible if the data and scratch data are compatible with the new class. To assert that, use BaseNode.Class.is.
Type Parameters
- N2 extends BaseNode.Class<D, S>
Parameters
- NodeType: { Class: Node.Class<D, S, N2> }
  The node type to change the functionality class into.
Returns N2
The same node, wrapped in the new functionality class.
Inherited from Class.as
- Defined in flow/src/graph/BaseNode.ts:212

bfs

bfs(propagate?: (edge: BaseEdge.Class) => boolean): Generator<SearchVisit>
Parameters
- Optionalpropagate: (edge: BaseEdge.Class) => boolean
Returns Generator<SearchVisit>
Inherited from Class.bfs
- Defined in flow/src/graph/BaseNode.ts:531

dfs

dfs(propagate?: (edge: BaseEdge.Class) => boolean): Generator<SearchVisit>
Parameters
- Optionalpropagate: (edge: BaseEdge.Class) => boolean
Returns Generator<SearchVisit>
Inherited from Class.dfs
- Defined in flow/src/graph/BaseNode.ts:512

edgesFrom

edgesFrom(
    nodes:
        | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
        | NodeCollection<
            BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
            BaseNode.Data,
            BaseNode.ScratchData,
        >,
): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
Retrieves the edges from the given nodes to this node.
Parameters
- nodes:
      | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
      | NodeCollection<
          BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
          BaseNode.Data,
          BaseNode.ScratchData,
      >
  The node or collection of nodes to check for edges connected with this node.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges from the given nodes to this node.
Inherited from Class.edgesFrom
- Defined in flow/src/graph/BaseNode.ts:468

edgesTo

edgesTo(
    nodes:
        | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
        | NodeCollection<
            BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
            BaseNode.Data,
            BaseNode.ScratchData,
        >,
): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
Retrieves the edges from this node to the given nodes.
Parameters
- nodes:
      | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
      | NodeCollection<
          BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
          BaseNode.Data,
          BaseNode.ScratchData,
      >
  The node or collection of nodes to check for edges connected with this node.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges from this node to the given nodes.
Inherited from Class.edgesTo
- Defined in flow/src/graph/BaseNode.ts:452

edgesWith

edgesWith(
    nodes:
        | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
        | NodeCollection<
            BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
            BaseNode.Data,
            BaseNode.ScratchData,
        >,
): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
Retrieves the edges that connect this node with the given nodes. Direction is not considered.
Parameters
- nodes:
      | BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
      | NodeCollection<
          BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
          BaseNode.Data,
          BaseNode.ScratchData,
      >
  The node or collection of nodes to check for edges connected with this node.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
The edges that connect this node with the given nodes.
Inherited from Class.edgesWith
- Defined in flow/src/graph/BaseNode.ts:436

expect

expect<
    D2 extends BaseNode.Data,
    S2 extends BaseNode.ScratchData,
    N2 extends BaseNode.Class<D2, S2>,
>(
    NodeType: Node<D2, S2, N2>,
    message?: string,
): N2
Changes the functionality class of the current node. Should only be used when it is known (but not statically provable) that the node is compatible with the new class. If not, an error will be thrown.

It is bad practice to try and catch the error thrown by this function. For such cases, combine BaseNode.Class.is with BaseNode.Class.as, or use BaseNode.Class.switch instead.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
- N2 extends BaseNode.Class<D2, S2>
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to change the functionality class into.
- Optionalmessage: string
  The message to throw if the node is not compatible with the type.
Returns N2
The node, wrapped in the new functionality class.

Throws
LaraFlowError if the node is not compatible with the type. This error should be seen as a logic error and not catched.
Inherited from Class.expect
- Defined in flow/src/graph/BaseNode.ts:240

init

init<D2 extends BaseNode.Data, S2 extends BaseNode.ScratchData>(
builder: Node.Builder<D2, S2, D, S>,
): BaseNode.Class<D2, S2>
Initializes the node with the information of a builder. This is effectively extends the type of the node to include the data and scratch data of the builder.

The same node may simultaneously be of multiple types, as long as the data and scratch data are compatible with the types. The builder methods may overwrite data and scratch data fields with names that collide with its type's fields.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- builder: Node.Builder<D2, S2, D, S>
  The builder to use to initialize the node.
Returns BaseNode.Class<D2, S2>
The same node, with the data and scratch data of the builder. The node is downcasted to BaseNode.Class because the builder may overwrite the data and scratch data fields, invalidating the current type.
Inherited from Class.init
- Defined in flow/src/graph/BaseNode.ts:163

is

is<
    D2 extends BaseNode.Data,
    S2 extends BaseNode.ScratchData,
    N2 extends BaseNode.Class<D2, S2>,
>(
    NodeType: Node<D2, S2, N2>,
): this is BaseNode.Class<D2, S2>
Checks if this node's data and scratch data are compatible with a specific type. This is effectively a type guard function.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
- N2 extends BaseNode.Class<D2, S2>
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to check compatibility with.
Returns this is BaseNode.Class<D2, S2>
Whether the node is compatible with the given type.
Inherited from Class.is
- Defined in flow/src/graph/BaseNode.ts:186

isRegistered

isRegistered(): boolean
Returns boolean
Whether this function is registered in the graph.

Throws
LaraFlowError if the node is not part of a FlowGraph.
- Defined in flow/src/flow/FunctionNode.ts:158

register

register(): void
Registers the function in the graph, so that its name points to this node.

Returns void
Throws
LaraFlowError if the node is not part of a FlowGraph or if another function with the same name is already registered in the graph.
- Defined in flow/src/flow/FunctionNode.ts:125

remove

remove(): void
Removes this node from the graph.

Returns void
Inherited from Class.remove
- Defined in flow/src/graph/BaseNode.ts:538

renameFunction

renameFunction(name: string): this
Changes the function name. This name must be unique in the graph, so it should be mangled if the use case permits overloading.

The graph's function map will be updated.
Parameters
- name: string
  The new name of the function.
Returns this
Itself, for chaining.

Throws
LaraFlowError if the new function name already exists in the graph. This should be seen as a logic error and should not be catched. Instead, ensure that no existing function shares the same name by renaming or removing.
- Defined in flow/src/flow/FunctionNode.ts:45

restore

restore(): void
Restores this node if it has been removed. See BaseNode.Class.remove.

Returns void
Inherited from Class.restore
- Defined in flow/src/graph/BaseNode.ts:552

search

search<V extends SearchVisit>(
algorithm: Search<V, FunctionNode.Class<D, S>>,
): Generator<V>
Type Parameters
- V extends SearchVisit
Parameters
- algorithm: Search<V, FunctionNode.Class<D, S>>
Returns Generator<V>
Inherited from Class.search
- Defined in flow/src/graph/BaseNode.ts:491

switch

switch(
    ...cases: _Case<
        BaseNode.Data,
        BaseNode.ScratchData,
        BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
    >[],
): void
Checks if the type of the node is compatible with several types, calling a callback for the first match. See Node.Case for the syntax of each case.

For a default case, match with BaseNode, which will always be compatible with any node type.
Parameters
- ...cases: _Case<
      BaseNode.Data,
      BaseNode.ScratchData,
      BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
  >[]
  The cases to match against.
Returns void
Inherited from Class.switch
- Defined in flow/src/graph/BaseNode.ts:297

toCollection

toCollection(): NodeCollection<FunctionNode.Class<D, S>, D, S>
Returns NodeCollection<FunctionNode.Class<D, S>, D, S>
A collection containing only this node.
Inherited from Class.toCollection
- Defined in flow/src/graph/BaseNode.ts:559

toCy

toCy(): NodeSingular
Returns NodeSingular
the underlying cytoscape node object.
Inherited from Class.toCy
- Defined in flow/src/graph/BaseNode.ts:578

tryAs

tryAs<
    D2 extends BaseNode.Data,
    S2 extends BaseNode.ScratchData,
    N2 extends BaseNode.Class<D2, S2>,
>(
    NodeType: Node<D2, S2, N2>,
): N2 | undefined
Tries to change the functionality class of the current node. If the node is not compatible with the new class, undefined is returned.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
- N2 extends BaseNode.Class<D2, S2>
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to change the functionality class into.
Returns N2 | undefined
The node, wrapped in the new functionality class, or undefined if the node is not compatible with the type.
Example
```
if (node === undefined || !node.is(ControlFlowNode)) {
    return undefined;
}
return node.as(ControlFlowNode);
```
Can be simplified to:
```
return node?.tryAs(ControlFlowNode);
```
Inherited from Class.tryAs
- Defined in flow/src/graph/BaseNode.ts:276

unregister

unregister(): void
Unregisters the function from the graph, removing its name from the function map.

Returns void
Throws
LaraFlowError if the node is not part of a FlowGraph.
- Defined in flow/src/flow/FunctionNode.ts:138

Class Class<D, S>

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

adjacentEdges

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>

adjacentNodes

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

ancestors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

cfgEntryNode

Returns | ControlFlowNode.Class< ControlFlowNode.Data, ControlFlowNode.ScratchData, > | undefined

Parameters

Returns void

children

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

controlFlowNodes

Returns NodeCollection< ControlFlowNode.Class<ControlFlowNode.Data, ControlFlowNode.ScratchData>,>

data

Returns D

degree

Returns number

degreeWithoutLoops

Returns number

descendants

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

functionName

Returns string

graph

Returns BaseGraph.Class

id

Returns string

incomers

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>

indegree

Returns number

indegreeWithoutLoops

Returns number

isChild

Returns boolean

isParent

Returns boolean

isRemoved

Returns boolean

outdegree

Returns number

outdegreeWithoutLoops

Returns number

outgoers

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>

parent

Returns BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined

Parameters

Returns void

predecessors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

scratchData

Returns S

successors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>

Methods

as

Type Parameters

Parameters

Returns N2

bfs

Parameters

Returns Generator<SearchVisit>

dfs

Parameters

Returns Generator<SearchVisit>

edgesFrom

Parameters

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>

edgesTo

Parameters

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>

Returns
| ControlFlowNode.Class<
ControlFlowNode.Data,
ControlFlowNode.ScratchData,
>
| undefined

Returns NodeCollection<
ControlFlowNode.Class<ControlFlowNode.Data, ControlFlowNode.ScratchData>,
>