Skip to content
Browse files

Initial import into PEAR CVS

git-svn-id: http://svn.php.net/repository/pear/packages/Structures_Graph/trunk@158015 c90b9560-bf6c-de11-be94-00142212c4b1
  • Loading branch information...
1 parent b3687cd commit 91edafc07090c47aabc9dfa3a503ff9bae6cf43f Sergio Carvalho committed May 5, 2004
Showing with 4,282 additions and 0 deletions.
  1. +504 −0 LICENSE
  2. +156 −0 Structures/Graph.php
  3. +137 −0 Structures/Graph/Manipulator/AcyclicTest.php
  4. +157 −0 Structures/Graph/Manipulator/TopologicalSorter.php
  5. +339 −0 Structures/Graph/Node.php
  6. +8 −0 docs/generate.sh
  7. +243 −0 docs/html/Structures_Graph/Structures_Graph.html
  8. +105 −0 docs/html/Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.html
  9. +107 −0 docs/html/Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.html
  10. +549 −0 docs/html/Structures_Graph/Structures_Graph_Node.html
  11. +119 −0 docs/html/Structures_Graph/_Structures_Graph_Manipulator_AcyclicTest_php.html
  12. +133 −0 docs/html/Structures_Graph/_Structures_Graph_Manipulator_TopologicalSorter_php.html
  13. +105 −0 docs/html/Structures_Graph/_Structures_Graph_Node_php.html
  14. +136 −0 docs/html/Structures_Graph/_Structures_Graph_php.html
  15. +75 −0 docs/html/Structures_Graph/tutorial_Structures_Graph.pkg.html
  16. +36 −0 docs/html/classtrees_Structures_Graph.html
  17. +339 −0 docs/html/elementindex.html
  18. +336 −0 docs/html/elementindex_Structures_Graph.html
  19. +16 −0 docs/html/errors.html
  20. +24 −0 docs/html/index.html
  21. +53 −0 docs/html/li_Structures_Graph.html
  22. +32 −0 docs/html/media/banner.css
  23. +134 −0 docs/html/media/stylesheet.css
  24. +27 −0 docs/html/packages.html
  25. +21 −0 docs/html/todolist.html
  26. +98 −0 docs/tutorials/Structures_Graph/Structures_Graph.pkg
  27. +16 −0 genpackage.xml.pl
  28. +51 −0 package.sh
  29. +5 −0 publish.sh
  30. 0 tests/README
  31. +39 −0 tests/all-tests.php
  32. +182 −0 tests/testCase/BasicGraph.php
View
504 LICENSE
@@ -0,0 +1,504 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 2.1, February 1999
+
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+[This is the first released version of the Lesser GPL. It also counts
+ as the successor of the GNU Library Public License, version 2, hence
+ the version number 2.1.]
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+Licenses are intended to guarantee your freedom to share and change
+free software--to make sure the software is free for all its users.
+
+ This license, the Lesser General Public License, applies to some
+specially designated software packages--typically libraries--of the
+Free Software Foundation and other authors who decide to use it. You
+can use it too, but we suggest you first think carefully about whether
+this license or the ordinary General Public License is the better
+strategy to use in any particular case, based on the explanations below.
+
+ When we speak of free software, we are referring to freedom of use,
+not price. Our General Public Licenses are designed to make sure that
+you have the freedom to distribute copies of free software (and charge
+for this service if you wish); that you receive source code or can get
+it if you want it; that you can change the software and use pieces of
+it in new free programs; and that you are informed that you can do
+these things.
+
+ To protect your rights, we need to make restrictions that forbid
+distributors to deny you these rights or to ask you to surrender these
+rights. These restrictions translate to certain responsibilities for
+you if you distribute copies of the library or if you modify it.
+
+ For example, if you distribute copies of the library, whether gratis
+or for a fee, you must give the recipients all the rights that we gave
+you. You must make sure that they, too, receive or can get the source
+code. If you link other code with the library, you must provide
+complete object files to the recipients, so that they can relink them
+with the library after making changes to the library and recompiling
+it. And you must show them these terms so they know their rights.
+
+ We protect your rights with a two-step method: (1) we copyright the
+library, and (2) we offer you this license, which gives you legal
+permission to copy, distribute and/or modify the library.
+
+ To protect each distributor, we want to make it very clear that
+there is no warranty for the free library. Also, if the library is
+modified by someone else and passed on, the recipients should know
+that what they have is not the original version, so that the original
+author's reputation will not be affected by problems that might be
+introduced by others.
+
+ Finally, software patents pose a constant threat to the existence of
+any free program. We wish to make sure that a company cannot
+effectively restrict the users of a free program by obtaining a
+restrictive license from a patent holder. Therefore, we insist that
+any patent license obtained for a version of the library must be
+consistent with the full freedom of use specified in this license.
+
+ Most GNU software, including some libraries, is covered by the
+ordinary GNU General Public License. This license, the GNU Lesser
+General Public License, applies to certain designated libraries, and
+is quite different from the ordinary General Public License. We use
+this license for certain libraries in order to permit linking those
+libraries into non-free programs.
+
+ When a program is linked with a library, whether statically or using
+a shared library, the combination of the two is legally speaking a
+combined work, a derivative of the original library. The ordinary
+General Public License therefore permits such linking only if the
+entire combination fits its criteria of freedom. The Lesser General
+Public License permits more lax criteria for linking other code with
+the library.
+
+ We call this license the "Lesser" General Public License because it
+does Less to protect the user's freedom than the ordinary General
+Public License. It also provides other free software developers Less
+of an advantage over competing non-free programs. These disadvantages
+are the reason we use the ordinary General Public License for many
+libraries. However, the Lesser license provides advantages in certain
+special circumstances.
+
+ For example, on rare occasions, there may be a special need to
+encourage the widest possible use of a certain library, so that it becomes
+a de-facto standard. To achieve this, non-free programs must be
+allowed to use the library. A more frequent case is that a free
+library does the same job as widely used non-free libraries. In this
+case, there is little to gain by limiting the free library to free
+software only, so we use the Lesser General Public License.
+
+ In other cases, permission to use a particular library in non-free
+programs enables a greater number of people to use a large body of
+free software. For example, permission to use the GNU C Library in
+non-free programs enables many more people to use the whole GNU
+operating system, as well as its variant, the GNU/Linux operating
+system.
+
+ Although the Lesser General Public License is Less protective of the
+users' freedom, it does ensure that the user of a program that is
+linked with the Library has the freedom and the wherewithal to run
+that program using a modified version of the Library.
+
+ The precise terms and conditions for copying, distribution and
+modification follow. Pay close attention to the difference between a
+"work based on the library" and a "work that uses the library". The
+former contains code derived from the library, whereas the latter must
+be combined with the library in order to run.
+
+ GNU LESSER GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License Agreement applies to any software library or other
+program which contains a notice placed by the copyright holder or
+other authorized party saying it may be distributed under the terms of
+this Lesser General Public License (also called "this License").
+Each licensee is addressed as "you".
+
+ A "library" means a collection of software functions and/or data
+prepared so as to be conveniently linked with application programs
+(which use some of those functions and data) to form executables.
+
+ The "Library", below, refers to any such software library or work
+which has been distributed under these terms. A "work based on the
+Library" means either the Library or any derivative work under
+copyright law: that is to say, a work containing the Library or a
+portion of it, either verbatim or with modifications and/or translated
+straightforwardly into another language. (Hereinafter, translation is
+included without limitation in the term "modification".)
+
+ "Source code" for a work means the preferred form of the work for
+making modifications to it. For a library, complete source code means
+all the source code for all modules it contains, plus any associated
+interface definition files, plus the scripts used to control compilation
+and installation of the library.
+
+ Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running a program using the Library is not restricted, and output from
+such a program is covered only if its contents constitute a work based
+on the Library (independent of the use of the Library in a tool for
+writing it). Whether that is true depends on what the Library does
+and what the program that uses the Library does.
+
+ 1. You may copy and distribute verbatim copies of the Library's
+complete source code as you receive it, in any medium, provided that
+you conspicuously and appropriately publish on each copy an
+appropriate copyright notice and disclaimer of warranty; keep intact
+all the notices that refer to this License and to the absence of any
+warranty; and distribute a copy of this License along with the
+Library.
+
+ You may charge a fee for the physical act of transferring a copy,
+and you may at your option offer warranty protection in exchange for a
+fee.
+
+ 2. You may modify your copy or copies of the Library or any portion
+of it, thus forming a work based on the Library, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) The modified work must itself be a software library.
+
+ b) You must cause the files modified to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ c) You must cause the whole of the work to be licensed at no
+ charge to all third parties under the terms of this License.
+
+ d) If a facility in the modified Library refers to a function or a
+ table of data to be supplied by an application program that uses
+ the facility, other than as an argument passed when the facility
+ is invoked, then you must make a good faith effort to ensure that,
+ in the event an application does not supply such function or
+ table, the facility still operates, and performs whatever part of
+ its purpose remains meaningful.
+
+ (For example, a function in a library to compute square roots has
+ a purpose that is entirely well-defined independent of the
+ application. Therefore, Subsection 2d requires that any
+ application-supplied function or table used by this function must
+ be optional: if the application does not supply it, the square
+ root function must still compute square roots.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Library,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Library, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Library.
+
+In addition, mere aggregation of another work not based on the Library
+with the Library (or with a work based on the Library) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may opt to apply the terms of the ordinary GNU General Public
+License instead of this License to a given copy of the Library. To do
+this, you must alter all the notices that refer to this License, so
+that they refer to the ordinary GNU General Public License, version 2,
+instead of to this License. (If a newer version than version 2 of the
+ordinary GNU General Public License has appeared, then you can specify
+that version instead if you wish.) Do not make any other change in
+these notices.
+
+ Once this change is made in a given copy, it is irreversible for
+that copy, so the ordinary GNU General Public License applies to all
+subsequent copies and derivative works made from that copy.
+
+ This option is useful when you wish to copy part of the code of
+the Library into a program that is not a library.
+
+ 4. You may copy and distribute the Library (or a portion or
+derivative of it, under Section 2) in object code or executable form
+under the terms of Sections 1 and 2 above provided that you accompany
+it with the complete corresponding machine-readable source code, which
+must be distributed under the terms of Sections 1 and 2 above on a
+medium customarily used for software interchange.
+
+ If distribution of object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the
+source code from the same place satisfies the requirement to
+distribute the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 5. A program that contains no derivative of any portion of the
+Library, but is designed to work with the Library by being compiled or
+linked with it, is called a "work that uses the Library". Such a
+work, in isolation, is not a derivative work of the Library, and
+therefore falls outside the scope of this License.
+
+ However, linking a "work that uses the Library" with the Library
+creates an executable that is a derivative of the Library (because it
+contains portions of the Library), rather than a "work that uses the
+library". The executable is therefore covered by this License.
+Section 6 states terms for distribution of such executables.
+
+ When a "work that uses the Library" uses material from a header file
+that is part of the Library, the object code for the work may be a
+derivative work of the Library even though the source code is not.
+Whether this is true is especially significant if the work can be
+linked without the Library, or if the work is itself a library. The
+threshold for this to be true is not precisely defined by law.
+
+ If such an object file uses only numerical parameters, data
+structure layouts and accessors, and small macros and small inline
+functions (ten lines or less in length), then the use of the object
+file is unrestricted, regardless of whether it is legally a derivative
+work. (Executables containing this object code plus portions of the
+Library will still fall under Section 6.)
+
+ Otherwise, if the work is a derivative of the Library, you may
+distribute the object code for the work under the terms of Section 6.
+Any executables containing that work also fall under Section 6,
+whether or not they are linked directly with the Library itself.
+
+ 6. As an exception to the Sections above, you may also combine or
+link a "work that uses the Library" with the Library to produce a
+work containing portions of the Library, and distribute that work
+under terms of your choice, provided that the terms permit
+modification of the work for the customer's own use and reverse
+engineering for debugging such modifications.
+
+ You must give prominent notice with each copy of the work that the
+Library is used in it and that the Library and its use are covered by
+this License. You must supply a copy of this License. If the work
+during execution displays copyright notices, you must include the
+copyright notice for the Library among them, as well as a reference
+directing the user to the copy of this License. Also, you must do one
+of these things:
+
+ a) Accompany the work with the complete corresponding
+ machine-readable source code for the Library including whatever
+ changes were used in the work (which must be distributed under
+ Sections 1 and 2 above); and, if the work is an executable linked
+ with the Library, with the complete machine-readable "work that
+ uses the Library", as object code and/or source code, so that the
+ user can modify the Library and then relink to produce a modified
+ executable containing the modified Library. (It is understood
+ that the user who changes the contents of definitions files in the
+ Library will not necessarily be able to recompile the application
+ to use the modified definitions.)
+
+ b) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (1) uses at run time a
+ copy of the library already present on the user's computer system,
+ rather than copying library functions into the executable, and (2)
+ will operate properly with a modified version of the library, if
+ the user installs one, as long as the modified version is
+ interface-compatible with the version that the work was made with.
+
+ c) Accompany the work with a written offer, valid for at
+ least three years, to give the same user the materials
+ specified in Subsection 6a, above, for a charge no more
+ than the cost of performing this distribution.
+
+ d) If distribution of the work is made by offering access to copy
+ from a designated place, offer equivalent access to copy the above
+ specified materials from the same place.
+
+ e) Verify that the user has already received a copy of these
+ materials or that you have already sent this user a copy.
+
+ For an executable, the required form of the "work that uses the
+Library" must include any data and utility programs needed for
+reproducing the executable from it. However, as a special exception,
+the materials to be distributed need not include anything that is
+normally distributed (in either source or binary form) with the major
+components (compiler, kernel, and so on) of the operating system on
+which the executable runs, unless that component itself accompanies
+the executable.
+
+ It may happen that this requirement contradicts the license
+restrictions of other proprietary libraries that do not normally
+accompany the operating system. Such a contradiction means you cannot
+use both them and the Library together in an executable that you
+distribute.
+
+ 7. You may place library facilities that are a work based on the
+Library side-by-side in a single library together with other library
+facilities not covered by this License, and distribute such a combined
+library, provided that the separate distribution of the work based on
+the Library and of the other library facilities is otherwise
+permitted, and provided that you do these two things:
+
+ a) Accompany the combined library with a copy of the same work
+ based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the
+ Sections above.
+
+ b) Give prominent notice with the combined library of the fact
+ that part of it is a work based on the Library, and explaining
+ where to find the accompanying uncombined form of the same work.
+
+ 8. You may not copy, modify, sublicense, link with, or distribute
+the Library except as expressly provided under this License. Any
+attempt otherwise to copy, modify, sublicense, link with, or
+distribute the Library is void, and will automatically terminate your
+rights under this License. However, parties who have received copies,
+or rights, from you under this License will not have their licenses
+terminated so long as such parties remain in full compliance.
+
+ 9. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Library or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Library (or any work based on the
+Library), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Library or works based on it.
+
+ 10. Each time you redistribute the Library (or any work based on the
+Library), the recipient automatically receives a license from the
+original licensor to copy, distribute, link with or modify the Library
+subject to these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties with
+this License.
+
+ 11. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Library at all. For example, if a patent
+license would not permit royalty-free redistribution of the Library by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Library.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply,
+and the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 12. If the distribution and/or use of the Library is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Library under this License may add
+an explicit geographical distribution limitation excluding those countries,
+so that distribution is permitted only in or among countries not thus
+excluded. In such case, this License incorporates the limitation as if
+written in the body of this License.
+
+ 13. The Free Software Foundation may publish revised and/or new
+versions of the Lesser General Public License from time to time.
+Such new versions will be similar in spirit to the present version,
+but may differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Library does not specify a
+license version number, you may choose any version ever published by
+the Free Software Foundation.
+
+ 14. If you wish to incorporate parts of the Library into other free
+programs whose distribution conditions are incompatible with these,
+write to the author to ask for permission. For software which is
+copyrighted by the Free Software Foundation, write to the Free
+Software Foundation; we sometimes make exceptions for this. Our
+decision will be guided by the two goals of preserving the free status
+of all derivatives of our free software and of promoting the sharing
+and reuse of software generally.
+
+ NO WARRANTY
+
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Libraries
+
+ If you develop a new library, and you want it to be of the greatest
+possible use to the public, we recommend making it free software that
+everyone can redistribute and change. You can do so by permitting
+redistribution under these terms (or, alternatively, under the terms of the
+ordinary General Public License).
+
+ To apply these terms, attach the following notices to the library. It is
+safest to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the library's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+Also add information on how to contact you by electronic and paper mail.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the library, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
+
+ <signature of Ty Coon>, 1 April 1990
+ Ty Coon, President of Vice
+
+That's all there is to it!
+
+
View
156 Structures/Graph.php
@@ -0,0 +1,156 @@
+<?php
+/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
+// +-----------------------------------------------------------------------------+
+// | Copyright (c) 2003 Sérgio Gonçalves Carvalho |
+// +-----------------------------------------------------------------------------+
+// | This file is part of Structures_Graph. |
+// | |
+// | Structures_Graph is free software; you can redistribute it and/or modify |
+// | it under the terms of the GNU Lesser General Public License as published by |
+// | the Free Software Foundation; either version 2.1 of the License, or |
+// | (at your option) any later version. |
+// | |
+// | Structures_Graph is distributed in the hope that it will be useful, |
+// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
+// | GNU Lesser General Public License for more details. |
+// | |
+// | You should have received a copy of the GNU Lesser General Public License |
+// | along with Structures_Graph; if not, write to the Free Software |
+// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
+// | 02111-1307 USA |
+// +-----------------------------------------------------------------------------+
+// | Author: Sérgio Carvalho <sergio.carvalho@portugalmail.com> |
+// +-----------------------------------------------------------------------------+
+//
+/**
+ * The Graph.php file contains the definition of the Structures_Graph class
+ *
+ * @see Structures_Graph
+ * @package Structures_Graph
+ */
+
+/* dependencies {{{ */
+/** PEAR base classes */
+require_once 'PEAR.php';
+/** Graph Node */
+require_once 'Structures/Graph/Node.php';
+/* }}} */
+
+define('STRUCTURES_GRAPH_ERROR_GENERIC', 100);
+
+/* class Structures_Graph {{{ */
+/**
+ * The Structures_Graph class represents a graph data structure.
+ *
+ * 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.
+ *
+ * @author Sérgio Carvalho <sergio.carvalho@portugalmail.com>
+ * @copyright (c) 2004 by Sérgio Carvalho
+ * @package Structures_Graph
+ */
+/* }}} */
+class Structures_Graph {
+ /* fields {{{ */
+ /**
+ * @access private
+ */
+ var $_nodes = array();
+ /**
+ * @access private
+ */
+ var $_directed = false;
+ /* }}} */
+
+ /* Constructor {{{ */
+ /**
+ *
+ * Constructor
+ *
+ * @param boolean Set to true if the graph is directed. Set to false if it is not directed. (Optional, defaults to true)
+ * @access public
+ */
+ function Structures_Graph($directed = true) {
+ $this->_directed = $directed;
+ }
+ /* }}} */
+
+ /* isDirected {{{ */
+ /**
+ *
+ * Return true if a graph is directed
+ *
+ * @return boolean true if the graph is directed
+ * @access public
+ */
+ function isDirected() {
+ return (boolean) $this->_directed;
+ }
+ /* }}} */
+
+ /* addNode {{{ */
+ /**
+ *
+ * Add a Node to the Graph
+ *
+ * @param Structures_Graph_Node The node to be added.
+ * @access public
+ */
+ function addNode(&$newNode) {
+ // We only add nodes
+ if (!is_a($newNode, 'Structures_Graph_Node'))
+ Pear::raiseError('Structures_Graph::addNode received an object that is not a Structures_Graph_Node', STRUCTURES_GRAPH_ERROR_GENERIC);
+ // Graphs are node *sets*, so duplicates are forbidden. We allow nodes that are exactly equal, but disallow equal references.
+ foreach($this->_nodes as $key => $node) {
+ /*
+ ZE1 equality operators choke on the recursive cycle introduced by the _graph field in the Node object.
+ So, we'll check references the hard way
+ */
+ $savedData = $this->_nodes[$key];
+ $referenceIsEqualFlag = false;
+ $this->_nodes[$key] = true;
+ if ($node === true) {
+ $this->_nodes[$key] = false;
+ if ($node === false)
+ $referenceIsEqualFlag = true;
+ }
+ $this->_nodes[$key] = $savedData;
+ if ($referenceIsEqualFlag)
+ Pear::raiseError('Structures_Graph::addNode received an object that is a duplicate for this dataset', STRUCTURES_GRAPH_ERROR_GENERIC);
+ }
+ $this->_nodes[] =& $newNode;
+ $newNode->setGraph($this);
+ }
+ /* }}} */
+
+ /* removeNode (unimplemented) {{{ */
+ /**
+ *
+ * Remove a Node from the Graph
+ *
+ * @todo This is unimplemented
+ * @param Structures_Graph_Node The node to be removed from the graph
+ * @access public
+ */
+ function removeNode(&$node) {
+ }
+ /* }}} */
+
+ /* getNodes {{{ */
+ /**
+ *
+ * Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.
+ *
+ * @access public
+ * @see Structures_Graph_Manipulator_TopologicalSorter
+ * @return array The set of nodes in this graph
+ */
+ function &getNodes() {
+ return $this->_nodes;
+ }
+ /* }}} */
+}
+?>
View
137 Structures/Graph/Manipulator/AcyclicTest.php
@@ -0,0 +1,137 @@
+<?php
+/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
+// +-----------------------------------------------------------------------------+
+// | Copyright (c) 2003 Sérgio Gonçalves Carvalho |
+// +-----------------------------------------------------------------------------+
+// | This file is part of Structures_Graph. |
+// | |
+// | Structures_Graph is free software; you can redistribute it and/or modify |
+// | it under the terms of the GNU Lesser General Public License as published by |
+// | the Free Software Foundation; either version 2.1 of the License, or |
+// | (at your option) any later version. |
+// | |
+// | Structures_Graph is distributed in the hope that it will be useful, |
+// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
+// | GNU Lesser General Public License for more details. |
+// | |
+// | You should have received a copy of the GNU Lesser General Public License |
+// | along with Structures_Graph; if not, write to the Free Software |
+// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
+// | 02111-1307 USA |
+// +-----------------------------------------------------------------------------+
+// | Author: Sérgio Carvalho <sergio.carvalho@portugalmail.com> |
+// +-----------------------------------------------------------------------------+
+//
+/**
+ * This file contains the definition of the Structures_Graph_Manipulator_AcyclicTest graph manipulator.
+ *
+ * @see Structures_Graph_Manipulator_AcyclicTest
+ * @package Structures_Graph
+ */
+
+/* dependencies {{{ */
+/** */
+require_once 'PEAR.php';
+/** */
+require_once 'Structures/Graph.php';
+/** */
+require_once 'Structures/Graph/Node.php';
+/* }}} */
+
+/* class Structures_Graph_Manipulator_AcyclicTest {{{ */
+/**
+ * The Structures_Graph_Manipulator_AcyclicTest is a graph manipulator
+ * which tests whether a graph contains a cycle.
+ *
+ * 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.
+ *
+ * @author Sérgio Carvalho <sergio.carvalho@portugalmail.com>
+ * @copyright (c) 2004 by Sérgio Carvalho
+ * @package Structures_Graph
+ */
+class Structures_Graph_Manipulator_AcyclicTest {
+ /* _nonVisitedInDegree {{{ */
+ /**
+ *
+ * This is a variant of Structures_Graph::inDegree which does
+ * not count nodes marked as visited.
+ *
+ * @access private
+ * @return integer Number of non-visited nodes that link to this one
+ */
+ function _nonVisitedInDegree(&$node) {
+ $result = 0;
+ $graphNodes =& $node->_graph->getNodes();
+ foreach (array_keys($graphNodes) as $key) {
+ if ((!$graphNodes[$key]->getMetadata('acyclic-test-visited')) && $graphNodes[$key]->connectsTo($node)) $result++;
+ }
+ return $result;
+
+ }
+ /* }}} */
+
+ /* _isAcyclic {{{ */
+ /**
+ * @access private
+ */
+ function _isAcyclic(&$graph) {
+ // Mark every node as not visited
+ $nodes =& $graph->getNodes();
+ $nodeKeys = array_keys($nodes);
+ $refGenerator = array();
+ foreach($nodeKeys as $key) {
+ $refGenerator[] = false;
+ $nodes[$key]->setMetadata('acyclic-test-visited', $refGenerator[sizeof($refGenerator) - 1]);
+ }
+
+ // Iteratively peel off leaf nodes
+ do {
+ // Find out which nodes are leafs (excluding visited nodes)
+ $leafNodes = array();
+ foreach($nodeKeys as $key) {
+ if ((!$nodes[$key]->getMetadata('acyclic-test-visited')) && Structures_Graph_Manipulator_AcyclicTest::_nonVisitedInDegree($nodes[$key]) == 0) {
+ $leafNodes[] =& $nodes[$key];
+ }
+ }
+ // Mark leafs as visited
+ for ($i=sizeof($leafNodes) - 1; $i>=0; $i--) {
+ $visited =& $leafNodes[$i]->getMetadata('acyclic-test-visited');
+ $visited = true;
+ $leafNodes[$i]->setMetadata('acyclic-test-visited', $visited);
+ }
+ } while (sizeof($leafNodes) > 0);
+
+ // If graph is a DAG, there should be no non-visited nodes. Let's try to prove otherwise
+ $result = true;
+ foreach($nodeKeys as $key) if (!$nodes[$key]->getMetadata('acyclic-test-visited')) $result = false;
+
+ // Cleanup visited marks
+ foreach($nodeKeys as $key) $nodes[$key]->unsetMetadata('acyclic-test-visited');
+
+ return $result;
+ }
+ /* }}} */
+
+ /* isAcyclic {{{ */
+ /**
+ *
+ * isAcyclic returns true if a graph contains no cycles, false otherwise.
+ *
+ * @return boolean true iff graph is acyclic
+ * @access public
+ */
+ function isAcyclic(&$graph) {
+ // We only test graphs
+ if (!is_a($graph, 'Structures_Graph'))
+ Pear::raiseError('Structures_Graph_Manipulator_AcyclicTest::isAcyclic received an object that is not a Structures_Graph', STRUCTURES_GRAPH_ERROR_GENERIC);
+ if (!$graph->isDirected()) return false; // Only directed graphs may be acyclic
+
+ return Structures_Graph_Manipulator_AcyclicTest::_isAcyclic($graph);
+ }
+ /* }}} */
+}
+/* }}} */
+?>
View
157 Structures/Graph/Manipulator/TopologicalSorter.php
@@ -0,0 +1,157 @@
+<?php
+/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
+// +-----------------------------------------------------------------------------+
+// | Copyright (c) 2003 Sérgio Gonçalves Carvalho |
+// +-----------------------------------------------------------------------------+
+// | This file is part of Structures_Graph. |
+// | |
+// | Structures_Graph is free software; you can redistribute it and/or modify |
+// | it under the terms of the GNU Lesser General Public License as published by |
+// | the Free Software Foundation; either version 2.1 of the License, or |
+// | (at your option) any later version. |
+// | |
+// | Structures_Graph is distributed in the hope that it will be useful, |
+// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
+// | GNU Lesser General Public License for more details. |
+// | |
+// | You should have received a copy of the GNU Lesser General Public License |
+// | along with Structures_Graph; if not, write to the Free Software |
+// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
+// | 02111-1307 USA |
+// +-----------------------------------------------------------------------------+
+// | Author: Sérgio Carvalho <sergio.carvalho@portugalmail.com> |
+// +-----------------------------------------------------------------------------+
+//
+/**
+ * This file contains the definition of the Structures_Graph_Manipulator_TopologicalSorter class.
+ *
+ * @see Structures_Graph_Manipulator_TopologicalSorter
+ * @package Structures_Graph
+ */
+
+/* dependencies {{{ */
+/** */
+require_once 'PEAR.php';
+/** */
+require_once 'Structures/Graph.php';
+/** */
+require_once 'Structures/Graph/Node.php';
+/** */
+require_once 'Structures/Graph/Manipulator/AcyclicTest.php';
+/* }}} */
+
+/* class Structures_Graph_Manipulator_TopologicalSorter {{{ */
+/**
+ * The Structures_Graph_Manipulator_TopologicalSorter is a manipulator
+ * which is able to return the set of nodes in a graph, sorted by topological
+ * order.
+ *
+ * A graph may only be sorted topologically iff it's a DAG. You can test it
+ * with the Structures_Graph_Manipulator_AcyclicTest.
+ *
+ * @author Sérgio Carvalho <sergio.carvalho@portugalmail.com>
+ * @copyright (c) 2004 by Sérgio Carvalho
+ * @see Structures_Graph_Manipulator_AcyclicTest
+ * @package Structures_Graph
+ */
+class Structures_Graph_Manipulator_TopologicalSorter {
+ /* _nonVisitedInDegree {{{ */
+ /**
+ *
+ * This is a variant of Structures_Graph::inDegree which does
+ * not count nodes marked as visited.
+ *
+ * @access private
+ * @return integer Number of non-visited nodes that link to this one
+ */
+ function _nonVisitedInDegree(&$node) {
+ $result = 0;
+ $graphNodes =& $node->_graph->getNodes();
+ foreach (array_keys($graphNodes) as $key) {
+ if ((!$graphNodes[$key]->getMetadata('topological-sort-visited')) && $graphNodes[$key]->connectsTo($node)) $result++;
+ }
+ return $result;
+
+ }
+ /* }}} */
+
+ /* _sort {{{ */
+ /**
+ * @access private
+ */
+ function _sort(&$graph) {
+ // Mark every node as not visited
+ $nodes =& $graph->getNodes();
+ $nodeKeys = array_keys($nodes);
+ $refGenerator = array();
+ foreach($nodeKeys as $key) {
+ $refGenerator[] = false;
+ $nodes[$key]->setMetadata('topological-sort-visited', $refGenerator[sizeof($refGenerator) - 1]);
+ }
+
+ // Iteratively peel off leaf nodes
+ $topologicalLevel = 0;
+ do {
+ // Find out which nodes are leafs (excluding visited nodes)
+ $leafNodes = array();
+ foreach($nodeKeys as $key) {
+ if ((!$nodes[$key]->getMetadata('topological-sort-visited')) && Structures_Graph_Manipulator_TopologicalSorter::_nonVisitedInDegree($nodes[$key]) == 0) {
+ $leafNodes[] =& $nodes[$key];
+ }
+ }
+ // Mark leafs as visited
+ $refGenerator[] = $topologicalLevel;
+ for ($i=sizeof($leafNodes) - 1; $i>=0; $i--) {
+ $visited =& $leafNodes[$i]->getMetadata('topological-sort-visited');
+ $visited = true;
+ $leafNodes[$i]->setMetadata('topological-sort-visited', $visited);
+ $leafNodes[$i]->setMetadata('topological-sort-level', $refGenerator[sizeof($refGenerator) - 1]);
+ }
+ $topologicalLevel++;
+ } while (sizeof($leafNodes) > 0);
+
+ // Cleanup visited marks
+ foreach($nodeKeys as $key) $nodes[$key]->unsetMetadata('topological-sort-visited');
+
+ return $result;
+ }
+ /* }}} */
+
+ /* sort {{{ */
+ /**
+ *
+ * sort returns the graph's nodes, sorted by topological order.
+ *
+ * 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.
+ *
+ * @return array The graph's nodes, sorted by topological order.
+ * @access public
+ */
+ function sort(&$graph) {
+ // We only sort graphs
+ if (!is_a($graph, 'Structures_Graph'))
+ Pear::raiseError('Structures_Graph_Manipulator_TopologicalSorter::sort received an object that is not a Structures_Graph', STRUCTURES_GRAPH_ERROR_GENERIC);
+ if (!Structures_Graph_Manipulator_AcyclicTest::isAcyclic($graph))
+ Pear::raiseError('Structures_Graph_Manipulator_TopologicalSorter::sort received an graph that has cycles', STRUCTURES_GRAPH_ERROR_GENERIC);
+
+ Structures_Graph_Manipulator_TopologicalSorter::_sort($graph);
+ $result = array();
+
+ // Fill out result array
+ $nodes =& $graph->getNodes();
+ $nodeKeys = array_keys($nodes);
+ foreach($nodeKeys as $key) {
+ if (!array_key_exists($nodes[$key]->getMetadata('topological-sort-level'), $result)) $result[$nodes[$key]->getMetadata('topological-sort-level')] = array();
+ $result[$nodes[$key]->getMetadata('topological-sort-level')][] =& $nodes[$key];
+ $nodes[$key]->unsetMetadata('topological-sort-level');
+ }
+
+ return $result;
+ }
+ /* }}} */
+}
+/* }}} */
+?>
View
339 Structures/Graph/Node.php
@@ -0,0 +1,339 @@
+<?php
+/* vim: set expandtab tabstop=4 shiftwidth=4 foldmethod=marker: */
+// +-----------------------------------------------------------------------------+
+// | Copyright (c) 2003 Sérgio Gonçalves Carvalho |
+// +-----------------------------------------------------------------------------+
+// | This file is part of Structures_Graph. |
+// | |
+// | Structures_Graph is free software; you can redistribute it and/or modify |
+// | it under the terms of the GNU Lesser General Public License as published by |
+// | the Free Software Foundation; either version 2.1 of the License, or |
+// | (at your option) any later version. |
+// | |
+// | Structures_Graph is distributed in the hope that it will be useful, |
+// | but WITHOUT ANY WARRANTY; without even the implied warranty of |
+// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
+// | GNU Lesser General Public License for more details. |
+// | |
+// | You should have received a copy of the GNU Lesser General Public License |
+// | along with Structures_Graph; if not, write to the Free Software |
+// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
+// | 02111-1307 USA |
+// +-----------------------------------------------------------------------------+
+// | Author: Sérgio Carvalho <sergio.carvalho@portugalmail.com> |
+// +-----------------------------------------------------------------------------+
+//
+/**
+ * This file contains the definition of the Structures_Graph_Node class
+ *
+ * @see Structures_Graph_Node
+ * @package Structures_Graph
+ */
+
+/* dependencies {{{ */
+/** */
+require_once 'PEAR.php';
+/** */
+require_once 'Structures/Graph.php';
+/* }}} */
+
+/* class Structures_Graph_Node {{{ */
+/**
+ * The Structures_Graph_Node class represents a Node that can be member of a
+ * graph node set.
+ *
+ * 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.
+ *
+ * Regular data is accessed via getData and setData. Key indexed data is accessed
+ * via getMetadata and setMetadata.
+ *
+ * @author Sérgio Carvalho <sergio.carvalho@portugalmail.com>
+ * @copyright (c) 2004 by Sérgio Carvalho
+ * @package Structures_Graph
+ */
+/* }}} */
+class Structures_Graph_Node {
+ /* fields {{{ */
+ /**
+ * @access private
+ */
+ var $_data = null;
+ /** @access private */
+ var $_metadata = array();
+ /** @access private */
+ var $_arcs = array();
+ /** @access private */
+ var $_graph = null;
+ /* }}} */
+
+ /* Constructor {{{ */
+ /**
+ *
+ * Constructor
+ *
+ * @access public
+ */
+ function Structures_Graph_Node() {
+ }
+ /* }}} */
+
+ /* getGraph {{{ */
+ /**
+ *
+ * Node graph getter
+ *
+ * @return Structures_Graph Graph where node is stored
+ * @access public
+ */
+ function &getGraph() {
+ return $this->_graph;
+ }
+ /* }}} */
+
+ /* setGraph {{{ */
+ /**
+ *
+ * Node graph setter. This method should not be called directly. Use Graph::addNode instead.
+ *
+ * @param Structures_Graph Set the graph for this node.
+ * @see Structures_Graph::addNode()
+ * @access public
+ */
+ function setGraph(&$graph) {
+ $this->_graph =& $graph;
+ }
+ /* }}} */
+
+ /* getData {{{ */
+ /**
+ *
+ * Node data getter.
+ *
+ * Each graph node can contain a reference to one variable. This is the getter for that reference.
+ *
+ * @return mixed Data stored in node
+ * @access public
+ */
+ function &getData() {
+ return $this->_data;
+ }
+ /* }}} */
+
+ /* setData {{{ */
+ /**
+ *
+ * Node data setter
+ *
+ * Each graph node can contain a reference to one variable. This is the setter for that reference.
+ *
+ * @return mixed Data to store in node
+ * @access public
+ */
+ function setData($data) {
+ $this->_data =& $data;
+ }
+ /* }}} */
+
+ /* metadataKeyExists {{{ */
+ /**
+ *
+ * Test for existence of metadata under a given key.
+ *
+ * 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.
+ *
+ * @param string Key to test
+ * @return boolean
+ * @access public
+ */
+ function metadataKeyExists($key) {
+ return array_key_exists($key, $this->_metadata);
+ }
+ /* }}} */
+
+ /* getMetadata {{{ */
+ /**
+ *
+ * Node metadata getter
+ *
+ * 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.
+ *
+ * @param string Key
+ * @param boolean nullIfNonexistent (defaults to false).
+ * @return mixed Metadata Data stored in node under given key
+ * @see metadataKeyExists
+ * @access public
+ */
+ function &getMetadata($key, $nullIfNonexistent = false) {
+ if (array_key_exists($key, $this->_metadata)) {
+ return $this->_metadata[$key];
+ } else {
+ if ($nullIfNonexistent) {
+ return null;
+ } else {
+ Pear::raiseError('Structures_Graph_Node::getMetadata: Requested key does not exist', STRUCTURES_GRAPH_ERROR_GENERIC);
+ }
+ }
+ }
+ /* }}} */
+
+ /* unsetMetadata {{{ */
+ /**
+ *
+ * Delete metadata by key
+ *
+ * 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.
+ *
+ * @param string Key
+ * @access public
+ */
+ function unsetMetadata($key) {
+ if (array_key_exists($key, $this->_metadata)) unset($this->_metadata[$key]);
+ }
+ /* }}} */
+
+ /* setMetadata {{{ */
+ /**
+ *
+ * Node metadata setter
+ *
+ * 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.
+ *
+ * @param string Key
+ * @param mixed Data
+ * @access public
+ */
+ function setMetadata($key, $data) {
+ $this->_metadata[$key] =& $data;
+ }
+ /* }}} */
+
+ /* _connectTo {{{ */
+ /** @access private */
+ function _connectTo(&$destinationNode) {
+ $this->_arcs[] =& $destinationNode;
+ }
+ /* }}} */
+
+ /* connectTo {{{ */
+ /**
+ *
+ * Connect this node to another one.
+ *
+ * If the graph is not directed, the reverse arc, connecting $destinationNode to $this is also created.
+ *
+ * @param Structures_Graph Node to connect to
+ * @access public
+ */
+ function connectTo(&$destinationNode) {
+ // We only connect to nodes
+ if (!is_a($destinationNode, 'Structures_Graph_Node'))
+ Pear::raiseError('Structures_Graph_Node::connectTo received an object that is not a Structures_Graph_Node', STRUCTURES_GRAPH_ERROR_GENERIC);
+ // Nodes must already be in graphs to be connected
+ if ($this->_graph == null)
+ Pear::raiseError('Structures_Graph_Node::connectTo Tried to connect a node that is not in a graph', STRUCTURES_GRAPH_ERROR_GENERIC);
+ if ($destinationNode->getGraph() == null)
+ Pear::raiseError('Structures_Graph_Node::connectTo Tried to connect to a node that is not in a graph', STRUCTURES_GRAPH_ERROR_GENERIC);
+ // Connect here
+ $this->_connectTo($destinationNode);
+ // If graph is undirected, connect back
+ if (!$this->_graph->isDirected()) {
+ $destinationNode->_connectTo($this);
+ }
+ }
+ /* }}} */
+
+ /* getNeighbours {{{ */
+ /**
+ *
+ * Return nodes connected to this one.
+ *
+ * @return array Array of nodes
+ * @access public
+ */
+ function getNeighbours() {
+ return $this->_arcs;
+ }
+ /* }}} */
+
+ /* connectsTo {{{ */
+ /**
+ *
+ * Test wether this node has an arc to the target node
+ *
+ * @return boolean True if the two nodes are connected
+ * @access public
+ */
+ function connectsTo(&$target) {
+ $copy = $target;
+ $arcKeys = array_keys($this->_arcs);
+ foreach($arcKeys as $key) {
+ /* ZE1 chokes on this expression:
+ if ($target === $arc) return true;
+ so, we'll use more convoluted stuff
+ */
+ $arc =& $this->_arcs[$key];
+ $target = true;
+ if ($arc === true) {
+ $target = false;
+ if ($arc === false) {
+ $target = $copy;
+ return true;
+ }
+ }
+ }
+ $target = $copy;
+ return false;
+ }
+ /* }}} */
+
+ /* inDegree {{{ */
+ /**
+ *
+ * Calculate the in degree of the node.
+ *
+ * The indegree for a node is the number of arcs entering the node. For non directed graphs,
+ * the indegree is equal to the outdegree.
+ *
+ * @return integer In degree of the node
+ * @access public
+ */
+ function inDegree() {
+ if ($this->_graph == null) return 0;
+ if (!$this->_graph->isDirected()) return $this->outDegree();
+ $result = 0;
+ $graphNodes =& $this->_graph->getNodes();
+ foreach (array_keys($graphNodes) as $key) {
+ if ($graphNodes[$key]->connectsTo($this)) $result++;
+ }
+ return $result;
+
+ }
+ /* }}} */
+
+ /* outDegree {{{ */
+ /**
+ *
+ * Calculate the out degree of the node.
+ *
+ * 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.
+ *
+ * @return integer Out degree of the node
+ * @access public
+ */
+ function outDegree() {
+ if ($this->_graph == null) return 0;
+ return sizeof($this->_arcs);
+ }
+ /* }}} */
+}
+?>
View
8 docs/generate.sh
@@ -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
View
243 docs/html/Structures_Graph/Structures_Graph.html
@@ -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 &lt;<a href="mailto:sergio.carvalho@portugalmail.com">mailto:sergio.carvalho@portugalmail.com</a>&gt;</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>&nbsp;<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>&nbsp;<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">&amp;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>&nbsp;<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>&nbsp;<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>&nbsp;<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">
+ &amp;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>&nbsp;<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>
View
105 docs/html/Structures_Graph/Structures_Graph_Manipulator_AcyclicTest.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 &lt;<a href="mailto:sergio.carvalho@portugalmail.com">mailto:sergio.carvalho@portugalmail.com</a>&gt;</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>&nbsp;<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>&nbsp;<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>
View
107 docs/html/Structures_Graph/Structures_Graph_Manipulator_TopologicalSorter.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 &lt;<a href="mailto:sergio.carvalho@portugalmail.com">mailto:sergio.carvalho@portugalmail.com</a>&gt;</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>&nbsp;<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>&nbsp;<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>
View
549 docs/html/Structures_Graph/Structures_Graph_Node.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 &lt;<a href="mailto:sergio.carvalho@portugalmail.com">mailto:sergio.carvalho@portugalmail.com</a>&gt;</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>&nbsp;<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>&nbsp;<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">&amp;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">&amp;getGraph</a>
+ ()
+ </div>
+
+ <div class="method-definition">
+ <span class="method-result">mixed</span>
+ <a href="#getMetadata" title="details" class="method-name">&amp;getMetadata</a>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">boolean</span>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<span class="var-name">$key</span>, <span class="var-type">mixed</span>&nbsp;<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>&nbsp;<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>&nbsp;<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>&nbsp;<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">
+ &amp;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">
+ &amp;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">
+ &amp;getMetadata
+ </span>
+ (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type">boolean</span>&nbsp;<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>&nbsp;<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>