[3996] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[17180] | 3 | * Copyright (C) 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;
|
---|
[3996] | 24 | using HeuristicLab.Common;
|
---|
| 25 |
|
---|
[5490] | 26 | namespace HeuristicLab.Problems.DataAnalysis {
|
---|
[14376] | 27 | public class OnlinePearsonsRCalculator : DeepCloneable, IOnlineCalculator {
|
---|
[5942] | 28 | private OnlineCovarianceCalculator covCalculator = new OnlineCovarianceCalculator();
|
---|
| 29 | private OnlineMeanAndVarianceCalculator sxCalculator = new OnlineMeanAndVarianceCalculator();
|
---|
| 30 | private OnlineMeanAndVarianceCalculator syCalculator = new OnlineMeanAndVarianceCalculator();
|
---|
[3996] | 31 |
|
---|
[12492] | 32 | public double R {
|
---|
[3996] | 33 | get {
|
---|
[5942] | 34 | double xVar = sxCalculator.PopulationVariance;
|
---|
| 35 | double yVar = syCalculator.PopulationVariance;
|
---|
[4126] | 36 | if (xVar.IsAlmost(0.0) || yVar.IsAlmost(0.0)) {
|
---|
| 37 | return 0.0;
|
---|
| 38 | } else {
|
---|
[13038] | 39 | var r = covCalculator.Covariance / (Math.Sqrt(xVar) * Math.Sqrt(yVar));
|
---|
| 40 | if (r < -1.0) r = -1.0;
|
---|
| 41 | else if (r > 1.0) r = 1.0;
|
---|
| 42 | return r;
|
---|
[4126] | 43 | }
|
---|
[3996] | 44 | }
|
---|
| 45 | }
|
---|
| 46 |
|
---|
[12492] | 47 | public OnlinePearsonsRCalculator() { }
|
---|
[3996] | 48 |
|
---|
[14465] | 49 | protected OnlinePearsonsRCalculator(OnlinePearsonsRCalculator original, Cloner cloner)
|
---|
| 50 | : base(original, cloner) {
|
---|
| 51 | covCalculator = cloner.Clone(original.covCalculator);
|
---|
| 52 | sxCalculator = cloner.Clone(original.sxCalculator);
|
---|
| 53 | syCalculator = cloner.Clone(original.syCalculator);
|
---|
[14293] | 54 | }
|
---|
[14465] | 55 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
| 56 | return new OnlinePearsonsRCalculator(this, cloner);
|
---|
| 57 | }
|
---|
[14293] | 58 |
|
---|
[5942] | 59 | #region IOnlineCalculator Members
|
---|
| 60 | public OnlineCalculatorError ErrorState {
|
---|
| 61 | get { return covCalculator.ErrorState | sxCalculator.PopulationVarianceErrorState | syCalculator.PopulationVarianceErrorState; }
|
---|
[5894] | 62 | }
|
---|
[4022] | 63 | public double Value {
|
---|
[12492] | 64 | get { return R; }
|
---|
[4022] | 65 | }
|
---|
[3996] | 66 | public void Reset() {
|
---|
[5942] | 67 | covCalculator.Reset();
|
---|
| 68 | sxCalculator.Reset();
|
---|
| 69 | syCalculator.Reset();
|
---|
[3996] | 70 | }
|
---|
| 71 |
|
---|
[4122] | 72 | public void Add(double x, double y) {
|
---|
[5746] | 73 | // no need to check validity of values explicitly here as it is checked in all three evaluators
|
---|
[5942] | 74 | covCalculator.Add(x, y);
|
---|
| 75 | sxCalculator.Add(x);
|
---|
| 76 | syCalculator.Add(y);
|
---|
[3996] | 77 | }
|
---|
| 78 |
|
---|
| 79 | #endregion
|
---|
| 80 |
|
---|
[5942] | 81 | public static double Calculate(IEnumerable<double> first, IEnumerable<double> second, out OnlineCalculatorError errorState) {
|
---|
[5500] | 82 | IEnumerator<double> firstEnumerator = first.GetEnumerator();
|
---|
| 83 | IEnumerator<double> secondEnumerator = second.GetEnumerator();
|
---|
[12492] | 84 | var calculator = new OnlinePearsonsRCalculator();
|
---|
[5500] | 85 |
|
---|
[5564] | 86 | // always move forward both enumerators (do not use short-circuit evaluation!)
|
---|
| 87 | while (firstEnumerator.MoveNext() & secondEnumerator.MoveNext()) {
|
---|
[6961] | 88 | double original = firstEnumerator.Current;
|
---|
[5500] | 89 | double estimated = secondEnumerator.Current;
|
---|
[12492] | 90 | calculator.Add(original, estimated);
|
---|
| 91 | if (calculator.ErrorState != OnlineCalculatorError.None) break;
|
---|
[5500] | 92 | }
|
---|
| 93 |
|
---|
[5564] | 94 | // check if both enumerators are at the end to make sure both enumerations have the same length
|
---|
[12492] | 95 | if (calculator.ErrorState == OnlineCalculatorError.None &&
|
---|
[5945] | 96 | (secondEnumerator.MoveNext() || firstEnumerator.MoveNext())) {
|
---|
[5500] | 97 | throw new ArgumentException("Number of elements in first and second enumeration doesn't match.");
|
---|
| 98 | } else {
|
---|
[12492] | 99 | errorState = calculator.ErrorState;
|
---|
| 100 | return calculator.R;
|
---|
[5500] | 101 | }
|
---|
| 102 | }
|
---|
[3996] | 103 | }
|
---|
| 104 | }
|
---|