Changeset 17730

Timestamp:

08/27/20 12:06:16 (4 years ago)

Author:

dpiringe

Message:

#3081

• renamed method Calculate -> Apply
• copied/added comments of the method Modify -> Apply

Location:

trunk/HeuristicLab.Optimization.Operators/3.3

Files:

• ExponentialDiscreteDoubleValueModifier.cs (modified) (2 diffs)
• GeneralizedExponentialDiscreteDoubleValueModifier.cs (modified) (2 diffs)
• LinearDiscreteDoubleValueModifier.cs (modified) (1 diff)
• QuadraticDiscreteDoubleValueModifier.cs (modified) (1 diff)
• SquareRootDiscreteDoubleValueModifier.cs (modified) (1 diff)

trunk/HeuristicLab.Optimization.Operators/3.3/ExponentialDiscreteDoubleValueModifier.cs

@@ -43 +43 @@
     }
 
+    
+    protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+      return Apply(value, startValue, endValue, index, startIndex, endIndex);
+    }
+
     /// <summary>
     /// Calculates a new value based on exponential decay or growth.
@@ -54 +59 @@
     /// <param name="endIndex">The end index.</param>
     /// <returns>The new value.</returns>
-    protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
-      return Calculate(value, startValue, endValue, index, startIndex, endIndex);
-    }
-
-    public static double Calculate(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+    public static double Apply(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
       if (endValue <= 0 || startValue <= 0) throw new ArgumentException("startValue and endValue must be greater than 0.");
       double b = Math.Pow(endValue / startValue, 1.0 / (endIndex - startIndex));

trunk/HeuristicLab.Optimization.Operators/3.3/GeneralizedExponentialDiscreteDoubleValueModifier.cs

@@ -58 +58 @@
     }
 
+    protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+      return Apply(value, startValue, endValue, index, startIndex, endIndex, Base);
+    }
+
     /// <summary>
     /// Calculates a new value based on exponential decay or growth.
@@ -69 +73 @@
     /// <param name="endIndex">The final index.</param>
     /// <returns>The new value.</returns>
-    protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
-      return Calculate(value, startValue, endValue, index, startIndex, endIndex, Base);
-    }
-
-    public static double Calculate(double value, double startValue, double endValue, int index, int startIndex, int endIndex, double @base) {
+    public static double Apply(double value, double startValue, double endValue, int index, int startIndex, int endIndex, double @base) {
       if (@base <= 0)
         throw new ArgumentException("Base must be > 0.");

trunk/HeuristicLab.Optimization.Operators/3.3/LinearDiscreteDoubleValueModifier.cs

@@ -41 +41 @@
 
     protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
-      return Calculate(value, startValue, endValue, index, startIndex, endIndex);
+      return Apply(value, startValue, endValue, index, startIndex, endIndex);
     }
 
-    public static double Calculate(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+    /// <summary>
+    /// Calculates a new value based on linear decay or growth.
+    /// </summary>
+    /// <param name="value">The previous value.</param>
+    /// <param name="startValue">The initial value.</param>
+    /// <param name="endValue">The final value.</param>
+    /// <param name="index">The current index.</param>
+    /// <param name="startIndex">The initial index.</param>
+    /// <param name="endIndex">The final index.</param>
+    /// <returns>The new value.</returns>
+    public static double Apply(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
       double k = (endValue - startValue) / (endIndex - startIndex);
       double x = index - startIndex;

trunk/HeuristicLab.Optimization.Operators/3.3/QuadraticDiscreteDoubleValueModifier.cs

@@ -41 +41 @@
 
     protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
-      return Calculate(value, startValue, endValue, index, startIndex, endIndex);
+      return Apply(value, startValue, endValue, index, startIndex, endIndex);
     }
 
-    public static double Calculate(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+    /// <summary>
+    /// Calculates a new value based on quadratic decay or growth.
+    /// </summary>
+    /// <param name="value">The previous value.</param>
+    /// <param name="startValue">The initial value.</param>
+    /// <param name="endValue">The final value.</param>
+    /// <param name="index">The current index.</param>
+    /// <param name="startIndex">The initial index.</param>
+    /// <param name="endIndex">The final index.</param>
+    /// <returns>The new value.</returns>
+    public static double Apply(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
       double a = (endValue - startValue) / ((endIndex - startIndex) * (endIndex - startIndex));
       return a * (index - startIndex) * (index - startIndex) + startValue;

trunk/HeuristicLab.Optimization.Operators/3.3/SquareRootDiscreteDoubleValueModifier.cs

@@ -42 +42 @@
 
     protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
-      return Calculate(value, startValue, endValue, index, startIndex, endIndex);
+      return Apply(value, startValue, endValue, index, startIndex, endIndex);
     }
 
-    public static double Calculate(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
+    /// <summary>
+    /// Calculates a new value based on sqrt decay or growth.
+    /// </summary>
+    /// <param name="value">The previous value.</param>
+    /// <param name="startValue">The initial value.</param>
+    /// <param name="endValue">The final value.</param>
+    /// <param name="index">The current index.</param>
+    /// <param name="startIndex">The initial index.</param>
+    /// <param name="endIndex">The final index.</param>
+    /// <returns>The new value.</returns>
+    public static double Apply(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
       double a = (endValue - startValue) / Math.Sqrt(endIndex - startIndex);
       return a * Math.Sqrt(index - startIndex) + startValue;