JMGQ\AStar\Algorithm

Complexity

Total Complexity

16

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getOpenList()	0	3	1
A	clear()	0	4	1
A	computeAdjacentNodes()	0	10	2
A	__construct()	0	4	1
A	generatePathFromStartNodeTo()	0	13	2
A	getClosedList()	0	3	1
B	run()	0	49	8

<?php

namespace JMGQ\AStar;

abstract class Algorithm
{
    private $openList;
    private $closedList;

    public function __construct()
    {
        $this->openList = new NodeList();
        $this->closedList = new NodeList();
    }

    /**
     * @param Node $node
     * @return Node[]
     */
    abstract public function generateAdjacentNodes(Node $node);

    /**
     * @param Node $node
     * @param Node $adjacent
     * @return integer | float
     */
    abstract public function calculateRealCost(Node $node, Node $adjacent);

    /**
     * @param Node $start
     * @param Node $end
     * @return integer | float
     */
    abstract public function calculateEstimatedCost(Node $start, Node $end);

    /**
     * @return NodeList
     */
    public function getOpenList()
    {
        return $this->openList;
    }

    /**
     * @return NodeList
     */
    public function getClosedList()
    {
        return $this->closedList;
    }

    /**
     * Sets the algorithm to its initial state
     */
    public function clear()
    {
        $this->getOpenList()->clear();
        $this->getClosedList()->clear();
    }

    /**
     * @param Node $start
     * @param Node $goal
     * @return Node[]
     */
    public function run(Node $start, Node $goal)
    {
        $path = array();

        $this->clear();

        $start->setG(0);
        $start->setH($this->calculateEstimatedCost($start, $goal));

        $this->getOpenList()->add($start);

        while (!$this->getOpenList()->isEmpty()) {
            $currentNode = $this->getOpenList()->extractBest();

            $this->getClosedList()->add($currentNode);

It seems like $currentNode can also be of type null; however, parameter $node of JMGQ\AStar\NodeList::add() does only seem to accept JMGQ\AStar\Node, maybe add an additional type check?

            if ($currentNode->getID() === $goal->getID()) {
                $path = $this->generatePathFromStartNodeTo($currentNode);

It seems like $currentNode can also be of type null; however, parameter $node of JMGQ\AStar\Algorithm::generatePathFromStartNodeTo() does only seem to accept JMGQ\AStar\Node, maybe add an additional type check?

                break;
            }

            $successors = $this->computeAdjacentNodes($currentNode, $goal);

It seems like $currentNode can also be of type null; however, parameter $node of JMGQ\AStar\Algorithm::computeAdjacentNodes() does only seem to accept JMGQ\AStar\Node, maybe add an additional type check?

            foreach ($successors as $successor) {
                if ($this->getOpenList()->contains($successor)) {
                    $successorInOpenList = $this->getOpenList()->get($successor);

                    if ($successor->getG() >= $successorInOpenList->getG()) {
                        continue;
                    }
                }

                if ($this->getClosedList()->contains($successor)) {
                    $successorInClosedList = $this->getClosedList()->get($successor);

                    if ($successor->getG() >= $successorInClosedList->getG()) {
                        continue;
                    }
                }

                $successor->setParent($currentNode);

It seems like $currentNode can also be of type null; however, parameter $parent of JMGQ\AStar\Node::setParent() does only seem to accept JMGQ\AStar\Node, maybe add an additional type check?

                $this->getClosedList()->remove($successor);

                $this->getOpenList()->add($successor);
            }
        }

        return $path;
    }

    private function generatePathFromStartNodeTo(Node $node)
    {
        $path = array();

        $currentNode = $node;

        while ($currentNode !== null) {
            array_unshift($path, $currentNode);

            $currentNode = $currentNode->getParent();
        }

        return $path;
    }

    private function computeAdjacentNodes(Node $node, Node $goal)
    {
        $nodes = $this->generateAdjacentNodes($node);

        foreach ($nodes as $adjacentNode) {
            $adjacentNode->setG($node->getG() + $this->calculateRealCost($node, $adjacentNode));
            $adjacentNode->setH($this->calculateEstimatedCost($adjacentNode, $goal));
        }

        return $nodes;
    }
}