notebooks/PICS/ChangeExplorer-synopsis-1.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.40.1 (20161225.0304)
 -->
<!-- Title: %3 Pages: 1 -->
<svg width="421pt" height="284pt"
 viewBox="0.00 0.00 420.50 284.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 280)">
<title>%3</title>
<g id="a_graph0"><a xlink:title="FineChangeCounter class hierarchy">
<polygon fill="#ffffff" stroke="transparent" points="-4,4 -4,-280 416.5,-280 416.5,4 -4,4"/>
</a>
</g>
<!-- FineChangeCounter -->
<g id="node1" class="node">
<title>FineChangeCounter</title>
<g id="a_node1"><a xlink:href="#" xlink:title="class FineChangeCounter">
<polygon fill="none" stroke="#000000" points="0,-11.5 0,-53.5 151,-53.5 151,-11.5 0,-11.5"/>
<text text-anchor="start" x="8" y="-39.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">FineChangeCounter</text>
<polyline fill="none" stroke="#000000" points="0,-30.5 151,-30.5 "/>
<g id="a_node1_0"><a xlink:href="#" xlink:title="FineChangeCounter">
<g id="a_node1_1"><a xlink:href="#" xlink:title="update_elems(self, node, m)">
<text text-anchor="start" x="33.5" y="-19" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">update_elems()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- ChangeCounter -->
<g id="node2" class="node">
<title>ChangeCounter</title>
<g id="a_node2"><a xlink:href="#" xlink:title="class ChangeCounter">
<polygon fill="none" stroke="#000000" points="87,-101.5 87,-275.5 210,-275.5 210,-101.5 87,-101.5"/>
<text text-anchor="start" x="95" y="-261.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">ChangeCounter</text>
<polyline fill="none" stroke="#000000" points="87,-252.5 210,-252.5 "/>
<g id="a_node2_2"><a xlink:href="#" xlink:title="ChangeCounter">
<g id="a_node2_3"><a xlink:href="#" xlink:title="__init__(self, repo, filter=None, log=False, **kwargs):&#10; &#160;&#160;&#160;Constructor. `repo` is a git repository (as URL or directory).&#10; &#160;&#160;&#160;`filter` is a predicate that takes a modification and returns True&#10; &#160;&#160;&#160;if it should be considered (default: consider all).&#10; &#160;&#160;&#160;`log` turns on logging if set.&#10; &#160;&#160;&#160;`kwargs` are passed to the `RepositoryMining()` constructor.">
<text text-anchor="start" x="100.5" y="-241" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00" fill="#000000">__init__()</text>
</a>
</g>
<g id="a_node2_4"><a xlink:href="#" xlink:title="map(self):&#10; &#160;&#160;&#160;Produce an interactive tree map of the repository.">
<text text-anchor="start" x="100.5" y="-230" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="10.00" fill="#000000">map()</text>
</a>
</g>
<g id="a_node2_5"><a xlink:href="#" xlink:title="include(self, m):&#10; &#160;&#160;&#160;Return True if the modification `m` should be included&#10; &#160;&#160;&#160;(default: the `filter` predicate given to the constructor).&#10; &#160;&#160;&#160;To be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-219" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">include()</text>
</a>
</g>
<g id="a_node2_6"><a xlink:href="#" xlink:title="map_colorscale(self):&#10; &#160;&#160;&#160;Return the colorscale for the map. To be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-208" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_colorscale()</text>
</a>
</g>
<g id="a_node2_7"><a xlink:href="#" xlink:title="map_hoverinfo(self):&#10; &#160;&#160;&#160;Return the text to be shown when hovering over a node.&#10; &#160;&#160;&#160;To be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-197" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_hoverinfo()</text>
</a>
</g>
<g id="a_node2_8"><a xlink:href="#" xlink:title="map_node_color(self, node):&#10; &#160;&#160;&#160;Return a color of the node, as a number. Can be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-186" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_node_color()</text>
</a>
</g>
<g id="a_node2_9"><a xlink:href="#" xlink:title="map_node_sizes(self):&#10; &#160;&#160;&#160;Return a mapping of nodes to sizes. Can be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-175" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_node_sizes()</text>
</a>
</g>
<g id="a_node2_10"><a xlink:href="#" xlink:title="map_node_text(self, node):&#10; &#160;&#160;&#160;Return the text to be shown for the node (default: #changes).&#10; &#160;&#160;&#160;Can be overloaded in subclasses.">
<text text-anchor="start" x="100.5" y="-164" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_node_text()</text>
</a>
</g>
<g id="a_node2_11"><a xlink:href="#" xlink:title="mine(self, **kwargs):&#10; &#160;&#160;&#160;Gather data from repository. To be extended in subclasses.">
<text text-anchor="start" x="100.5" y="-153" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">mine()</text>
</a>
</g>
<g id="a_node2_12"><a xlink:href="#" xlink:title="update_changes(self, node, commit_msg):&#10; &#160;&#160;&#160;Update stats for `node` changed with `commit_msg`.&#10; &#160;&#160;&#160;Can be extended in subclasses.">
<text text-anchor="start" x="100.5" y="-142" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">update_changes()</text>
</a>
</g>
<g id="a_node2_13"><a xlink:href="#" xlink:title="update_elems(self, node, m):&#10; &#160;&#160;&#160;Update counters for subelements of `node` with modification `m`.&#10; &#160;&#160;&#160;To be defined in subclasses.">
<text text-anchor="start" x="100.5" y="-131" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">update_elems()</text>
</a>
</g>
<g id="a_node2_14"><a xlink:href="#" xlink:title="update_size(self, node, size):&#10; &#160;&#160;&#160;Update counters for `node` with `size`. Can be extended in subclasses.">
<text text-anchor="start" x="100.5" y="-120" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">update_size()</text>
</a>
</g>
<g id="a_node2_15"><a xlink:href="#" xlink:title="update_stats(self, m):&#10; &#160;&#160;&#160;Update counters with modification `m`. Can be extended in subclasses.">
<text text-anchor="start" x="100.5" y="-109" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">update_stats()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- FineChangeCounter&#45;&gt;ChangeCounter -->
<g id="edge1" class="edge">
<title>FineChangeCounter&#45;&gt;ChangeCounter</title>
<path fill="none" stroke="#000000" d="M85.3451,-53.5389C90.2761,-64.0763 96.6342,-77.6635 103.4111,-92.1456"/>
<polygon fill="none" stroke="#000000" points="100.2672,-93.6852 107.6757,-101.2591 106.6074,-90.7183 100.2672,-93.6852"/>
</g>
<!-- FixCounter -->
<g id="node3" class="node">
<title>FixCounter</title>
<g id="a_node3"><a xlink:href="#" xlink:title="class FixCounter">
<polygon fill="none" stroke="#000000" points="169,-.5 169,-64.5 276,-64.5 276,-.5 169,-.5"/>
<text text-anchor="start" x="185.5" y="-50.3" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="14.00" fill="#6a0dad">FixCounter</text>
<polyline fill="none" stroke="#000000" points="169,-41.5 276,-41.5 "/>
<g id="a_node3_16"><a xlink:href="#" xlink:title="FixCounter">
<g id="a_node3_17"><a xlink:href="#" xlink:title="include(self, m):&#10; &#160;&#160;&#160;Include all modifications whose commit messages start with &#39;Fix:&#39;">
<text text-anchor="start" x="177.5" y="-30" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">include()</text>
</a>
</g>
<g id="a_node3_18"><a xlink:href="#" xlink:title="map_hoverinfo(self)">
<text text-anchor="start" x="177.5" y="-19" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_hoverinfo()</text>
</a>
</g>
<g id="a_node3_19"><a xlink:href="#" xlink:title="map_node_text(self, node)">
<text text-anchor="start" x="177.5" y="-8" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="10.00" fill="#000000">map_node_text()</text>
</a>
</g>
</a>
</g>
</a>
</g>
</g>
<!-- FixCounter&#45;&gt;ChangeCounter -->
<g id="edge2" class="edge">
<title>FixCounter&#45;&gt;ChangeCounter</title>
<path fill="none" stroke="#000000" d="M207.1672,-64.8233C203.2129,-73.1593 198.7488,-82.57 194.0926,-92.3859"/>
<polygon fill="none" stroke="#000000" points="190.8952,-90.96 189.7716,-101.4951 197.2197,-93.9601 190.8952,-90.96"/>
</g>
<!-- Legend -->
<g id="node4" class="node">
<title>Legend</title>
<text text-anchor="start" x="294.5" y="-50" font-family="Raleway, Helvetica, Arial, sans-serif" font-weight="bold" font-size="10.00" fill="#6a0dad">Legend</text>
<text text-anchor="start" x="294.5" y="-40" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00" fill="#000000">• </text>
<text text-anchor="start" x="301.5" y="-40" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-weight="bold" font-size="8.00" fill="#000000">public_method()</text>
<text text-anchor="start" x="294.5" y="-30" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00" fill="#000000">• </text>
<text text-anchor="start" x="301.5" y="-30" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-size="8.00" fill="#000000">private_method()</text>
<text text-anchor="start" x="294.5" y="-20" font-family="Raleway, Helvetica, Arial, sans-serif" font-size="10.00" fill="#000000">• </text>
<text text-anchor="start" x="301.5" y="-20" font-family="'Fira Mono', 'Source Code Pro', 'Courier', monospace" font-style="italic" font-size="8.00" fill="#000000">overloaded_method()</text>
<text text-anchor="start" x="294.5" y="-10.8" font-family="Helvetica,sans-Serif" font-size="9.00" fill="#000000">Hover over names to see doc</text>
</g>
</g>
</svg>