Merge pull request #932 from AlfredClemedtson/add-clique-counting-memory-estimation

Add clique counting memory estimation.

Author: AlfredClemedtson

doc/sphinx/algorithms.json

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

doc/sphinx/source/algorithms.rst

@@ -820,18 +820,34 @@ These all assume that an object of :class:`.GraphDataScience` is available as `g
 
     Counts the number of cliques, of different size, each node is part of.
 
+.. py:function:: gds.cliqueCounting.mutate.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. 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.stats.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. 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.stream.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. 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.cliqueCounting.write.estimate(G: Graph, **config: Any) -> Series[Any]
+
+    Returns an estimation of the memory consumption for that procedure.
+
 .. py:function:: gds.closeness.harmonic.mutate(G: Graph, **config: Any) -> DataFrame
 
     Harmonic centrality is a way of detecting nodes that are able to spread information