graphology-metrics - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

centrality/index.d.ts

 export {default as betweenness} from './betweenness';
+export {default as edgeBetweenness} from './edge-betweenness';
 export {default as closeness} from './closeness';
@@ -3,0 +4,0 @@ export {

centrality/index.js

@@ -10,2 +10,3 @@ /**
 exports.betweenness = require('./betweenness.js');
+exports.edgeBetweenness = require('./edge-betweenness.js');
 exports.closeness = require('./closeness.js');
@@ -12,0 +13,0 @@ exports.eigenvector = require('./eigenvector.js');

edge/disparity.js

@@ -84,11 +84,3 @@ /**
 
-  graph.forEachAssymetricAdjacencyEntry(function (
-    source,
-    target,
-    sa,
-    ta,
-    edge,
-    attr,
-    undirected
-  ) {
+  graph.forEachEdge(function (edge, attr, source, target, sa, ta, undirected) {
     var weight = getEdgeWeight(edge, attr, source, target, sa, ta, undirected);
@@ -95,0 +87,0 @@

package.json

 {
   "name": "graphology-metrics",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Miscellaneous graph metrics for graphology.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -35,2 +35,3 @@ # Graphology metrics
 - [Betweenness centrality](#betweenness-centrality)
+- [Edge betweenness centrality](#edge-betweenness-centrality)
 - [Closeness centrality](#closeness-centrality)
@@ -367,2 +368,37 @@ - [Degree centrality](#degree-centrality)
 
+### Edge betweenness centrality
+
+Computes the betweenness centrality for every edge.
+
+```js
+import edgeBetweennessCentrality from 'graphology-metrics/centrality/edge-betweenness';
+
+// To compute centrality for every edge:
+const centralities = edgeBetweennessCentrality(graph);
+
+// To directly map the result onto edges' attributes (`edgeBetweennessCentrality`):
+edgeBetweennessCentrality.assign(graph);
+
+// To directly map the result onto a custom attribute:
+edgeBetweennessCentrality.assign(graph, {
+  edgeCentralityAttribute: 'myCentrality'
+});
+
+// To ignore weights
+const centralities = edgeBetweennessCentrality(graph, {getEdgeWeight: null});
+
+// To use a getter function for weights
+const centralities = edgeBetweennessCentrality(graph, {
+  getEdgeWeight: (_, attr) => attr.importance
+});
+```
+
+_Arguments_
+
+- **graph** _Graph_: target graph.
+- **options** _?object_: options:
+  - **edgeCentralityAttribute** _?string_ [`betweennessCentrality`]: Name of the centrality attribute to assign.
+  - **getEdgeWeight** _?string\|function_ [`weight`]: Name of the edge weight attribute or getter function.
+  - **normalized** _?boolean_ [`true`]: should the result be normalized?
+
 ### Closeness centrality
@@ -369,0 +405,0 @@

No alert changes

Improved metrics

Total package byte prevSize

102914

increased by6.14%

Number of package files

55

increased by3.77%

Lines of code

2461

increased by5.58%

Number of lines in readme file

584

increased by6.57%

No dependency changes