Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Problems.DataAnalysis/3.4/OnlineCalculators/OnlineMeanSquaredErrorCalculator.cs @ 7259

Last change on this file since 7259 was 7259, checked in by swagner, 12 years ago

Updated year of copyrights to 2012 (#1716)

File size: 3.5 KB
RevLine 
[3996]1#region License Information
2/* HeuristicLab
[7259]3 * Copyright (C) 2002-2012 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
[3996]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;
[5500]23using System.Collections.Generic;
[3996]24
[5491]25namespace HeuristicLab.Problems.DataAnalysis {
[5942]26  public class OnlineMeanSquaredErrorCalculator : IOnlineCalculator {
[3996]27
28    private double sse;
29    private int n;
30    public double MeanSquaredError {
31      get {
[5746]32        return n > 0 ? sse / n : 0.0;
[3996]33      }
34    }
35
[5942]36    public OnlineMeanSquaredErrorCalculator() {
[3996]37      Reset();
38    }
39
[5942]40    #region IOnlineCalculator Members
41    private OnlineCalculatorError errorState;
42    public OnlineCalculatorError ErrorState {
[5894]43      get { return errorState; }
44    }
[4022]45    public double Value {
46      get { return MeanSquaredError; }
47    }
[3996]48    public void Reset() {
49      n = 0;
50      sse = 0.0;
[5942]51      errorState = OnlineCalculatorError.InsufficientElementsAdded;
[3996]52    }
53
54    public void Add(double original, double estimated) {
55      if (double.IsNaN(estimated) || double.IsInfinity(estimated) ||
[5942]56          double.IsNaN(original) || double.IsInfinity(original) || (errorState & OnlineCalculatorError.InvalidValueAdded) > 0) {
57        errorState = errorState | OnlineCalculatorError.InvalidValueAdded;
[5904]58      } else {
[3996]59        double error = estimated - original;
60        sse += error * error;
61        n++;
[5942]62        errorState = errorState & (~OnlineCalculatorError.InsufficientElementsAdded);        // n >= 1
[3996]63      }
64    }
65    #endregion
[5500]66
[6961]67    public static double Calculate(IEnumerable<double> originalValues, IEnumerable<double> estimatedValues, out OnlineCalculatorError errorState) {
68      IEnumerator<double> originalEnumerator = originalValues.GetEnumerator();
69      IEnumerator<double> estimatedEnumerator = estimatedValues.GetEnumerator();
[5942]70      OnlineMeanSquaredErrorCalculator mseCalculator = new OnlineMeanSquaredErrorCalculator();
[5500]71
[5564]72      // always move forward both enumerators (do not use short-circuit evaluation!)
[6961]73      while (originalEnumerator.MoveNext() & estimatedEnumerator.MoveNext()) {
74        double original = originalEnumerator.Current;
75        double estimated = estimatedEnumerator.Current;
[5942]76        mseCalculator.Add(original, estimated);
[5945]77        if (mseCalculator.ErrorState != OnlineCalculatorError.None) break;
[5500]78      }
79
[5564]80      // check if both enumerators are at the end to make sure both enumerations have the same length
[5945]81      if (mseCalculator.ErrorState == OnlineCalculatorError.None &&
[6961]82         (estimatedEnumerator.MoveNext() || originalEnumerator.MoveNext())) {
[6964]83        throw new ArgumentException("Number of elements in originalValues and estimatedValues enumerations doesn't match.");
[5500]84      } else {
[5942]85        errorState = mseCalculator.ErrorState;
86        return mseCalculator.MeanSquaredError;
[5500]87      }
88    }
[3996]89  }
90}
Note: See TracBrowser for help on using the repository browser.