1

/* $Id$ */

     2

     3

/** @file yapf_costrail.hpp */

     4

     5

#ifndef  YAPF_COSTRAIL_HPP

     6

#define  YAPF_COSTRAIL_HPP

     7

     8

     9

template <class Types>

    10

class CYapfCostRailT

    11

	: public CYapfCostBase

    12

	, public CostRailSettings

    13

{

    14

public:

    15

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

    16

	typedef typename Types::TrackFollower TrackFollower;

    17

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

    18

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

    19

	typedef typename Node::CachedData CachedData;

    20

    21

protected:

    22

	int           m_max_cost;

    23

	CBlobT<int>   m_sig_look_ahead_costs;

    24

public:

    25

	bool          m_stopped_on_first_two_way_signal;

    26

protected:

    27

    28

	static const int s_max_segment_cost = 10000;

    29

    30

	CYapfCostRailT()

    31

		: m_max_cost(0)

    32

		, m_stopped_on_first_two_way_signal(false)

    33

	{

    34

		// pre-compute look-ahead penalties into array

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

	}

    42

    43

	/// to access inherited path finder

    44

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

    45

    46

public:

    47

	FORCEINLINE int SlopeCost(TileIndex tile, Trackdir td)

    48

	{

    49

		CPerfStart perf_cost(Yapf().m_perf_slope_cost);

    50

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

    51

		return Yapf().PfGetSettings().rail_slope_penalty;

    52

	}

    53

    54

	FORCEINLINE int CurveCost(Trackdir td1, Trackdir td2)

    55

	{

    56

		int cost = 0;

    57

		if (TrackFollower::Allow90degTurns()

    58

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

    59

			// 90-deg curve penalty

    60

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

    61

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

    62

			// 45-deg curve penalty

    63

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

    64

		}

    65

		return cost;

    66

	}

    67

    68

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

    69

	FORCEINLINE int OneTileCost(TileIndex prev_tile, TileIndex& tile, Trackdir trackdir)

    70

	{

    71

		int cost = 0;

    72

		// set base cost

    73

		if (IsDiagonalTrackdir(trackdir)) {

    74

			cost += YAPF_TILE_LENGTH;

    75

			switch (GetTileType(tile)) {

    76

				case MP_STREET:

    77

					/* Increase the cost for level crossings */

    78

					if (IsLevelCrossing(tile))

    79

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

    80

					break;

    81

    82

				default:

    83

					break;

    84

			}

    85

		} else {

    86

			// non-diagonal trackdir

    87

			cost = YAPF_TILE_CORNER_LENGTH;

    88

		}

    89

		return cost;

    90

	}

    91

    92

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

    93

	{

    94

		int cost = 0;

    95

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

    96

		CPerfStart perf_cost(Yapf().m_perf_other_cost);

    97

		if (IsTileType(tile, MP_RAILWAY)) {

    98

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

    99

			bool has_signal_along = HasSignalOnTrackdir(tile, trackdir);

   100

			if (has_signal_against && !has_signal_along) {

   101

				// one-way signal in opposite direction

   102

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

   103

			} else if (has_signal_along) {

   104

				SignalState sig_state = GetSignalStateByTrackdir(tile, trackdir);

   105

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

   106

				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;

   107

				if (sig_state != SIGNAL_STATE_RED) {

   108

					// green signal

   109

					n.flags_u.flags_s.m_last_signal_was_red = false;

   110

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

   111

					if (look_ahead_cost < 0) {

   112

						// add its negation to the cost

   113

						cost -= look_ahead_cost;

   114

					}

   115

				} else {

   116

					// we have a red signal in our direction

   117

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

   118

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

   119

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

   120

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

   121

						Yapf().m_stopped_on_first_two_way_signal = true;

   122

						return -1;

   123

					}

   124

					SignalType sig_type = GetSignalType(tile);

   125

					n.m_last_red_signal_type = sig_type;

   126

					n.flags_u.flags_s.m_last_signal_was_red = true;

   127

   128

					// look-ahead signal penalty

   129

					if (look_ahead_cost > 0) {

   130

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

   131

						cost += look_ahead_cost;

   132

					}

   133

   134

					// special signal penalties

   135

					if (n.m_num_signals_passed == 0) {

   136

						switch (sig_type) {

   137

							case SIGTYPE_COMBO:

   138

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

   139

							case SIGTYPE_NORMAL:

   140

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

   141

						};

   142

					}

   143

				}

   144

				n.m_num_signals_passed++;

   145

				n.m_segment->m_last_signal_tile = tile;

   146

				n.m_segment->m_last_signal_td = trackdir;

   147

			}

   148

		}

   149

		return cost;

   150

	}

   151

   152

	FORCEINLINE int PlatformLengthPenalty(int platform_length)

   153

	{

   154

		int cost = 0;

   155

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

   156

		assert(v != NULL);

   157

		assert(v->type == VEH_TRAIN);

   158

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

   159

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

   160

		if (platform_length > needed_platform_length) {

   161

			// apply penalty for longer platform than needed

   162

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

   163

		} else if (needed_platform_length > platform_length) {

   164

			// apply penalty for shorter platform than needed

   165

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

   166

		}

   167

		return cost;

   168

	}

   169

   170

public:

   171

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

   172

   173

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

   174

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

   175

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

   176

	FORCEINLINE bool PfCalcCost(Node &n, const TrackFollower &tf)

   177

	{

   178

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

   179

		CPerfStart perf_cost(Yapf().m_perf_cost);

   180

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

   181

		int first_tile_cost = 0;

   182

		int segment_cost = 0;

   183

		int extra_cost = 0;

   184

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

   185

   186

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

   187

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

   188

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

   189

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

   190

   191

		TileIndex tile = n.m_key.m_tile;

   192

		Trackdir trackdir = n.m_key.m_td;

   193

		TileType tile_type = GetTileType(tile);

   194

   195

		RailType rail_type = GetTileRailType(tile);

   196

   197

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

   198

   199

		if (tf.m_is_station) {

   200

			// station tiles have an extra penalty

   201

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

   202

		}

   203

   204

		while (true) {

   205

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

   206

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

   207

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

   208

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

   209

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

   210

				break;

   211

			}

   212

   213

			// finish if we have reached the destination

   214

			if (target_seen) {

   215

				break;

   216

			}

   217

   218

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

   219

			// when cached segments are used

   220

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

   221

				break;

   222

			}

   223

   224

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

   225

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

   226

				break;

   227

			}

   228

   229

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

   230

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

   231

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

   232

				// we can't continue?

   233

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

   234

				break;

   235

			}

   236

   237

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

   238

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

   239

				break;

   240

			}

   241

   242

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

   243

   244

			{

   245

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

   246

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

   247

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

   248

					break;

   249

   250

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

   251

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

   252

					return false;

   253

			}

   254

   255

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

   256

			{

   257

				RailType new_rail_type = GetTileRailType(F.m_new_tile);

   258

				if (new_rail_type != rail_type) {

   259

					break;

   260

				}

   261

				rail_type = new_rail_type;

   262

			}

   263

   264

			// move to the next tile

   265

			prev_tile = tile;

   266

			prev_trackdir = trackdir;

   267

			prev_tile_type = tile_type;

   268

   269

			tile = F.m_new_tile;

   270

			trackdir = new_td;

   271

			tile_type = GetTileType(tile);

   272

   273

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

   274

   275

			// reversing in depot penalty

   276

			if (tile == prev_tile) {

   277

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

   278

				break;

   279

			}

   280

   281

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

   282

			segment_cost += YAPF_TILE_LENGTH * F.m_tiles_skipped;

   283

   284

			// add penalty for skipped station tiles

   285

			if (F.m_is_station)

   286

			{

   287

				uint platform_length = F.m_tiles_skipped + 1;

   288

				if (target_seen) {

   289

					// it is our destination station

   290

					segment_cost += PlatformLengthPenalty(platform_length);

   291

				} else {

   292

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

   293

					segment_cost += Yapf().PfGetSettings().rail_station_penalty * platform_length;

   294

				}

   295

			}

   296

   297

			// add min/max speed penalties

   298

			int min_speed = 0;

   299

			int max_speed = F.GetSpeedLimit(&min_speed);

   300

			if (max_speed < v->max_speed)

   301

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

   302

			if (min_speed > v->max_speed)

   303

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

   304

   305

			// finish if we already exceeded the maximum cost

   306

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

   307

				return false;

   308

			}

   309

   310

			if (first_tile_cost == 0) {

   311

				// we just have done first tile

   312

				first_tile_cost = segment_cost;

   313

				segment_cost = 0;

   314

   315

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

   316

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

   317

					// reuse the cached segment cost

   318

					break;

   319

				}

   320

			}

   321

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

   322

			n.SetLastTileTrackdir(tile, trackdir);

   323

   324

		} // while (true)

   325

   326

		if (first_tile_cost == 0) {

   327

			// we have just finished first tile

   328

			first_tile_cost = segment_cost;

   329

			segment_cost = 0;

   330

		}

   331

   332

		// do we have cached segment cost?

   333

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

   334

			// reuse the cached segment cost

   335

			segment_cost = n.m_segment->m_cost;

   336

		} else {

   337

			// save segment cost

   338

			n.m_segment->m_cost = segment_cost;

   339

   340

			// save end of segment back to the node

   341

			n.SetLastTileTrackdir(tile, trackdir);

   342

		}

   343

   344

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

   345

		if (target_seen) {

   346

			n.flags_u.flags_s.m_targed_seen = true;

   347

			if (n.flags_u.flags_s.m_last_signal_was_red) {

   348

				if (n.m_last_red_signal_type == SIGTYPE_EXIT) {

   349

					// last signal was red pre-signal-exit

   350

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

   351

				} else {

   352

					// last signal was red, but not exit

   353

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

   354

				}

   355

			}

   356

		}

   357

   358

		// total node cost

   359

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

   360

   361

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

   362

	}

   363

   364

	FORCEINLINE bool CanUseGlobalCache(Node& n) const

   365

	{

   366

		return (n.m_parent != NULL)

   367

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

   368

	}

   369

   370

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

   371

	{

   372

		n.m_segment = &ci;

   373

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

   374

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

   375

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

   376

		}

   377

	}

   378

   379

};

   380

   381

   382

   383

#endif /* YAPF_COSTRAIL_HPP */