1

/* $Id$ */

     2

     3

#ifndef  YAPF_COSTRAIL_HPP

     4

#define  YAPF_COSTRAIL_HPP

     5

     6

     7

template <class Types>

     8

class CYapfCostRailT

     9

	: public CYapfCostBase

    10

	, public CostRailSettings

    11

{

    12

public:

    13

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

    14

	typedef typename Types::TrackFollower TrackFollower;

    15

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

    16

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

    17

	typedef typename Node::CachedData CachedData;

    18

    19

protected:

    20

	int           m_max_cost;

    21

	CBlobT<int>   m_sig_look_ahead_costs;

    22

    23

	static const int s_max_segment_cost = 10000;

    24

    25

	CYapfCostRailT() : m_max_cost(0)

    26

	{

    27

		// pre-compute look-ahead penalties into array

    28

		int p0 = Yapf().PfGetSettings().rail_look_ahead_signal_p0;

    29

		int p1 = Yapf().PfGetSettings().rail_look_ahead_signal_p1;

    30

		int p2 = Yapf().PfGetSettings().rail_look_ahead_signal_p2;

    31

		int *pen = m_sig_look_ahead_costs.GrowSizeNC(Yapf().PfGetSettings().rail_look_ahead_max_signals);

    32

		for (uint i = 0; i < Yapf().PfGetSettings().rail_look_ahead_max_signals; i++)

    33

			pen[i] = p0 + i * (p1 + i * p2);

    34

	}

    35

    36

	/// to access inherited path finder

    37

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

    38

    39

public:

    40

	FORCEINLINE int SlopeCost(TileIndex tile, Trackdir td)

    41

	{

    42

		CPerfStart perf_cost(Yapf().m_perf_slope_cost);

    43

		if (!stSlopeCost(tile, td)) return 0;

    44

		return Yapf().PfGetSettings().rail_slope_penalty;

    45

	}

    46

    47

	FORCEINLINE int CurveCost(Trackdir td1, Trackdir td2)

    48

	{

    49

		int cost = 0;

    50

		if (TrackFollower::Allow90degTurns()

    51

				&& ((TrackdirToTrackdirBits(td2) & (TrackdirBits)TrackdirCrossesTrackdirs(td1)) != 0)) {

    52

			// 90-deg curve penalty

    53

			cost += Yapf().PfGetSettings().rail_curve90_penalty;

    54

		} else if (td2 != NextTrackdir(td1)) {

    55

			// 45-deg curve penalty

    56

			cost += Yapf().PfGetSettings().rail_curve45_penalty;

    57

		}

    58

		return cost;

    59

	}

    60

    61

	/** return one tile cost. If tile is a tunnel entry, it is moved to the end of tunnel */

    62

	FORCEINLINE int OneTileCost(TileIndex& tile, Trackdir trackdir)

    63

	{

    64

		int cost = 0;

    65

		// set base cost

    66

		if (IsDiagonalTrackdir(trackdir)) {

    67

			cost += YAPF_TILE_LENGTH;

    68

			switch (GetTileType(tile)) {

    69

				case MP_STREET:

    70

					/* Increase the cost for level crossings */

    71

					if (IsLevelCrossing(tile))

    72

						cost += Yapf().PfGetSettings().rail_crossing_penalty;

    73

					break;

    74

    75

				case MP_STATION:

    76

					// penalty for passing station tiles

    77

					cost += Yapf().PfGetSettings().rail_station_penalty;

    78

					break;

    79

    80

				default:

    81

					break;

    82

			}

    83

		} else {

    84

			// non-diagonal trackdir

    85

			cost = YAPF_TILE_CORNER_LENGTH;

    86

		}

    87

		return cost;

    88

	}

    89

    90

	int SignalCost(Node& n, TileIndex tile, Trackdir trackdir)

    91

	{

    92

		int cost = 0;

    93

		// if there is one-way signal in the opposite direction, then it is not our way

    94

		CPerfStart perf_cost(Yapf().m_perf_other_cost);

    95

		if (IsTileType(tile, MP_RAILWAY)) {

    96

			bool has_signal_against = HasSignalOnTrackdir(tile, ReverseTrackdir(trackdir));

    97

			bool has_signal_along = HasSignalOnTrackdir(tile, trackdir);

    98

			if (has_signal_against && !has_signal_along) {

    99

				// one-way signal in opposite direction

   100

				n.m_segment->flags_u.flags_s.m_end_of_line = true;

   101

			} else if (has_signal_along) {

   102

				SignalState sig_state = GetSignalStateByTrackdir(tile, trackdir);

   103

				if (sig_state != SIGNAL_STATE_RED) {

   104

					// green signal

   105

					n.flags_u.flags_s.m_last_signal_was_red = false;

   106

				} else {

   107

					// we have a red signal in our direction

   108

					// was it first signal which is two-way?

   109

					if (Yapf().TreatFirstRedTwoWaySignalAsEOL() && has_signal_against && n.m_num_signals_passed == 0) {

   110

						// yes, the first signal is two-way red signal => DEAD END

   111

						n.m_segment->flags_u.flags_s.m_end_of_line = true;

   112

						return -1;

   113

					}

   114

					SignalType sig_type = GetSignalType(tile);

   115

					n.m_last_red_signal_type = sig_type;

   116

					n.flags_u.flags_s.m_last_signal_was_red = true;

   117

   118

					// look-ahead signal penalty

   119

					if (n.m_num_signals_passed < m_sig_look_ahead_costs.Size()) {

   120

						cost += m_sig_look_ahead_costs.Data()[n.m_num_signals_passed];

   121

					}

   122

   123

					// special signal penalties

   124

					if (n.m_num_signals_passed == 0) {

   125

						switch (sig_type) {

   126

							case SIGTYPE_COMBO:

   127

							case SIGTYPE_EXIT:   cost += Yapf().PfGetSettings().rail_firstred_exit_penalty; break; // first signal is red pre-signal-exit

   128

							case SIGTYPE_NORMAL:

   129

							case SIGTYPE_ENTRY:  cost += Yapf().PfGetSettings().rail_firstred_penalty; break;

   130

						};

   131

					}

   132

				}

   133

				n.m_num_signals_passed++;

   134

				n.m_segment->m_last_signal_tile = tile;

   135

				n.m_segment->m_last_signal_td = trackdir;

   136

			}

   137

		}

   138

		return cost;

   139

	}

   140

   141

public:

   142

	FORCEINLINE void SetMaxCost(int max_cost) {m_max_cost = max_cost;}

   143

   144

	/** Called by YAPF to calculate the cost from the origin to the given node.

   145

	*   Calculates only the cost of given node, adds it to the parent node cost

   146

	*   and stores the result into Node::m_cost member */

   147

	FORCEINLINE bool PfCalcCost(Node& n)

   148

	{

   149

		assert(!n.flags_u.flags_s.m_targed_seen);

   150

		CPerfStart perf_cost(Yapf().m_perf_cost);

   151

		int parent_cost = (n.m_parent != NULL) ? n.m_parent->m_cost : 0;

   152

		int first_tile_cost = 0;

   153

		int segment_cost = 0;

   154

		int extra_cost = 0;

   156

   157

		// start at n.m_key.m_tile / n.m_key.m_td and walk to the end of segment

   158

		TileIndex prev_tile      = (n.m_parent != NULL) ? n.m_parent->GetLastTile() : INVALID_TILE;

   159

		Trackdir  prev_trackdir  = (n.m_parent != NULL) ? n.m_parent->GetLastTrackdir() : INVALID_TRACKDIR;

   160

		TileType  prev_tile_type = (n.m_parent != NULL) ? GetTileType(n.m_parent->GetLastTile()) : MP_VOID;

   161

   162

		TileIndex tile = n.m_key.m_tile;

   163

		Trackdir trackdir = n.m_key.m_td;

   164

		TileType tile_type = GetTileType(tile);

   165

   166

		RailType rail_type = GetTileRailType(tile, trackdir);

   167

   168

		bool target_seen = false;

   169

   170

		while (true) {

   171

			segment_cost += Yapf().OneTileCost(tile, trackdir);

   172

			segment_cost += Yapf().CurveCost(prev_trackdir, trackdir);

   173

			segment_cost += Yapf().SlopeCost(tile, trackdir);

   174

			segment_cost += Yapf().SignalCost(n, tile, trackdir);

   175

			if (n.m_segment->flags_u.flags_s.m_end_of_line) {

   176

				break;

   177

			}

   178

   179

			// finish if we have reached the destination

   180

			target_seen = Yapf().PfDetectDestination(n);

   181

			if (target_seen) {

   182

				break;

   183

			}

   184

   185

			// finish on first station tile - segment should end here to avoid target skipping

   186

			// when cached segments are used

   187

			if (tile_type == MP_STATION && prev_tile_type != MP_STATION) {

   188

				break;

   189

			}

   190

   191

			// finish also on waypoint - same workaround as for first station tile

   192

			if (tile_type == MP_RAILWAY && IsRailWaypoint(tile)) {

   193

				break;

   194

			}

   195

   196

			// if there are no reachable trackdirs on the next tile, we have end of road

   197

			TrackFollower F(v, &Yapf().m_perf_ts_cost);

   198

			if (!F.Follow(tile, trackdir)) {

   199

				// we can't continue?

   200

				// n.m_segment->flags_u.flags_s.m_end_of_line = true;

   201

				break;

   202

			}

   203

   204

			// if there are more trackdirs available & reachable, we are at the end of segment

   205

			if (KillFirstBit2x64(F.m_new_td_bits) != 0) {

   206

				break;

   207

			}

   208

   209

			Trackdir new_td = (Trackdir)FindFirstBit2x64(F.m_new_td_bits);

   210

   211

			{

   212

				// end segment if train is about to enter simple loop with no junctions

   213

				// so next time it should stop on the next if

   214

				if (segment_cost > s_max_segment_cost && IsTileType(F.m_new_tile, MP_RAILWAY))

   215

					break;

   216

   217

				// stop if train is on simple loop with no junctions

   218

				if (F.m_new_tile == n.m_key.m_tile && new_td == n.m_key.m_td)

   219

					return false;

   220

			}

   221

   222

			// if tail type changes, finish segment (cached segment can't contain more rail types)

   223

			{

   224

				RailType new_rail_type = GetTileRailType(F.m_new_tile, (Trackdir)FindFirstBit2x64(F.m_new_td_bits));

   225

				if (new_rail_type != rail_type) {

   226

					break;

   227

				}

   228

				rail_type = new_rail_type;

   229

			}

   230

   231

			// move to the next tile

   232

			prev_tile = tile;

   233

			prev_trackdir = trackdir;

   234

			prev_tile_type = tile_type;

   235

   236

			tile = F.m_new_tile;

   237

			trackdir = new_td;

   238

			tile_type = GetTileType(tile);

   239

   240

			// reversing in depot penalty

   241

			if (tile == prev_tile) {

   242

				segment_cost += Yapf().PfGetSettings().rail_depot_reverse_penalty;

   243

				break;

   244

			}

   245

   246

			// if we skipped some tunnel tiles, add their cost

   247

			segment_cost += YAPF_TILE_LENGTH * F.m_tunnel_tiles_skipped;

   248

   249

			// add min/max speed penalties

   250

			int min_speed = 0;

   251

			int max_speed = F.GetSpeedLimit(&min_speed);

   252

			if (max_speed < v->max_speed)

   253

				segment_cost += YAPF_TILE_LENGTH * (v->max_speed - max_speed) / v->max_speed;

   254

			if (min_speed > v->max_speed)

   255

				segment_cost += YAPF_TILE_LENGTH * (min_speed - v->max_speed);

   256

   257

			// finish if we already exceeded the maximum cost

   258

			if (m_max_cost > 0 && (parent_cost + first_tile_cost + segment_cost) > m_max_cost) {

   259

				return false;

   260

			}

   261

   262

			if (first_tile_cost == 0) {

   263

				// we just have done first tile

   264

				first_tile_cost = segment_cost;

   265

				segment_cost = 0;

   266

   267

				// look if we can reuse existing (cached) segment cost

   268

				if (n.m_segment->m_cost >= 0) {

   269

					// reuse the cached segment cost

   270

					break;

   271

				}

   272

			}

   273

			// segment cost was not filled yes, we have not cached it yet

   274

			n.SetLastTileTrackdir(tile, trackdir);

   275

   276

		} // while (true)

   277

   278

		if (first_tile_cost == 0) {

   279

			// we have just finished first tile

   280

			first_tile_cost = segment_cost;

   281

			segment_cost = 0;

   282

		}

   283

   284

		// do we have cached segment cost?

   285

		if (n.m_segment->m_cost >= 0) {

   286

			// reuse the cached segment cost

   287

			segment_cost = n.m_segment->m_cost;

   288

		} else {

   289

			// save segment cost

   290

			n.m_segment->m_cost = segment_cost;

   291

   292

			// save end of segment back to the node

   293

			n.SetLastTileTrackdir(tile, trackdir);

   294

		}

   295

   296

		// special costs for the case we have reached our target

   297

		if (target_seen) {

   298

			n.flags_u.flags_s.m_targed_seen = true;

   299

			if (n.flags_u.flags_s.m_last_signal_was_red) {

   300

				if (n.m_last_red_signal_type == SIGTYPE_EXIT) {

   301

					// last signal was red pre-signal-exit

   302

					extra_cost += Yapf().PfGetSettings().rail_lastred_exit_penalty;

   303

				} else {

   304

					// last signal was red, but not exit

   305

					extra_cost += Yapf().PfGetSettings().rail_lastred_penalty;

   306

				}

   307

			}

   308

		}

   309

   310

		// total node cost

   311

		n.m_cost = parent_cost + first_tile_cost + segment_cost + extra_cost;

   312

   313

		return !n.m_segment->flags_u.flags_s.m_end_of_line;

   314

	}

   315

   316

	FORCEINLINE bool CanUseGlobalCache(Node& n) const

   317

	{

   318

		return (n.m_parent != NULL)

   319

			&& (n.m_parent->m_num_signals_passed >= m_sig_look_ahead_costs.Size());

   320

	}

   321

   322

	FORCEINLINE void ConnectNodeToCachedData(Node& n, CachedData& ci)

   323

	{

   324

		n.m_segment = &ci;

   325

		if (n.m_segment->m_cost < 0) {

   326

			n.m_segment->m_last_tile = n.m_key.m_tile;

   327

			n.m_segment->m_last_td = n.m_key.m_td;

   328

		}

   329

	}

   330

   331

};

   332

   333

   334

   335

#endif /* YAPF_COSTRAIL_HPP */