Skip to content

Typed API (TypeDoc)


Typed API (TypeDoc) / IncidenceMatrix

Class: IncidenceMatrix ​

Defined in: graph/src/matrix/incidence-matrix.ts:8

Constructors ​

Constructor ​

new IncidenceMatrix(vertexCount, edgeCount): IncidenceMatrix

Defined in: graph/src/matrix/incidence-matrix.ts:21

Parameters ​

vertexCount ​

number

edgeCount ​

number

Returns ​

IncidenceMatrix

Description ​

Create a new incidence matrix for a graph with vertexCount vertices and edgeCount reserved edge columns.

Accessors ​

edgeCount ​

Get Signature ​

get edgeCount(): number

Defined in: graph/src/matrix/incidence-matrix.ts:41

Description ​

Current number of columns (edges) tracked by the matrix.

Returns ​

number


vertexCount ​

Get Signature ​

get vertexCount(): number

Defined in: graph/src/matrix/incidence-matrix.ts:34

Description ​

Current number of rows (vertices) tracked by the matrix.

Returns ​

number

Methods ​

get() ​

get(v, e): -1 | 0 | 1

Defined in: graph/src/matrix/incidence-matrix.ts:48

Parameters ​

v ​

number

e ​

number

Returns ​

-1 | 0 | 1

Description ​

Returns the incidence value for vertex v in column e.


resizeEdges() ​

resizeEdges(newSize): void

Defined in: graph/src/matrix/incidence-matrix.ts:117

Parameters ​

newSize ​

number

Returns ​

void

Description ​

Adjust the number of edge columns tracked by the matrix.


resizeVertices() ​

resizeVertices(newSize): void

Defined in: graph/src/matrix/incidence-matrix.ts:99

Parameters ​

newSize ​

number

Returns ​

void

Description ​

Adjust the number of vertices tracked by the matrix. Any rows beyond the new count are cleared.


set() ​

set(v, e, value): void

Defined in: graph/src/matrix/incidence-matrix.ts:64

Parameters ​

v ​

number

e ​

number

value ​

-1 | 0 | 1

Returns ​

void

Description ​

Mutates the incidence value for vertex v in column e. At most two non-zero entries are kept per column.

Built with VitePress – Released under the MIT License.