Class Class<D, S>

The class with functionality for the base graph type.

Type Parameters

D extends CoralGraph.Data = CoralGraph.Data
S extends CoralGraph.ScratchData = CoralGraph.ScratchData

Hierarchy (View Summary)

ClavaFlowGraph.Class<D, S>
- Class

Accessors

clavaFunctions

get clavaFunctions(): NodeCollection<
    ClavaFunctionNode.Class<
        ClavaFunctionNode.Data,
        ClavaFunctionNode.ScratchData,
    >,
>
Returns NodeCollection<
    ClavaFunctionNode.Class<
        ClavaFunctionNode.Data,
        ClavaFunctionNode.ScratchData,
    >,
>
Inherited from ClavaFlowGraph.Class.clavaFunctions
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:20

config

get config(): CoralConfig
Returns CoralConfig
- Defined in coral/src/graph/CoralGraph.ts:51

data

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

Returns D
the data object associated with this graph.
Inherited from ClavaFlowGraph.Class.data
- Defined in flow/dist/graph/BaseGraph.d.ts:38

edges

get edges(): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>>
A collection of all edges in the graph.
Inherited from ClavaFlowGraph.Class.edges
- Defined in flow/dist/graph/BaseGraph.d.ts:197

functions

get functions(): NodeCollection<
FunctionNode.Class<FunctionNode.Data, FunctionNode.ScratchData>,
>
Retrieves all functions in the graph.

The functions must be in the map, the respective nodes must exist, and the nodes must be FunctionNode to be included in the collection.

Returns NodeCollection<FunctionNode.Class<FunctionNode.Data, FunctionNode.ScratchData>>
A collection of all functions in the graph.
Inherited from ClavaFlowGraph.Class.functions
- Defined in flow/dist/flow/FlowGraph.d.ts:76

functionsToAnalyze

get functionsToAnalyze(): NodeCollection<
    CoralFunctionNode.Class<
        CoralFunctionNode.Data,
        CoralFunctionNode.ScratchData,
    >,
>
Returns NodeCollection<
    CoralFunctionNode.Class<
        CoralFunctionNode.Data,
        CoralFunctionNode.ScratchData,
    >,
>
- Defined in coral/src/graph/CoralGraph.ts:21

instrumentation

get instrumentation(): Instrumentation
Returns Instrumentation
- Defined in coral/src/graph/CoralGraph.ts:55

isDebug

get isDebug(): boolean
Returns boolean
- Defined in coral/src/graph/CoralGraph.ts:47

nodes

get nodes(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>>
A collection of all nodes in the graph.
Inherited from ClavaFlowGraph.Class.nodes
- Defined in flow/dist/graph/BaseGraph.d.ts:193

scratchData

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

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

Returns S
the scratch data object associated with this graph.
Inherited from ClavaFlowGraph.Class.scratchData
- Defined in flow/dist/graph/BaseGraph.d.ts:47

Methods

addEdge

addEdge(
    source: BaseNode.Class,
    target: BaseNode.Class,
    id?: string,
): BaseEdge.Class
Adds a new empty edge to the graph, connecting two existing nodes.
Parameters
- source: BaseNode.Class
  The source node of the edge.
- target: BaseNode.Class
  The target node of the edge.
- Optionalid: string
  The id of the edge to add. If not provided, a new id will be generated.
Returns BaseEdge.Class
the newly created edge.
Inherited from Class.addEdge
- Defined in flow/dist/graph/BaseGraph.d.ts:175

addFunction

addFunction(
name: string,
node?: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
): FunctionNode.Class
Adds a FunctionNode to the graph, updating the function map.
Parameters
- name: 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.
- Optionalnode: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
  The node to initialize as the FunctionNode. If not provided, a new node will be created.
Returns FunctionNode.Class
The FunctionNode that was added.

Throws
LaraFlowError if the function name already exists in the graph. This should be seen as a logic error and should not catched. Instead, ensure that no existing function shares the same name by renaming or removing.
Inherited from Class.addFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:12
addFunction(
fn: FunctionJp,
node?: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
): ClavaFunctionNode.Class
Parameters
- fn: FunctionJp
- Optionalnode: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
Returns ClavaFunctionNode.Class
Inherited from Class.addFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:13

addNode

addNode(
id?: string,
parent?: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>,
): BaseNode.Class
Adds a new empty node to the graph.
Parameters
- Optionalid: string
  The id of the node to add. If not provided, a new id will be generated.
- Optionalparent: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>
  The parent node of the node to add. If not provided, the node will be orphan.
Returns BaseNode.Class
the newly created node.
Inherited from Class.addNode
- Defined in flow/dist/graph/BaseGraph.d.ts:166

apply

apply<G2 extends BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>>(
transformation: Transformation<CoralGraph.Class<D, S>, G2>,
): G2
Applies a Graph.Transformation to the graph. May be chained.
Type Parameters
- G2 extends BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>
Parameters
- transformation: Transformation<CoralGraph.Class<D, S>, G2>
  The transformation to apply.
Returns G2
The graph after applying the transformation.
Inherited from Class.apply
- Defined in flow/dist/graph/BaseGraph.d.ts:232

arrayCollection

arrayCollection<
    D extends BaseNode.Data,
    S extends BaseNode.ScratchData,
    N extends BaseNode.Class<D, S>,
>(
    NodeType: Node<D, S, N>,
    nodes: N[],
): NodeCollection<N, D, S>
Creates a collection from an array of nodes. Given that the array may be empty, passing the NodeType is mandatory.
Type Parameters
- D extends BaseNode.Data
- S extends BaseNode.ScratchData
- N extends BaseNode.Class<D, S>
Parameters
- NodeType: Node<D, S, N>
  The type of node to create a collection for.
- nodes: N[]
  The nodes to create a collection from.
Returns NodeCollection<N, D, S>
A collection of the given type with the given nodes.
Inherited from Class.arrayCollection
- Defined in flow/dist/graph/BaseGraph.d.ts:216
arrayCollection<
    D extends BaseEdge.Data,
    S extends BaseEdge.ScratchData,
    E extends BaseEdge.Class<D, S>,
>(
    EdgeType: Edge<D, S, E>,
    edges: E[],
): EdgeCollection<E, D, S>
Creates a collection from an array of edges. Given that the array may be empty, passing the EdgeType is mandatory.
Type Parameters
- D extends BaseEdge.Data
- S extends BaseEdge.ScratchData
- E extends BaseEdge.Class<D, S>
Parameters
- EdgeType: Edge<D, S, E>
  The type of edge to create a collection for.
- edges: E[]
  The edges to create a collection from.
Returns EdgeCollection<E, D, S>
A collection of the given type with the given edges.
Inherited from Class.arrayCollection
- Defined in flow/dist/graph/BaseGraph.d.ts:225

as

as<G extends BaseGraph.Class<D, S>>(
GraphType: { Class: Graph.Class<D, S, G> },
): G
Changes the functionality class of the current graph. This is only possible if the data and scratch data are compatible with the new class. To assert that, use BaseGraph.Class.is.
Type Parameters
- G extends BaseGraph.Class<D, S>
Parameters
- GraphType: { Class: Graph.Class<D, S, G> }
  The graph type to change the functionality class into.
Returns G
The same graph, wrapped in the new functionality class.
Inherited from Class.as
- Defined in flow/dist/graph/BaseGraph.d.ts:78

emptyCollection

emptyCollection<
    N extends BaseNode.Class<D, S>,
    D extends BaseNode.Data,
    S extends BaseNode.ScratchData,
>(
    NodeType: Node<D, S, N>,
): NodeCollection<N, D, S>
Type Parameters
- N extends BaseNode.Class<D, S>
- D extends BaseNode.Data
- S extends BaseNode.ScratchData
Parameters
- NodeType: Node<D, S, N>
  The type of node to create an empty collection for.
Returns NodeCollection<N, D, S>
An empty collection of the given type.
Inherited from Class.emptyCollection
- Defined in flow/dist/graph/BaseGraph.d.ts:202
emptyCollection<
    D extends BaseEdge.Data,
    S extends BaseEdge.ScratchData,
    E extends BaseEdge.Class<D, S>,
>(
    EdgeType: Edge<D, S, E>,
): EdgeCollection<E, D, S>
Type Parameters
- D extends BaseEdge.Data
- S extends BaseEdge.ScratchData
- E extends BaseEdge.Class<D, S>
Parameters
- EdgeType: Edge<D, S, E>
  The type of edge to create an empty collection for.
Returns EdgeCollection<E, D, S>
An empty collection of the given type.
Inherited from Class.emptyCollection
- Defined in flow/dist/graph/BaseGraph.d.ts:207

expect

expect<
    D2 extends BaseGraph.Data,
    S2 extends BaseGraph.ScratchData,
    G2 extends BaseGraph.Class<D2, S2>,
>(
    GraphType: Graph<D2, S2, G2>,
    message?: string,
): G2
Changes the functionality class of the current graph. Should only be used when it is known (but not statically provable) that the graph 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 BaseGraph.Class.is with BaseGraph.Class.as, or use BaseGraph.Class.switch instead.
Type Parameters
- D2 extends BaseGraph.Data
- S2 extends BaseGraph.ScratchData
- G2 extends BaseGraph.Class<D2, S2>
Parameters
- GraphType: Graph<D2, S2, G2>
  The graph type to change the functionality class into.
- Optionalmessage: string
  The message to throw if the graph is not compatible with the type.
Returns G2
The graph, wrapped in the new functionality class.

Throws
LaraFlowError if the graph 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/dist/graph/BaseGraph.d.ts:96

getEdgeById

getEdgeById(
id: string,
): BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData> | undefined
Retrieve a specific edge from the graph by its id.
Parameters
- id: string
  The id of the edge to get.
Returns BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData> | undefined
The edge with the given id, or undefined if no such edge exists.
Inherited from Class.getEdgeById
- Defined in flow/dist/graph/BaseGraph.d.ts:189

getFunction

getFunction(
    name: string,
):
    | FunctionNode.Class<FunctionNode.Data, FunctionNode.ScratchData>
    | undefined
Retrieves a FunctionNode from the graph by the name of the function.

If the function is not in the map, the node does not exist, or the node is not a FunctionNode, undefined will be returned.
Parameters
- name: string
  The name of the function.
Returns FunctionNode.Class<FunctionNode.Data, FunctionNode.ScratchData> | undefined
The FunctionNode, or undefined if it does not exist.
Inherited from Class.getFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:14
getFunction(
    fn: FunctionJp,
):
    | ClavaFunctionNode.Class<
        ClavaFunctionNode.Data,
        ClavaFunctionNode.ScratchData,
    >
    | undefined
Parameters
- fn: FunctionJp
Returns
    | ClavaFunctionNode.Class<
        ClavaFunctionNode.Data,
        ClavaFunctionNode.ScratchData,
    >
    | undefined
Inherited from Class.getFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:15

getNodeById

getNodeById(
id: string,
): BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined
Retrieve a specific node from the graph by its id.
Parameters
- id: string
  The id of the node to get.
Returns BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | undefined
The node with the given id, or undefined if no such node exists.
Inherited from Class.getNodeById
- Defined in flow/dist/graph/BaseGraph.d.ts:182

getOrAddFunction

getOrAddFunction(name: string): FunctionNode.Class
Retrieves a FunctionNode from the graph by the name of the function. If the function does not exist, a new node will be created, updating the function map.
Parameters
- name: string
  The name of the function.
Returns FunctionNode.Class
The FunctionNode that was retrieved or created.
Inherited from Class.getOrAddFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:16
getOrAddFunction(fn: FunctionJp): ClavaFunctionNode.Class
Parameters
- fn: FunctionJp
Returns ClavaFunctionNode.Class
Inherited from Class.getOrAddFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:17

hasFunction

hasFunction(name: string): boolean
Checks if the graph has a function with the given name.

The function must be in the map, the respective node must exist, and the node must be a FunctionNode for this method to return true.
Parameters
- name: string
  The name of the function.
Returns boolean
true if the graph has a function with the given name, false otherwise.
Inherited from Class.hasFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:18
hasFunction(fn: FunctionJp): boolean
Parameters
- fn: FunctionJp
Returns boolean
Inherited from Class.hasFunction
- Defined in clava-flow/dist/ClavaFlowGraph.d.ts:19

init

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

The same graph 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 BaseGraph.Data
- S2 extends BaseGraph.ScratchData
Parameters
- builder: Graph.Builder<D2, S2, D, S>
  The builder to use to initialize the graph.
Returns BaseGraph.Class<D2, S2>
The same graph, with the data and scratch data of the builder. The graph is downcasted to BaseGraph.Class because the builder may overwrite the data and scratch data fields, invalidating the current type.
Inherited from Class.init
- Defined in flow/dist/graph/BaseGraph.d.ts:61

is

is<
    D2 extends BaseGraph.Data,
    S2 extends BaseGraph.ScratchData,
    G2 extends BaseGraph.Class<D2, S2>,
>(
    GraphType: Graph<D2, S2, G2>,
): this is BaseGraph.Class<D2, S2>
Checks if this graph's data and scratch data are compatible with a specific type. This is effectively a type guard function.
Type Parameters
- D2 extends BaseGraph.Data
- S2 extends BaseGraph.ScratchData
- G2 extends BaseGraph.Class<D2, S2>
Parameters
- GraphType: Graph<D2, S2, G2>
  The graph type to check compatibility with.
Returns this is BaseGraph.Class<D2, S2>
Whether the graph is compatible with the given type.
Inherited from Class.is
- Defined in flow/dist/graph/BaseGraph.d.ts:69

setEdgeIdGenerator

setEdgeIdGenerator(generator: Edge.IdGenerator | undefined): this
Sets the id generator to be used when generating edge identifiers. This id generator is only used when creating an edge without specifying an id. In other words, if an id is explicitly provided when creating an edge, it will have precedence over calling the id generator.

When no id generator is set and no id is provided when creating an edge, the id generation will be delegated to cytoscape.
Parameters
- generator: Edge.IdGenerator | undefined
  The id generator to use, or undefined to delegate to cytoscape's default id generation.
Returns this
itself for chaining.
Inherited from Class.setEdgeIdGenerator
- Defined in flow/dist/graph/BaseGraph.d.ts:157

setNodeIdGenerator

setNodeIdGenerator(generator: Node.IdGenerator | undefined): this
Sets the id generator to be used when generating node identifiers. This id generator is only used when creating a node without specifying an id. In other words, if an id is explicitly provided when creating a node, it will have precedence over calling the id generator.

When no id generator is set and no id is provided when creating a node, the id generation will be delegated to cytoscape.
Parameters
- generator: Node.IdGenerator | undefined
  The id generator to use, or undefined to delegate to cytoscape's default id generation.
Returns this
itself for chaining.
Inherited from Class.setNodeIdGenerator
- Defined in flow/dist/graph/BaseGraph.d.ts:143

switch

switch(
    ...cases: {
        callback: (g: any) => void;
        GraphType: Graph<any, any, any>;
    }[],
): void
Checks if the type of the graph is compatible with several types, calling a callback for the first match. See Graph.Case for the syntax of each case.

For a default case, match with BaseGraph, which will always be compatible with any graph type.
Parameters
- ...cases: { callback: (g: any) => void; GraphType: Graph<any, any, any> }[]
  The cases to match against.
Returns void
Inherited from Class.switch
- Defined in flow/dist/graph/BaseGraph.d.ts:129

toCy

toCy(): Core
Returns Core
the underlying cytoscape graph object.
Inherited from Class.toCy
- Defined in flow/dist/graph/BaseGraph.d.ts:252

toFile

toFile(formatter: Formatter<CoralGraph.Class<D, S>>, filename: string): void
Converts the graph to a string using a Graph.Formatter and writes it to a file.
Parameters
- formatter: Formatter<CoralGraph.Class<D, S>>
  The formatter to use.
- filename: string
  The name of the file to write to.
Returns void
The file to where the contents where written.
Inherited from Class.toFile
- Defined in flow/dist/graph/BaseGraph.d.ts:248

toString

toString(formatter: Formatter<CoralGraph.Class<D, S>>): string
Converts the graph to a string using a Graph.Formatter.
Parameters
- formatter: Formatter<CoralGraph.Class<D, S>>
  The formatter to use.
Returns string
The string representation of the graph.
Inherited from Class.toString
- Defined in flow/dist/graph/BaseGraph.d.ts:239

tryAs

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

Class Class<D, S>

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

clavaFunctions

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

config

Returns CoralConfig

data

Returns D

edges

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

functions

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

functionsToAnalyze

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

instrumentation

Returns Instrumentation

isDebug

Returns boolean

nodes

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

scratchData

Returns S

Methods

addEdge

Parameters

Returns BaseEdge.Class

addFunction

Parameters

Returns FunctionNode.Class

Throws

Parameters

Returns ClavaFunctionNode.Class

addNode

Parameters

Returns BaseNode.Class

apply

Type Parameters

Parameters

Returns G2

arrayCollection

Type Parameters

Parameters

Returns NodeCollection<N, D, S>

Type Parameters

Parameters

Returns EdgeCollection<E, D, S>

as

Type Parameters

Parameters

Returns G

emptyCollection

Type Parameters

Parameters

Returns NodeCollection<N, D, S>

Type Parameters

Parameters

Returns EdgeCollection<E, D, S>

expect

Type Parameters

Parameters

Returns G2

Throws

getEdgeById

Parameters

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

getFunction

Parameters

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

Parameters

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

getNodeById

Parameters

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

getOrAddFunction

Parameters

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

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

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