Add anc module

StructuralGT/average_nodal_connectivity.py

@@ -0,0 +1,35 @@
+from StructuralGT.util import _Compute
+import numpy as np
+
+class AverageNodalConnectivity(_Compute):
+    """A module solely for calculating the average nodal connectivity.
+    Written separately because it is computationally very expensive, yet has
+    been shown to correlate well with material properties.REF
+    """
+    def __init__(self):
+        pass
+
+    def compute(self):
+        """Computes the average nodal connectivity."""
+        from StructuralGT import _average_nodal_connectivity_cast
+        _copy = copy.deepcopy(self.Gr)
+
+        cast = _average_nodal_connectivity_cast.PyCast(_copy._raw_pointer())
+
+        cast.average_nodal_connectivity_compute()
+
+        self._average_nodal_connectivity = cast.average_nodal_connectivity
+
+    @_Compute._computed_property
+    def average_nodal_connectivity(self):
+        r"""The nodal connectivity $\kappa(i,j)$, is the minimum number of edges
+        that would need to be removed to disconnect nodes $i$ and $j$. The 
+        average nodal connectivity is the connectivity value averaged over all
+        pairs of nodes:
+
+        .. math::
+
+        \bar{\kappa} = 2\frac{\sum_{i \neq j}\kappa(i,j)}{n(n-1)}
+
+        """
+        return self._average_nodal_connectivity