Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceReintegration/HeuristicLab.Optimization.Operators/3.3/ExponentialDiscreteDoubleValueModifier.cs @ 14927

Last change on this file since 14927 was 14927, checked in by gkronber, 7 years ago

#2520: changed all usages of StorableClass to use StorableType with an auto-generated GUID (did not add StorableType to other type definitions yet)

File size: 3.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Persistence;
26
27namespace HeuristicLab.Optimization.Operators {
28  /// <summary>
29  /// Modifies the value by exponential fall (steep fall initially, slow fall to the end) or rise (slow rise initially, fast rise to the end).
30  /// </summary>
31  [Item("ExponentialDiscreteDoubleValueModifier",
32@"Modifies the value by exponential fall (steep fall initially, slow fall to the end) or rise (slow rise initially, fast rise to the end).
33This uses a standard exponential distribution and yields a base which is implicitly derived by start and end indices and values.")]
34  [StorableType("cddc93fe-edc3-4736-a610-71fb9058b582")]
35  public class ExponentialDiscreteDoubleValueModifier : DiscreteDoubleValueModifier {
36    [StorableConstructor]
37    protected ExponentialDiscreteDoubleValueModifier(bool deserializing) : base(deserializing) { }
38    protected ExponentialDiscreteDoubleValueModifier(ExponentialDiscreteDoubleValueModifier original, Cloner cloner) : base(original, cloner) { }
39    public ExponentialDiscreteDoubleValueModifier() : base() { }
40
41    public override IDeepCloneable Clone(Cloner cloner) {
42      return new ExponentialDiscreteDoubleValueModifier(this, cloner);
43    }
44
45    /// <summary>
46    /// Calculates a new value based on exponential decay or growth.
47    /// </summary>
48    /// <exception cref="ArgumentException">Thrown when endValue or startValue or both are 0.</exception>
49    /// <param name="value">The last value.</param>
50    /// <param name="startValue">The start value.</param>
51    /// <param name="endValue">The end value.</param>
52    /// <param name="index">The current index.</param>
53    /// <param name="startIndex">The start index.</param>
54    /// <param name="endIndex">The end index.</param>
55    /// <returns>The new value.</returns>
56    protected override double Modify(double value, double startValue, double endValue, int index, int startIndex, int endIndex) {
57      if (endValue <= 0 || startValue <= 0) throw new ArgumentException("startValue and endValue must be greater than 0.");
58      double b = Math.Pow(endValue / startValue, 1.0 / (endIndex - startIndex));
59      return startValue * Math.Pow(b, index - startIndex);
60    }
61  }
62}
Note: See TracBrowser for help on using the repository browser.