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

public:

    23

	bool          m_stopped_on_first_two_way_signal;

    24

protected:

    25

    26

	static const int s_max_segment_cost = 10000;

    27

    28

	CYapfCostRailT()

    29

		: m_max_cost(0)

    30

		, m_stopped_on_first_two_way_signal(false)

    31

	{

    32

		// pre-compute look-ahead penalties into array

    33

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

    34

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

    35

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

    36

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

    37

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

    38

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

    39

	}

    40

    41

	/// to access inherited path finder

    42

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

    43

    44

public:

    45

	FORCEINLINE int SlopeCost(TileIndex tile, Trackdir td)

    46

	{

    47

		CPerfStart perf_cost(Yapf().m_perf_slope_cost);

    48

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

    49

		return Yapf().PfGetSettings().rail_slope_penalty;

    50

	}

    51

    52

	FORCEINLINE int CurveCost(Trackdir td1, Trackdir td2)

    53

	{

    54

		int cost = 0;

    55

		if (TrackFollower::Allow90degTurns()

    56

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

    57

			// 90-deg curve penalty

    58

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

    59

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

    60

			// 45-deg curve penalty

    61

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

    62

		}

    63

		return cost;

    64

	}

    65

    66

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

    68

	{

    69

		int cost = 0;

    70

		// set base cost

    71

		if (IsDiagonalTrackdir(trackdir)) {

    72

			cost += YAPF_TILE_LENGTH;

    73

			switch (GetTileType(tile)) {

    74

				case MP_STREET:

    75

					/* Increase the cost for level crossings */

    76

					if (IsLevelCrossing(tile))

    77

						cost += Yapf().PfGetSettings().rail_crossing_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

						Yapf().m_stopped_on_first_two_way_signal = true;

   120

						return -1;

   121

					}

   122

					SignalType sig_type = GetSignalType(tile);

   123

					n.m_last_red_signal_type = sig_type;

   124

					n.flags_u.flags_s.m_last_signal_was_red = true;

   125

   126

					// look-ahead signal penalty

   127

					if (look_ahead_cost > 0) {

   128

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

   129

						cost += look_ahead_cost;

   130

					}

   131

   132

					// special signal penalties

   133

					if (n.m_num_signals_passed == 0) {

   134

						switch (sig_type) {

   135

							case SIGTYPE_COMBO:

   136

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

   137

							case SIGTYPE_NORMAL:

   138

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

   139

						};

   140

					}

   141

				}

   142

				n.m_num_signals_passed++;

   143

				n.m_segment->m_last_signal_tile = tile;

   144

				n.m_segment->m_last_signal_td = trackdir;

   145

			}

   146

		}

   147

		return cost;

   148

	}

   149

   150

	FORCEINLINE int PlatformLengthPenalty(int platform_length)

   151

	{

   152

		int cost = 0;

   153

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

   154

		assert(v != NULL);

   155

		assert(v->type == VEH_Train);

   156

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

   157

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

   158

		if (platform_length > needed_platform_length) {

   159

			// apply penalty for longer platform than needed

   160

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

   161

		} else if (needed_platform_length > platform_length) {

   162

			// apply penalty for shorter platform than needed

   163

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

   164

		}

   165

		return cost;

   166

	}

   167

   168

public:

   169

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

   170

   171

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

   172

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

   173

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

   175

	{

   176

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

   177

		CPerfStart perf_cost(Yapf().m_perf_cost);

   178

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

   179

		int first_tile_cost = 0;

   180

		int segment_cost = 0;

   181

		int extra_cost = 0;

   182

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

   183

   184

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

   185

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

   186

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

   187

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

   188

   189

		TileIndex tile = n.m_key.m_tile;

   190

		Trackdir trackdir = n.m_key.m_td;

   191

		TileType tile_type = GetTileType(tile);

   192

   193

		RailType rail_type = GetTileRailType(tile, trackdir);

   194

   195

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

   196

   202

		while (true) {

   204

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

   205

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

   206

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

   207

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

   208

				break;

   209

			}

   210

   211

			// finish if we have reached the destination

   212

			if (target_seen) {

   213

				break;

   214

			}

   215

   216

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

   217

			// when cached segments are used

   218

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

   219

				break;

   220

			}

   221

   222

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

   223

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

   224

				break;

   225

			}

   226

   227

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

   228

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

   229

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

   230

				// we can't continue?

   231

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

   232

				break;

   233

			}

   234

   235

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

   236

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

   237

				break;

   238

			}

   239

   240

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

   241

   242

			{

   243

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

   244

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

   245

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

   246

					break;

   247

   248

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

   249

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

   250

					return false;

   251

			}

   252

   253

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

   254

			{

   255

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

   256

				if (new_rail_type != rail_type) {

   257

					break;

   258

				}

   259

				rail_type = new_rail_type;

   260

			}

   261

   262

			// move to the next tile

   263

			prev_tile = tile;

   264

			prev_trackdir = trackdir;

   265

			prev_tile_type = tile_type;

   266

   267

			tile = F.m_new_tile;

   268

			trackdir = new_td;

   269

			tile_type = GetTileType(tile);

   270

   271

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

   272

   273

			// reversing in depot penalty

   274

			if (tile == prev_tile) {

   275

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

   276

				break;

   277

			}

   278

   279

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

   280

			segment_cost += YAPF_TILE_LENGTH * F.m_tiles_skipped;

   281

   282

			// add penalty for skipped station tiles

   283

			if (F.m_is_station)

   284

			{

   286

				if (target_seen) {

   287

					// it is our destination station

   288

					segment_cost += PlatformLengthPenalty(platform_length);

   289

				} else {

   290

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

   292

				}

   293

			}

   294

   295

			// add min/max speed penalties

   296

			int min_speed = 0;

   297

			int max_speed = F.GetSpeedLimit(&min_speed);

   298

			if (max_speed < v->max_speed)

   299

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

   300

			if (min_speed > v->max_speed)

   301

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

   302

   303

			// finish if we already exceeded the maximum cost

   304

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

   305

				return false;

   306

			}

   307

   308

			if (first_tile_cost == 0) {

   309

				// we just have done first tile

   310

				first_tile_cost = segment_cost;

   311

				segment_cost = 0;

   312

   313

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

   314

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

   315

					// reuse the cached segment cost

   316

					break;

   317

				}

   318

			}

   319

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

   320

			n.SetLastTileTrackdir(tile, trackdir);

   321

   322

		} // while (true)

   323

   324

		if (first_tile_cost == 0) {

   325

			// we have just finished first tile

   326

			first_tile_cost = segment_cost;

   327

			segment_cost = 0;

   328

		}

   329

   330

		// do we have cached segment cost?

   331

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

   332

			// reuse the cached segment cost

   333

			segment_cost = n.m_segment->m_cost;

   334

		} else {

   335

			// save segment cost

   336

			n.m_segment->m_cost = segment_cost;

   337

   338

			// save end of segment back to the node

   339

			n.SetLastTileTrackdir(tile, trackdir);

   340

		}

   341

   342

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

   343

		if (target_seen) {

   344

			n.flags_u.flags_s.m_targed_seen = true;

   345

			if (n.flags_u.flags_s.m_last_signal_was_red) {

   346

				if (n.m_last_red_signal_type == SIGTYPE_EXIT) {

   347

					// last signal was red pre-signal-exit

   348

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

   349

				} else {

   350

					// last signal was red, but not exit

   351

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

   352

				}

   353

			}

   354

		}

   355

   356

		// total node cost

   357

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

   358

   359

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

   360

	}

   361

   362

	FORCEINLINE bool CanUseGlobalCache(Node& n) const

   363

	{

   364

		return (n.m_parent != NULL)

   365

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

   366

	}

   367

   368

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

   369

	{

   370

		n.m_segment = &ci;

   371

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

   372

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

   373

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

   374

		}

   375

	}

   376

   377

};

   378

   379

   380

   381

#endif /* YAPF_COSTRAIL_HPP */