Class DedupedEdgesGraph<T>

Type Parameters

T extends DataType = any

Hierarchy (View Summary)

Graph<T>
- DedupedEdgesGraph

Index

Accessors

edgeIds edges nodeIds nodes numEdges numNodes

Methods

analyzeClustering computeClusters dedupeEdges degree forceAtlas2 fromEdgeList

Accessors

edgeIds

get edgeIds(): DataFrame<{ dst: Int32; id: Int32; src: Int32 }>
Returns DataFrame<{ dst: Int32; id: Int32; src: Int32 }>
Inherited from Graph.edgeIds
- Defined in graph.ts:92

edges

get edges(): DataFrame<
    {
        dst: (T & DataType) & DataType;
        id: (Int32 & DataType) & DataType;
        src: (T & DataType) & DataType;
        weight: (Float32 & DataType) & DataType;
    },
>
Returns DataFrame<
    {
        dst: (T & DataType) & DataType;
        id: (Int32 & DataType) & DataType;
        src: (T & DataType) & DataType;
        weight: (Float32 & DataType) & DataType;
    },
>
Inherited from Graph.edges
- Defined in graph.ts:73

nodeIds

get nodeIds(): DataFrame<{ id: Int32 }>
Returns DataFrame<{ id: Int32 }>
Inherited from Graph.nodeIds
- Defined in graph.ts:90

nodes

get nodes(): DataFrame<{ node: T }>
Returns DataFrame<{ node: T }>
Inherited from Graph.nodes
- Defined in graph.ts:71

numEdges

get numEdges(): number
Returns number
Inherited from Graph.numEdges
- Defined in graph.ts:64

numNodes

get numNodes(): number
Returns number
Inherited from Graph.numNodes
- Defined in graph.ts:69

Methods

analyzeClustering

analyzeClustering(options: AnalyzeClusteringOptions): number
Parameters
- options: AnalyzeClusteringOptions
Returns number
The computed clustering score
- Defined in graph.ts:218

computeClusters

computeClusters(
options: ClusteringOptions,
): DataFrame<{ cluster: Int32; vertex: Int32 }>
Parameters
- options: ClusteringOptions
  Options for the clustering method
Returns DataFrame<{ cluster: Int32; vertex: Int32 }>
See
- https://en.wikipedia.org/wiki/Cluster_analysis
- https://en.wikipedia.org/wiki/Spectral_clustering
- Defined in graph.ts:190

dedupeEdges

dedupeEdges(): DedupedEdgesGraph<Series<(T & DataType) & DataType>["type"]>
Returns DedupedEdgesGraph<Series<(T & DataType) & DataType>["type"]>
Inherited from Graph.dedupeEdges
- Defined in graph.ts:94

degree

degree(): DataFrame<{ degree: Int32; vertex: Int32 }>
Returns DataFrame<{ degree: Int32; vertex: Int32 }>
Inherited from Graph.degree
- Defined in graph.ts:104

forceAtlas2

forceAtlas2(options?: ForceAtlas2Options<any>): Float32Buffer
Parameters
- options: ForceAtlas2Options<any> = ...
Returns Float32Buffer
The new positions.

Note
Peak memory allocation occurs at 30*V.
Inherited from Graph.forceAtlas2
- Defined in graph.ts:117

`Static`fromEdgeList

fromEdgeList<T extends Series<DataType>>(
    src: T,
    dst: T,
    weights?: Float32Series,
    options?: GraphOptions,
): DedupedEdgesGraph<T["type"]>
Type Parameters
- T extends Series<DataType>
Parameters
- src: T
- dst: T
- weights: Float32Series = ...
- options: GraphOptions = ...
Returns DedupedEdgesGraph<T["type"]>
Overrides Graph.fromEdgeList
- Defined in graph.ts:155

Class DedupedEdgesGraph<T>

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

edgeIds

Returns DataFrame<{ dst: Int32; id: Int32; src: Int32 }>

edges

Returns DataFrame< { dst: (T & DataType) & DataType; id: (Int32 & DataType) & DataType; src: (T & DataType) & DataType; weight: (Float32 & DataType) & DataType; },>

nodeIds

Returns DataFrame<{ id: Int32 }>

nodes

Returns DataFrame<{ node: T }>

numEdges

Returns number

numNodes

Returns number

Methods

analyzeClustering

Parameters

Returns number

computeClusters

Parameters

Returns DataFrame<{ cluster: Int32; vertex: Int32 }>

See

dedupeEdges

Returns DedupedEdgesGraph<Series<(T & DataType) & DataType>["type"]>

degree

Returns DataFrame<{ degree: Int32; vertex: Int32 }>

forceAtlas2

Parameters

Returns Float32Buffer

Note

StaticfromEdgeList

Type Parameters

Parameters

Returns DedupedEdgesGraph<T["type"]>

Settings

On This Page

Returns DataFrame<
{
dst: (T & DataType) & DataType;
id: (Int32 & DataType) & DataType;
src: (T & DataType) & DataType;
weight: (Float32 & DataType) & DataType;
},
>

`Static`fromEdgeList