graphology-metrics/centrality/betweenness.d.ts

Miscellaneous graph metrics for graphology.

import Graph, {Attributes} from 'graphology-types';
import {MinimalEdgeMapper} from 'graphology-utils/getters';

type BetweennessCentralityMapping = {[node: string]: number};

type BetweennessCentralityOptions<EdgeAttributes extends Attributes> = {
  nodeCentralityAttribute?: string;
  getEdgeWeight?:
    | keyof EdgeAttributes
    | MinimalEdgeMapper<number, EdgeAttributes>
    | null;
  normalized?: boolean;
};

interface IBetweennessCentrality {
  <
    NodeAttributes extends Attributes = Attributes,
    EdgeAttributes extends Attributes = Attributes
  >(
    graph: Graph<NodeAttributes, EdgeAttributes>,
    options?: BetweennessCentralityOptions<EdgeAttributes>
  ): BetweennessCentralityMapping;
  assign<
    NodeAttributes extends Attributes = Attributes,
    EdgeAttributes extends Attributes = Attributes
  >(
    graph: Graph<NodeAttributes, EdgeAttributes>,
    options?: BetweennessCentralityOptions<EdgeAttributes>
  ): void;
}

declare const betweennessCentrality: IBetweennessCentrality;

export default betweennessCentrality;