1
|
|
|
<?php |
2
|
|
|
/* |
3
|
|
|
MIT License |
4
|
|
|
Copyright (c) 2014 Peter Petermann |
5
|
|
|
|
6
|
|
|
Permission is hereby granted, free of charge, to any person |
7
|
|
|
obtaining a copy of this software and associated documentation |
8
|
|
|
files (the "Software"), to deal in the Software without |
9
|
|
|
restriction, including without limitation the rights to use, |
10
|
|
|
copy, modify, merge, publish, distribute, sublicense, and/or sell |
11
|
|
|
copies of the Software, and to permit persons to whom the |
12
|
|
|
Software is furnished to do so, subject to the following |
13
|
|
|
conditions: |
14
|
|
|
|
15
|
|
|
The above copyright notice and this permission notice shall be |
16
|
|
|
included in all copies or substantial portions of the Software. |
17
|
|
|
|
18
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
19
|
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
20
|
|
|
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
21
|
|
|
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
22
|
|
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
23
|
|
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
24
|
|
|
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
25
|
|
|
OTHER DEALINGS IN THE SOFTWARE. |
26
|
|
|
*/ |
27
|
|
|
|
28
|
|
|
namespace PathFinder; |
29
|
|
|
|
30
|
|
|
abstract class Node |
31
|
|
|
{ |
32
|
|
|
/** |
33
|
|
|
* @var Node|bool |
34
|
|
|
*/ |
35
|
|
|
protected $parent = false; |
36
|
|
|
|
37
|
|
|
/** |
38
|
|
|
* @var int|float |
39
|
|
|
*/ |
40
|
|
|
protected $gCost; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @param Node $parent |
44
|
|
|
*/ |
45
|
2 |
|
public function setParent(Node $parent) |
46
|
|
|
{ |
47
|
2 |
|
$this->parent = $parent; |
48
|
2 |
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @return Node|bool |
52
|
|
|
*/ |
53
|
2 |
|
public function getParent() |
54
|
|
|
{ |
55
|
2 |
|
return $this->parent; |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* @return int|float |
60
|
|
|
*/ |
61
|
2 |
|
public function getGCost() |
62
|
|
|
{ |
63
|
2 |
|
if(is_null($this->gCost)) { |
64
|
2 |
|
$this->gCost = |
65
|
2 |
|
$this->parent ? $this->parent->getGCost() + $this->getOwnCost() : $this->getOwnCost(); |
66
|
|
|
} |
67
|
|
|
|
68
|
2 |
|
return $this->gCost; |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* @param Node $target |
73
|
|
|
* @return float|int |
74
|
|
|
*/ |
75
|
2 |
|
public function getFCost(Node $target) |
76
|
|
|
{ |
77
|
2 |
|
return $this->getGCost() + $this->getHCost($target); |
78
|
|
|
} |
79
|
|
|
|
80
|
|
|
/** |
81
|
|
|
* @return int|float |
82
|
|
|
*/ |
83
|
|
|
abstract public function getOwnCost(); |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* @param Node $target |
87
|
|
|
* @return int|float |
88
|
|
|
*/ |
89
|
|
|
abstract public function getHCost(Node $target); |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* @return Node[] |
93
|
|
|
*/ |
94
|
|
|
abstract public function getAdjacentNodes(); |
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* @param Node $compareTo |
98
|
|
|
* @return bool |
99
|
|
|
*/ |
100
|
|
|
abstract public function equals(Node $compareTo); |
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* should return a unique string for this |
104
|
|
|
* |
105
|
|
|
* @return string |
106
|
|
|
*/ |
107
|
|
|
abstract public function __toString(); |
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* this method should allow a node |
111
|
|
|
* to get the data from the target node getHostCost requires for its heuristic (if needed) |
112
|
|
|
* |
113
|
|
|
* @return array |
114
|
|
|
*/ |
115
|
|
|
public function getDataForH() |
116
|
|
|
{ |
117
|
|
|
return []; |
118
|
|
|
} |
119
|
|
|
} |
120
|
|
|
|