source: branches/ScatterSearch (trunk integration)/HeuristicLab.Problems.TestFunctions/3.3/SimilarityCalculators/SingleObjectiveTestFunctionSimilarityCalculator.cs @ 8303

Last change on this file since 8303 was 8303, checked in by jkarder, 7 years ago

#1331: made similarity calculators storable and cloneable

File size: 3.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2012 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 HeuristicLab.Common;
24using HeuristicLab.Core;
25using HeuristicLab.Data;
26using HeuristicLab.Encodings.RealVectorEncoding;
27using HeuristicLab.Optimization.Operators;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Problems.TestFunctions {
31  /// <summary>
32  /// An operator that performs similarity calculation between two test functions solutions.
33  /// </summary>
34  [Item("SingleObjectiveTestFunctionSimilarityCalculator", "An operator that performs similarity calculation between two test functions solutions.")]
35  [StorableClass]
36  public sealed class SingleObjectiveTestFunctionSimilarityCalculator : SimilarityCalculator {
37    #region Properties
38    [Storable]
39    public DoubleMatrix Bounds { get; set; }
40    #endregion
41
42    [StorableConstructor]
43    private SingleObjectiveTestFunctionSimilarityCalculator(bool deserializing) : base(deserializing) { }
44    private SingleObjectiveTestFunctionSimilarityCalculator(SingleObjectiveTestFunctionSimilarityCalculator original, Cloner cloner)
45      : base(original, cloner) {
46      this.Bounds = cloner.Clone(original.Bounds);
47    }
48    public SingleObjectiveTestFunctionSimilarityCalculator() : base() { }
49
50    public override IDeepCloneable Clone(Cloner cloner) {
51      return new SingleObjectiveTestFunctionSimilarityCalculator(this, cloner);
52    }
53
54    public static double CalculateSimilarity(RealVector left, RealVector right, DoubleMatrix bounds) {
55      if (left == null || right == null)
56        throw new ArgumentException("Cannot calculate similarity because one of the provided solutions or both are null.");
57      if (bounds == null)
58        throw new ArgumentException("Cannot calculate similarity because no bounds were provided.");
59
60      double maxSum = 0.0;
61      for (int i = 0; i < left.Length; i++)
62        maxSum += Math.Pow(bounds[0, 0] - bounds[0, 1], 2);
63      double maxDistance = Math.Sqrt(maxSum) / left.Length;
64
65      double sum = 0.0;
66      for (int i = 0; i < left.Length; i++)
67        sum += Math.Pow(left[i] - right[i], 2);
68      double distance = Math.Sqrt(sum) / left.Length;
69
70      return 1.0 - distance / maxDistance;
71    }
72
73    protected override double CalculateSimilarity(IScope left, IScope right) {
74      RealVector sol1 = left.Variables[Target].Value as RealVector;
75      RealVector sol2 = right.Variables[Target].Value as RealVector;
76
77      return CalculateSimilarity(sol1, sol2, Bounds);
78    }
79  }
80}
Note: See TracBrowser for help on using the repository browser.