1

/* $Id$ */

     2

     3

#ifndef  YAPF_BASE_HPP

     4

#define  YAPF_BASE_HPP

     5

     6

EXTERN_C_BEGIN

     7

#include "../debug.h"

     8

EXTERN_C_END

     9

    10

#include "fixedsizearray.hpp"

    11

#include "blob.hpp"

    12

#include "nodelist.hpp"

    13

    14

extern int _total_pf_time_us;

    15

    16

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

    17

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

    18

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

    19

 *

    20

 * Requirements for the Types struct:

    21

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

    22

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

    23

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

    24

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

    25

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

    26

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

    27

 *

    28

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

    29

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

    30

 *

    31

 *

    32

 *  Requrements to your pathfinder class derived from CYapfBaseT:

    33

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

    34

 *  Your pathfinder derived class needs to implement following methods:

    35

 *    FORCEINLINE void PfSetStartupNodes()

    36

 *    FORCEINLINE void PfFollowNode(Node& org)

    37

 *    FORCEINLINE bool PfCalcCost(Node& n)

    38

 *    FORCEINLINE bool PfCalcEstimate(Node& n)

    39

 *    FORCEINLINE bool PfDetectDestination(Node& n)

    40

 *

    41

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

    42

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

    43

 *  test_yapf.h (part or unittest project).

    44

 */

    45

template <class Types>

    46

class CYapfBaseT {

    47

public:

    48

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

    49

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

    50

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

    51

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

    52

    53

    54

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

    55

protected:

    56

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

    57

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

    58

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

    59

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

    60

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

    61

    62

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

    63

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

    64

    65

public:

    66

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

    67

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

    68

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

    69

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

    70

    71

public:

    72

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

    73

    74

public:

    75

	/// default constructor

    76

	FORCEINLINE CYapfBaseT()

    77

		: m_pBestDestNode(NULL)

    78

		, m_pBestIntermediateNode(NULL)

    79

		, m_settings(&_patches.yapf)

    80

		, m_max_search_nodes(PfGetSettings().max_search_nodes)

    81

		, m_veh(NULL)

    82

		, m_stats_cost_calcs(0)

    83

		, m_stats_cache_hits(0)

    84

		, m_num_steps(0)

    85

	{

    86

	}

    87

    88

	/// default destructor

    89

	~CYapfBaseT() {}

    90

    91

protected:

    92

	/// to access inherited path finder

    93

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

    94

    95

public:

    96

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

    97

	FORCEINLINE const YapfSettings& PfGetSettings() const

    98

	{

    99

		return *m_settings;

   100

	}

   101

   102

	/** Main pathfinder routine:

   103

	 *   - set startup node(s)

   104

	 *   - main loop that stops if:

   105

	 *      - the destination was found

   106

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

   107

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

   108

	 * @return true if the path was found */

   109

	inline bool FindPath(const Vehicle* v)

   110

	{

   111

		m_veh = v;

   112

   113

		CPerformanceTimer perf;

   114

		perf.Start();

   115

		Yapf().PfSetStartupNodes();

   116

   117

		while (true) {

   118

			m_num_steps++;

   119

			Node* n = m_nodes.GetBestOpenNode();

   120

			if (n == NULL)

   121

				break;

   122

   123

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

   124

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

   125

				break;

   126

   127

			Yapf().PfFollowNode(*n);

   128

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

   129

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

   130

				m_nodes.InsertClosedNode(*n);

   131

			} else {

   132

				m_pBestDestNode = m_pBestIntermediateNode;

   133

				break;

   134

			}

   135

		}

   136

		bool bDestFound = (m_pBestDestNode != NULL);

   137

   138

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

   139

   140

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

   141

   142

		perf.Stop();

   143

		int t = perf.Get(1000000);

   144

		_total_pf_time_us += t;

   145

		char ttc = Yapf().TransportTypeChar();

   146

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

   147

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

   148

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

   149

		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));

   150

		return bDestFound;

   151

	}

   152

   153

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

   154

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

   155

	 */

   156

	FORCEINLINE Node& GetBestNode()

   157

	{

   158

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

   159

	}

   160

   161

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

   162

	 *  as argument for AddStartupNode() or AddNewNode()

   163

	 */

   164

	FORCEINLINE Node& CreateNewNode()

   165

	{

   166

		Node& node = *m_nodes.CreateNewNode();

   167

		return node;

   168

	}

   169

   170

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

   171

	FORCEINLINE void AddStartupNode(Node& n)

   172

	{

   173

		Yapf().PfNodeCacheFetch(n);

   174

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

   175

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

   176

			m_nodes.InsertOpenNode(n);

   177

		} else {

   178

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

   179

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

   180

			//   very unlikely, but it happened

   181

		}

   182

	}

   183

   184

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

   185

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

   186

	{

   187

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

   188

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

   189

			Trackdir td = (Trackdir)FindFirstBit2x64(rtds);

   190

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

   191

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

   192

			Yapf().AddNewNode(n);

   193

		}

   194

	}

   195

   196

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

   197

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

   198

	void AddNewNode(Node& n)

   199

	{

   200

		// evaluate the node

   201

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

   202

		if (!bCached) {

   203

			m_stats_cost_calcs++;

   204

		} else {

   205

			m_stats_cache_hits++;

   206

		}

   207

   208

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

   209

   210

		if (bCached) {

   211

			Yapf().PfNodeCacheFlush(n);

   212

		}

   213

   214

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

   215

   216

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

   217

		if (!bValid) return;

   218

   219

		// detect the destination

   220

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

   221

		if (bDestination) {

   222

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

   223

				m_pBestDestNode = &n;

   224

			}

   225

			m_nodes.FoundBestNode(n);

   226

			return;

   227

		}

   228

   229

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

   230

			m_pBestIntermediateNode = &n;

   231

		}

   232

   233

		// check new node against open list

   234

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

   235

		if (openNode != NULL) {

   236

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

   237

			// is it better than new one?

   238

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

   239

				// update the old node by value from new one

   240

				m_nodes.PopOpenNode(n.GetKey());

   241

				*openNode = n;

   242

				// add the updated old node back to open list

   243

				m_nodes.InsertOpenNode(*openNode);

   244

			}

   245

			return;

   246

		}

   247

   248

		// check new node against closed list

   249

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

   250

		if (closedNode != NULL) {

   251

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

   252

			// is it better than new one?

   253

			int node_est = n.GetCostEstimate();

   254

			int closed_est = closedNode->GetCostEstimate();

   255

			if (node_est < closed_est) {

   256

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

   257

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

   258

				// The problem could be:

   259

				//  - PfCalcEstimate() gives too large numbers

   260

				//  - PfCalcCost() gives too small numbers

   261

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

   262

				assert(0);

   263

   264

				return;

   265

			}

   266

			return;

   267

		}

   268

		// the new node is really new

   269

		// add it to the open list

   270

		m_nodes.InsertOpenNode(n);

   271

	}

   272

   273

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

   274

   275

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

   276

   277

#if 0

   278

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

   279

	FORCEINLINE void PfSetStartupNodes()

   280

	{

   281

		// example:

   282

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

   283

		.

   284

		. // setup node members here

   285

		.

   286

		base::m_nodes.InsertOpenNode(n1);

   287

	}

   288

   289

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

   290

	FORCEINLINE void PfFollowNode(Node& org)

   291

	{

   292

		for (each follower of node org) {

   293

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

   294

			.

   295

			. // setup node members here

   296

			.

   297

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

   298

			AddNewNode(n);

   299

		}

   300

	}

   301

   302

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

   303

	FORCEINLINE bool PfCalcCost(Node& n)

   304

	{

   305

		// evaluate last step cost

   306

		int cost = ...;

   307

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

   308

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

   309

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

   310

	}

   311

   312

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

   313

	FORCEINLINE bool PfCalcEstimate(Node& n)

   314

	{

   315

		// evaluate the distance to our destination

   316

		int distance = ...;

   317

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

   318

		n.m_estimate = n.m_cost + distance;

   319

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

   320

	}

   321

   322

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

   323

	FORCEINLINE bool PfDetectDestination(Node& n)

   324

	{

   325

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

   326

		return bDest;

   327

	}

   328

#endif

   329

};

   330

   331

#endif /* YAPF_BASE_HPP */