update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / netgraph.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.util.netgraph &mdash; NEPI 3.2 documentation</title>
10     
11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../../../',
17         VERSION:     '3.2',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
26     <link rel="top" title="NEPI 3.2 documentation" href="../../../index.html" />
27     <link rel="up" title="Module code" href="../../index.html" /> 
28   </head>
29   <body>
30     <div class="related">
31       <h3>Navigation</h3>
32       <ul>
33         <li class="right" style="margin-right: 10px">
34           <a href="../../../genindex.html" title="General Index"
35              accesskey="I">index</a></li>
36         <li class="right" >
37           <a href="../../../py-modindex.html" title="Python Module Index"
38              >modules</a> |</li>
39         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
41       </ul>
42     </div>
43       <div class="sphinxsidebar">
44         <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
46   <h3>Quick search</h3>
47     <form class="search" action="../../../search.html" method="get">
48       <input type="text" name="q" />
49       <input type="submit" value="Go" />
50       <input type="hidden" name="check_keywords" value="yes" />
51       <input type="hidden" name="area" value="default" />
52     </form>
53     <p class="searchtip" style="font-size: 90%">
54     Enter search terms or a module, class or function name.
55     </p>
56 </div>
57 <script type="text/javascript">$('#searchbox').show(0);</script>
58         </div>
59       </div>
60
61     <div class="document">
62       <div class="documentwrapper">
63         <div class="bodywrapper">
64           <div class="body">
65             
66   <h1>Source code for nepi.util.netgraph</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c">#    NEPI, a framework to manage network experiments</span>
69 <span class="c">#    Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c">#    published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
78 <span class="c">#    GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84
85 <span class="kn">import</span> <span class="nn">ipaddr</span>
86 <span class="kn">import</span> <span class="nn">networkx</span>
87 <span class="kn">import</span> <span class="nn">math</span>
88 <span class="kn">import</span> <span class="nn">random</span>
89
90 <div class="viewcode-block" id="TopologyType"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.TopologyType">[docs]</a><span class="k">class</span> <span class="nc">TopologyType</span><span class="p">:</span>
91     <span class="n">LINEAR</span> <span class="o">=</span> <span class="s">&quot;linear&quot;</span>
92     <span class="n">LADDER</span> <span class="o">=</span> <span class="s">&quot;ladder&quot;</span>
93     <span class="n">MESH</span> <span class="o">=</span> <span class="s">&quot;mesh&quot;</span>
94     <span class="n">TREE</span> <span class="o">=</span> <span class="s">&quot;tree&quot;</span>
95     <span class="n">STAR</span> <span class="o">=</span> <span class="s">&quot;star&quot;</span>
96     <span class="n">ADHOC</span> <span class="o">=</span> <span class="s">&quot;adhoc&quot;</span>
97
98 <span class="c">## TODO: </span>
99 <span class="c">##      - AQ: Add support for hypergraphs (to be able to add hyper edges to </span>
100 <span class="c">##        model CSMA or wireless networks)</span>
101 </div>
102 <div class="viewcode-block" id="NetGraph"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph">[docs]</a><span class="k">class</span> <span class="nc">NetGraph</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
103     <span class="sd">&quot;&quot;&quot; NetGraph represents a network topology. </span>
104 <span class="sd">    Network graphs are internally using the networkx library.</span>
105
106 <span class="sd">    &quot;&quot;&quot;</span>
107
108     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
109         <span class="sd">&quot;&quot;&quot; A graph can be generated using a specified pattern </span>
110 <span class="sd">        (LADDER, MESH, TREE, etc), or provided as an argument.</span>
111
112 <span class="sd">            :param topology: Undirected graph to use as internal representation </span>
113 <span class="sd">            :type topology: networkx.Graph</span>
114
115 <span class="sd">            :param topo_type: One of TopologyType.{LINEAR,LADDER,MESH,TREE,STAR}</span>
116 <span class="sd">            used to automatically generate the topology graph. </span>
117 <span class="sd">            :type topo_type: TopologyType</span>
118
119 <span class="sd">            :param node_count: Number of nodes in the topology to be generated. </span>
120 <span class="sd">            :type node_count: int</span>
121
122 <span class="sd">            :param branches: Number of branches (arms) for the STAR topology. </span>
123 <span class="sd">            :type branches: int</span>
124
125
126 <span class="sd">            :param assign_ips: Automatically assign IP addresses to each node. </span>
127 <span class="sd">            :type assign_ips: bool</span>
128
129 <span class="sd">            :param network: Base network segment for IP address assignment.</span>
130 <span class="sd">            :type network: str</span>
131
132 <span class="sd">            :param prefix: Base network prefix for IP address assignment.</span>
133 <span class="sd">            :type prefix: int</span>
134
135 <span class="sd">            :param version: IP version for IP address assignment.</span>
136 <span class="sd">            :type version: int</span>
137
138 <span class="sd">            :param assign_st: Select source and target nodes on the graph.</span>
139 <span class="sd">            :type assign_st: bool</span>
140
141 <span class="sd">           :param sources_targets: dictionary with the list of sources (key =</span>
142 <span class="sd">            &quot;sources&quot;) and list of targets (key = &quot;targets&quot;) if defined, ignore</span>
143 <span class="sd">            assign_st</span>
144 <span class="sd">           :type sources_targets: dictionary of lists</span>
145
146 <span class="sd">           :param leaf_source: if True, random sources will be selected only </span>
147 <span class="sd">            from leaf nodes.</span>
148 <span class="sd">           :type leaf_source: bool</span>
149
150 <span class="sd">        NOTE: Only point-to-point like network topologies are supported for now.</span>
151 <span class="sd">                (Wireless and Ethernet networks were several nodes share the same</span>
152 <span class="sd">                edge (hyperedge) can not be modeled for the moment).</span>
153
154 <span class="sd">        &quot;&quot;&quot;</span>
155         <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;topology&quot;</span><span class="p">)</span>
156         <span class="bp">self</span><span class="o">.</span><span class="n">_topo_type</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;topo_type&quot;</span><span class="p">,</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">ADHOC</span><span class="p">)</span>
157
158         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">:</span>
159             <span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;node_count&quot;</span><span class="p">):</span>
160                 <span class="n">node_count</span> <span class="o">=</span> <span class="n">kwargs</span><span class="p">[</span><span class="s">&quot;node_count&quot;</span><span class="p">]</span>
161                 <span class="n">branches</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;branches&quot;</span><span class="p">)</span>
162
163                 <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_topology</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">topo_type</span><span class="p">,</span> 
164                         <span class="n">node_count</span><span class="p">,</span> <span class="n">branches</span> <span class="o">=</span> <span class="n">branches</span><span class="p">)</span>
165             <span class="k">else</span><span class="p">:</span>
166                 <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">Graph</span><span class="p">()</span>
167
168         <span class="k">if</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;assign_ips&quot;</span><span class="p">):</span>
169             <span class="n">network</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;network&quot;</span><span class="p">,</span> <span class="s">&quot;10.0.0.0&quot;</span><span class="p">)</span>
170             <span class="n">prefix</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;prefix&quot;</span><span class="p">,</span> <span class="mi">8</span><span class="p">)</span>
171             <span class="n">version</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;version&quot;</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
172
173             <span class="bp">self</span><span class="o">.</span><span class="n">assign_p2p_ips</span><span class="p">(</span><span class="n">network</span> <span class="o">=</span> <span class="n">network</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span><span class="p">,</span> 
174                     <span class="n">version</span> <span class="o">=</span> <span class="n">version</span><span class="p">)</span>
175
176         <span class="n">sources_targets</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;sources_targets&quot;</span><span class="p">)</span>
177         <span class="k">if</span> <span class="n">sources_targets</span><span class="p">:</span>
178             <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">set_source</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">sources_targets</span><span class="p">[</span><span class="s">&quot;sources&quot;</span><span class="p">]]</span>
179             <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="n">n</span><span class="p">)</span> <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="n">sources_targets</span><span class="p">[</span><span class="s">&quot;targets&quot;</span><span class="p">]]</span>
180         <span class="k">elif</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;assign_st&quot;</span><span class="p">):</span>
181             <span class="bp">self</span><span class="o">.</span><span class="n">select_target_zero</span><span class="p">()</span>
182             <span class="bp">self</span><span class="o">.</span><span class="n">select_random_source</span><span class="p">(</span><span class="n">is_leaf</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;leaf_source&quot;</span><span class="p">))</span>
183
184     <span class="nd">@property</span>
185 <div class="viewcode-block" id="NetGraph.topology"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.topology">[docs]</a>    <span class="k">def</span> <span class="nf">topology</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
186         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topology</span>
187 </div>
188     <span class="nd">@property</span>
189 <div class="viewcode-block" id="NetGraph.topo_type"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.topo_type">[docs]</a>    <span class="k">def</span> <span class="nf">topo_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
190         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_topo_type</span>
191 </div>
192     <span class="nd">@property</span>
193 <div class="viewcode-block" id="NetGraph.order"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.order">[docs]</a>    <span class="k">def</span> <span class="nf">order</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
194         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">order</span><span class="p">()</span>
195 </div>
196 <div class="viewcode-block" id="NetGraph.nodes"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.nodes">[docs]</a>    <span class="k">def</span> <span class="nf">nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
197         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span>
198 </div>
199 <div class="viewcode-block" id="NetGraph.edges"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edges">[docs]</a>    <span class="k">def</span> <span class="nf">edges</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
200         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edges</span><span class="p">()</span>
201 </div>
202 <div class="viewcode-block" id="NetGraph.generate_topology"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.generate_topology">[docs]</a>    <span class="k">def</span> <span class="nf">generate_topology</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">topo_type</span><span class="p">,</span> <span class="n">node_count</span><span class="p">,</span> <span class="n">branches</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
203         <span class="k">if</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LADDER</span><span class="p">:</span>
204             <span class="n">total_nodes</span> <span class="o">=</span> <span class="n">node_count</span><span class="o">/</span><span class="mi">2</span>
205             <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">ladder_graph</span><span class="p">(</span><span class="n">total_nodes</span><span class="p">)</span>
206
207         <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LINEAR</span><span class="p">:</span>
208             <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">path_graph</span><span class="p">(</span><span class="n">node_count</span><span class="p">)</span>
209
210         <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">MESH</span><span class="p">:</span>
211             <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">complete_graph</span><span class="p">(</span><span class="n">node_count</span><span class="p">)</span>
212
213         <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">TREE</span><span class="p">:</span>
214             <span class="n">h</span> <span class="o">=</span> <span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">node_count</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span><span class="o">/</span><span class="n">math</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span>
215             <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">balanced_tree</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="n">h</span><span class="p">)</span>
216
217         <span class="k">elif</span> <span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">STAR</span><span class="p">:</span>
218             <span class="n">graph</span> <span class="o">=</span> <span class="n">networkx</span><span class="o">.</span><span class="n">Graph</span><span class="p">()</span>
219             <span class="n">graph</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
220
221             <span class="n">nodesinbranch</span> <span class="o">=</span> <span class="p">(</span><span class="n">node_count</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span><span class="o">/</span> <span class="n">BRANCHES</span>
222             <span class="n">c</span> <span class="o">=</span> <span class="mi">1</span>
223
224             <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">BRANCHES</span><span class="p">):</span>
225                 <span class="n">prev</span> <span class="o">=</span> <span class="mi">0</span>
226                 <span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="n">nodesinbranch</span> <span class="o">+</span> <span class="mi">1</span><span class="p">):</span>
227                     <span class="n">graph</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
228                     <span class="n">graph</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">prev</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
229                     <span class="n">prev</span> <span class="o">=</span> <span class="n">c</span>
230                     <span class="n">c</span> <span class="o">+=</span> <span class="mi">1</span>
231
232         <span class="k">return</span> <span class="n">graph</span>
233 </div>
234 <div class="viewcode-block" id="NetGraph.add_node"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.add_node">[docs]</a>    <span class="k">def</span> <span class="nf">add_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
235         <span class="k">if</span> <span class="n">nid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">:</span> 
236             <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nid</span><span class="p">)</span>
237 </div>
238 <div class="viewcode-block" id="NetGraph.add_edge"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.add_edge">[docs]</a>    <span class="k">def</span> <span class="nf">add_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
239         <span class="bp">self</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span><span class="n">nid1</span><span class="p">)</span>
240         <span class="bp">self</span><span class="o">.</span><span class="n">add_node</span><span class="p">(</span> <span class="n">nid2</span><span class="p">)</span>
241
242         <span class="k">if</span> <span class="n">nid1</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">[</span><span class="n">nid2</span><span class="p">]:</span>
243             <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="n">nid2</span><span class="p">,</span> <span class="n">nid1</span><span class="p">)</span>
244 </div>
245 <div class="viewcode-block" id="NetGraph.annotate_node_ip"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_node_ip">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_node_ip</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">ip</span><span class="p">):</span>
246         <span class="k">if</span> <span class="s">&quot;ips&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]:</span>
247             <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
248
249         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ip</span><span class="p">)</span>
250  </div>
251 <div class="viewcode-block" id="NetGraph.node_ip_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_ip_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">node_ip_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
252         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;ips&quot;</span><span class="p">,</span> <span class="p">[])</span>
253    </div>
254 <div class="viewcode-block" id="NetGraph.annotate_node"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_node">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_node</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
255         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">and</span> \
256                 <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
257             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Non-serializable annotation&quot;</span>
258
259         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
260     </div>
261 <div class="viewcode-block" id="NetGraph.node_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">node_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
262         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
263 </div>
264 <div class="viewcode-block" id="NetGraph.node_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.node_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">node_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
265         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
266     </div>
267 <div class="viewcode-block" id="NetGraph.del_node_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.del_node_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">del_node_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
268         <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="n">name</span><span class="p">]</span>
269 </div>
270 <div class="viewcode-block" id="NetGraph.annotate_edge"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_edge">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
271         <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">and</span> \
272                 <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">float</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
273             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Non-serializable annotation&quot;</span>
274
275         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
276    </div>
277 <div class="viewcode-block" id="NetGraph.annotate_edge_net"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.annotate_edge_net">[docs]</a>    <span class="k">def</span> <span class="nf">annotate_edge_net</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">ip1</span><span class="p">,</span> <span class="n">ip2</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span> 
278             <span class="n">prefixlen</span><span class="p">):</span>
279         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
280         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="n">nid1</span><span class="p">]</span> <span class="o">=</span> <span class="n">ip1</span>
281         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span> <span class="o">=</span> <span class="n">ip2</span>
282         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;mask&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">mask</span>
283         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;network&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">network</span>
284         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">][</span><span class="s">&quot;prefix&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">prefixlen</span>
285 </div>
286 <div class="viewcode-block" id="NetGraph.edge_net_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_net_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">edge_net_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
287         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;net&quot;</span><span class="p">,</span> <span class="nb">dict</span><span class="p">())</span>
288  </div>
289 <div class="viewcode-block" id="NetGraph.edge_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">edge_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
290         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
291  </div>
292 <div class="viewcode-block" id="NetGraph.edge_annotations"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.edge_annotations">[docs]</a>    <span class="k">def</span> <span class="nf">edge_annotations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
293         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">]</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
294     </div>
295 <div class="viewcode-block" id="NetGraph.del_edge_annotation"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.del_edge_annotation">[docs]</a>    <span class="k">def</span> <span class="nf">del_edge_annotation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
296         <span class="k">del</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="n">name</span><span class="p">]</span>
297 </div>
298 <div class="viewcode-block" id="NetGraph.assign_p2p_ips"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.assign_p2p_ips">[docs]</a>    <span class="k">def</span> <span class="nf">assign_p2p_ips</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">network</span> <span class="o">=</span> <span class="s">&quot;10.0.0.0&quot;</span><span class="p">,</span> <span class="n">prefix</span> <span class="o">=</span> <span class="mi">8</span><span class="p">,</span> <span class="n">version</span> <span class="o">=</span> <span class="mi">4</span><span class="p">):</span>
299         <span class="sd">&quot;&quot;&quot; Assign IP addresses to each end of each edge of the network graph,</span>
300 <span class="sd">        computing all the point to point subnets and addresses in the network</span>
301 <span class="sd">        representation.</span>
302
303 <span class="sd">            :param network: Base network address used for subnetting. </span>
304 <span class="sd">            :type network: str</span>
305
306 <span class="sd">            :param prefix: Prefix for the base network address used for subnetting.</span>
307 <span class="sd">            :type prefixt: int</span>
308
309 <span class="sd">            :param version: IP version (either 4 or 6).</span>
310 <span class="sd">            :type version: int</span>
311
312 <span class="sd">        &quot;&quot;&quot;</span>
313         <span class="k">if</span> <span class="n">networkx</span><span class="o">.</span><span class="n">number_connected_components</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
314             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Disconnected graph!!&quot;</span><span class="p">)</span>
315
316         <span class="c"># Assign IP addresses to host</span>
317         <span class="n">netblock</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">/</span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">prefix</span><span class="p">)</span>
318         <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
319             <span class="n">net</span> <span class="o">=</span> <span class="n">ipaddr</span><span class="o">.</span><span class="n">IPv4Network</span><span class="p">(</span><span class="n">netblock</span><span class="p">)</span>
320             <span class="n">new_prefix</span> <span class="o">=</span> <span class="mi">30</span>
321         <span class="k">elif</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">6</span><span class="p">:</span>
322             <span class="n">net</span> <span class="o">=</span> <span class="n">ipaddr</span><span class="o">.</span><span class="n">IPv6Network</span><span class="p">(</span><span class="n">netblock</span><span class="p">)</span>
323             <span class="n">new_prefix</span> <span class="o">=</span> <span class="mi">30</span>
324         <span class="k">else</span><span class="p">:</span>
325             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;Invalid IP version </span><span class="si">%d</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">version</span>
326         
327         <span class="c">## Clear all previusly assigned IPs</span>
328         <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">():</span>
329             <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;ips&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
330
331         <span class="c">## Generate and assign new IPs</span>
332         <span class="n">sub_itr</span> <span class="o">=</span> <span class="n">net</span><span class="o">.</span><span class="n">iter_subnets</span><span class="p">(</span><span class="n">new_prefix</span> <span class="o">=</span> <span class="n">new_prefix</span><span class="p">)</span>
333         
334         <span class="k">for</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edges</span><span class="p">():</span>
335             <span class="c">#### Compute subnets for each link</span>
336             
337             <span class="c"># get a subnet of base_add with prefix /30</span>
338             <span class="n">subnet</span> <span class="o">=</span> <span class="n">sub_itr</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
339             <span class="n">mask</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">netmask</span><span class="o">.</span><span class="n">exploded</span>
340             <span class="n">network</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">exploded</span>
341             <span class="n">prefixlen</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">prefixlen</span>
342
343             <span class="c"># get host addresses in that subnet</span>
344             <span class="n">i</span> <span class="o">=</span> <span class="n">subnet</span><span class="o">.</span><span class="n">iterhosts</span><span class="p">()</span>
345             <span class="n">addr1</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
346             <span class="n">addr2</span> <span class="o">=</span> <span class="n">i</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
347
348             <span class="n">ip1</span> <span class="o">=</span> <span class="n">addr1</span><span class="o">.</span><span class="n">exploded</span>
349             <span class="n">ip2</span> <span class="o">=</span> <span class="n">addr2</span><span class="o">.</span><span class="n">exploded</span>
350             <span class="bp">self</span><span class="o">.</span><span class="n">annotate_edge_net</span><span class="p">(</span><span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">,</span> <span class="n">ip1</span><span class="p">,</span> <span class="n">ip2</span><span class="p">,</span> <span class="n">mask</span><span class="p">,</span> <span class="n">network</span><span class="p">,</span> 
351                     <span class="n">prefixlen</span><span class="p">)</span>
352
353             <span class="bp">self</span><span class="o">.</span><span class="n">annotate_node_ip</span><span class="p">(</span><span class="n">nid1</span><span class="p">,</span> <span class="n">ip1</span><span class="p">)</span>
354             <span class="bp">self</span><span class="o">.</span><span class="n">annotate_node_ip</span><span class="p">(</span><span class="n">nid2</span><span class="p">,</span> <span class="n">ip2</span><span class="p">)</span>
355 </div>
356 <div class="viewcode-block" id="NetGraph.get_p2p_info"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.get_p2p_info">[docs]</a>    <span class="k">def</span> <span class="nf">get_p2p_info</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid1</span><span class="p">,</span> <span class="n">nid2</span><span class="p">):</span>
357         <span class="n">net</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">edge</span><span class="p">[</span><span class="n">nid1</span><span class="p">][</span><span class="n">nid2</span><span class="p">][</span><span class="s">&quot;net&quot;</span><span class="p">]</span>
358         <span class="k">return</span> <span class="p">(</span> <span class="n">net</span><span class="p">[</span><span class="n">nid1</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="n">nid2</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="s">&quot;mask&quot;</span><span class="p">],</span> <span class="n">net</span><span class="p">[</span><span class="s">&quot;network&quot;</span><span class="p">],</span> 
359                 <span class="n">net</span><span class="p">[</span><span class="s">&quot;prefixlen&quot;</span><span class="p">]</span> <span class="p">)</span>
360 </div>
361 <div class="viewcode-block" id="NetGraph.set_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.set_source">[docs]</a>    <span class="k">def</span> <span class="nf">set_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
362         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;source&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
363 </div>
364 <div class="viewcode-block" id="NetGraph.is_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.is_source">[docs]</a>    <span class="k">def</span> <span class="nf">is_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
365         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)</span>
366 </div>
367 <div class="viewcode-block" id="NetGraph.set_target"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.set_target">[docs]</a>    <span class="k">def</span> <span class="nf">set_target</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
368         <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">][</span><span class="s">&quot;target&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
369 </div>
370 <div class="viewcode-block" id="NetGraph.is_target"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.is_target">[docs]</a>    <span class="k">def</span> <span class="nf">is_target</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nid</span><span class="p">):</span>
371         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)</span>
372 </div>
373 <div class="viewcode-block" id="NetGraph.targets"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.targets">[docs]</a>    <span class="k">def</span> <span class="nf">targets</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
374         <span class="sd">&quot;&quot;&quot; Returns the nodes that are targets &quot;&quot;&quot;</span>
375         <span class="k">return</span> <span class="p">[</span><span class="n">nid</span> <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> \
376                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)]</span>
377 </div>
378 <div class="viewcode-block" id="NetGraph.sources"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.sources">[docs]</a>    <span class="k">def</span> <span class="nf">sources</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
379         <span class="sd">&quot;&quot;&quot; Returns the nodes that are sources &quot;&quot;&quot;</span>
380         <span class="k">return</span> <span class="p">[</span><span class="n">nid</span> <span class="k">for</span> <span class="n">nid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> \
381                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">nid</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)]</span>
382 </div>
383 <div class="viewcode-block" id="NetGraph.select_target_zero"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.select_target_zero">[docs]</a>    <span class="k">def</span> <span class="nf">select_target_zero</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
384         <span class="sd">&quot;&quot;&quot; Mark the node 0 as target</span>
385 <span class="sd">        &quot;&quot;&quot;</span>
386         <span class="n">nid</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="mi">0</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">nodes</span><span class="p">()</span> <span class="k">else</span> <span class="s">&quot;0&quot;</span>
387         <span class="bp">self</span><span class="o">.</span><span class="n">set_target</span><span class="p">(</span><span class="n">nid</span><span class="p">)</span>
388 </div>
389 <div class="viewcode-block" id="NetGraph.select_random_source"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.netgraph.NetGraph.select_random_source">[docs]</a>    <span class="k">def</span> <span class="nf">select_random_source</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
390         <span class="sd">&quot;&quot;&quot;  Mark a random node as source. </span>
391 <span class="sd">        &quot;&quot;&quot;</span>
392
393         <span class="c"># The ladder is a special case because is not symmetric.</span>
394         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">topo_type</span> <span class="o">==</span> <span class="n">TopologyType</span><span class="o">.</span><span class="n">LADDER</span><span class="p">:</span>
395             <span class="n">total_nodes</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">order</span><span class="o">/</span><span class="mi">2</span>
396             <span class="n">leaf1</span> <span class="o">=</span> <span class="n">total_nodes</span>
397             <span class="n">leaf2</span> <span class="o">=</span> <span class="n">total_nodes</span> <span class="o">-</span> <span class="mi">1</span>
398             <span class="n">leaves</span> <span class="o">=</span> <span class="p">[</span><span class="n">leaf1</span><span class="p">,</span> <span class="n">leaf2</span><span class="p">]</span>
399             <span class="n">source</span> <span class="o">=</span> <span class="n">leaves</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">leaves</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
400         <span class="k">else</span><span class="p">:</span>
401             <span class="c"># options must not be already sources or targets</span>
402             <span class="n">options</span> <span class="o">=</span> <span class="p">[</span> <span class="n">k</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">degree</span><span class="p">()</span><span class="o">.</span><span class="n">iteritems</span><span class="p">()</span> \
403                     <span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;is_leaf&quot;</span><span class="p">)</span> <span class="ow">or</span> <span class="n">v</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span>  \
404                         <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;source&quot;</span><span class="p">)</span> \
405                         <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">topology</span><span class="o">.</span><span class="n">node</span><span class="p">[</span><span class="n">k</span><span class="p">]</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&quot;target&quot;</span><span class="p">)]</span>
406             <span class="n">source</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">options</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">))</span>
407         
408         <span class="bp">self</span><span class="o">.</span><span class="n">set_source</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
409 </pre></div></div></div>
410
411           </div>
412         </div>
413       </div>
414       <div class="clearer"></div>
415     </div>
416     <div class="related">
417       <h3>Navigation</h3>
418       <ul>
419         <li class="right" style="margin-right: 10px">
420           <a href="../../../genindex.html" title="General Index"
421              >index</a></li>
422         <li class="right" >
423           <a href="../../../py-modindex.html" title="Python Module Index"
424              >modules</a> |</li>
425         <li><a href="../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
426           <li><a href="../../index.html" >Module code</a> &raquo;</li> 
427       </ul>
428     </div>
429     <div class="footer">
430         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
431       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
432     </div>
433   </body>
434 </html>