1

/* $Id$ */

     2

     3

#ifndef  YAPF_BASE_HPP

     4

#define  YAPF_BASE_HPP

     5

     6

#include "../debug.h"

     7

     8

#include "fixedsizearray.hpp"

     9

#include "blob.hpp"

    10

#include "nodelist.hpp"

    11

    12

extern int _total_pf_time_us;

    13

    14

/** CYapfBaseT - A-star type path finder base class.

    15

 *  Derive your own pathfinder from it. You must provide the following template argument:

    16

 *    Types      - used as collection of local types used in pathfinder

    17

 *

    18

 * Requirements for the Types struct:

    19

 *  ----------------------------------

    20

 *  The following types must be defined in the 'Types' argument:

    21

 *    - Types::Tpf - your pathfinder derived from CYapfBaseT

    22

 *    - Types::NodeList - open/closed node list (look at CNodeList_HashTableT)

    23

 *  NodeList needs to have defined local type Titem - defines the pathfinder node type.

    24

 *  Node needs to define local type Key - the node key in the collection ()

    25

 *

    26

 *  For node list you can use template class CNodeList_HashTableT, for which

    27

 *  you need to declare only your node type. Look at test_yapf.h for an example.

    28

 *

    29

 *

    30

 *  Requrements to your pathfinder class derived from CYapfBaseT:

    31

 *  -------------------------------------------------------------

    32

 *  Your pathfinder derived class needs to implement following methods:

    33

 *    FORCEINLINE void PfSetStartupNodes()

    34

 *    FORCEINLINE void PfFollowNode(Node& org)

    35

 *    FORCEINLINE bool PfCalcCost(Node& n)

    36

 *    FORCEINLINE bool PfCalcEstimate(Node& n)

    37

 *    FORCEINLINE bool PfDetectDestination(Node& n)

    38

 *

    39

 *  For more details about those methods, look at the end of CYapfBaseT

    40

 *  declaration. There are some examples. For another example look at

    41

 *  test_yapf.h (part or unittest project).

    42

 */

    43

template <class Types>

    44

class CYapfBaseT {

    45

public:

    46

	typedef typename Types::Tpf Tpf;           ///< the pathfinder class (derived from THIS class)

    47

	typedef typename Types::NodeList NodeList; ///< our node list

    48

	typedef typename NodeList::Titem Node;     ///< this will be our node type

    49

	typedef typename Node::Key Key;            ///< key to hash tables

    50

    51

    52

	NodeList             m_nodes;              ///< node list multi-container

    53

protected:

    54

	Node*                m_pBestDestNode;      ///< pointer to the destination node found at last round

    55

	Node*                m_pBestIntermediateNode; ///< here should be node closest to the destination if path not found

    56

	const YapfSettings  *m_settings;           ///< current settings (_patches.yapf)

    57

	int                  m_max_search_nodes;   ///< maximum number of nodes we are allowed to visit before we give up

    58

	const Vehicle*       m_veh;                ///< vehicle that we are trying to drive

    59

    60

	int                  m_stats_cost_calcs;   ///< stats - how many node's costs were calculated

    61

	int                  m_stats_cache_hits;   ///< stats - how many node's costs were reused from cache

    62

    63

public:

    64

	CPerformanceTimer    m_perf_cost;          ///< stats - total CPU time of this run

    65

	CPerformanceTimer    m_perf_slope_cost;    ///< stats - slope calculation CPU time

    66

	CPerformanceTimer    m_perf_ts_cost;       ///< stats - GetTrackStatus() CPU time

    67

	CPerformanceTimer    m_perf_other_cost;    ///< stats - other CPU time

    68

    69

public:

    70

	int                  m_num_steps;          ///< this is there for debugging purposes (hope it doesn't hurt)

    71

    72

public:

    73

	/// default constructor

    74

	FORCEINLINE CYapfBaseT()

    75

		: m_pBestDestNode(NULL)

    76

		, m_pBestIntermediateNode(NULL)

    77

		, m_settings(&_patches.yapf)

    78

		, m_max_search_nodes(PfGetSettings().max_search_nodes)

    79

		, m_veh(NULL)

    80

		, m_stats_cost_calcs(0)

    81

		, m_stats_cache_hits(0)

    82

		, m_num_steps(0)

    83

	{

    84

	}

    85

    86

	/// default destructor

    87

	~CYapfBaseT() {}

    88

    89

protected:

    90

	/// to access inherited path finder

    91

	FORCEINLINE Tpf& Yapf() {return *static_cast<Tpf*>(this);}

    92

    93

public:

    94

	/// return current settings (can be custom - player based - but later)

    95

	FORCEINLINE const YapfSettings& PfGetSettings() const

    96

	{

    97

		return *m_settings;

    98

	}

    99

   100

	/** Main pathfinder routine:

   101

	 *   - set startup node(s)

   102

	 *   - main loop that stops if:

   103

	 *      - the destination was found

   104

	 *      - or the open list is empty (no route to destination).

   105

	 *      - or the maximum amount of loops reached - m_max_search_nodes (default = 10000)

   106

	 * @return true if the path was found */

   107

	inline bool FindPath(const Vehicle* v)

   108

	{

   109

		m_veh = v;

   110

   111

		CPerformanceTimer perf;

   112

		perf.Start();

   113

		Yapf().PfSetStartupNodes();

   114

   115

		while (true) {

   116

			m_num_steps++;

   117

			Node* n = m_nodes.GetBestOpenNode();

   118

			if (n == NULL)

   119

				break;

   120

   121

			// if the best open node was worse than the best path found, we can finish

   122

			if (m_pBestDestNode != NULL && m_pBestDestNode->GetCost() < n->GetCostEstimate())

   123

				break;

   124

   125

			Yapf().PfFollowNode(*n);

   126

			if (m_max_search_nodes == 0 || m_nodes.ClosedCount() < m_max_search_nodes) {

   127

				m_nodes.PopOpenNode(n->GetKey());

   128

				m_nodes.InsertClosedNode(*n);

   129

			} else {

   130

				m_pBestDestNode = m_pBestIntermediateNode;

   131

				break;

   132

			}

   133

		}

   134

		bool bDestFound = (m_pBestDestNode != NULL);

   135

   136

		int16 veh_idx = (m_veh != NULL) ? m_veh->unitnumber : 0;

   137

   138

//		if (veh_idx != 433) return bDestFound;

   139

   140

		perf.Stop();

   141

		int t = perf.Get(1000000);

   142

		_total_pf_time_us += t;

   143

		char ttc = Yapf().TransportTypeChar();

   144

		float cache_hit_ratio = (float)m_stats_cache_hits / (float)(m_stats_cache_hits + m_stats_cost_calcs) * 100.0f;

   145

		int cost = bDestFound ? m_pBestDestNode->m_cost : -1;

   146

		int dist = bDestFound ? m_pBestDestNode->m_estimate - m_pBestDestNode->m_cost : -1;

   147

		DEBUG(yapf, 3, "[YAPF%c]%c%4d- %d us - %d rounds - %d open - %d closed - CHR %4.1f%% - c%d(sc%d, ts%d, o%d) -- ", ttc, bDestFound ? '-' : '!', veh_idx, t, m_num_steps, m_nodes.OpenCount(), m_nodes.ClosedCount(), cache_hit_ratio, cost, dist, m_perf_cost.Get(1000000), m_perf_slope_cost.Get(1000000), m_perf_ts_cost.Get(1000000), m_perf_other_cost.Get(1000000));

   148

		return bDestFound;

   149

	}

   150

   151

	/** If path was found return the best node that has reached the destination. Otherwise

   152

	 *  return the best visited node (which was nearest to the destination).

   153

	 */

   154

	FORCEINLINE Node& GetBestNode()

   155

	{

   156

		return (m_pBestDestNode != NULL) ? *m_pBestDestNode : *m_pBestIntermediateNode;

   157

	}

   158

   159

	/** Calls NodeList::CreateNewNode() - allocates new node that can be filled and used

   160

	 *  as argument for AddStartupNode() or AddNewNode()

   161

	 */

   162

	FORCEINLINE Node& CreateNewNode()

   163

	{

   164

		Node& node = *m_nodes.CreateNewNode();

   165

		return node;

   166

	}

   167

   168

	/** Add new node (created by CreateNewNode and filled with data) into open list */

   169

	FORCEINLINE void AddStartupNode(Node& n)

   170

	{

   171

		Yapf().PfNodeCacheFetch(n);

   172

		// insert the new node only if it is not there

   173

		if (m_nodes.FindOpenNode(n.m_key) == NULL) {

   174

			m_nodes.InsertOpenNode(n);

   175

		} else {

   176

			// if we are here, it means that node is already there - how it is possible?

   177

			//   probably the train is in the position that both its ends point to the same tile/exit-dir

   178

			//   very unlikely, but it happened

   179

		}

   180

	}

   181

   182

	/** add multiple nodes - direct children of the given node */

   183

	FORCEINLINE void AddMultipleNodes(Node* parent, TileIndex tile, TrackdirBits td_bits)

   184

	{

   185

		bool is_choice = (KillFirstBit2x64(td_bits) != 0);

   186

		for (TrackdirBits rtds = td_bits; rtds != TRACKDIR_BIT_NONE; rtds = (TrackdirBits)KillFirstBit2x64(rtds)) {

   187

			Trackdir td = (Trackdir)FindFirstBit2x64(rtds);

   188

			Node& n = Yapf().CreateNewNode();

   189

			n.Set(parent, tile, td, is_choice);

   190

			Yapf().AddNewNode(n);

   191

		}

   192

	}

   193

   194

	/** AddNewNode() - called by Tderived::PfFollowNode() for each child node.

   195

	 *  Nodes are evaluated here and added into open list */

   196

	void AddNewNode(Node& n)

   197

	{

   198

		// evaluate the node

   199

		bool bCached = Yapf().PfNodeCacheFetch(n);

   200

		if (!bCached) {

   201

			m_stats_cost_calcs++;

   202

		} else {

   203

			m_stats_cache_hits++;

   204

		}

   205

   206

		bool bValid = Yapf().PfCalcCost(n);

   207

   208

		if (bCached) {

   209

			Yapf().PfNodeCacheFlush(n);

   210

		}

   211

   212

		if (bValid) bValid = Yapf().PfCalcEstimate(n);

   213

   214

		// have the cost or estimate callbacks marked this node as invalid?

   215

		if (!bValid) return;

   216

   217

		// detect the destination

   218

		bool bDestination = Yapf().PfDetectDestination(n);

   219

		if (bDestination) {

   220

			if (m_pBestDestNode == NULL || n < *m_pBestDestNode) {

   221

				m_pBestDestNode = &n;

   222

			}

   223

			m_nodes.FoundBestNode(n);

   224

			return;

   225

		}

   226

   227

		if (m_max_search_nodes > 0 && (m_pBestIntermediateNode == NULL || (m_pBestIntermediateNode->GetCostEstimate() - m_pBestIntermediateNode->GetCost()) > (n.GetCostEstimate() - n.GetCost()))) {

   228

			m_pBestIntermediateNode = &n;

   229

		}

   230

   231

		// check new node against open list

   232

		Node* openNode = m_nodes.FindOpenNode(n.GetKey());

   233

		if (openNode != NULL) {

   234

			// another node exists with the same key in the open list

   235

			// is it better than new one?

   236

			if (n.GetCostEstimate() < openNode->GetCostEstimate()) {

   237

				// update the old node by value from new one

   238

				m_nodes.PopOpenNode(n.GetKey());

   239

				*openNode = n;

   240

				// add the updated old node back to open list

   241

				m_nodes.InsertOpenNode(*openNode);

   242

			}

   243

			return;

   244

		}

   245

   246

		// check new node against closed list

   247

		Node* closedNode = m_nodes.FindClosedNode(n.GetKey());

   248

		if (closedNode != NULL) {

   249

			// another node exists with the same key in the closed list

   250

			// is it better than new one?

   251

			int node_est = n.GetCostEstimate();

   252

			int closed_est = closedNode->GetCostEstimate();

   253

			if (node_est < closed_est) {

   254

				// If this assert occurs, you have probably problem in

   255

				// your Tderived::PfCalcCost() or Tderived::PfCalcEstimate().

   256

				// The problem could be:

   257

				//  - PfCalcEstimate() gives too large numbers

   258

				//  - PfCalcCost() gives too small numbers

   259

				//  - You have used negative cost penalty in some cases (cost bonus)

   260

				assert(0);

   261

   262

				return;

   263

			}

   264

			return;

   265

		}

   266

		// the new node is really new

   267

		// add it to the open list

   268

		m_nodes.InsertOpenNode(n);

   269

	}

   270

   271

	const Vehicle* GetVehicle() const {return m_veh;}

   272

   273

	// methods that should be implemented at derived class Types::Tpf (derived from CYapfBaseT)

   274

   275

#if 0

   276

	/** Example: PfSetStartupNodes() - set source (origin) nodes */

   277

	FORCEINLINE void PfSetStartupNodes()

   278

	{

   279

		// example:

   280

		Node& n1 = *base::m_nodes.CreateNewNode();

   281

		.

   282

		. // setup node members here

   283

		.

   284

		base::m_nodes.InsertOpenNode(n1);

   285

	}

   286

   287

	/** Example: PfFollowNode() - set following (child) nodes of the given node */

   288

	FORCEINLINE void PfFollowNode(Node& org)

   289

	{

   290

		for (each follower of node org) {

   291

			Node& n = *base::m_nodes.CreateNewNode();

   292

			.

   293

			. // setup node members here

   294

			.

   295

			n.m_parent   = &org; // set node's parent to allow back tracking

   296

			AddNewNode(n);

   297

		}

   298

	}

   299

   300

	/** Example: PfCalcCost() - set path cost from origin to the given node */

   301

	FORCEINLINE bool PfCalcCost(Node& n)

   302

	{

   303

		// evaluate last step cost

   304

		int cost = ...;

   305

		// set the node cost as sum of parent's cost and last step cost

   306

		n.m_cost = n.m_parent->m_cost + cost;

   307

		return true; // true if node is valid follower (i.e. no obstacle was found)

   308

	}

   309

   310

	/** Example: PfCalcEstimate() - set path cost estimate from origin to the target through given node */

   311

	FORCEINLINE bool PfCalcEstimate(Node& n)

   312

	{

   313

		// evaluate the distance to our destination

   314

		int distance = ...;

   315

		// set estimate as sum of cost from origin + distance to the target

   316

		n.m_estimate = n.m_cost + distance;

   317

		return true; // true if node is valid (i.e. not too far away :)

   318

	}

   319

   320

	/** Example: PfDetectDestination() - return true if the given node is our destination */

   321

	FORCEINLINE bool PfDetectDestination(Node& n)

   322

	{

   323

		bool bDest = (n.m_key.m_x == m_x2) && (n.m_key.m_y == m_y2);

   324

		return bDest;

   325

	}

   326

#endif

   327

};

   328

   329

#endif /* YAPF_BASE_HPP */