Free cookie consent management tool by TermsFeed Policy Generator

source: branches/symbreg-factors-2650/HeuristicLab.Problems.DataAnalysis/3.4/OnlineCalculators/OnlineMaxAbsoluteErrorCalculator.cs @ 14330

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

#2650 Merged r14282:14322 from trunk to branch (fixing conflicts)

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