mirror of
https://github.com/ACSPRI/queXS
synced 2024-04-02 12:12:16 +00:00
Import from DCARF SVN
This commit is contained in:
azammitdcarf
8
include/pear/docs/Structures_Graph/docs/generate.sh
Normal file
8
include/pear/docs/Structures_Graph/docs/generate.sh
Normal file
@@ -0,0 +1,8 @@
|
||||
#!/bin/sh
|
||||
(cd ..; tar czf docs/arch.tgz "{arch}")
|
||||
rm -Rf "../{arch}"
|
||||
rm -Rf ./html
|
||||
mkdir -p ./html
|
||||
phpdoc --directory ../Structures,./tutorials --target ./html --title "Structures_Graph Documentation" --output "HTML:frames" --defaultpackagename structures_graph --defaultcategoryname structures --pear
|
||||
(cd ..; tar --absolute-names -xzf docs/arch.tgz)
|
||||
#rm arch.tgz
|
||||
@@ -0,0 +1,243 @@
|
||||
<?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>
|
||||
@@ -0,0 +1,105 @@
|
||||
<?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_Manipulator_AcyclicTest</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_Manipulator_AcyclicTest</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_Manipulator_AcyclicTest is a graph manipulator which tests whether a graph contains a cycle.</p>
|
||||
<p class="description"><p>The definition of an acyclic graph used in this manipulator is that of a DAG. The graph must be directed, or else it is considered cyclic, even when there are no arcs.</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_Manipulator_AcyclicTest_php.html">/Structures/Graph/Manipulator/AcyclicTest.php</a> (line <span class="field">55</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">boolean</span>
|
||||
<a href="#isAcyclic" title="details" class="method-name">isAcyclic</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$graph</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="methodisAcyclic" id="isAcyclic"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">isAcyclic</span> (line <span class="line-number">126</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">isAcyclic returns true if a graph contains no cycles, false otherwise.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> true iff graph is acyclic</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
isAcyclic
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$graph</span>)
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,107 @@
|
||||
<?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_Manipulator_TopologicalSorter</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_Manipulator_TopologicalSorter</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_Manipulator_TopologicalSorter is a manipulator which is able to return the set of nodes in a graph, sorted by topological order.</p>
|
||||
<p class="description"><p>A graph may only be sorted topologically iff it's a DAG. You can test it with the Structures_Graph_Manipulator_AcyclicTest.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a></li>
|
||||
<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_Manipulator_TopologicalSorter_php.html">/Structures/Graph/Manipulator/TopologicalSorter.php</a> (line <span class="field">58</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">array</span>
|
||||
<a href="#sort" title="details" class="method-name">sort</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$graph</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="methodsort" id="sort"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">sort</span> (line <span class="line-number">133</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">sort returns the graph's nodes, sorted by topological order.</p>
|
||||
<p class="description"><p>The result is an array with as many entries as topological levels. Each entry in this array is an array of nodes within the given topological level.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The graph's nodes, sorted by topological order.</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
sort
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$graph</span>)
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,549 @@
|
||||
<?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_Node</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_Node</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_Node class represents a Node that can be member of a graph node set.</p>
|
||||
<p class="description"><p>A graph node can contain data. Under this API, the node contains default data, and key index data. It behaves, thus, both as a regular data node, and as a dictionary (or associative array) node.</p><p>Regular data is accessed via getData and setData. Key indexed data is accessed via getMetadata and setMetadata.</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_Node_php.html">/Structures/Graph/Node.php</a> (line <span class="field">57</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_Node</span>
|
||||
<a href="#Structures_Graph_Node" title="details" class="method-name">Structures_Graph_Node</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#connectsTo" title="details" class="method-name">connectsTo</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$target</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#connectTo" title="details" class="method-name">connectTo</a>
|
||||
(<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span> <span class="var-name">&$destinationNode</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#getData" title="details" class="method-name">&getData</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span>
|
||||
<a href="#getGraph" title="details" class="method-name">&getGraph</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#getMetadata" title="details" class="method-name">&getMetadata</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$nullIfNonexistent</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">array</span>
|
||||
<a href="#getNeighbours" title="details" class="method-name">getNeighbours</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#inDegree" title="details" class="method-name">inDegree</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#metadataKeyExists" title="details" class="method-name">metadataKeyExists</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">integer</span>
|
||||
<a href="#outDegree" title="details" class="method-name">outDegree</a>
|
||||
()
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#setData" title="details" class="method-name">setData</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$data</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setGraph" title="details" class="method-name">setGraph</a>
|
||||
(<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span> <span class="var-name">&$graph</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#setMetadata" title="details" class="method-name">setMetadata</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$data</span>)
|
||||
</div>
|
||||
|
||||
<div class="method-definition">
|
||||
<span class="method-result">void</span>
|
||||
<a href="#unsetMetadata" title="details" class="method-name">unsetMetadata</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</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_Node" id="Structures_Graph_Node"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">Constructor Structures_Graph_Node</span> (line <span class="line-number">78</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_Node</span>
|
||||
<span class="method-name">
|
||||
Structures_Graph_Node
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodconnectsTo" id="connectsTo"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">connectsTo</span> (line <span class="line-number">275</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Test wether this node has an arc to the target node</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> True if the two nodes are connected</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
connectsTo
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">&$target</span>)
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodconnectTo" id="connectTo"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">connectTo</span> (line <span class="line-number">236</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Connect this node to another one.</p>
|
||||
<p class="description"><p>If the graph is not directed, the reverse arc, connecting $destinationNode to $this is also created.</p></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">
|
||||
connectTo
|
||||
</span>
|
||||
(<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span> <span class="var-name">&$destinationNode</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span>
|
||||
<span class="var-name">&$destinationNode</span><span class="var-description">: Node to connect to</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetData" id="getData"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getData</span> (line <span class="line-number">119</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node data getter.</p>
|
||||
<p class="description"><p>Each graph node can contain a reference to one variable. This is the getter for that reference.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Data stored in node</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
&getData
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetGraph" id="getGraph"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getGraph</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node graph getter</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Graph where node is stored</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span>
|
||||
<span class="method-name">
|
||||
&getGraph
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetMetadata" id="getMetadata"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getMetadata</span> (line <span class="line-number">171</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node metadata getter</p>
|
||||
<p class="description"><p>Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method gets the data under the given key. If the key does not exist, an error will be thrown, so testing using metadataKeyExists might be needed.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Metadata Data stored in node under given key</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Node.html#methodmetadataKeyExists">Structures_Graph_Node::metadataKeyExists()</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
&getMetadata
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>, [<span class="var-type">boolean</span> <span class="var-name">$nullIfNonexistent</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$key</span><span class="var-description">: Key</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$nullIfNonexistent</span><span class="var-description">: nullIfNonexistent (defaults to false).</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodgetNeighbours" id="getNeighbours"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">getNeighbours</span> (line <span class="line-number">262</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return nodes connected to this one.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Array of nodes</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">array</span>
|
||||
<span class="method-name">
|
||||
getNeighbours
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodinDegree" id="inDegree"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">inDegree</span> (line <span class="line-number">309</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Calculate the in degree of the node.</p>
|
||||
<p class="description"><p>The indegree for a node is the number of arcs entering the node. For non directed graphs, the indegree is equal to the outdegree.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> In degree of the node</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
inDegree
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodmetadataKeyExists" id="metadataKeyExists"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">metadataKeyExists</span> (line <span class="line-number">151</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Test for existence of metadata under a given key.</p>
|
||||
<p class="description"><p>Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method tests whether a given metadata key exists for this node.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
metadataKeyExists
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$key</span><span class="var-description">: Key to test</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodoutDegree" id="outDegree"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">outDegree</span> (line <span class="line-number">333</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Calculate the out degree of the node.</p>
|
||||
<p class="description"><p>The outdegree for a node is the number of arcs exiting the node. For non directed graphs, the outdegree is always equal to the indegree.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Out degree of the node</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">integer</span>
|
||||
<span class="method-name">
|
||||
outDegree
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetData" id="setData"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setData</span> (line <span class="line-number">134</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node data setter</p>
|
||||
<p class="description"><p>Each graph node can contain a reference to one variable. This is the setter for that reference.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Data to store in node</li>
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
setData
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$data</span>)
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetGraph" id="setGraph"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setGraph</span> (line <span class="line-number">104</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node graph setter. This method should not be called directly. Use Graph::addNode instead.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph.html#methodaddNode">Structures_Graph::addNode()</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
setGraph
|
||||
</span>
|
||||
(<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span> <span class="var-name">&$graph</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"><a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></span>
|
||||
<span class="var-name">&$graph</span><span class="var-description">: Set the graph for this node.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsetMetadata" id="setMetadata"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">setMetadata</span> (line <span class="line-number">214</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Node metadata setter</p>
|
||||
<p class="description"><p>Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method stores data under the given key. If the key already exists, previously stored data is discarded.</p></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">
|
||||
setMetadata
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>, <span class="var-type">mixed</span> <span class="var-name">$data</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$key</span><span class="var-description">: Key</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$data</span><span class="var-description">: Data</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodunsetMetadata" id="unsetMetadata"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<span class="method-title">unsetMetadata</span> (line <span class="line-number">196</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Delete metadata by key</p>
|
||||
<p class="description"><p>Each graph node can contain multiple 'metadata' entries, each stored under a different key, as in an associative array or in a dictionary. This method removes any data that might be stored under the provided key. If the key does not exist, no error is thrown, so it is safe using this method without testing for key existence.</p></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">
|
||||
unsetMetadata
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$key</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$key</span><span class="var-description">: Key</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,119 @@
|
||||
<?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 page AcyclicTest.php</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="file-name">/Structures/Graph/Manipulator/AcyclicTest.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This file contains the definition of the Structures_Graph_Manipulator_AcyclicTest graph manipulator.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a>
|
||||
</td>
|
||||
<td>
|
||||
The Structures_Graph_Manipulator_AcyclicTest is a graph manipulator which tests whether a graph contains a cycle.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_PEAR_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'PEAR.php'</span>)
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_php.html">'Structures/Graph.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph/Node_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_Node_php.html">'Structures/Graph/Node.php'</a></span>)
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,133 @@
|
||||
<?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 page TopologicalSorter.php</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="file-name">/Structures/Graph/Manipulator/TopologicalSorter.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This file contains the definition of the Structures_Graph_Manipulator_TopologicalSorter class.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a>
|
||||
</td>
|
||||
<td>
|
||||
The Structures_Graph_Manipulator_TopologicalSorter is a manipulator which is able to return the set of nodes in a graph, sorted by topological order.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_PEAR_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'PEAR.php'</span>)
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_php.html">'Structures/Graph.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph/Node_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_Node_php.html">'Structures/Graph/Node.php'</a></span>)
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph/Manipulator/AcyclicTest_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_Manipulator_AcyclicTest_php.html">'Structures/Graph/Manipulator/AcyclicTest.php'</a></span>)
|
||||
(line <span class="line-number">41</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,105 @@
|
||||
<?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 page Node.php</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="file-name">/Structures/Graph/Node.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">This file contains the definition of the Structures_Graph_Node class</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a>
|
||||
</td>
|
||||
<td>
|
||||
The Structures_Graph_Node class represents a Node that can be member of a graph node set.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_PEAR_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'PEAR.php'</span>)
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_Structures/Graph_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_php.html">'Structures/Graph.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@@ -0,0 +1,136 @@
|
||||
<?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 page Graph.php</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="file-name">/Structures/Graph.php</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-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The Graph.php file contains the definition of the Structures_Graph class</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">see:</span> <a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top">
|
||||
<a href="../Structures_Graph/Structures_Graph.html">Structures_Graph</a>
|
||||
</td>
|
||||
<td>
|
||||
The Structures_Graph class represents a graph data structure.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_Structures/Graph/Node_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../Structures_Graph/_Structures_Graph_Node_php.html">'Structures/Graph/Node.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Graph Node</p>
|
||||
|
||||
</div>
|
||||
<a name="_PEAR_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'PEAR.php'</span>)
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">PEAR base classes</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineSTRUCTURES_GRAPH_ERROR_GENERIC"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<span class="const-title">
|
||||
<span class="const-name">STRUCTURES_GRAPH_ERROR_GENERIC</span> = 100
|
||||
(line <span class="line-number">40</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</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>
|
||||
@@ -0,0 +1,75 @@
|
||||
<?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>Structures_Graph Tutorial</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">
|
||||
|
||||
<div><a name="package.database.structures_graph.tutorial"></a><div class="ref-title-box"><h1 class="ref-title">Structures_Graph Tutorial</h1>
|
||||
<h2 class="ref-purpose">A first tour of graph datastructure manipulation</h2></div>
|
||||
<span><a name="package.database.structures_graph.tutorial.intro"></a><h2 class="title">Introduction</h2><p>Structures_Graph is a package for creating and manipulating graph datastructures. A graph is a set of objects, called nodes, connected by arcs. When used as a datastructure, usually nodes contain data, and arcs represent relationships between nodes. When arcs have a direction, and can be travelled only one way, graphs are said to be directed. When arcs have no direction, and can always be travelled both ways, graphs are said to be non directed.</p>
|
||||
<p>Structures_Graph provides an object oriented API to create and directly query a graph, as well as a set of Manipulator classes to extract information from the graph.</p></span>
|
||||
<span><a name="package.database.structures_graph.tutorial.creation"></a><h2 class="title">Creating a Graph</h2><p>Creating a graph is done using the simple constructor:
|
||||
<pre class="listing"><pre>
|
||||
require_once 'Structures/Graph.php';
|
||||
|
||||
$directedGraph =& new Structures_Graph(true);
|
||||
$nonDirectedGraph =& new Structures_Graph(false);
|
||||
</pre></pre>
|
||||
and passing the constructor a flag telling it whether the graph should be directed. A directed graph will always be directed during its lifetime. It's a permanent characteristic.</p>
|
||||
<p>To fill out the graph, we'll need to create some nodes, and then call Graph::addNode.
|
||||
<pre class="listing"><pre>
|
||||
require_once 'Structures/Graph/Node.php';
|
||||
|
||||
$nodeOne =& new Structures_Graph_Node();
|
||||
$nodeTwo =& new Structures_Graph_Node();
|
||||
$nodeThree =& new Structures_Graph_Node();
|
||||
|
||||
$directedGraph->addNode(&$nodeOne);
|
||||
$directedGraph->addNode(&$nodeTwo);
|
||||
$directedGraph->addNode(&$nodeThree);
|
||||
</pre></pre>
|
||||
and then setup the arcs:
|
||||
<pre class="listing"><pre>
|
||||
$nodeOne->connectTo($nodeTwo);
|
||||
$nodeOne->connectTo($nodeThree);
|
||||
</pre></pre>
|
||||
Note that arcs can only be created after the nodes have been inserted into the graph.</p></span>
|
||||
<span><a name="package.database.structures_graph.tutorial.nodesanddata"></a><h2 class="title">Associating Data</h2><p>Graphs are only useful as datastructures if they can hold data. Structure_Graph stores data in nodes. Each node contains a setter and a getter for its data.
|
||||
<pre class="listing"><pre>
|
||||
$nodeOne->setData("Node One's Data is a String");
|
||||
$nodeTwo->setData(1976);
|
||||
$nodeThree->setData('Some other string');
|
||||
|
||||
print("NodeTwo's Data is an integer: " . $nodeTwo->getData());
|
||||
</pre></pre></p>
|
||||
<p>Structure_Graph nodes can also store metadata, alongside with the main data. Metadata differs from regular data just because it is stored under a key, making it possible to store more than one data reference per node. The metadata getter and setter need the key to perform the operation:
|
||||
<pre class="listing"><pre>
|
||||
$nodeOne->setMetadata('example key', "Node One's Sample Metadata");
|
||||
print("Metadata stored under key 'example key' in node one: " . $nodeOne->getMetadata('example key'));
|
||||
$nodeOne->unsetMetadata('example key');
|
||||
</pre></pre></p></span>
|
||||
<span><a name="package.database.structures_graph.tutorial.querying"></a><h2 class="title">Querying a Graph</h2><p>Structures_Graph provides for basic querying of the graph:
|
||||
<pre class="listing"><pre>
|
||||
// Nodes are able to calculate their indegree and outdegree
|
||||
print("NodeOne's inDegree: " . $nodeOne->inDegree());
|
||||
print("NodeOne's outDegree: " . $nodeOne->outDegree());
|
||||
|
||||
// and naturally, nodes can report on their arcs
|
||||
$arcs = $nodeOne->getNeighbours();
|
||||
for ($i=0;$i<sizeof($arcs);$i++) {
|
||||
print("NodeOne has an arc to " . $arcs[$i]->getData());
|
||||
}
|
||||
</pre></pre></p></span></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>
|
||||
@@ -0,0 +1,36 @@
|
||||
<?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></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<!-- Start of Class Data -->
|
||||
<H2>
|
||||
|
||||
</H2>
|
||||
<h2>Root class Structures_Graph</h2>
|
||||
<ul>
|
||||
<li><a href="Structures_Graph/Structures_Graph.html">Structures_Graph</a></li></ul>
|
||||
|
||||
<h2>Root class Structures_Graph_Manipulator_AcyclicTest</h2>
|
||||
<ul>
|
||||
<li><a href="Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a></li></ul>
|
||||
|
||||
<h2>Root class Structures_Graph_Manipulator_TopologicalSorter</h2>
|
||||
<ul>
|
||||
<li><a href="Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a></li></ul>
|
||||
|
||||
<h2>Root class Structures_Graph_Node</h2>
|
||||
<ul>
|
||||
<li><a href="Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a></li></ul>
|
||||
|
||||
<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>
|
||||
</body>
|
||||
</html>
|
||||
339
include/pear/docs/Structures_Graph/docs/html/elementindex.html
Normal file
339
include/pear/docs/Structures_Graph/docs/html/elementindex.html
Normal file
@@ -0,0 +1,339 @@
|
||||
<?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></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a name="top"></a>
|
||||
<h2>Full index</h2>
|
||||
<h3>Package indexes</h3>
|
||||
<ul>
|
||||
<li><a href="elementindex_Structures_Graph.html">Structures_Graph</a></li>
|
||||
</ul>
|
||||
<br />
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex.html#u">u</a>
|
||||
</div>
|
||||
|
||||
<a name="a"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">a</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">addNode</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodaddNode">Structures_Graph::addNode()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Add a Node to the Graph</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">AcyclicTest.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Manipulator_AcyclicTest_php.html">AcyclicTest.php</a> in AcyclicTest.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="c"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">c</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">connectsTo</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodconnectsTo">Structures_Graph_Node::connectsTo()</a> in Node.php</div>
|
||||
<div class="index-item-description">Test wether this node has an arc to the target node</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">connectTo</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodconnectTo">Structures_Graph_Node::connectTo()</a> in Node.php</div>
|
||||
<div class="index-item-description">Connect this node to another one.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="g"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">g</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">getData</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetData">Structures_Graph_Node::getData()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node data getter.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getGraph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetGraph">Structures_Graph_Node::getGraph()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node graph getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetMetadata">Structures_Graph_Node::getMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node metadata getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getNeighbours</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetNeighbours">Structures_Graph_Node::getNeighbours()</a> in Node.php</div>
|
||||
<div class="index-item-description">Return nodes connected to this one.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getNodes</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodgetNodes">Structures_Graph::getNodes()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Graph.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_php.html">Graph.php</a> in Graph.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="i"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">i</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">inDegree</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodinDegree">Structures_Graph_Node::inDegree()</a> in Node.php</div>
|
||||
<div class="index-item-description">Calculate the in degree of the node.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">isAcyclic</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html#methodisAcyclic">Structures_Graph_Manipulator_AcyclicTest::isAcyclic()</a> in AcyclicTest.php</div>
|
||||
<div class="index-item-description">isAcyclic returns true if a graph contains no cycles, false otherwise.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">isDirected</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodisDirected">Structures_Graph::isDirected()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Return true if a graph is directed</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="m"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">m</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">metadataKeyExists</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodmetadataKeyExists">Structures_Graph_Node::metadataKeyExists()</a> in Node.php</div>
|
||||
<div class="index-item-description">Test for existence of metadata under a given key.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="n"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">n</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">Node.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Node_php.html">Node.php</a> in Node.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="o"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">o</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">outDegree</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodoutDegree">Structures_Graph_Node::outDegree()</a> in Node.php</div>
|
||||
<div class="index-item-description">Calculate the out degree of the node.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="r"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">r</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">removeNode</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodremoveNode">Structures_Graph::removeNode()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Remove a Node from the Graph</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="s"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">s</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">setData</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetData">Structures_Graph_Node::setData()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node data setter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">setGraph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetGraph">Structures_Graph_Node::setGraph()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node graph setter. This method should not be called directly. Use Graph::addNode instead.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">setMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetMetadata">Structures_Graph_Node::setMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node metadata setter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">sort</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html#methodsort">Structures_Graph_Manipulator_TopologicalSorter::sort()</a> in TopologicalSorter.php</div>
|
||||
<div class="index-item-description">sort returns the graph's nodes, sorted by topological order.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html">Structures_Graph</a> in Graph.php</div>
|
||||
<div class="index-item-description">The Structures_Graph class represents a graph data structure.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">Structures_Graph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodStructures_Graph">Structures_Graph::Structures_Graph()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">STRUCTURES_GRAPH_ERROR_GENERIC</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_php.html#defineSTRUCTURES_GRAPH_ERROR_GENERIC">STRUCTURES_GRAPH_ERROR_GENERIC</a> in Graph.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Manipulator_AcyclicTest
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a> in AcyclicTest.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Manipulator_AcyclicTest is a graph manipulator which tests whether a graph contains a cycle.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Manipulator_TopologicalSorter
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a> in TopologicalSorter.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Manipulator_TopologicalSorter is a manipulator which is able to return the set of nodes in a graph, sorted by topological order.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">Structures_Graph_Node</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodStructures_Graph_Node">Structures_Graph_Node::Structures_Graph_Node()</a> in Node.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Node
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a> in Node.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Node class represents a Node that can be member of a graph node set.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="t"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">t</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">TopologicalSorter.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Manipulator_TopologicalSorter_php.html">TopologicalSorter.php</a> in TopologicalSorter.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="u"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">u</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">unsetMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodunsetMetadata">Structures_Graph_Node::unsetMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Delete metadata by key</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex.html#u">u</a>
|
||||
</div> </body>
|
||||
</html>
|
||||
@@ -0,0 +1,336 @@
|
||||
<?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></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a name="top"></a>
|
||||
<h2>[Structures_Graph] element index</h2>
|
||||
<a href="elementindex.html">All elements</a>
|
||||
<br />
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#u">u</a>
|
||||
</div>
|
||||
|
||||
<a name="a"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">a</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">addNode</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodaddNode">Structures_Graph::addNode()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Add a Node to the Graph</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">AcyclicTest.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Manipulator_AcyclicTest_php.html">AcyclicTest.php</a> in AcyclicTest.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="c"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">c</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">connectsTo</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodconnectsTo">Structures_Graph_Node::connectsTo()</a> in Node.php</div>
|
||||
<div class="index-item-description">Test wether this node has an arc to the target node</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">connectTo</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodconnectTo">Structures_Graph_Node::connectTo()</a> in Node.php</div>
|
||||
<div class="index-item-description">Connect this node to another one.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="g"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">g</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">getData</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetData">Structures_Graph_Node::getData()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node data getter.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getGraph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetGraph">Structures_Graph_Node::getGraph()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node graph getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetMetadata">Structures_Graph_Node::getMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node metadata getter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getNeighbours</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodgetNeighbours">Structures_Graph_Node::getNeighbours()</a> in Node.php</div>
|
||||
<div class="index-item-description">Return nodes connected to this one.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">getNodes</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodgetNodes">Structures_Graph::getNodes()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="include-title">Graph.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_php.html">Graph.php</a> in Graph.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="i"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">i</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">inDegree</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodinDegree">Structures_Graph_Node::inDegree()</a> in Node.php</div>
|
||||
<div class="index-item-description">Calculate the in degree of the node.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">isAcyclic</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html#methodisAcyclic">Structures_Graph_Manipulator_AcyclicTest::isAcyclic()</a> in AcyclicTest.php</div>
|
||||
<div class="index-item-description">isAcyclic returns true if a graph contains no cycles, false otherwise.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">isDirected</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodisDirected">Structures_Graph::isDirected()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Return true if a graph is directed</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="m"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">m</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">metadataKeyExists</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodmetadataKeyExists">Structures_Graph_Node::metadataKeyExists()</a> in Node.php</div>
|
||||
<div class="index-item-description">Test for existence of metadata under a given key.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="n"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">n</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">Node.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Node_php.html">Node.php</a> in Node.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="o"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">o</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">outDegree</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodoutDegree">Structures_Graph_Node::outDegree()</a> in Node.php</div>
|
||||
<div class="index-item-description">Calculate the out degree of the node.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="r"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">r</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">removeNode</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodremoveNode">Structures_Graph::removeNode()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Remove a Node from the Graph</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="s"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">s</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">setData</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetData">Structures_Graph_Node::setData()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node data setter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">setGraph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetGraph">Structures_Graph_Node::setGraph()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node graph setter. This method should not be called directly. Use Graph::addNode instead.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">setMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodsetMetadata">Structures_Graph_Node::setMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Node metadata setter</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">sort</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html#methodsort">Structures_Graph_Manipulator_TopologicalSorter::sort()</a> in TopologicalSorter.php</div>
|
||||
<div class="index-item-description">sort returns the graph's nodes, sorted by topological order.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html">Structures_Graph</a> in Graph.php</div>
|
||||
<div class="index-item-description">The Structures_Graph class represents a graph data structure.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">Structures_Graph</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph.html#methodStructures_Graph">Structures_Graph::Structures_Graph()</a> in Graph.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="const-title">STRUCTURES_GRAPH_ERROR_GENERIC</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_php.html#defineSTRUCTURES_GRAPH_ERROR_GENERIC">STRUCTURES_GRAPH_ERROR_GENERIC</a> in Graph.php</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Manipulator_AcyclicTest
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html">Structures_Graph_Manipulator_AcyclicTest</a> in AcyclicTest.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Manipulator_AcyclicTest is a graph manipulator which tests whether a graph contains a cycle.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Manipulator_TopologicalSorter
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html">Structures_Graph_Manipulator_TopologicalSorter</a> in TopologicalSorter.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Manipulator_TopologicalSorter is a manipulator which is able to return the set of nodes in a graph, sorted by topological order.</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
<span class="method-title">Structures_Graph_Node</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodStructures_Graph_Node">Structures_Graph_Node::Structures_Graph_Node()</a> in Node.php</div>
|
||||
<div class="index-item-description">Constructor</div>
|
||||
</dd>
|
||||
<dt class="field">
|
||||
Structures_Graph_Node
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html">Structures_Graph_Node</a> in Node.php</div>
|
||||
<div class="index-item-description">The Structures_Graph_Node class represents a Node that can be member of a graph node set.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="t"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">t</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="include-title">TopologicalSorter.php</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/_Structures_Graph_Manipulator_TopologicalSorter_php.html">TopologicalSorter.php</a> in TopologicalSorter.php</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a name="u"></a>
|
||||
<div class="index-letter-section">
|
||||
<div style="float: left" class="index-letter-title">u</div>
|
||||
<div style="float: right"><a href="#top">top</a></div>
|
||||
<div style="clear: both"></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt class="field">
|
||||
<span class="method-title">unsetMetadata</span>
|
||||
</dt>
|
||||
<dd class="index-item-body">
|
||||
<div class="index-item-details"><a href="Structures_Graph/Structures_Graph_Node.html#methodunsetMetadata">Structures_Graph_Node::unsetMetadata()</a> in Node.php</div>
|
||||
<div class="index-item-description">Delete metadata by key</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<div class="index-letter-menu">
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#a">a</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#c">c</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#g">g</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#i">i</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#m">m</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#n">n</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#o">o</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#r">r</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#s">s</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#t">t</a>
|
||||
<a class="index-letter" href="elementindex_Structures_Graph.html#u">u</a>
|
||||
</div> </body>
|
||||
</html>
|
||||
16
include/pear/docs/Structures_Graph/docs/html/errors.html
Normal file
16
include/pear/docs/Structures_Graph/docs/html/errors.html
Normal file
@@ -0,0 +1,16 @@
|
||||
<?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>phpDocumentor Parser Errors and Warnings</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<a href="#Post-parsing">Post-parsing</a><br>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
24
include/pear/docs/Structures_Graph/docs/html/index.html
Normal file
24
include/pear/docs/Structures_Graph/docs/html/index.html
Normal file
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html
|
||||
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//FR"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- Generated by phpDocumentor on Fri, 30 Jan 2004 16:37:28 +0000 -->
|
||||
<title>Structures_Graph Documentation</title>
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
|
||||
<FRAMESET rows='100,*'>
|
||||
<FRAME src='packages.html' name='left_top' frameborder="1" bordercolor="#999999">
|
||||
<FRAMESET cols='25%,*'>
|
||||
<FRAME src='li_Structures_Graph.html' name='left_bottom' frameborder="1" bordercolor="#999999">
|
||||
<FRAME src='Structures_Graph/tutorial_Structures_Graph.pkg.html' name='right' frameborder="1" bordercolor="#999999">
|
||||
</FRAMESET>
|
||||
<NOFRAMES>
|
||||
<H2>Frame Alert</H2>
|
||||
<P>This document is designed to be viewed using the frames feature.
|
||||
If you see this message, you are using a non-frame-capable web client.</P>
|
||||
</NOFRAMES>
|
||||
</FRAMESET>
|
||||
</HTML>
|
||||
@@ -0,0 +1,53 @@
|
||||
<?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></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="package-title">Structures_Graph</div>
|
||||
<div class="package-details">
|
||||
|
||||
<dl class="tree">
|
||||
|
||||
<dt class="folder-title">Description</dt>
|
||||
<dd>
|
||||
<a href='classtrees_Structures_Graph.html' target='right'>Class trees</a><br />
|
||||
<a href='elementindex_Structures_Graph.html' target='right'>Index of elements</a><br />
|
||||
<a href="todolist.html" target="right">Todo List</a><br />
|
||||
</dd>
|
||||
|
||||
|
||||
|
||||
<dt class="folder-title">Tutorials/Manuals</dt>
|
||||
<dd>
|
||||
<dl class="tree">
|
||||
<dt class="folder-title">Package-level</dt>
|
||||
<dd>
|
||||
<div><a href="Structures_Graph/tutorial_Structures_Graph.pkg.html" target="right">Structures_Graph Tutorial</a></div>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</dd>
|
||||
<dt class="folder-title">Classes</dt>
|
||||
<dd><a href='Structures_Graph/Structures_Graph.html' target='right'>Structures_Graph</a></dd>
|
||||
<dd><a href='Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html' target='right'>Structures_Graph_Manipulator_AcyclicTest</a></dd>
|
||||
<dd><a href='Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html' target='right'>Structures_Graph_Manipulator_TopologicalSorter</a></dd>
|
||||
<dd><a href='Structures_Graph/Structures_Graph_Node.html' target='right'>Structures_Graph_Node</a></dd>
|
||||
<dt class="folder-title">Files</dt>
|
||||
<dd><a href='Structures_Graph/_Structures_Graph_Manipulator_AcyclicTest_php.html' target='right'>AcyclicTest.php</a></dd>
|
||||
<dd><a href='Structures_Graph/_Structures_Graph_php.html' target='right'>Graph.php</a></dd>
|
||||
<dd><a href='Structures_Graph/_Structures_Graph_Node_php.html' target='right'>Node.php</a></dd>
|
||||
<dd><a href='Structures_Graph/_Structures_Graph_Manipulator_TopologicalSorter_php.html' target='right'>TopologicalSorter.php</a></dd>
|
||||
|
||||
|
||||
</dl>
|
||||
</div>
|
||||
<p class="notes"><a href="http://www.phpdoc.org" target="_blank">phpDocumentor v <span class="field">1.2.3</span></a></p>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@@ -0,0 +1,32 @@
|
||||
body
|
||||
{
|
||||
background-color: #CCCCFF;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
/* Banner (top bar) classes */
|
||||
|
||||
.banner { }
|
||||
|
||||
.banner-menu
|
||||
{
|
||||
clear: both;
|
||||
padding: .5em;
|
||||
border-top: 2px solid #6666AA;
|
||||
}
|
||||
|
||||
.banner-title
|
||||
{
|
||||
text-align: right;
|
||||
font-size: 20pt;
|
||||
font-weight: bold;
|
||||
margin: .2em;
|
||||
}
|
||||
|
||||
.package-selector
|
||||
{
|
||||
background-color: #AAAADD;
|
||||
border: 1px solid black;
|
||||
color: yellow;
|
||||
}
|
||||
@@ -0,0 +1,134 @@
|
||||
a { color: #336699; text-decoration: none; }
|
||||
a:hover { color: #6699CC; text-decoration: underline; }
|
||||
a:active { color: #6699CC; text-decoration: underline; }
|
||||
|
||||
body { background : #FFFFFF; }
|
||||
body, table { font-family: Georgia, Times New Roman, Times, serif; font-size: 10pt }
|
||||
p, li { line-height: 140% }
|
||||
a img { border: 0px; }
|
||||
dd { margin-left: 0px; padding-left: 1em; }
|
||||
|
||||
/* Page layout/boxes */
|
||||
|
||||
.info-box {}
|
||||
.info-box-title { margin: 1em 0em 0em 0em; padding: .25em; font-weight: normal; font-size: 14pt; border: 2px solid #999999; background-color: #CCCCFF }
|
||||
.info-box-body { border: 1px solid #999999; padding: .5em; }
|
||||
.nav-bar { font-size: 8pt; white-space: nowrap; text-align: right; padding: .2em; margin: 0em 0em 1em 0em; }
|
||||
|
||||
.oddrow { background-color: #F8F8F8; border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
|
||||
.evenrow { border: 1px solid #AAAAAA; padding: .5em; margin-bottom: 1em}
|
||||
|
||||
.page-body { max-width: 800px; margin: auto; }
|
||||
.tree dl { margin: 0px }
|
||||
|
||||
/* Index formatting classes */
|
||||
|
||||
.index-item-body { margin-top: .5em; margin-bottom: .5em}
|
||||
.index-item-description { margin-top: .25em }
|
||||
.index-item-details { font-weight: normal; font-style: italic; font-size: 8pt }
|
||||
.index-letter-section { background-color: #EEEEEE; border: 1px dotted #999999; padding: .5em; margin-bottom: 1em}
|
||||
.index-letter-title { font-size: 12pt; font-weight: bold }
|
||||
.index-letter-menu { text-align: center; margin: 1em }
|
||||
.index-letter { font-size: 12pt }
|
||||
|
||||
/* Docbook classes */
|
||||
|
||||
.description {}
|
||||
.short-description { font-weight: bold; color: #666666; }
|
||||
.tags { padding-left: 0em; margin-left: 3em; color: #666666; list-style-type: square; }
|
||||
.parameters { padding-left: 0em; margin-left: 3em; font-style: italic; list-style-type: square; }
|
||||
.redefinitions { font-size: 8pt; padding-left: 0em; margin-left: 2em; }
|
||||
.package { }
|
||||
.package-title { font-weight: bold; font-size: 14pt; border-bottom: 1px solid black }
|
||||
.package-details { font-size: 85%; }
|
||||
.sub-package { font-weight: bold; font-size: 120% }
|
||||
.tutorial { border-width: thin; border-color: #0066ff }
|
||||
.tutorial-nav-box { width: 100%; border: 1px solid #999999; background-color: #F8F8F8; }
|
||||
.nav-button-disabled { color: #999999; }
|
||||
.nav-button:active,
|
||||
.nav-button:focus,
|
||||
.nav-button:hover { background-color: #DDDDDD; outline: 1px solid #999999; text-decoration: none }
|
||||
.folder-title { font-style: italic }
|
||||
|
||||
/* Generic formatting */
|
||||
|
||||
.field { font-weight: bold; }
|
||||
.detail { font-size: 8pt; }
|
||||
.notes { font-style: italic; font-size: 8pt; }
|
||||
.separator { background-color: #999999; height: 2px; }
|
||||
.warning { color: #FF6600; }
|
||||
.disabled { font-style: italic; color: #999999; }
|
||||
|
||||
/* Code elements */
|
||||
|
||||
.line-number { }
|
||||
|
||||
.class-table { width: 100%; }
|
||||
.class-table-header { border-bottom: 1px dotted #666666; text-align: left}
|
||||
.class-name { color: #000000; font-weight: bold; }
|
||||
|
||||
.method-summary { padding-left: 1em; font-size: 8pt }
|
||||
.method-header { }
|
||||
.method-definition { margin-bottom: .3em }
|
||||
.method-title { font-weight: bold; }
|
||||
.method-name { font-weight: bold; }
|
||||
.method-signature { font-size: 85%; color: #666666; margin: .5em 0em }
|
||||
.method-result { font-style: italic; }
|
||||
|
||||
.var-summary { padding-left: 1em; font-size: 8pt; }
|
||||
.var-header { }
|
||||
.var-title { margin-bottom: .3em }
|
||||
.var-type { font-style: italic; }
|
||||
.var-name { font-weight: bold; }
|
||||
.var-default {}
|
||||
.var-description { font-weight: normal; color: #000000; }
|
||||
|
||||
.include-title { }
|
||||
.include-type { font-style: italic; }
|
||||
.include-name { font-weight: bold; }
|
||||
|
||||
.const-title { }
|
||||
.const-name { font-weight: bold; }
|
||||
|
||||
/* Syntax highlighting */
|
||||
|
||||
.src-code { border: 1px solid #336699; padding: 1em; background-color: #EEEEEE; }
|
||||
|
||||
.src-comm { color: green; }
|
||||
.src-id { }
|
||||
.src-inc { color: #0000FF; }
|
||||
.src-key { color: #0000FF; }
|
||||
.src-num { color: #CC0000; }
|
||||
.src-str { color: #66cccc; }
|
||||
.src-sym { font-weight: bold; }
|
||||
.src-var { }
|
||||
|
||||
.src-php { font-weight: bold; }
|
||||
|
||||
.src-doc { color: #009999 }
|
||||
.src-doc-close-template { color: #0000FF }
|
||||
.src-doc-coretag { color: #0099FF; font-weight: bold }
|
||||
.src-doc-inlinetag { color: #0099FF }
|
||||
.src-doc-internal { color: #6699cc }
|
||||
.src-doc-tag { color: #0080CC }
|
||||
.src-doc-template { color: #0000FF }
|
||||
.src-doc-type { font-style: italic }
|
||||
.src-doc-var { font-style: italic }
|
||||
|
||||
/* tutorial */
|
||||
|
||||
.authors { }
|
||||
.author { font-style: italic; font-weight: bold }
|
||||
.author-blurb { margin: .5em 0em .5em 2em; font-size: 85%; font-weight: normal; font-style: normal }
|
||||
.example { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em }
|
||||
.listing { border: 1px dashed #999999; background-color: #EEEEEE; padding: .5em; white-space: nowrap }
|
||||
.release-info { font-size: 85%; font-style: italic; margin: 1em 0em }
|
||||
.ref-title-box { }
|
||||
.ref-title { }
|
||||
.ref-purpose { font-style: italic; color: #666666 }
|
||||
.ref-synopsis { }
|
||||
.title { font-weight: bold; margin: 1em 0em 0em 0em; padding: .25em; border: 2px solid #999999; background-color: #CCCCFF }
|
||||
.cmd-synopsis { margin: 1em 0em }
|
||||
.cmd-title { font-weight: bold }
|
||||
.toc { margin-left: 2em; padding-left: 0em }
|
||||
|
||||
27
include/pear/docs/Structures_Graph/docs/html/packages.html
Normal file
27
include/pear/docs/Structures_Graph/docs/html/packages.html
Normal file
@@ -0,0 +1,27 @@
|
||||
<?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></title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<link rel="stylesheet" href="media/banner.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="banner">
|
||||
<div class="banner-title">Structures_Graph</div>
|
||||
<div class="banner-menu">
|
||||
<table cellpadding="0" cellspacing="0" style="width: 100%">
|
||||
<tr>
|
||||
<td>
|
||||
</td>
|
||||
<td style="width: 2em"> </td>
|
||||
<td style="text-align: right">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
21
include/pear/docs/Structures_Graph/docs/html/todolist.html
Normal file
21
include/pear/docs/Structures_Graph/docs/html/todolist.html
Normal file
@@ -0,0 +1,21 @@
|
||||
<?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>Todo List</title>
|
||||
<link rel="stylesheet" href="media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div align="center"><h1>Todo List</h1></div>
|
||||
<h2>Structures_Graph</h2>
|
||||
<h3><a href="Structures_Graph/Structures_Graph.html#methodremoveNode">Structures_Graph::removeNode()</a></h3>
|
||||
<ul>
|
||||
<li>This is unimplemented</li>
|
||||
</ul>
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Fri, 30 Jan 2004 16:37:29 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.3</a>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,98 @@
|
||||
<refentry id="{@id package.database.structures_graph.tutorial}">
|
||||
<refnamediv>
|
||||
<refname><classname>Structures_Graph</classname> Tutorial</refname>
|
||||
<refpurpose>A first tour of graph datastructure manipulation</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 id="{@id package.database.structures_graph.tutorial.intro}">
|
||||
<title>Introduction</title>
|
||||
<para>
|
||||
Structures_Graph is a package for creating and manipulating graph datastructures. A graph is a set of objects, called nodes, connected by arcs. When used as a datastructure, usually nodes contain data, and arcs represent relationships between nodes. When arcs have a direction, and can be travelled only one way, graphs are said to be directed. When arcs have no direction, and can always be travelled both ways, graphs are said to be non directed.
|
||||
</para>
|
||||
<para>
|
||||
Structures_Graph provides an object oriented API to create and directly query a graph, as well as a set of Manipulator classes to extract information from the graph.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 id="{@id package.database.structures_graph.tutorial.creation}">
|
||||
<title>Creating a Graph</title>
|
||||
<para>
|
||||
Creating a graph is done using the simple constructor:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
require_once 'Structures/Graph.php';
|
||||
|
||||
$directedGraph =& new Structures_Graph(true);
|
||||
$nonDirectedGraph =& new Structures_Graph(false);
|
||||
]]>
|
||||
</programlisting>
|
||||
and passing the constructor a flag telling it whether the graph should be directed. A directed graph will always be directed during its lifetime. It's a permanent characteristic.
|
||||
</para>
|
||||
<para>
|
||||
To fill out the graph, we'll need to create some nodes, and then call Graph::addNode.
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
require_once 'Structures/Graph/Node.php';
|
||||
|
||||
$nodeOne =& new Structures_Graph_Node();
|
||||
$nodeTwo =& new Structures_Graph_Node();
|
||||
$nodeThree =& new Structures_Graph_Node();
|
||||
|
||||
$directedGraph->addNode(&$nodeOne);
|
||||
$directedGraph->addNode(&$nodeTwo);
|
||||
$directedGraph->addNode(&$nodeThree);
|
||||
]]>
|
||||
</programlisting>
|
||||
and then setup the arcs:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
$nodeOne->connectTo($nodeTwo);
|
||||
$nodeOne->connectTo($nodeThree);
|
||||
]]>
|
||||
</programlisting>
|
||||
Note that arcs can only be created after the nodes have been inserted into the graph.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 id="{@id package.database.structures_graph.tutorial.nodesanddata}">
|
||||
<title>Associating Data</title>
|
||||
<para>
|
||||
Graphs are only useful as datastructures if they can hold data. Structure_Graph stores data in nodes. Each node contains a setter and a getter for its data.
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
$nodeOne->setData("Node One's Data is a String");
|
||||
$nodeTwo->setData(1976);
|
||||
$nodeThree->setData('Some other string');
|
||||
|
||||
print("NodeTwo's Data is an integer: " . $nodeTwo->getData());
|
||||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
Structure_Graph nodes can also store metadata, alongside with the main data. Metadata differs from regular data just because it is stored under a key, making it possible to store more than one data reference per node. The metadata getter and setter need the key to perform the operation:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
$nodeOne->setMetadata('example key', "Node One's Sample Metadata");
|
||||
print("Metadata stored under key 'example key' in node one: " . $nodeOne->getMetadata('example key'));
|
||||
$nodeOne->unsetMetadata('example key');
|
||||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 id="{@id package.database.structures_graph.tutorial.querying}">
|
||||
<title>Querying a Graph</title>
|
||||
<para>
|
||||
Structures_Graph provides for basic querying of the graph:
|
||||
<programlisting>
|
||||
<![CDATA[
|
||||
// Nodes are able to calculate their indegree and outdegree
|
||||
print("NodeOne's inDegree: " . $nodeOne->inDegree());
|
||||
print("NodeOne's outDegree: " . $nodeOne->outDegree());
|
||||
|
||||
// and naturally, nodes can report on their arcs
|
||||
$arcs = $nodeOne->getNeighbours();
|
||||
for ($i=0;$i<sizeof($arcs);$i++) {
|
||||
print("NodeOne has an arc to " . $arcs[$i]->getData());
|
||||
}
|
||||
]]>
|
||||
</programlisting>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user