116 lines
5.3 KiB
HTML
116 lines
5.3 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>OR-Tools</title>
|
|
<meta http-equiv="Content-Type" content="text/html;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">Google OR-Tools 7.5</span>
|
|
</div>
|
|
</div>
|
|
<div id="content" style="width: 100%; overflow: hidden;">
|
|
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
|
|
<h2>C++ Reference</h2>
|
|
<ul>
|
|
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
|
|
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
|
|
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
|
|
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
|
|
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="content">
|
|
<div align="center">
|
|
<h1 style="color: #145A32;">C++ Reference: Graph</h1>
|
|
</div>
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Graph Legend</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<p>This page explains how to interpret the graphs that are generated by doxygen.</p>
|
|
<p>Consider the following example: </p><div class="fragment"><div class="line">/*! Invisible class because of truncation */</div>
|
|
<div class="line">class Invisible { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Truncated class, inheritance relation is hidden */</div>
|
|
<div class="line">class Truncated : public Invisible { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/* Class not documented with doxygen comments */</div>
|
|
<div class="line">class Undocumented { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Class that is inherited using public inheritance */</div>
|
|
<div class="line">class PublicBase : public Truncated { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! A template class */</div>
|
|
<div class="line">template<class T> class Templ { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Class that is inherited using protected inheritance */</div>
|
|
<div class="line">class ProtectedBase { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Class that is inherited using private inheritance */</div>
|
|
<div class="line">class PrivateBase { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Class that is used by the Inherited class */</div>
|
|
<div class="line">class Used { };</div>
|
|
<div class="line"> </div>
|
|
<div class="line">/*! Super class that inherits a number of other classes */</div>
|
|
<div class="line">class Inherited : public PublicBase,</div>
|
|
<div class="line"> protected ProtectedBase,</div>
|
|
<div class="line"> private PrivateBase,</div>
|
|
<div class="line"> public Undocumented,</div>
|
|
<div class="line"> public Templ<int></div>
|
|
<div class="line">{</div>
|
|
<div class="line"> private:</div>
|
|
<div class="line"> Used *m_usedClass;</div>
|
|
<div class="line">};</div>
|
|
</div><!-- fragment --><p> This will result in the following graph:</p>
|
|
<center><img src="graph_legend.png" alt="" class="inline"/></center><p>The boxes in the above graph have the following meaning: </p>
|
|
<ul>
|
|
<li>
|
|
A filled gray box represents the struct or class for which the graph is generated. </li>
|
|
<li>
|
|
A box with a black border denotes a documented struct or class. </li>
|
|
<li>
|
|
A box with a gray border denotes an undocumented struct or class. </li>
|
|
<li>
|
|
A box with a red border denotes a documented struct or class forwhich not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries. </li>
|
|
</ul>
|
|
<p>The arrows have the following meaning: </p>
|
|
<ul>
|
|
<li>
|
|
A dark blue arrow is used to visualize a public inheritance relation between two classes. </li>
|
|
<li>
|
|
A dark green arrow is used for protected inheritance. </li>
|
|
<li>
|
|
A dark red arrow is used for private inheritance. </li>
|
|
<li>
|
|
A purple dashed arrow is used if a class is contained or used by another class. The arrow is labelled with the variable(s) through which the pointed class or struct is accessible. </li>
|
|
<li>
|
|
A yellow dashed arrow denotes a relation between a template instance and the template class it was instantiated from. The arrow is labelled with the template parameters of the instance. </li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|