HeuristicLab.Optimization.Operators/3.3/SingleObjectiveSolutionSimilarityCalculator.cs

   1 #region License Information
   2 /* HeuristicLab
   3  * Copyright (C) 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
  22 using HeuristicLab.Common;
  23 using HeuristicLab.Core;
  24 using HeuristicLab.Data;
  25 using HEAL.Attic;
  26
  27 namespace HeuristicLab.Optimization.Operators {
  28   /// <summary>
  29   /// A base class for items that perform similarity calculation between two single objective solutions.
  30   /// </summary>
  31   [Item("SimilarityCalculator", "A base class for items that perform similarity calculation between two solutions.")]
  32   [StorableType("16E69099-B75B-467B-ADAC-8CA64796F389")]
  33 #pragma warning disable 0618
  34   public abstract class SingleObjectiveSolutionSimilarityCalculator : SolutionSimilarityCalculator, ISingleObjectiveSolutionSimilarityCalculator {
  35 #pragma warning restore 0618
  36     [StorableConstructor]
  37     protected SingleObjectiveSolutionSimilarityCalculator(StorableConstructorFlag _) : base(_) { }
  38     protected SingleObjectiveSolutionSimilarityCalculator(SingleObjectiveSolutionSimilarityCalculator original, Cloner cloner)
  39       : base(original, cloner) {
  40
  41     }
  42     protected SingleObjectiveSolutionSimilarityCalculator() : base() { }
  43
  44     public override bool Equals(IScope x, IScope y) {
  45       if (object.ReferenceEquals(x, y)) return true;
  46       if (x == null || y == null) return false;
  47       double q1 = ((DoubleValue)x.Variables[QualityVariableName].Value).Value;
  48       double q2 = ((DoubleValue)y.Variables[QualityVariableName].Value).Value;
  49       return q1.IsAlmost(q2) && CalculateSolutionSimilarity(x, y).IsAlmost(1.0);
  50     }
  51
  52     public override int GetHashCode(IScope scope) {
  53       return ((DoubleValue)scope.Variables[QualityVariableName].Value).Value.GetHashCode();
  54     }
  55   }
  56 }