Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.DataAnalysis/3.4/OnlineCalculators/OnlineMeanAbsolutePercentageErrorCalculator.cs @ 14293

Last change on this file since 14293 was 14293, checked in by bburlacu, 8 years ago

#2672: Implement online calculator cloning.

File size: 4.2 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 System.Collections.Generic;
24using HeuristicLab.Common;
25
26namespace HeuristicLab.Problems.DataAnalysis {
27  public class OnlineMeanAbsolutePercentageErrorCalculator : IOnlineCalculator, IDeepCloneable {
28
29    private double sre;
30    private int n;
31    public double MeanAbsolutePercentageError {
32      get {
33        return n > 0 ? sre / n : 0.0;
34      }
35    }
36
37    public OnlineMeanAbsolutePercentageErrorCalculator() {
38      Reset();
39    }
40
41    // private constructor used internally by the Clone() method
42    private OnlineMeanAbsolutePercentageErrorCalculator(OnlineMeanAbsolutePercentageErrorCalculator other) {
43      sre = other.sre;
44      n = other.n;
45      errorState = other.errorState;
46    }
47
48    #region IOnlineCalculator Members
49    private OnlineCalculatorError errorState;
50    public OnlineCalculatorError ErrorState {
51      get { return errorState; }
52    }
53    public double Value {
54      get { return MeanAbsolutePercentageError; }
55    }
56    public void Reset() {
57      n = 0;
58      sre = 0.0;
59      errorState = OnlineCalculatorError.InsufficientElementsAdded;
60    }
61
62    public void Add(double original, double estimated) {
63      if (double.IsNaN(estimated) || double.IsInfinity(estimated) ||
64          double.IsNaN(original) || double.IsInfinity(original) ||
65        original.IsAlmost(0.0)) {
66        errorState = errorState | OnlineCalculatorError.InvalidValueAdded;
67      } else {
68        sre += Math.Abs((estimated - original) / original);
69        n++;
70        errorState = errorState & (~OnlineCalculatorError.InsufficientElementsAdded);        // n >= 1
71      }
72    }
73
74    #endregion
75
76    public static double Calculate(IEnumerable<double> originalValues, IEnumerable<double> estimatedValues, out OnlineCalculatorError errorState) {
77      IEnumerator<double> originalEnumerator = originalValues.GetEnumerator();
78      IEnumerator<double> estimatedEnumerator = estimatedValues.GetEnumerator();
79      OnlineMeanAbsolutePercentageErrorCalculator calculator = new OnlineMeanAbsolutePercentageErrorCalculator();
80
81      // always move forward both enumerators (do not use short-circuit evaluation!)
82      while (originalEnumerator.MoveNext() & estimatedEnumerator.MoveNext()) {
83        double original = originalEnumerator.Current;
84        double estimated = estimatedEnumerator.Current;
85        calculator.Add(original, estimated);
86        if (calculator.ErrorState != OnlineCalculatorError.None) break;
87      }
88
89      // check if both enumerators are at the end to make sure both enumerations have the same length
90      if (calculator.ErrorState == OnlineCalculatorError.None &&
91            (estimatedEnumerator.MoveNext() || originalEnumerator.MoveNext())) {
92        throw new ArgumentException("Number of elements in originalValues and second estimatedValues doesn't match.");
93      } else {
94        errorState = calculator.ErrorState;
95        return calculator.MeanAbsolutePercentageError;
96      }
97    }
98
99    // IDeepCloneable interface members
100    public object Clone() {
101      return new OnlineMeanAbsolutePercentageErrorCalculator(this);
102    }
103
104    public IDeepCloneable Clone(Cloner cloner) {
105      var clone = cloner.GetClone(this);
106      if (clone == null) {
107        clone = (IDeepCloneable)this.Clone();
108        cloner.RegisterClonedObject(this, clone);
109      }
110      return clone;
111    }
112  }
113}
Note: See TracBrowser for help on using the repository browser.