Revert "remove Bike2WeightTagParser (graphhopper#2668)"

This reverts commit 5b1c7b2.

Author: karussell

core/src/main/java/com/graphhopper/GraphHopper.java

@@ -652,12 +652,8 @@ private void buildEncodingManagerAndOSMParsers(String flagEncodersStr, String en
             osmParsers.addWayTagParser(new OSMMaxSpeedParser(encodingManager.getDecimalEncodedValue(MaxSpeed.KEY)));
         if (!encodedValueStrings.contains(RoadAccess.KEY))
             osmParsers.addWayTagParser(new OSMRoadAccessParser(encodingManager.getEnumEncodedValue(RoadAccess.KEY, RoadAccess.class), OSMRoadAccessParser.toOSMRestrictions(TransportationMode.CAR)));
-        if (encodingManager.hasEncodedValue(AverageSlope.KEY) || encodingManager.hasEncodedValue(MaxSlope.KEY)) {
-            if (!encodingManager.hasEncodedValue(AverageSlope.KEY) || !encodingManager.hasEncodedValue(MaxSlope.KEY))
-                throw new IllegalArgumentException("Enable both, average_slope and max_slope");
-            osmParsers.addWayTagParser(new SlopeCalculator(encodingManager.getDecimalEncodedValue(MaxSlope.KEY),
-                    encodingManager.getDecimalEncodedValue(AverageSlope.KEY)));
-        }
+        if (encodingManager.hasEncodedValue(AverageSlope.KEY) || encodingManager.hasEncodedValue(MaxSlope.KEY))
+            osmParsers.addWayTagParser(new SlopeCalculator(encodingManager.getDecimalEncodedValue(MaxSlope.KEY), encodingManager.getDecimalEncodedValue(AverageSlope.KEY)));
         if (encodingManager.hasEncodedValue(Curvature.KEY))
             osmParsers.addWayTagParser(new CurvatureCalculator(encodingManager.getDecimalEncodedValue(Curvature.KEY)));
 

core/src/main/java/com/graphhopper/routing/util/Bike2WeightTagParser.java

@@ -0,0 +1,129 @@
+/*
+ *  Licensed to GraphHopper GmbH under one or more contributor
+ *  license agreements. See the NOTICE file distributed with this work for
+ *  additional information regarding copyright ownership.
+ *
+ *  GraphHopper GmbH licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except in
+ *  compliance with the License. You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+package com.graphhopper.routing.util;
+
+import com.graphhopper.reader.ReaderWay;
+import com.graphhopper.routing.ev.*;
+import com.graphhopper.storage.IntsRef;
+import com.graphhopper.util.PMap;
+import com.graphhopper.util.PointList;
+
+import static com.graphhopper.util.Helper.keepIn;
+
+/**
+ * Stores two speed values into an edge to support avoiding too much incline
+ *
+ * @author Peter Karich
+ */
+public class Bike2WeightTagParser extends BikeTagParser {
+
+    public Bike2WeightTagParser(EncodedValueLookup lookup, PMap properties) {
+        this(
+                lookup.getBooleanEncodedValue(VehicleAccess.key(properties.getString("name", "bike2"))),
+                lookup.getDecimalEncodedValue(VehicleSpeed.key(properties.getString("name", "bike2"))),
+                lookup.getDecimalEncodedValue(VehiclePriority.key(properties.getString("name", "bike2"))),
+                lookup.getEnumEncodedValue(BikeNetwork.KEY, RouteNetwork.class),
+                lookup.getBooleanEncodedValue(Roundabout.KEY),
+                lookup.getEnumEncodedValue(Smoothness.KEY, Smoothness.class),
+                lookup.hasEncodedValue(TurnCost.key(properties.getString("name", "bike2"))) ? lookup.getDecimalEncodedValue(TurnCost.key(properties.getString("name", "bike2"))) : null,
+                properties
+        );
+    }
+
+    public Bike2WeightTagParser(BooleanEncodedValue accessEnc, DecimalEncodedValue speedEnc,
+                                DecimalEncodedValue priorityEnc, EnumEncodedValue<RouteNetwork> bikeRouteEnc,
+                                BooleanEncodedValue roundaboutEnc,
+                                EnumEncodedValue<Smoothness> smoothnessEnc, DecimalEncodedValue turnCostEnc, PMap properties) {
+        super(accessEnc, speedEnc, priorityEnc, bikeRouteEnc, smoothnessEnc, properties.getString("name", "bike2"),
+                roundaboutEnc, turnCostEnc);
+        blockPrivate(properties.getBool("block_private", true));
+        blockFords(properties.getBool("block_fords", false));
+    }
+
+    @Override
+    public IntsRef handleWayTags(IntsRef edgeFlags, ReaderWay way) {
+        edgeFlags = super.handleWayTags(edgeFlags, way);
+        return applyWayTags(way, edgeFlags);
+    }
+
+    public IntsRef applyWayTags(ReaderWay way, IntsRef intsRef) {
+        PointList pl = way.getTag("point_list", null);
+        if (pl == null)
+            throw new IllegalArgumentException("The artificial point_list tag is missing");
+        if (!pl.is3D())
+            throw new IllegalStateException(getName() + " requires elevation data to improve speed calculation based on it. Please enable it in config via e.g. graph.elevation.provider: srtm");
+
+        if (way.hasTag("tunnel", "yes") || way.hasTag("bridge", "yes") || way.hasTag("highway", "steps"))
+            // do not change speed
+            // note: although tunnel can have a difference in elevation it is very unlikely that the elevation data is correct for a tunnel
+            return intsRef;
+
+        // Decrease the speed for ele increase (incline), and decrease the speed for ele decrease (decline). The speed-decrease
+        // has to be bigger (compared to the speed-increase) for the same elevation difference to simulate losing energy and avoiding hills.
+        // For the reverse speed this has to be the opposite but again keeping in mind that up+down difference.
+        double incEleSum = 0, incDist2DSum = 0, decEleSum = 0, decDist2DSum = 0;
+        // double prevLat = pl.getLat(0), prevLon = pl.getLon(0);
+        double prevEle = pl.getEle(0);
+        if (!way.hasTag("edge_distance"))
+            throw new IllegalArgumentException("The artificial edge_distance tag is missing");
+        double fullDist2D = way.getTag("edge_distance", 0d);
+
+        // for short edges an incline makes no sense and for 0 distances could lead to NaN values for speed, see #432
+        if (fullDist2D < 2)
+            return intsRef;
+
+        double eleDelta = pl.getEle(pl.size() - 1) - prevEle;
+        if (eleDelta > 0.1) {
+            incEleSum = eleDelta;
+            incDist2DSum = fullDist2D;
+        } else if (eleDelta < -0.1) {
+            decEleSum = -eleDelta;
+            decDist2DSum = fullDist2D;
+        }
+
+        // Calculate slop via tan(asin(height/distance)) but for rather smallish angles where we can assume tan a=a and sin a=a.
+        // Then calculate a factor which decreases or increases the speed.
+        // Do this via a simple quadratic equation where y(0)=1 and y(0.3)=1/4 for incline and y(0.3)=2 for decline
+        double fwdIncline = incDist2DSum > 1 ? incEleSum / incDist2DSum : 0;
+        double fwdDecline = decDist2DSum > 1 ? decEleSum / decDist2DSum : 0;
+        double restDist2D = fullDist2D - incDist2DSum - decDist2DSum;
+        double maxSpeed = getHighwaySpeed("cycleway");
+        if (accessEnc.getBool(false, intsRef)) {
+            // use weighted mean so that longer incline influences speed more than shorter
+            double speed = avgSpeedEnc.getDecimal(false, intsRef);
+            double fwdFaster = 1 + 2 * keepIn(fwdDecline, 0, 0.2);
+            fwdFaster = fwdFaster * fwdFaster;
+            double fwdSlower = 1 - 5 * keepIn(fwdIncline, 0, 0.2);
+            fwdSlower = fwdSlower * fwdSlower;
+            speed = speed * (fwdSlower * incDist2DSum + fwdFaster * decDist2DSum + 1 * restDist2D) / fullDist2D;
+            setSpeed(false, intsRef, keepIn(speed, MIN_SPEED, maxSpeed));
+        }
+
+        if (accessEnc.getBool(true, intsRef)) {
+            double speedReverse = avgSpeedEnc.getDecimal(true, intsRef);
+            double bwFaster = 1 + 2 * keepIn(fwdIncline, 0, 0.2);
+            bwFaster = bwFaster * bwFaster;
+            double bwSlower = 1 - 5 * keepIn(fwdDecline, 0, 0.2);
+            bwSlower = bwSlower * bwSlower;
+            speedReverse = speedReverse * (bwFaster * incDist2DSum + bwSlower * decDist2DSum + 1 * restDist2D) / fullDist2D;
+            setSpeed(true, intsRef, keepIn(speedReverse, MIN_SPEED, maxSpeed));
+        }
+        return intsRef;
+    }
+
+}

core/src/main/java/com/graphhopper/routing/util/DefaultVehicleEncodedValuesFactory.java

@@ -39,8 +39,8 @@ public VehicleEncodedValues createVehicleEncodedValues(String name, PMap configu
         if (name.equals(BIKE))
             return VehicleEncodedValues.bike(configuration);
 
-        if (name.equals("bike2"))
-            throw new IllegalArgumentException("Instead of bike2 use the bike vehicle and a custom model, see custom_models/bike2.json and #1234");
+        if (name.equals(BIKE2))
+            return VehicleEncodedValues.bike2(configuration);
 
         if (name.equals(RACINGBIKE))
             return VehicleEncodedValues.racingbike(configuration);

core/src/main/java/com/graphhopper/routing/util/DefaultVehicleTagParserFactory.java

@@ -31,6 +31,8 @@ public VehicleTagParser createParser(EncodedValueLookup lookup, String name, PMa
             return new CarTagParser(lookup, configuration);
         if (name.equals(BIKE))
             return new BikeTagParser(lookup, configuration);
+        if (name.equals(BIKE2))
+            return new Bike2WeightTagParser(lookup, configuration);
         if (name.equals(RACINGBIKE))
             return new RacingBikeTagParser(lookup, configuration);
         if (name.equals(MOUNTAINBIKE))

core/src/main/java/com/graphhopper/routing/util/SlopeCalculator.java

@@ -23,7 +23,7 @@ public IntsRef handleWayTags(IntsRef edgeFlags, ReaderWay way, IntsRef relationF
         PointList pointList = way.getTag("point_list", null);
         if (pointList != null) {
             if (pointList.isEmpty() || !pointList.is3D()) {
-                averageSlopeEnc.setDecimal(false, edgeFlags, 0);
+                if (averageSlopeEnc != null) averageSlopeEnc.setDecimal(false, edgeFlags, 0);
                 return edgeFlags;
             }
             // Calculate 2d distance, although pointList might be 3D.
@@ -32,20 +32,20 @@ public IntsRef handleWayTags(IntsRef edgeFlags, ReaderWay way, IntsRef relationF
 
             if (distance2D < MIN_LENGTH) {
                 // default is minimum of average_slope is negative so we have to explicitly set it to 0
-                averageSlopeEnc.setDecimal(false, edgeFlags, 0);
+                if (averageSlopeEnc != null) averageSlopeEnc.setDecimal(false, edgeFlags, 0);
                 return edgeFlags;
             }
 
             double towerNodeSlope = calcSlope(pointList.getEle(pointList.size() - 1) - pointList.getEle(0), distance2D);
             if (Double.isNaN(towerNodeSlope))
                 throw new IllegalArgumentException("average_slope was NaN for OSM way ID " + way.getId());
 
-
-            if (towerNodeSlope >= 0)
-                averageSlopeEnc.setDecimal(false, edgeFlags, Math.min(towerNodeSlope, averageSlopeEnc.getMaxStorableDecimal()));
-            else
-                averageSlopeEnc.setDecimal(true, edgeFlags, Math.min(Math.abs(towerNodeSlope), averageSlopeEnc.getMaxStorableDecimal()));
-
+            if (averageSlopeEnc != null) {
+                if (towerNodeSlope >= 0)
+                    averageSlopeEnc.setDecimal(false, edgeFlags, Math.min(towerNodeSlope, averageSlopeEnc.getMaxStorableDecimal()));
+                else
+                    averageSlopeEnc.setDecimal(true, edgeFlags, Math.min(Math.abs(towerNodeSlope), averageSlopeEnc.getMaxStorableDecimal()));
+            }
 
             // max_slope is more error-prone as the shorter distances increase the fluctuation
             // so apply some more filtering (here we use the average elevation delta of the previous two points)
@@ -74,7 +74,8 @@ public IntsRef handleWayTags(IntsRef edgeFlags, ReaderWay way, IntsRef relationF
 
             // TODO Use two independent values for both directions to store if it is a gain or loss and not just the absolute change.
             // TODO To save space then it would be nice to have an encoded value that can store two different values which are swapped when the reverse direction is used
-            maxSlopeEnc.setDecimal(false, edgeFlags, Math.min(maxSlope, maxSlopeEnc.getMaxStorableDecimal()));
+            if (maxSlopeEnc != null)
+                maxSlopeEnc.setDecimal(false, edgeFlags, Math.min(maxSlope, maxSlopeEnc.getMaxStorableDecimal()));
         }
         return edgeFlags;
     }

core/src/main/java/com/graphhopper/routing/util/VehicleEncodedValues.java

@@ -27,7 +27,7 @@
 import static com.graphhopper.routing.util.VehicleEncodedValuesFactory.*;
 
 public class VehicleEncodedValues {
-    public static final List<String> OUTDOOR_VEHICLES = Arrays.asList(BIKE, RACINGBIKE, MOUNTAINBIKE, FOOT, HIKE, WHEELCHAIR);
+    public static final List<String> OUTDOOR_VEHICLES = Arrays.asList(BIKE, BIKE2, RACINGBIKE, MOUNTAINBIKE, FOOT, HIKE, WHEELCHAIR);
 
     private final String name;
     private final BooleanEncodedValue accessEnc;

core/src/main/java/com/graphhopper/routing/util/VehicleEncodedValuesFactory.java

@@ -26,6 +26,7 @@ public interface VehicleEncodedValuesFactory {
     String ROADS = "roads";
     String CAR = "car";
     String BIKE = "bike";
+    String BIKE2 = "bike2";
     String RACINGBIKE = "racingbike";
     String MOUNTAINBIKE = "mtb";
     String FOOT = "foot";

core/src/test/java/com/graphhopper/routing/RoutingAlgorithmWithOSMTest.java

@@ -41,8 +41,6 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.Function;
 
-import static com.graphhopper.json.Statement.Op.LIMIT;
-import static com.graphhopper.json.Statement.Op.MULTIPLY;
 import static com.graphhopper.util.Parameters.Algorithms.*;
 import static org.junit.jupiter.api.Assertions.*;
 
@@ -130,7 +128,7 @@ public void testMonacoMotorcycleCurvature() {
         queries.add(new Query(43.733802, 7.413433, 43.739662, 7.424355, 2423, 141));
         queries.add(new Query(43.730949, 7.412338, 43.739643, 7.424542, 2253, 120));
         queries.add(new Query(43.727592, 7.419333, 43.727712, 7.419333, 0, 1));
-        CustomModel model = new CustomModel().addToPriority(Statement.If("true", MULTIPLY, "curvature"));
+        CustomModel model = new CustomModel().addToPriority(Statement.If("true", Statement.Op.MULTIPLY, "curvature"));
 
         GraphHopper hopper = createHopper(MONACO, new CustomProfile("motorcycle").setCustomModel(model).
                 setVehicle("motorcycle").setWeighting("custom"));
@@ -146,9 +144,8 @@ public void testBike2_issue432() {
         queries.add(new Query(52.349969, 8.013813, 52.349713, 8.013293, 56, 7));
         // reverse route avoids the location
 //        list.add(new OneRun(52.349713, 8.013293, 52.349969, 8.013813, 293, 21));
-        CustomModel model = new CustomModel();
         GraphHopper hopper = createHopper(DIR + "/map-bug432.osm.gz",
-                new CustomProfile("bike2").setCustomModel(model).setVehicle("bike").setWeighting("custom"));
+                new Profile("bike2").setVehicle("bike2").setWeighting("fastest"));
         hopper.setElevationProvider(new SRTMProvider(DIR));
         hopper.importOrLoad();
         checkQueries(hopper, queries);
@@ -325,31 +322,25 @@ public void testNorthBayreuthHikeFastestAnd3D() {
     }
 
     @Test
-    public void testMonacoBike3D() {
+    public void testMonacoBike3D_twoSpeedsPerEdge() {
         List<Query> queries = new ArrayList<>();
         // 1. alternative: go over steps 'Rampe Major' => 1.7km vs. around 2.7km
-        queries.add(new Query(43.730864, 7.420771, 43.727687, 7.418737, 1999, 101));
+        queries.add(new Query(43.730864, 7.420771, 43.727687, 7.418737, 2689, 118));
         // 2.
-        queries.add(new Query(43.728499, 7.417907, 43.74958, 7.436566, 3939, 187));
+        queries.add(new Query(43.728499, 7.417907, 43.74958, 7.436566, 3735, 194));
         // 3.
-        queries.add(new Query(43.728677, 7.41016, 43.739213, 7.427806, 2776, 163));
+        queries.add(new Query(43.728677, 7.41016, 43.739213, 7.427806, 2776, 167));
         // 4.
         queries.add(new Query(43.733802, 7.413433, 43.739662, 7.424355, 1544, 84));
 
         // try reverse direction
         // 1.
         queries.add(new Query(43.727687, 7.418737, 43.730864, 7.420771, 2599, 115));
-        queries.add(new Query(43.74958, 7.436566, 43.728499, 7.417907, 3902, 199));
-        queries.add(new Query(43.739213, 7.427806, 43.728677, 7.41016, 2870, 154));
+        queries.add(new Query(43.74958, 7.436566, 43.728499, 7.417907, 4180, 165));
+        queries.add(new Query(43.739213, 7.427806, 43.728677, 7.41016, 2805, 145));
         // 4. avoid tunnel(s)!
-        queries.add(new Query(43.739662, 7.424355, 43.733802, 7.413433, 1795, 96));
-        CustomModel model = new CustomModel();
-        model.addToSpeed(Statement.If("average_slope >= 10", LIMIT, "4")).
-                addToSpeed(Statement.If("average_slope >= 5", MULTIPLY, "0.45")).
-                addToSpeed(Statement.If("average_slope >= 3.5", MULTIPLY, "0.7")).
-                addToSpeed(Statement.If("average_slope >= 2", MULTIPLY, "0.9")).
-                addToSpeed(Statement.If("average_slope < -5", MULTIPLY, "1.25"));
-        GraphHopper hopper = createHopper(MONACO, new CustomProfile("bike2").setCustomModel(model).setVehicle("bike").setWeighting("custom"));
+        queries.add(new Query(43.739662, 7.424355, 43.733802, 7.413433, 2436, 112));
+        GraphHopper hopper = createHopper(MONACO, new Profile("bike2").setVehicle("bike2").setWeighting("fastest"));
         hopper.setElevationProvider(new SRTMProvider(DIR));
         hopper.importOrLoad();
         checkQueries(hopper, queries);
@@ -580,8 +571,7 @@ public void testNeudrossenfeld() {
 
         Helper.removeDir(new File(GH_LOCATION));
 
-        CustomModel model = new CustomModel();
-        hopper = createHopper(BAYREUTH, new CustomProfile("bike2").setCustomModel(model).setVehicle("bike").setWeighting("custom"));
+        hopper = createHopper(BAYREUTH, new Profile("bike2").setVehicle("bike2").setWeighting("fastest"));
         hopper.setElevationProvider(new SRTMProvider(DIR));
         hopper.importOrLoad();
         checkQueries(hopper, list);
@@ -696,7 +686,6 @@ private GraphHopper createHopper(String osmFile, Profile... profiles) {
                 setStoreOnFlush(true).
                 setOSMFile(osmFile).
                 setProfiles(profiles).
-                setEncodedValuesString("average_slope,max_slope").
                 setGraphHopperLocation(GH_LOCATION);
         hopper.getRouterConfig().setSimplifyResponse(false);
         hopper.setMinNetworkSize(0);