feat(python): Add entropy_rate property

Author: Anton Eriksson

interfaces/python/infomap.py

@@ -2569,6 +2569,35 @@ def relative_codelength_savings(self):
         """
         return super().getRelativeCodelengthSavings()
 
+    @property
+    def entropy_rate(self):
+        """Get the entropy rate of the network.
+
+        The entropy rate is an indication of the sparsity of a network.
+        A higher entropy rate corresponds to a densely connected network.
+
+        Notes
+        -----
+        This value is only accessable after running the optimizer (``im.run()``).
+
+        Examples
+        --------
+
+        >>> from infomap import Infomap
+        >>> im = Infomap(silent=True, no_infomap=True)
+        >>> im.read_file("twotriangles.net")
+        >>> im.run()
+        >>> f"{im.entropy_rate:.5f}"
+        '0.35714'
+
+
+        Returns
+        -------
+        float
+            The entropy rate
+        """
+        return super().getEntropyRate()
+
     @property
     def meta_codelength(self):
         """Get the meta codelength.

src/Infomap.h

@@ -91,6 +91,7 @@ struct InfomapWrapper : public InfomapBase {
   }
 
   using InfomapBase::codelength;
+  using InfomapBase::getEntropyRate;
   using InfomapBase::getMultilevelModules;
   using InfomapBase::iterLeafNodes;
   using InfomapBase::iterTree;

src/core/InfomapBase.h

@@ -135,6 +135,8 @@ class InfomapBase : public InfomapConfig<InfomapBase> {
     return oneLevelCodelength < 1e-16 ? 0 : 1.0 - codelength() / oneLevelCodelength;
   }
 
+  double getEntropyRate() { return calcEntropyRate(); }
+
   const Date& getStartDate() const { return m_startDate; }
   const Stopwatch& getElapsedTime() const { return m_elapsedTime; }