core: add compulsory EnvelopeProfile attribute to EnvelopePart

Author: Erashin

core/envelope-sim/src/main/java/fr/sncf/osrd/envelope/EnvelopeSpeedCap.java

@@ -1,22 +1,27 @@
 package fr.sncf.osrd.envelope;
 
 import fr.sncf.osrd.envelope.part.EnvelopePartBuilder;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import fr.sncf.osrd.envelope_utils.CmpOperator;
+import java.util.Collection;
+import java.util.HashSet;
 
 public class EnvelopeSpeedCap {
     /** Adds a global speed limit to an envelope */
     public static Envelope from(
             Envelope base,
-            Iterable<EnvelopeAttr> attrs,
+            Collection<EnvelopeAttr> attrs,
             double speedLimit
     ) {
         var cursor = new EnvelopeCursor(base, false);
         var builder = OverlayEnvelopeBuilder.forward(base);
+        var envelopeAttrs = new HashSet<>(attrs);
+        envelopeAttrs.add(EnvelopeProfile.CONSTANT_SPEED);
         while (cursor.findSpeed(speedLimit, CmpOperator.STRICTLY_HIGHER)) {
             var startPos = cursor.getPosition();
 
             var partBuilder = new EnvelopePartBuilder();
-            partBuilder.setAttrs(attrs);
+            partBuilder.setAttrs(envelopeAttrs);
             partBuilder.initEnvelopePart(startPos, speedLimit, 1);
 
             var hasNotReachedEnd = cursor.findSpeed(speedLimit, CmpOperator.STRICTLY_LOWER);

core/envelope-sim/src/main/java/fr/sncf/osrd/envelope/part/EnvelopePart.java

@@ -1,12 +1,14 @@
 package fr.sncf.osrd.envelope.part;
 
 import static fr.sncf.osrd.envelope.EnvelopePhysics.intersectStepWithSpeed;
+import static fr.sncf.osrd.envelope_sim.TrainPhysicsIntegrator.areSpeedsEqual;
 
 import com.carrotsearch.hppc.DoubleArrayList;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import fr.sncf.osrd.envelope.EnvelopeAttr;
 import fr.sncf.osrd.envelope.EnvelopePhysics;
 import fr.sncf.osrd.envelope.SearchableEnvelope;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import fr.sncf.osrd.envelope_utils.ExcludeFromGeneratedCodeCoverage;
 import java.util.Arrays;
 import java.util.Collections;
@@ -111,11 +113,16 @@ public static EnvelopePart generateTimes(
             double[] positions,
             double[] speeds
     ) {
-        return new EnvelopePart(
-                new HashMap<>(),
+        var envelopeProfile = EnvelopeProfile.BRAKING;
+        if (areSpeedsEqual(speeds[0], speeds[speeds.length - 1])) {
+            envelopeProfile = EnvelopeProfile.CONSTANT_SPEED;
+        } else if (speeds[0] < speeds[speeds.length - 1]) {
+            envelopeProfile = EnvelopeProfile.ACCELERATING;
+        }
+        return generateTimes(
+                Collections.singleton(envelopeProfile),
                 positions,
-                speeds,
-                computeTimes(positions, speeds)
+                speeds
         );
     }
 
@@ -165,6 +172,7 @@ public Map<Class<? extends EnvelopeAttr>, EnvelopeAttr> getAttrs() {
      * (which should be avoided when possible) */
     private void runSanityChecks() {
         assert attrs != null : "missing attributes";
+        assert hasAttr(EnvelopeProfile.class) : "missing EnvelopeProfile attribute";
         assert positions.length > 0 : "attempted to create an empty EnvelopePart";
         assert positions.length == speeds.length : "there must be the same number of point and speeds";
         assert timeDeltas.length == positions.length - 1 : "there must be as many timeDeltas as gaps between points";

core/envelope-sim/src/main/java/fr/sncf/osrd/envelope_sim/allowances/AbstractAllowanceWithRanges.java

@@ -14,6 +14,7 @@
 import fr.sncf.osrd.envelope.part.constraints.EnvelopeConstraint;
 import fr.sncf.osrd.envelope.part.constraints.EnvelopePartConstraint;
 import fr.sncf.osrd.envelope.part.constraints.PositionConstraint;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import fr.sncf.osrd.envelope_sim.EnvelopeSimContext;
 import fr.sncf.osrd.envelope_sim.PhysicsRollingStock;
 import fr.sncf.osrd.envelope_sim.allowances.utils.AllowanceRange;
@@ -157,7 +158,7 @@ private Envelope[] computeAllowanceRegion(Envelope envelopeRegion, EnvelopeSimCo
             var range = ranges.get(i);
             var percentage = range.value.getAllowanceRatio(
                     envelopeRegion.getTimeBetween(range.beginPos, range.endPos),
-                    range.beginPos - range.endPos
+                    range.endPos - range.beginPos
             );
             rangePercentages[i] = new RangePercentage(range, percentage);
         }
@@ -401,6 +402,7 @@ private EnvelopePart computeLeftJunction(Envelope envelopeSection,
             EnvelopeDeceleration.decelerate(
                     context, envelopeSection.getBeginPos(), imposedBeginSpeed, constrainedBuilder, 1
             );
+            partBuilder.setAttr(EnvelopeProfile.BRAKING);
             lastIntersection = constrainedBuilder.lastIntersection;
         } else if (imposedBeginSpeed < envelopeSection.getBeginSpeed()) {
             constraints.add(new EnvelopeConstraint(envelopeTarget, CEILING));
@@ -412,6 +414,7 @@ private EnvelopePart computeLeftJunction(Envelope envelopeSection,
             EnvelopeAcceleration.accelerate(
                     context, envelopeSection.getBeginPos(), imposedBeginSpeed, constrainedBuilder, 1
             );
+            partBuilder.setAttr(EnvelopeProfile.ACCELERATING);
             lastIntersection = constrainedBuilder.lastIntersection;
         }
         if (lastIntersection == 0) {
@@ -449,6 +452,7 @@ private EnvelopePart computeRightJunction(Envelope envelopeSection,
             EnvelopeAcceleration.accelerate(
                     context, envelopeSection.getEndPos(), imposedEndSpeed, constrainedBuilder, -1
             );
+            partBuilder.setAttr(EnvelopeProfile.ACCELERATING);
             lastIntersection = constrainedBuilder.lastIntersection;
         } else if (imposedEndSpeed < envelopeSection.getEndSpeed()) {
             constraints.add(new EnvelopeConstraint(envelopeTarget, CEILING));
@@ -459,6 +463,7 @@ private EnvelopePart computeRightJunction(Envelope envelopeSection,
             EnvelopeDeceleration.decelerate(
                     context, envelopeSection.getEndPos(), imposedEndSpeed, constrainedBuilder, -1
             );
+            partBuilder.setAttr(EnvelopeProfile.BRAKING);
             lastIntersection = constrainedBuilder.lastIntersection;
         }
         if (lastIntersection == 0) {

core/envelope-sim/src/main/java/fr/sncf/osrd/envelope_sim/allowances/mareco_impl/CoastingGenerator.java

@@ -52,6 +52,7 @@ public static EnvelopePart coastFromEnd(
 
         // coast backwards from the end position until the base curve is met
         var backwardPartBuilder = new EnvelopePartBuilder();
+        backwardPartBuilder.setAttr(EnvelopeProfile.COASTING);
         var constrainedBuilder = new ConstrainedEnvelopePartBuilder(
                 backwardPartBuilder,
                 new SpeedConstraint(0, FLOOR),

core/envelope-sim/src/test/java/fr/sncf/osrd/envelope/ConstraintBuilderTest.java

@@ -11,6 +11,7 @@
 import fr.sncf.osrd.envelope.part.constraints.EnvelopeConstraint;
 import fr.sncf.osrd.envelope.part.constraints.PositionConstraint;
 import fr.sncf.osrd.envelope.part.constraints.SpeedConstraint;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import org.junit.jupiter.api.Test;
 import java.util.List;
 
@@ -28,12 +29,10 @@ public class ConstraintBuilderTest {
 
     private ConstrainedEnvelopePartBuilder wrap(EnvelopePartConsumer sink) {
         var envelopeFloor = Envelope.make(EnvelopePart.generateTimes(
-                List.of(),
                 new double[] {0, 3, 4, 5, 6, 7, 10},
                 new double[] {0, 0, 1, 2, 1, 0, 0}
         ));
         var envelopeCeiling = Envelope.make(EnvelopePart.generateTimes(
-                List.of(),
                 new double[] {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10},
                 new double[] {2, 3, 4, 5, 6, 7, 6, 5, 4, 3, 2}
         ));
@@ -53,6 +52,7 @@ void testAttrs() {
         var builder = wrap(partBuilder);
         builder.setAttrs(List.of(TestAttr.A));
         builder.setAttr(TestAttr.B);
+        builder.setAttr(EnvelopeProfile.ACCELERATING);
         assertTrue(builder.initEnvelopePart(2, 0, 1));
         assertFalse(builder.addStep(5, 1));
         var part = partBuilder.build();

core/envelope-sim/src/test/java/fr/sncf/osrd/envelope/EnvelopeOverlayTest.java

@@ -8,6 +8,7 @@
 import fr.sncf.osrd.envelope.part.EnvelopePart;
 import fr.sncf.osrd.envelope.part.EnvelopePartBuilder;
 import fr.sncf.osrd.envelope.part.constraints.EnvelopeConstraint;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
@@ -66,6 +67,7 @@ void testConstantSpeedOverlay() {
         var builder = OverlayEnvelopeBuilder.forward(constSpeedEnvelope);
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.COASTING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder, new EnvelopeConstraint(constSpeedEnvelope, CEILING));
             overlayBuilder.initEnvelopePart(3, constSpeedEnvelope.interpolateSpeed(3), 1);
@@ -94,6 +96,7 @@ void testMultipleOverlays() {
 
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.COASTING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder, new EnvelopeConstraint(constSpeedEnvelope, CEILING));
             overlayBuilder.initEnvelopePart(0, constSpeedEnvelope.interpolateSpeed(0), 1);
@@ -104,6 +107,7 @@ void testMultipleOverlays() {
 
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.COASTING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder, new EnvelopeConstraint(constSpeedEnvelope, CEILING));
             overlayBuilder.initEnvelopePart(6, constSpeedEnvelope.interpolateSpeed(6), 1);
@@ -123,7 +127,7 @@ void testMultipleOverlays() {
     @ValueSource(booleans = {false, true})
     void testSymmetricOverlay(boolean backwardDir) {
         var constSpeedPart = EnvelopePart.generateTimes(
-                List.of(TestAttr.B),
+                List.of(TestAttr.B, EnvelopeProfile.CONSTANT_SPEED),
                 new double[]{0, 3.5, 8},
                 new double[]{2, 2, 2}
         );
@@ -134,6 +138,7 @@ void testSymmetricOverlay(boolean backwardDir) {
         {
             var partBuilder = new EnvelopePartBuilder();
             partBuilder.setAttr(TestAttr.A);
+            partBuilder.setAttr(EnvelopeProfile.COASTING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder, new EnvelopeConstraint(constSpeedEnvelope, CEILING));
             overlayBuilder.initEnvelopePart(overlayPoints[0], 2, backwardDir ? -1 : 1);
@@ -149,7 +154,7 @@ void testSymmetricOverlay(boolean backwardDir) {
         var expectedFirst = constSpeedPart.sliceBeginning(constSpeedPart.findLeft(3), 3, Double.NaN);
         EnvelopeTestUtils.assertEquals(expectedFirst, envelope.get(0));
         var expectedMid = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.COASTING),
                 new double[]{3, 4, 5},
                 new double[]{2, 1, 2}
         );
@@ -190,7 +195,8 @@ void testBaseCurveSplit(boolean isBackward) {
         var cursor = new EnvelopeCursor(baseEnvelope, isBackward);
         var positions = new double[] { 3, 4, 6 };
         var speeds = new double[] { 4, 3, 4 };
-        builder.addPart(EnvelopeTestUtils.buildContinuous(cursor, List.of(), positions, speeds, isBackward));
+        builder.addPart(EnvelopeTestUtils.buildContinuous(cursor, List.of(EnvelopeProfile.COASTING), positions, speeds,
+                isBackward));
         var envelope = builder.build();
         assertEquals(4, envelope.size());
         assertTrue(envelope.continuous);
@@ -233,6 +239,7 @@ void testDiscontinuityOverlayEnd() {
 
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.BRAKING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder,
                     new EnvelopeConstraint(baseEnvelope, CEILING)
@@ -279,7 +286,8 @@ void testLongOverlay(boolean reverse) {
         var cursor = new EnvelopeCursor(baseEnvelope, reverse);
         var positions = new double[] { 3, 4, 5, 6 };
         var speeds = new double[] { 4, 3, 3, 4 };
-        builder.addPart(EnvelopeTestUtils.buildContinuous(cursor, List.of(), positions, speeds, reverse));
+        builder.addPart(EnvelopeTestUtils.buildContinuous(cursor, List.of(EnvelopeProfile.COASTING), positions, speeds,
+                reverse));
         var envelope = builder.build();
         assertEquals(4, envelope.size());
         assertTrue(envelope.continuous);
@@ -296,6 +304,7 @@ void testUnlikelyIntersection() {
 
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.COASTING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder,
                     new EnvelopeConstraint(inputEnvelope, CEILING)
@@ -322,6 +331,7 @@ void testIncreasingContinuousOverlay() {
 
         {
             var partBuilder = new EnvelopePartBuilder();
+            partBuilder.setAttr(EnvelopeProfile.ACCELERATING);
             var overlayBuilder = new ConstrainedEnvelopePartBuilder(
                     partBuilder,
                     new EnvelopeConstraint(inputEnvelope, CEILING)

core/envelope-sim/src/test/java/fr/sncf/osrd/envelope/EnvelopePartSliceTest.java

@@ -6,6 +6,7 @@
 
 import fr.sncf.osrd.envelope.EnvelopeTestUtils.TestAttr;
 import fr.sncf.osrd.envelope.part.EnvelopePart;
+import fr.sncf.osrd.envelope_sim.EnvelopeProfile;
 import org.junit.jupiter.api.Test;
 import java.util.List;
 
@@ -14,12 +15,12 @@ public class EnvelopePartSliceTest {
     @Test
     void sliceIndex() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3, 5},
                 new double[] {3, 4, 4}
         );
         var ep2 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3},
                 new double[] {3, 4}
         );
@@ -31,7 +32,7 @@ void sliceIndex() {
     @Test
     void sliceIndexFull() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3, 5},
                 new double[] {3, 3, 4}
         );
@@ -43,7 +44,7 @@ void sliceIndexFull() {
     @Test
     void sliceIndexEmpty() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3, 5},
                 new double[] {3, 3, 4}
         );
@@ -54,7 +55,7 @@ void sliceIndexEmpty() {
     @Test
     void sliceOffsetEmpty() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3, 5},
                 new double[] {3, 3, 4}
         );
@@ -65,7 +66,7 @@ void sliceOffsetEmpty() {
     @Test
     void sliceOffsetFull() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1.5, 3, 5},
                 new double[] {3, 3, 4}
         );
@@ -76,13 +77,13 @@ void sliceOffsetFull() {
     @Test
     void sliceOffsetInterpolate() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.BRAKING),
                 new double[] {0, 3},
                 new double[] {3.46, 0}
         );
         var slice = ep1.slice(Double.NEGATIVE_INFINITY, 2);
         var expectedSlice = new EnvelopePart(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.BRAKING),
                 new double[] {0, 2},
                 new double[] {3.46, 2},
                 new double[] {0.73}
@@ -93,13 +94,13 @@ void sliceOffsetInterpolate() {
     @Test
     void sliceWithImposedSpeeds() {
         var ep1 = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {1, 3, 5},
                 new double[] {3, 3, 4}
         );
         var slice = ep1.sliceWithSpeeds(2, 3, 4, 3.5);
         var expectedSlice = EnvelopePart.generateTimes(
-                List.of(TestAttr.A),
+                List.of(TestAttr.A, EnvelopeProfile.ACCELERATING),
                 new double[] {2, 3, 4},
                 new double[] {3, 3, 3.5}
         );