Edit File: Structures_Graph.html
<?xml version="1.0" encoding="iso-8859-1"?> <!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> <!-- template designed by Marco Von Ballmoos --> <title>Docs For Class Structures_Graph</title> <link rel="stylesheet" href="../media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <div class="page-body"> <h2 class="class-name">Class Structures_Graph</h2> <a name="sec-description"></a> <div class="info-box"> <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">The Structures_Graph class represents a graph data structure.</p> <p class="description"><p>A Graph is a data structure composed by a set of nodes, connected by arcs. Graphs may either be directed or undirected. In a directed graph, arcs are directional, and can be traveled only one way. In an undirected graph, arcs are bidirectional, and can be traveled both ways.</p></p> <ul class="tags"> <li><span class="field">copyright:</span> (c) 2004 by S�rgio Carvalho</li> <li><span class="field">author:</span> S�rgio Carvalho <<a href="mailto:sergio.carvalho@portugalmail.com">mailto:sergio.carvalho@portugalmail.com</a>></li> </ul> <p class="notes"> Located in <a class="field" href="_Structures_Graph_php.html">/Structures/Graph.php</a> (line <span class="field">56</span>) </p> <pre></pre> </div> </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> <div class="method-definition"> <span class="method-result">Structures_Graph</span> <a href="#Structures_Graph" title="details" class="method-name">Structures_Graph</a> ([<span class="var-type">boolean</span> <span class="var-name">$directed</span> = <span class="var-default">true</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#addNode" title="details" class="method-name">addNode</a> (<span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$newNode</span>) </div> <div class="method-definition"> <span class="method-result">array</span> <a href="#getNodes" title="details" class="method-name">&getNodes</a> () </div> <div class="method-definition"> <span class="method-result">boolean</span> <a href="#isDirected" title="details" class="method-name">isDirected</a> () </div> <div class="method-definition"> <span class="method-result">void</span> <a href="#removeNode" title="details" class="method-name">removeNode</a> (<span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$node</span>) </div> </div> </div> </div> <a name="sec-methods"></a> <div class="info-box"> <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> <div class="info-box-body"> <A NAME='method_detail'></A> <a name="methodStructures_Graph" id="Structures_Graph"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">Constructor Structures_Graph</span> (line <span class="line-number">76</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Constructor</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">Structures_Graph</span> <span class="method-name"> Structures_Graph </span> ([<span class="var-type">boolean</span> <span class="var-name">$directed</span> = <span class="var-default">true</span>]) </div> <ul class="parameters"> <li> <span class="var-type">boolean</span> <span class="var-name">$directed</span><span class="var-description">: Set to true if the graph is directed. Set to false if it is not directed. (Optional, defaults to true)</span> </li> </ul> </div> <a name="methodaddNode" id="addNode"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">addNode</span> (line <span class="line-number">102</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Add a Node to the Graph</p> <ul class="tags"> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> addNode </span> (<span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$newNode</span>) </div> <ul class="parameters"> <li> <span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$newNode</span><span class="var-description">: The node to be added.</span> </li> </ul> </div> <a name="methodgetNodes" id="getNodes"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">getNodes</span> (line <span class="line-number">151</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.</p> <ul class="tags"> <li><span class="field">return:</span> The set of nodes in this graph</li> <li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a></li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">array</span> <span class="method-name"> &getNodes </span> () </div> </div> <a name="methodisDirected" id="isDirected"><!-- --></a> <div class="oddrow"> <div class="method-header"> <span class="method-title">isDirected</span> (line <span class="line-number">89</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Return true if a graph is directed</p> <ul class="tags"> <li><span class="field">return:</span> true if the graph is directed</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> <span class="method-result">boolean</span> <span class="method-name"> isDirected </span> () </div> </div> <a name="methodremoveNode" id="removeNode"><!-- --></a> <div class="evenrow"> <div class="method-header"> <span class="method-title">removeNode</span> (line <span class="line-number">138</span>) </div> <!-- ========== Info from phpDoc block ========= --> <p class="short-description">Remove a Node from the Graph</p> <ul class="tags"> <li><span class="field">access:</span> public</li> <li><span class="field">todo:</span> This is unimplemented</li> </ul> <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> removeNode </span> (<span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$node</span>) </div> <ul class="parameters"> <li> <span class="var-type"><a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></span> <span class="var-name">&$node</span><span class="var-description">: The node to be removed from the graph</span> </li> </ul> </div> </div> </div> <p class="notes" id="credit"> Documentation generated on Fri, 30 Jan 2004 16:37:28 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a> </p> </div></body> </html>
Back to File Manager