Skip to content

Commit 5d8ffb1

Browse files
purewpurew
authored
nit(rename): Renames the encoded live speed properties (valhalla#2998)
to make it clear that the raw values are usually not what you want. They are not measured in kph, but have on several occasions been used in that way due to the non-obvious naming. This rename adds `encoded_` to the speed properties to make it clearer that the value within may not be what you actually want. There already are getter-functions defined which should be preferred in most use-cases
1 parent f5fbcaf commit 5d8ffb1

14 files changed

+99
-96
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@
8282
* CHANGED: Factor for service roads is 1.0 by default. [#2988](https://github.com/valhalla/valhalla/pull/2988)
8383
* ADDED: Support for conditionally skipping CI runs [#2986](https://github.com/valhalla/valhalla/pull/2986)
8484
* ADDED: Add instructions for building valhalla on `arm64` macbook [#2997](https://github.com/valhalla/valhalla/pull/2997)
85+
* CHANGED: nit(rename): Renames the encoded live speed properties [#2998](https://github.com/valhalla/valhalla/pull/2998)
8586

8687

8788
## Release Date: 2021-01-25 Valhalla 3.1.0

‎bench/thor/routes.cc

+3-3
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ static void BM_UtrechtBidirectionalAstar(benchmark::State& state) {
101101
baldr::GraphId tile_id(tile.header->tile_id);
102102
if (traffic_dist(gen) < has_live_traffic) {
103103
current->breakpoint1 = 255;
104-
current->overall_speed = traffic_dist(gen) * 100;
104+
current->overall_encoded_speed = traffic_dist(gen) * 100;
105105
} else {
106106
}
107107
};
@@ -202,8 +202,8 @@ void customize_traffic(const boost::property_tree::ptree& config,
202202
auto edge_id = baldr::GraphId(tile_id.tileid(), tile_id.level(), index);
203203
if (edge_id == target_edge_id) {
204204
current->breakpoint1 = 255;
205-
current->overall_speed = target_speed >> 1;
206-
current->speed1 = target_speed >> 1;
205+
current->overall_encoded_speed = target_speed >> 1;
206+
current->encoded_speed1 = target_speed >> 1;
207207
}
208208
};
209209
test::customize_live_traffic_data(config, generate_traffic);

‎test/gurka/test_closure_annotations.cc

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ namespace {
1212
inline void SetLiveSpeedFrom(baldr::TrafficSpeed* live_speed, uint8_t speed, uint8_t breakpoint1) {
1313
live_speed->breakpoint1 = breakpoint1;
1414
live_speed->breakpoint2 = 255;
15-
live_speed->speed2 = speed >> 1;
16-
live_speed->speed3 = UNKNOWN_TRAFFIC_SPEED_RAW;
15+
live_speed->encoded_speed2 = speed >> 1;
16+
live_speed->encoded_speed3 = UNKNOWN_TRAFFIC_SPEED_RAW;
1717
}
1818

1919
inline void SetLiveSpeedUpto(baldr::TrafficSpeed* live_speed, uint8_t speed, uint8_t breakpoint1) {
2020
live_speed->breakpoint1 = breakpoint1;
21-
live_speed->speed1 = speed >> 1;
21+
live_speed->encoded_speed1 = speed >> 1;
2222
}
2323

2424
inline void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint8_t speed) {
2525
live_speed->breakpoint1 = 255;
26-
live_speed->overall_speed = speed >> 1;
27-
live_speed->speed1 = speed >> 1;
26+
live_speed->overall_encoded_speed = speed >> 1;
27+
live_speed->encoded_speed1 = speed >> 1;
2828
}
2929

3030
void close_partial_dir_edge_from(baldr::GraphReader& reader,

‎test/gurka/test_closure_penalty.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ using LiveTrafficCustomize = test::LiveTrafficCustomize;
1010
namespace {
1111
inline void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint64_t speed) {
1212
live_speed->breakpoint1 = 255;
13-
live_speed->overall_speed = speed >> 1;
14-
live_speed->speed1 = speed >> 1;
13+
live_speed->overall_encoded_speed = speed >> 1;
14+
live_speed->encoded_speed1 = speed >> 1;
1515
}
1616

1717
void close_dir_edge(baldr::GraphReader& reader,

‎test/gurka/test_costing_with_traffic.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ const std::vector<std::string>& costing = {"auto", "hov", "taxi",
1414

1515
void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint64_t speed) {
1616
live_speed->breakpoint1 = 255;
17-
live_speed->overall_speed = speed >> 1;
18-
live_speed->speed1 = speed >> 1;
17+
live_speed->overall_encoded_speed = speed >> 1;
18+
live_speed->encoded_speed1 = speed >> 1;
1919
}
2020

2121
void update_dir_edge(baldr::GraphReader& reader,

‎test/gurka/test_locate.cc

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ TEST(locate, basic_properties) {
3939
// turn on some traffic for fun
4040
auto traffic_cb = [](baldr::GraphReader& reader, baldr::TrafficTile& tile, int index,
4141
valhalla::baldr::TrafficSpeed* current) -> void {
42-
current->overall_speed = 124 >> 1;
43-
current->speed1 = 126 >> 1;
42+
current->overall_encoded_speed = 124 >> 1;
43+
current->encoded_speed1 = 126 >> 1;
4444
current->congestion1 = 0; // unknown
4545
current->breakpoint1 = 85;
46-
current->speed2 = 124 >> 1;
46+
current->encoded_speed2 = 124 >> 1;
4747
current->congestion2 = 32; // middle
4848
current->breakpoint2 = 170;
49-
current->speed3 = 122 >> 1;
49+
current->encoded_speed3 = 122 >> 1;
5050
current->congestion3 = 63; // high
5151
};
5252
test::customize_live_traffic_data(map.config, traffic_cb);

‎test/gurka/test_match.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ class TrafficBasedTest : public ::testing::Test {
213213
test::build_live_traffic_data(map.config);
214214
test::customize_live_traffic_data(map.config, [&](baldr::GraphReader&, baldr::TrafficTile&, int,
215215
valhalla::baldr::TrafficSpeed* traffic_speed) {
216-
traffic_speed->overall_speed = 50 >> 1;
217-
traffic_speed->speed1 = 50 >> 1;
216+
traffic_speed->overall_encoded_speed = 50 >> 1;
217+
traffic_speed->encoded_speed1 = 50 >> 1;
218218
traffic_speed->breakpoint1 = 255;
219219
});
220220

‎test/gurka/test_reach.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ using LiveTrafficCustomize = test::LiveTrafficCustomize;
1515
namespace {
1616
inline void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint64_t speed) {
1717
live_speed->breakpoint1 = 255;
18-
live_speed->overall_speed = speed >> 1;
19-
live_speed->speed1 = speed >> 1;
18+
live_speed->overall_encoded_speed = speed >> 1;
19+
live_speed->encoded_speed1 = speed >> 1;
2020
}
2121

2222
void close_dir_edge(baldr::GraphReader& reader,

‎test/gurka/test_route.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,8 @@ class AlgorithmTest : public ::testing::Test {
291291
test::build_live_traffic_data(map.config);
292292
test::customize_live_traffic_data(map.config, [&](baldr::GraphReader&, baldr::TrafficTile&, int,
293293
valhalla::baldr::TrafficSpeed* traffic_speed) {
294-
traffic_speed->overall_speed = 50 >> 1;
295-
traffic_speed->speed1 = 50 >> 1;
294+
traffic_speed->overall_encoded_speed = 50 >> 1;
295+
traffic_speed->encoded_speed1 = 50 >> 1;
296296
traffic_speed->breakpoint1 = 255;
297297
});
298298

‎test/gurka/test_search_filter.cc

+2-2
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ TEST_F(SearchFilter, ExcludeRamp) {
190190
namespace {
191191
inline void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint64_t speed) {
192192
live_speed->breakpoint1 = 255;
193-
live_speed->overall_speed = speed >> 1;
194-
live_speed->speed1 = speed >> 1;
193+
live_speed->overall_encoded_speed = speed >> 1;
194+
live_speed->encoded_speed1 = speed >> 1;
195195
}
196196

197197
void close_dir_edge(baldr::GraphReader& reader,

‎test/gurka/test_traffic.cc

+35-35
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ TEST(Traffic, BasicUpdates) {
5454
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
5555
current->breakpoint1 = 255;
5656
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
57-
current->overall_speed = 0;
58-
current->speed1 = 0;
57+
current->overall_encoded_speed = 0;
58+
current->encoded_speed1 = 0;
5959
} else {
60-
current->overall_speed = 24 >> 1;
61-
current->speed1 = 24 >> 1;
60+
current->overall_encoded_speed = 24 >> 1;
61+
current->encoded_speed1 = 24 >> 1;
6262
}
6363
};
6464
test::customize_live_traffic_data(map.config, cb_setter_24kmh);
@@ -82,9 +82,9 @@ TEST(Traffic, BasicUpdates) {
8282
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
8383
current->breakpoint1 = 255;
8484
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
85-
current->overall_speed = 0;
85+
current->overall_encoded_speed = 0;
8686
} else {
87-
current->overall_speed = UNKNOWN_TRAFFIC_SPEED_RAW - 1;
87+
current->overall_encoded_speed = UNKNOWN_TRAFFIC_SPEED_RAW - 1;
8888
}
8989
};
9090
test::customize_live_traffic_data(map.config, cb_setter_max);
@@ -210,8 +210,8 @@ TEST(Traffic, CutGeoms) {
210210
0u,
211211
0u,
212212
};
213-
ts.overall_speed = 42 >> 1;
214-
ts.speed1 = 42 >> 1;
213+
ts.overall_encoded_speed = 42 >> 1;
214+
ts.encoded_speed1 = 42 >> 1;
215215
ts.congestion1 = baldr::MAX_CONGESTION_VAL - 1;
216216
ts.breakpoint1 = 127;
217217

@@ -221,8 +221,8 @@ TEST(Traffic, CutGeoms) {
221221
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
222222
current->breakpoint1 = 255;
223223
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
224-
current->overall_speed = 0;
225-
current->speed1 = 0;
224+
current->overall_encoded_speed = 0;
225+
current->encoded_speed1 = 0;
226226
current->breakpoint1 = 255;
227227
} else {
228228
*current = ts;
@@ -279,13 +279,13 @@ TEST(Traffic, CutGeoms) {
279279
0u,
280280
0u,
281281
};
282-
ts.overall_speed = 30 >> 1;
282+
ts.overall_encoded_speed = 30 >> 1;
283283

284-
ts.speed1 = 20 >> 1;
284+
ts.encoded_speed1 = 20 >> 1;
285285
ts.congestion1 = baldr::MAX_CONGESTION_VAL - 1;
286286
ts.breakpoint1 = 100;
287287

288-
ts.speed2 = 40 >> 1;
288+
ts.encoded_speed2 = 40 >> 1;
289289
ts.congestion2 = 1; // low but not unknown - 0 = unknown
290290
ts.breakpoint2 = 200;
291291

@@ -297,8 +297,8 @@ TEST(Traffic, CutGeoms) {
297297
const_cast<valhalla::baldr::TrafficSpeed*>(tile.speeds + index);
298298
current->breakpoint1 = 255;
299299
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
300-
current->overall_speed = 0;
301-
current->speed1 = 0;
300+
current->overall_encoded_speed = 0;
301+
current->encoded_speed1 = 0;
302302
} else {
303303
*current = ts;
304304
}
@@ -360,17 +360,17 @@ TEST(Traffic, CutGeoms) {
360360
0u,
361361
0u,
362362
};
363-
ts.overall_speed = 36 >> 1;
363+
ts.overall_encoded_speed = 36 >> 1;
364364

365-
ts.speed1 = 20 >> 1;
365+
ts.encoded_speed1 = 20 >> 1;
366366
ts.congestion1 = baldr::MAX_CONGESTION_VAL - 1;
367367
ts.breakpoint1 = 100;
368368

369-
ts.speed2 = 40 >> 1;
369+
ts.encoded_speed2 = 40 >> 1;
370370
ts.congestion2 = 1;
371371
ts.breakpoint2 = 200;
372372

373-
ts.speed3 = 60 >> 1;
373+
ts.encoded_speed3 = 60 >> 1;
374374
ts.congestion3 = 1;
375375

376376
auto cb_setter_speed = [&map, &ts](baldr::GraphReader& reader, baldr::TrafficTile& tile,
@@ -379,8 +379,8 @@ TEST(Traffic, CutGeoms) {
379379
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
380380
current->breakpoint1 = 255;
381381
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
382-
current->overall_speed = 0;
383-
current->speed1 = 0;
382+
current->overall_encoded_speed = 0;
383+
current->encoded_speed1 = 0;
384384
} else {
385385
*current = ts;
386386
}
@@ -479,17 +479,17 @@ TEST(Traffic, CutGeoms) {
479479
0u,
480480
0u,
481481
};
482-
ts.overall_speed = 36 >> 1;
482+
ts.overall_encoded_speed = 36 >> 1;
483483

484-
ts.speed1 = 20 >> 1;
484+
ts.encoded_speed1 = 20 >> 1;
485485
ts.congestion1 = baldr::MAX_CONGESTION_VAL - 1;
486486
ts.breakpoint1 = 100;
487487

488-
ts.speed2 = 40 >> 1;
488+
ts.encoded_speed2 = 40 >> 1;
489489
ts.congestion2 = 1;
490490
ts.breakpoint2 = 200;
491491

492-
ts.speed3 = 60 >> 1;
492+
ts.encoded_speed3 = 60 >> 1;
493493
ts.congestion3 = 50;
494494

495495
auto cb_setter_speed = [&map, &ts](baldr::GraphReader& reader, baldr::TrafficTile& tile,
@@ -498,8 +498,8 @@ TEST(Traffic, CutGeoms) {
498498
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
499499
current->breakpoint1 = 255;
500500
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
501-
current->overall_speed = 0;
502-
current->speed1 = 0;
501+
current->overall_encoded_speed = 0;
502+
current->encoded_speed1 = 0;
503503
} else {
504504
*current = ts;
505505
}
@@ -716,13 +716,13 @@ TEST(Traffic, CutGeoms) {
716716
0u,
717717
0u,
718718
};
719-
ts.overall_speed = 36 >> 1;
719+
ts.overall_encoded_speed = 36 >> 1;
720720

721-
ts.speed1 = 20 >> 1;
721+
ts.encoded_speed1 = 20 >> 1;
722722
ts.congestion1 = baldr::MAX_CONGESTION_VAL - 1;
723723
ts.breakpoint1 = 100;
724724

725-
ts.speed2 = 40 >> 1;
725+
ts.encoded_speed2 = 40 >> 1;
726726
ts.congestion2 = 1;
727727

728728
// Regression is when breakpoint2 is set to 255,
@@ -731,7 +731,7 @@ TEST(Traffic, CutGeoms) {
731731
ts.breakpoint2 = 255;
732732

733733
// This needs to be set
734-
ts.speed3 = 60 >> 1;
734+
ts.encoded_speed3 = 60 >> 1;
735735
ts.congestion3 = 50;
736736

737737
auto cb_setter_speed = [&map, &ts](baldr::GraphReader& reader, baldr::TrafficTile& tile,
@@ -740,8 +740,8 @@ TEST(Traffic, CutGeoms) {
740740
auto BD = gurka::findEdge(reader, map.nodes, "BD", "D", tile_id);
741741
current->breakpoint1 = 255;
742742
if (std::get<1>(BD) != nullptr && std::get<0>(BD).id() == index) {
743-
current->overall_speed = 0;
744-
current->speed1 = 0;
743+
current->overall_encoded_speed = 0;
744+
current->encoded_speed1 = 0;
745745
} else {
746746
*current = ts;
747747
}
@@ -835,8 +835,8 @@ std::shared_ptr<baldr::GraphReader> WaypointsOnClosuresTest::clean_reader;
835835
namespace {
836836
inline void SetLiveSpeed(baldr::TrafficSpeed* live_speed, uint64_t speed) {
837837
live_speed->breakpoint1 = 255;
838-
live_speed->overall_speed = speed >> 1;
839-
live_speed->speed1 = speed >> 1;
838+
live_speed->overall_encoded_speed = speed >> 1;
839+
live_speed->encoded_speed1 = speed >> 1;
840840
}
841841
} // namespace
842842

0 commit comments

Comments
 (0)