Structures_Graph Class Reference

Public Member Functions
	__construct ($directed=true)
	addNode (&$newNode)
&	getNodes ()
	isDirected ()
	removeNode (&$node)
	Structures_Graph ($directed=true)

Data Fields
	$_directed = false
	$_nodes = array()

Detailed Description

Definition at line 53 of file Graph.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$directed = true

)

Constructor

Parameters

boolean

$directed

Set to true if the graph is directed. Set to false if it is not directed.

Definition at line 74 of file Graph.php.

    {
        $this->_directed = $directed;
    }

Referenced by Structures_Graph().

Here is the caller graph for this function:

Member Function Documentation

addNode()

addNode

(

&

$newNode

)

Add a Node to the Graph

Parameters

Structures_Graph_Node

$newNode

The node to be added.

Returns

void

Definition at line 109 of file Graph.php.

    {
        // We only add nodes
        if (!is_a($newNode, 'Structures_Graph_Node')) {
            return 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
             (change $this->_nodes[$key] and check if the change reflects in
             $node)
            */
            $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) {
                return 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);
    }

References STRUCTURES_GRAPH_ERROR_GENERIC.

getNodes()

& getNodes

(

)

Return the node set, in no particular order. For ordered node sets, use a Graph Manipulator insted.

Returns

array The set of nodes in this graph

See also

Structures_Graph_Manipulator_TopologicalSorter

Definition at line 171 of file Graph.php.

    {
        return $this->_nodes;
    }

isDirected()

isDirected

(

)

Return true if a graph is directed

Returns

boolean true if the graph is directed

Definition at line 97 of file Graph.php.

    {
        return (boolean) $this->_directed;
    }

removeNode()

removeNode

(

&

$node

)

Remove a Node from the Graph

Parameters

Structures_Graph_Node

$node

The node to be removed from the graph

Returns

void

Todo

This is unimplemented

Definition at line 160 of file Graph.php.

    {
    }

Structures_Graph()

Structures_Graph

(

$directed = true

)

Old constructor (PHP4-style; kept for BC with extending classes)

Parameters

boolean

$directed

Set to true if the graph is directed. Set to false if it is not directed.

Returns

void

Definition at line 87 of file Graph.php.

    {
        $this->__construct($directed);
    }

References __construct().

Here is the call graph for this function:

Field Documentation

$_directed

$_directed = false

If the graph is directed or not @access private

Definition at line 65 of file Graph.php.

$_nodes

$_nodes = array()

List of node objects in this graph @access private

Definition at line 59 of file Graph.php.

---

The documentation for this class was generated from the following file:

• E:/Bearsampp-development/sandbox/core/libs/php/pear/pear/Structures/Graph.php