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

				// cache the look-ahead polynomial constant only if we didn't pass more signals than the look-ahead limit is

   104

				int look_ahead_cost = (n.m_num_signals_passed < m_sig_look_ahead_costs.Size()) ? m_sig_look_ahead_costs.Data()[n.m_num_signals_passed] : 0;

   105

				if (sig_state != SIGNAL_STATE_RED) {

   106

					// green signal

   107

					n.flags_u.flags_s.m_last_signal_was_red = false;

   108

					// negative look-ahead red-signal penalties would cause problems later, so use them as positive penalties for green signal

   109

					if (look_ahead_cost < 0) {

   110

						// add its negation to the cost

   111

						cost -= look_ahead_cost;

   112

					}

   113

				} else {

   114

					// we have a red signal in our direction

   115

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

   116

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

   117

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

   118

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

   119

						return -1;

   120

					}

   121

					SignalType sig_type = GetSignalType(tile);

   122

					n.m_last_red_signal_type = sig_type;

   123

					n.flags_u.flags_s.m_last_signal_was_red = true;

   124

   125

					// look-ahead signal penalty

   126

					if (look_ahead_cost > 0) {

   127

						// add the look ahead penalty only if it is positive

   128

						cost += look_ahead_cost;

   129

					}

   130

   131

					// special signal penalties

   132

					if (n.m_num_signals_passed == 0) {

   133

						switch (sig_type) {

   134

							case SIGTYPE_COMBO:

   135

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

   136

							case SIGTYPE_NORMAL:

   137

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

   138

						};

   139

					}

   140

				}

   141

				n.m_num_signals_passed++;

   142

				n.m_segment->m_last_signal_tile = tile;

   143

				n.m_segment->m_last_signal_td = trackdir;

   144

			}

   145

		}

   146

		return cost;

   147

	}

   148

   149

	FORCEINLINE int PlatformLengthPenalty(int platform_length)

   150

	{

   151

		int cost = 0;

   152

		const Vehicle* v = Yapf().GetVehicle();

   153

		assert(v != NULL);

   154

		assert(v->type == VEH_Train);

   155

		assert(v->u.rail.cached_total_length != 0);

   156

		int needed_platform_length = (v->u.rail.cached_total_length + TILE_SIZE - 1) / TILE_SIZE;

   157

		if (platform_length > needed_platform_length) {

   158

			// apply penalty for longer platform than needed

   159

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

   160

		} else if (needed_platform_length > platform_length) {

   161

			// apply penalty for shorter platform than needed

   162

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

   163

		}

   164

		return cost;

   165

	}

   166

   167

public:

   168

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

   169

   170

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

   171

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

   172

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

   173

	FORCEINLINE bool PfCalcCost(Node& n)

   174

	{

   175

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

   176

		CPerfStart perf_cost(Yapf().m_perf_cost);

   177

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

   178

		int first_tile_cost = 0;

   179

		int segment_cost = 0;

   180

		int extra_cost = 0;

   181

		const Vehicle* v = Yapf().GetVehicle();

   182

   183

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

   184

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

   185

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

   186

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

   187

   188

		TileIndex tile = n.m_key.m_tile;

   189

		Trackdir trackdir = n.m_key.m_td;

   190

		TileType tile_type = GetTileType(tile);

   191

   192

		RailType rail_type = GetTileRailType(tile, trackdir);

   193

   194

		bool target_seen = Yapf().PfDetectDestination(tile, trackdir);

   195

   196

		while (true) {

   197

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

   198

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

   199

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

   200

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

   201

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

   202

				break;

   203

			}

   204

   205

			// finish if we have reached the destination

   206

			if (target_seen) {

   207

				break;

   208

			}

   209

   210

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

   211

			// when cached segments are used

   212

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

   213

				break;

   214

			}

   215

   216

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

   217

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

   218

				break;

   219

			}

   220

   221

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

   222

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

   223

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

   224

				// we can't continue?

   225

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

   226

				break;

   227

			}

   228

   229

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

   230

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

   231

				break;

   232

			}

   233

   234

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

   235

   236

			{

   237

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

   238

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

   239

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

   240

					break;

   241

   242

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

   243

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

   244

					return false;

   245

			}

   246

   247

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

   248

			{

   249

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

   250

				if (new_rail_type != rail_type) {

   251

					break;

   252

				}

   253

				rail_type = new_rail_type;

   254

			}

   255

   256

			// move to the next tile

   257

			prev_tile = tile;

   258

			prev_trackdir = trackdir;

   259

			prev_tile_type = tile_type;

   260

   261

			tile = F.m_new_tile;

   262

			trackdir = new_td;

   263

			tile_type = GetTileType(tile);

   264

   265

			target_seen = Yapf().PfDetectDestination(tile, trackdir);

   266

   267

			// reversing in depot penalty

   268

			if (tile == prev_tile) {

   269

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

   270

				break;

   271

			}

   272

   273

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

   274

			segment_cost += YAPF_TILE_LENGTH * F.m_tiles_skipped;

   275

   276

			// add penalty for skipped station tiles

   277

			if (F.m_is_station)

   278

			{

   279

				if (target_seen) {

   280

					// it is our destination station

   281

					uint platform_length = F.m_tiles_skipped + 1;

   282

					segment_cost += PlatformLengthPenalty(platform_length);

   283

				} else {

   284

					// station is not our destination station, apply penalty for skipped platform tiles

   285

					segment_cost += Yapf().PfGetSettings().rail_station_penalty * F.m_tiles_skipped;

   286

				}

   287

			}

   288

   289

			// add min/max speed penalties

   290

			int min_speed = 0;

   291

			int max_speed = F.GetSpeedLimit(&min_speed);

   292

			if (max_speed < v->max_speed)

   293

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

   294

			if (min_speed > v->max_speed)

   295

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

   296

   297

			// finish if we already exceeded the maximum cost

   298

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

   299

				return false;

   300

			}

   301

   302

			if (first_tile_cost == 0) {

   303

				// we just have done first tile

   304

				first_tile_cost = segment_cost;

   305

				segment_cost = 0;

   306

   307

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

   308

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

   309

					// reuse the cached segment cost

   310

					break;

   311

				}

   312

			}

   313

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

   314

			n.SetLastTileTrackdir(tile, trackdir);

   315

   316

		} // while (true)

   317

   318

		if (first_tile_cost == 0) {

   319

			// we have just finished first tile

   320

			first_tile_cost = segment_cost;

   321

			segment_cost = 0;

   322

		}

   323

   324

		// do we have cached segment cost?

   325

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

   326

			// reuse the cached segment cost

   327

			segment_cost = n.m_segment->m_cost;

   328

		} else {

   329

			// save segment cost

   330

			n.m_segment->m_cost = segment_cost;

   331

   332

			// save end of segment back to the node

   333

			n.SetLastTileTrackdir(tile, trackdir);

   334

		}

   335

   336

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

   337

		if (target_seen) {

   338

			n.flags_u.flags_s.m_targed_seen = true;

   339

			if (n.flags_u.flags_s.m_last_signal_was_red) {

   340

				if (n.m_last_red_signal_type == SIGTYPE_EXIT) {

   341

					// last signal was red pre-signal-exit

   342

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

   343

				} else {

   344

					// last signal was red, but not exit

   345

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

   346

				}

   347

			}

   348

		}

   349

   350

		// total node cost

   351

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

   352

   353

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

   354

	}

   355

   356

	FORCEINLINE bool CanUseGlobalCache(Node& n) const

   357

	{

   358

		return (n.m_parent != NULL)

   359

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

   360

	}

   361

   362

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

   363

	{

   364

		n.m_segment = &ci;

   365

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

   366

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

   367

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

   368

		}

   369

	}

   370

   371

};

   372

   373

   374

   375

#endif /* YAPF_COSTRAIL_HPP */