Class GraphStructure<K, V>`Abstract`

Abstract class representing a graph structure.

Type Parameters

K

The type of the vertices in the graph.
V

The type of the values associated with the vertices.

Hierarchy

GraphStructure
- Graph
- WeightedGraph

Index

Constructors

Properties

Accessors

asMatrix size vertices

Methods

addEdge getEdges getPath hasVertex isAdjacent removeEdge removeVertex

Constructors

constructor

new GraphStructure<K, V>(vertex): GraphStructure<K, V>
Creates a new graph structure with the given vertex.
Type Parameters
- K
- V
Parameters
- vertex: K
  
  The vertex to add to the graph.
Returns GraphStructure<K, V>
- Defined in src/structures/interfaces.ts:61

Properties

`Protected` map

map: Map<K, V[]> = ...

Accessors

asMatrix

get asMatrix(): Matrix
Returns the graph as an adjacency matrix.

Returns Matrix
A matrix representing the graph.
- Defined in src/structures/interfaces.ts:142

size

get size(): number
Returns the number of vertices in the graph.

Returns number
The number of vertices in the graph.
- Defined in src/structures/interfaces.ts:164

vertices

get vertices(): readonly K[]
Returns an array of vertices in the graph.

Returns readonly K[]
An array of vertices.
- Defined in src/structures/interfaces.ts:156

Methods

`Abstract` addEdge

addEdge(v1, v2): GraphStructure<K, V>
Adds an edge between two vertices in the graph.
Parameters
- v1: K
  
  The first vertex.
- v2: K
  
  The second vertex.
Returns GraphStructure<K, V>
The graph structure instance.
- Defined in src/structures/interfaces.ts:71

`Abstract` getEdges

getEdges(vertex): readonly K[]
Returns an array of vertices adjacent to the given vertex.
Parameters
- vertex: K
  
  The vertex to get the adjacent vertices for.
Returns readonly K[]
An array of adjacent vertices.
- Defined in src/structures/interfaces.ts:86

getPath

getPath(v1, v2): readonly K[]
Returns the shortest path between two vertices in the graph.
Parameters
- v1: K
  
  The starting vertex.
- v2: K
  
  The ending vertex.
Returns readonly K[]
An array of vertices representing the shortest path.

Throws
An error if the path could not be found.
- Defined in src/structures/interfaces.ts:110

hasVertex

hasVertex(vertex): boolean
Returns true if the graph contains the given vertex, false otherwise.
Parameters
- vertex: K
  
  The vertex to check for.
Returns boolean
True if the graph contains the vertex, false otherwise.
- Defined in src/structures/interfaces.ts:134

`Abstract` isAdjacent

isAdjacent(v1, v2): boolean
Returns a boolean indicating if two vertices are adjacent in the graph.
Parameters
- v1: K
  
  The first vertex.
- v2: K
  
  The second vertex.
Returns boolean
True if the vertices are adjacent, false otherwise.
- Defined in src/structures/interfaces.ts:94

`Abstract` removeEdge

removeEdge(v1, v2): GraphStructure<K, V>
Removes an edge between two vertices in the graph.
Parameters
- v1: K
  
  The first vertex.
- v2: K
  
  The second vertex.
Returns GraphStructure<K, V>
The graph structure instance.
- Defined in src/structures/interfaces.ts:79

`Abstract` removeVertex

removeVertex(vertex): GraphStructure<K, V>
Removes a vertex from the graph.
Parameters
- vertex: K
  
  The vertex to remove.
Returns GraphStructure<K, V>
The graph structure instance.
- Defined in src/structures/interfaces.ts:101