Rename functions

Signed-off-by: NathanDissoubray <nathan.dissoubray@rte-france.com>

Author: NathanDissoubray

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/Spring.java

@@ -14,6 +14,7 @@
 import java.util.Locale;
 import java.util.Objects;
 
+// TODO if we remove the getSprings inside ForceLayout, we can remove this class
 /**
  * @author Mathilde Grapin {@literal <mathilde.grapin at rte-france.com>}
  */

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/forces/CoulombForce.java

@@ -44,7 +44,7 @@ private void coulombBetweenPoints(Vector2D resultingForce, Point correspondingPo
         double magnitude = force.magnitude();
         // 0.5 because we assume both points are moving, so each does half of the movement
         double intensity = forceParameter.getForceIntensity() / (magnitude * magnitude * magnitude * 0.5 + 0.1 * magnitude);
-        force.multiply(intensity);
+        force.multiplyBy(intensity);
         resultingForce.add(force);
     }
 }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/forces/GravityForceByEdgeNumber.java

@@ -29,7 +29,7 @@ public Vector2D calculateForce(V forThisVertex, Point correspondingPoint, ForceG
         // this means less connected points will end more on the sides of the graph
         double magnitude = forceParameter.getForceIntensity() * (forceGraph.getSimpleGraph().degreeOf(forThisVertex) + 1);
         Vector2D force = Vector2D.calculateUnitVector(correspondingPoint, forceGraph.getOrigin());
-        force.multiply(magnitude);
+        force.multiplyBy(magnitude);
         return force;
     }
 }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/forces/GravityForceLinear.java

@@ -28,7 +28,7 @@ public Vector2D calculateForce(V forThisVertex, Point correspondingPoint, ForceG
         // it means that nodes will generally not get further than a certain distance from the center, instead of leaving room to other nodes for expanding
         // that makes graphs more compact, but it could also cause issues with big graphs, where it would be too compact
         Vector2D force = Vector2D.calculateVectorBetweenPoints(correspondingPoint, forceGraph.getOrigin());
-        force.multiply(forceParameter.getForceIntensity());
+        force.multiplyBy(forceParameter.getForceIntensity());
         return force;
     }
 }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/forces/GravityForceUnit.java

@@ -24,7 +24,7 @@ public GravityForceUnit(IntensityParameter forceParameter) {
     @Override
     public Vector2D calculateForce(V forThisVertex, Point correspondingPoint, ForceGraph<V, E> forceGraph) {
         Vector2D force = Vector2D.calculateUnitVector(correspondingPoint, forceGraph.getOrigin());
-        force.multiply(forceParameter.getForceIntensity());
+        force.multiplyBy(forceParameter.getForceIntensity());
         return force;
     }
 }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/forces/SpringForce.java

@@ -48,7 +48,7 @@ public Vector2D calculateForce(V forThisVertex, Point correspondingPoint, ForceG
 
             // multiply by 0.5 because each vertex will move half of the distance, assuming both are free
             // should this be different if the other point is not moving ?
-            force.multiply(spring.getStiffness() * displacement * 0.5);
+            force.multiplyBy(spring.getStiffness() * displacement * 0.5);
             // might be good to have a method to do this in place instead of creating new Vector2D each time
             resultingForce.add(force);
         }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/geometry/Vector2D.java

@@ -46,12 +46,12 @@ public void subtract(Vector2D otherVector) {
         this.y -= otherVector.y;
     }
 
-    public void multiply(double scalar) {
+    public void multiplyBy(double scalar) {
         this.x *= scalar;
         this.y *= scalar;
     }
 
-    public void divide(double scalar) {
+    public void divideBy(double scalar) {
         this.x /= scalar;
         this.y /= scalar;
     }
@@ -65,7 +65,7 @@ public double magnitudeSquare() {
     }
 
     public void normalize() {
-        this.divide(this.magnitude());
+        this.divideBy(this.magnitude());
     }
 
     public static Vector2D calculateVectorBetweenPoints(Point from, Point towards) {

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/layouts/SpringyLayout.java

@@ -103,12 +103,12 @@ public void calculateLayout(ForceGraph<V, E> forceGraph) {
     private void updateVelocity(ForceGraph<V, E> forceGraph) {
         for (Point point : forceGraph.getMovingPoints().values()) {
             Vector2D newVelocity = new Vector2D(point.getForces());
-            newVelocity.multiply((1 - Math.exp(-layoutParameters.getDeltaTime() * layoutParameters.getFriction() / point.getMass())) / layoutParameters.getFriction());
+            newVelocity.multiplyBy((1 - Math.exp(-layoutParameters.getDeltaTime() * layoutParameters.getFriction() / point.getMass())) / layoutParameters.getFriction());
             point.setVelocity(newVelocity);
 
             if (newVelocity.magnitude() > layoutParameters.getMaxSpeed()) {
                 newVelocity.normalize();
-                newVelocity.multiply(layoutParameters.getMaxSpeed());
+                newVelocity.multiplyBy(layoutParameters.getMaxSpeed());
             }
 
             point.resetForces();
@@ -119,7 +119,7 @@ private void updatePosition(ForceGraph<V, E> forceGraph) {
         // Here we only update the position for the nodes that do not have fixed positions
         for (Point point : forceGraph.getMovingPoints().values()) {
             Vector2D speed = new Vector2D(point.getVelocity());
-            speed.multiply(layoutParameters.getDeltaTime());
+            speed.multiplyBy(layoutParameters.getDeltaTime());
             point.getPosition().add(speed);
         }
     }

diagram-util/src/main/java/com/powsybl/diagram/util/forcelayout/setup/SpringySetup.java

@@ -31,7 +31,7 @@ public void setup(ForceGraph<V, E> forceGraph) {
             forceGraph.getInitialPoints().values().stream()
                     .map(Point::getPosition)
                     .forEach(initialPointsCenter::add);
-            initialPointsCenter.divide(forceGraph.getInitialPoints().size());
+            initialPointsCenter.divideBy(forceGraph.getInitialPoints().size());
         }
         forceGraph.setCenter(initialPointsCenter);
 

diagram-util/src/test/java/com/powsybl/diagram/util/forcelayout/geometry/Vector2DTest.java

@@ -29,13 +29,13 @@ void test() {
         assertEquals(0.44, vector.getX(), 0.01);
         assertEquals(0.89, vector.getY(), 0.01);
 
-        vector.divide(2.0);
+        vector.divideBy(2.0);
         assertEquals(0.49, vector.magnitude(), 0.01);
         assertEquals(0.24, vector.magnitudeSquare(), 0.01);
         assertEquals(0.22, vector.getX(), 0.01);
         assertEquals(0.44, vector.getY(), 0.01);
 
-        vector.multiply(2.0);
+        vector.multiplyBy(2.0);
         assertEquals(1.0, vector.magnitude(), 0.1);
         assertEquals(1.0, vector.magnitudeSquare(), 0.1);
         assertEquals(0.44, vector.getX(), 0.01);