Merge pull request #929 from AlfredClemedtson/add-clique-counting

Add clique counting

Author: AlfredClemedtson

doc/sphinx/algorithms.json

@@ -1150,6 +1150,38 @@
     },
     "description": "Returns an estimation of the memory consumption for that procedure."
   },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.mutate",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Counts the number of cliques, of different size, each node is part of."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.stream",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "DataFrame"
+    },
+    "description": "Counts the number of cliques, of different size, each node is part of."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.stats",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Counts the number of cliques, of different size, in the entire graph."
+  },
+  {
+    "function": {
+      "name": "gds.cliqueCounting.write",
+      "signature": "G: Graph, **config: Any",
+      "return_type": "Series[Any]"
+    },
+    "description": "Counts the number of cliques, of different size, each node is part of."
+  },
   {
     "function": {
       "name": "gds.scaleProperties.mutate",

doc/sphinx/source/algorithms.rst

@@ -661,6 +661,22 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Returns an estimation of the memory consumption for that procedure.
 
+.. py:function:: gds.cliqueCounting.mutate(G: Graph, **config: Any) -> Series[Any]
+
+    Counts the number of cliques, of different size, each node is part of.
+
+.. py:function:: gds.cliqueCounting.stream(G: Graph, **config: Any) -> DataFrame
+
+    Counts the number of cliques, of different size, each node is part of.
+
+.. py:function:: gds.cliqueCounting.stats(G: Graph, **config: Any) -> Series[Any]
+
+    Counts the number of cliques, of different size, in the entire graph.
+
+.. py:function:: gds.cliqueCounting.write(G: Graph, **config: Any) -> Series[Any]
+
+    Counts the number of cliques, of different size, each node is part of.
+
 .. py:function:: gds.scaleProperties.mutate(G: Graph, **config: Any) -> Series[Any]
 
     Scale node properties