summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinas Gjoka <minas.gjoka@gmail.com>2016-03-12 16:59:39 -0800
committerMinas Gjoka <minas.gjoka@gmail.com>2016-03-12 16:59:39 -0800
commit58f740d65883d6e7ee20936380f141650c5ec885 (patch)
tree8795fa94a1533721b47cb2cd5ecf7b97b64d95da
parentdabcd4d3fc877ec8007eb31fd30e0584481190f9 (diff)
downloadnetworkx-58f740d65883d6e7ee20936380f141650c5ec885.tar.gz
Change function name from joint_degree_model to joint_degree_graph
-rw-r--r--doc/source/reference/generators.rst2
-rw-r--r--networkx/generators/joint_degree_seq.py10
-rw-r--r--networkx/generators/tests/test_joint_degree_seq.py6
3 files changed, 9 insertions, 9 deletions
diff --git a/doc/source/reference/generators.rst b/doc/source/reference/generators.rst
index d25b1934..c9cef400 100644
--- a/doc/source/reference/generators.rst
+++ b/doc/source/reference/generators.rst
@@ -249,5 +249,5 @@ Joint Degree Sequence
:toctree: generated/
is_valid_joint_degree
- joint_degree_model
+ joint_degree_graph
diff --git a/networkx/generators/joint_degree_seq.py b/networkx/generators/joint_degree_seq.py
index ea842470..5d680228 100644
--- a/networkx/generators/joint_degree_seq.py
+++ b/networkx/generators/joint_degree_seq.py
@@ -12,7 +12,7 @@ import random
import networkx as nx
__all__ = ['is_valid_joint_degree',
- 'joint_degree_model']
+ 'joint_degree_graph']
def is_valid_joint_degree(joint_degrees):
@@ -31,7 +31,7 @@ def is_valid_joint_degree(joint_degrees):
- the total number of edges joining nodes of degree *k* with
nodes of degree *l* cannot exceed the total number of possible edges,
- each diagonal entry ``joint_degrees[k][k]`` must be even (this is
- a convention assumed by the :func:`joint_degree_model` function).
+ a convention assumed by the :func:`joint_degree_graph` function).
Parameters
@@ -146,7 +146,7 @@ def _neighbor_switch(G, w, unsat, h_node_residual, avoid_node_id=None):
if h_node_residual[w_prime] == 0:
unsat.remove(w_prime)
-def joint_degree_model(joint_degrees, seed=None):
+def joint_degree_graph(joint_degrees, seed=None):
""" Generates a random simple graph with the given joint degree dictionary.
Parameters
@@ -197,7 +197,7 @@ def joint_degree_model(joint_degrees, seed=None):
... 2: {2: 2, 3: 2, 4: 2},
... 3: {2: 2, 4: 1},
... 4: {1: 1, 2: 2, 3: 1}}
- >>> G=nx.joint_degree_model(joint_degrees)
+ >>> G=nx.joint_degree_graph(joint_degrees)
>>>
"""
@@ -292,5 +292,5 @@ def joint_degree_model(joint_degrees, seed=None):
l_unsat.discard(w)
- G.name = "joint_degree_model %d nodes"%(G.order())
+ G.name = "joint_degree_graph %d nodes"%(G.order())
return G
diff --git a/networkx/generators/tests/test_joint_degree_seq.py b/networkx/generators/tests/test_joint_degree_seq.py
index 33d44af9..0afdb770 100644
--- a/networkx/generators/tests/test_joint_degree_seq.py
+++ b/networkx/generators/tests/test_joint_degree_seq.py
@@ -1,6 +1,6 @@
import time
from nose.tools import *
-from networkx.generators.joint_degree_seq import is_valid_joint_degree, joint_degree_model
+from networkx.generators.joint_degree_seq import is_valid_joint_degree, joint_degree_graph
from networkx.algorithms.assortativity import degree_mixing_dict
from networkx.generators import powerlaw_cluster_graph
@@ -42,7 +42,7 @@ def test_is_valid_joint_degree():
joint_degrees_5 = {1:{1:9}}
assert_false(is_valid_joint_degree(joint_degrees_5))
-def test_joint_degree_model(ntimes=100):
+def test_joint_degree_graph(ntimes=100):
for _ in range(ntimes):
seed = time.time()
@@ -54,7 +54,7 @@ def test_joint_degree_model(ntimes=100):
# generate simple undirected graph with given joint degree
# joint_degrees_g
- G = joint_degree_model(joint_degrees_g)
+ G = joint_degree_graph(joint_degrees_g)
joint_degrees_G = degree_mixing_dict(G, normalized=False)
# assert that the given joint degree is equal to the generated