[3996] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[14185] | 3 | * Copyright (C) 2002-2016 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 |
|
---|
| 22 | using System;
|
---|
[5500] | 23 | using System.Collections.Generic;
|
---|
[14293] | 24 | using HeuristicLab.Common;
|
---|
[3996] | 25 |
|
---|
[5491] | 26 | namespace HeuristicLab.Problems.DataAnalysis {
|
---|
[14376] | 27 | public class OnlineMaxAbsoluteErrorCalculator : DeepCloneable, IOnlineCalculator {
|
---|
[3996] | 28 |
|
---|
[7678] | 29 | private double mae;
|
---|
[3996] | 30 | private int n;
|
---|
[7678] | 31 | public double MaxAbsoluteError {
|
---|
[3996] | 32 | get {
|
---|
[7678] | 33 | return n > 0 ? mae : 0.0;
|
---|
[3996] | 34 | }
|
---|
| 35 | }
|
---|
| 36 |
|
---|
[7678] | 37 | public OnlineMaxAbsoluteErrorCalculator() {
|
---|
[3996] | 38 | Reset();
|
---|
| 39 | }
|
---|
| 40 |
|
---|
[14294] | 41 | protected OnlineMaxAbsoluteErrorCalculator(OnlineMaxAbsoluteErrorCalculator other, Cloner cloner = null) {
|
---|
[14293] | 42 | mae = other.mae;
|
---|
| 43 | n = other.n;
|
---|
| 44 | errorState = other.errorState;
|
---|
| 45 | }
|
---|
| 46 |
|
---|
[5942] | 47 | #region IOnlineCalculator Members
|
---|
| 48 | private OnlineCalculatorError errorState;
|
---|
| 49 | public OnlineCalculatorError ErrorState {
|
---|
[5894] | 50 | get { return errorState; }
|
---|
| 51 | }
|
---|
[4022] | 52 | public double Value {
|
---|
[7678] | 53 | get { return MaxAbsoluteError; }
|
---|
[4022] | 54 | }
|
---|
[3996] | 55 | public void Reset() {
|
---|
| 56 | n = 0;
|
---|
[7678] | 57 | mae = double.MinValue;
|
---|
[5942] | 58 | errorState = OnlineCalculatorError.InsufficientElementsAdded;
|
---|
[3996] | 59 | }
|
---|
| 60 |
|
---|
| 61 | public void Add(double original, double estimated) {
|
---|
| 62 | if (double.IsNaN(estimated) || double.IsInfinity(estimated) ||
|
---|
[5942] | 63 | double.IsNaN(original) || double.IsInfinity(original) || (errorState & OnlineCalculatorError.InvalidValueAdded) > 0) {
|
---|
| 64 | errorState = errorState | OnlineCalculatorError.InvalidValueAdded;
|
---|
[5904] | 65 | } else {
|
---|
[7678] | 66 | double error = Math.Abs(estimated - original);
|
---|
| 67 | if (error > mae)
|
---|
| 68 | mae = error;
|
---|
[3996] | 69 | n++;
|
---|
[5942] | 70 | errorState = errorState & (~OnlineCalculatorError.InsufficientElementsAdded); // n >= 1
|
---|
[3996] | 71 | }
|
---|
| 72 | }
|
---|
| 73 | #endregion
|
---|
[5500] | 74 |
|
---|
[6961] | 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();
|
---|
[7678] | 78 | OnlineMaxAbsoluteErrorCalculator maeCalculator = new OnlineMaxAbsoluteErrorCalculator();
|
---|
[5500] | 79 |
|
---|
[5564] | 80 | // always move forward both enumerators (do not use short-circuit evaluation!)
|
---|
[6961] | 81 | while (originalEnumerator.MoveNext() & estimatedEnumerator.MoveNext()) {
|
---|
| 82 | double original = originalEnumerator.Current;
|
---|
| 83 | double estimated = estimatedEnumerator.Current;
|
---|
[6643] | 84 | maeCalculator.Add(original, estimated);
|
---|
| 85 | if (maeCalculator.ErrorState != OnlineCalculatorError.None) break;
|
---|
[5500] | 86 | }
|
---|
| 87 |
|
---|
[5564] | 88 | // check if both enumerators are at the end to make sure both enumerations have the same length
|
---|
[6643] | 89 | if (maeCalculator.ErrorState == OnlineCalculatorError.None &&
|
---|
[6961] | 90 | (estimatedEnumerator.MoveNext() || originalEnumerator.MoveNext())) {
|
---|
[6964] | 91 | throw new ArgumentException("Number of elements in originalValues and estimatedValues enumerations doesn't match.");
|
---|
[5500] | 92 | } else {
|
---|
[6643] | 93 | errorState = maeCalculator.ErrorState;
|
---|
[7678] | 94 | return maeCalculator.MaxAbsoluteError;
|
---|
[5500] | 95 | }
|
---|
| 96 | }
|
---|
[14293] | 97 |
|
---|
[14376] | 98 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
| 99 | return new OnlineMaxAbsoluteErrorCalculator(this, cloner);
|
---|
[14293] | 100 | }
|
---|
[3996] | 101 | }
|
---|
| 102 | }
|
---|