phpOMS/Algorithm/PathFinding/Heuristic.php
2024-03-20 07:21:26 +00:00

59 lines
1.7 KiB
PHP
Executable File

<?php
/**
* Jingga
*
* PHP Version 8.2
*
* @package phpOMS\Algorithm\PathFinding
* @copyright Dennis Eichhorn
* @license OMS License 2.0
* @version 1.0.0
* @link https://jingga.app
*/
declare(strict_types=1);
namespace phpOMS\Algorithm\PathFinding;
use phpOMS\Math\Topology\Metrics2D;
/**
* Node on grid.
*
* @package phpOMS\Algorithm\PathFinding
* @license OMS License 2.0
* @link https://jingga.app
* @since 1.0.0
*/
final class Heuristic
{
/**
* Calculate metric/distance between two nodes.
*
* @param array<string, int|float> $node1 Array with 'x' and 'y' coordinate
* @param array<string, int|float> $node2 Array with 'x' and 'y' coordinate
* @param int $heuristic Heuristic to use for calculation
*
* @return float
*
* @since 1.0.0
*/
public static function metric(array $node1, array $node2, int $heuristic) : float
{
if ($heuristic === HeuristicType::MANHATTAN) {
return Metrics2D::manhattan($node1, $node2);
} elseif ($heuristic === HeuristicType::EUCLIDEAN) {
return Metrics2D::euclidean($node1, $node2);
} elseif ($heuristic === HeuristicType::OCTILE) {
return Metrics2D::octile($node1, $node2);
} elseif ($heuristic === HeuristicType::MINKOWSKI) {
return Metrics2D::minkowski($node1, $node2, 1);
} elseif ($heuristic === HeuristicType::CANBERRA) {
return Metrics2D::canberra($node1, $node2);
} elseif ($heuristic === HeuristicType::BRAY_CURTIS) {
return Metrics2D::brayCurtis($node1, $node2);
}
return Metrics2D::chebyshev($node1, $node2);
}
}