Class DistanceMatrix<TRowKey, TColumnKey, TValue>

A Sparse Matrix representation of a distance graph.

Inheritance

System.Object

DistanceMatrix<TRowKey, TColumnKey, TValue>

Namespace: SigStat.Common

Assembly: SigStat.Common.dll

Syntax

public class DistanceMatrix<TRowKey, TColumnKey, TValue> : object

Type Parameters

Name	Description
TRowKey	Type to represent the row indexes
TColumnKey	Type to represent the column indexes
TValue	Type to represent the distances

Properties

Item[TRowKey, TColumnKey]

Gets or sets a distance for a given row and column

Declaration

public TValue this[TRowKey row, TColumnKey column] { get; set; }

Parameters

Type	Name	Description
TRowKey	row	row
TColumnKey	column	column

Property Value

Type	Description
TValue

Methods

ContainsKey(TRowKey, TColumnKey)

Determines whether the Matrix contains the specified key pair

Declaration

public bool ContainsKey(TRowKey row, TColumnKey column)

Parameters

Type	Name	Description
TRowKey	row
TColumnKey	column

Returns

Type	Description
System.Boolean	true if the Matrix contains an element with the specified keys; otherwise, false.

GetDistance(TRowKey, TColumnKey)

Gets or sets a distance for a given row and column

Declaration

public TValue GetDistance(TRowKey row, TColumnKey column)

Parameters

Type	Name	Description
TRowKey	row	row
TColumnKey	column	column

Returns

Type	Description
TValue

TryGetValue(TRowKey, TColumnKey, out TValue)

Gets the value associated with the specified keys.

Declaration

public bool TryGetValue(TRowKey row, TColumnKey column, out TValue value)

Parameters

Type	Name	Description
TRowKey	row
TColumnKey	column
TValue	value

Returns

Type	Description
System.Boolean	true if the Matrix contains an element with the specified keys; otherwise, false.