Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CPMClusteringAlgorithm Abstract

Abstract base class for clustering algorithms that use the CPM quality function.

Hierarchy

Implements

Index

Properties

Constructors

Methods

Properties

Static Readonly DEFAULT_RESOLUTION

DEFAULT_RESOLUTION: number = 1

Default resolution parameter.

Protected resolution

resolution: number

Resolution parameter.

Constructors

constructor

Methods

initializeBasedOnResolution

  • initializeBasedOnResolution(resolution: number): void

  • Initializes a CPM clustering algorithm with a specified resolution parameter.

    Parameters

    • resolution: number

      Resolution parameter

    Returns void

getResolution

  • getResolution(): number

setResolution

  • setResolution(resolution: number): void

calcQuality

  • Calculates the quality of a clustering using the CPM quality function.

    The CPM quality function is given by

    1 / (2 * m) * sum(d(c[i], c[j]) * (a[i][j] - resolution * n[i] *
    n[j])),

    where a[i][j] is the weight of the edge between nodes i and j, n[i] is the weight of node i, m is the total edge weight, and resolution is the resolutionparameter. The function d(c[i], c[j]) equals 1 if nodes i and j belong to the same cluster and 0 otherwise. The sum is taken over all pairs of nodes i and j.

    Modularity can be expressed in terms of CPM by setting n[i] equal to the total weight of the edges between node i and its neighbors and by rescaling the resolution parameter by 2 * m.

    Parameters

    Returns number

    Quality of the clustering

removeCluster

  • Removes a cluster from a clustering by merging the cluster with another cluster. If a cluster has no connections with other clusters, it cannot be removed.

    Parameters

    • network: Network

      Network

    • clustering: Clustering

      Clustering

    • cluster: number

      Cluster to be removed

    Returns number

    Cluster with which the cluster to be removed has been merged, or -1 if the cluster could not be removed

removeSmallClustersBasedOnNNodes

  • removeSmallClustersBasedOnNNodes(network: Network, clustering: Clustering, minNNodesPerCluster: number): boolean

  • Removes small clusters from a clustering. Clusters are merged until each cluster contains at least a certain minimum number of nodes.

    Parameters

    • network: Network

      Network

    • clustering: Clustering

      Clustering

    • minNNodesPerCluster: number

      Minimum number of nodes per cluster

    Returns boolean

    Boolean indicating whether any clusters have been removed

removeSmallClustersBasedOnWeight

  • removeSmallClustersBasedOnWeight(network: Network, clustering: Clustering, minClusterWeight: number): boolean

  • Removes small clusters from a clustering. Clusters are merged until each cluster has at least a certain minimum total node weight.

    The total node weight of a cluster equals the sum of the weights of the nodes belonging to the cluster.

    Parameters

    • network: Network

      Network

    • clustering: Clustering

      Clustering

    • minClusterWeight: number

      Minimum total node weight of a cluster

    Returns boolean

    Boolean indicating whether any clusters have been removed

Abstract clone

Abstract findClustering

Generated using TypeDoc