1 | #region License Information |
---|
2 | /* HeuristicLab |
---|
3 | * Copyright (C) 2002-2019 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 System; |
---|
23 | using HeuristicLab.Common; |
---|
24 | using HeuristicLab.Core; |
---|
25 | using HeuristicLab.Optimization.Operators; |
---|
26 | using HEAL.Attic; |
---|
27 | |
---|
28 | namespace HeuristicLab.Encodings.IntegerVectorEncoding { |
---|
29 | [Item("Hamming Similarity Calculator for IntegerVector", "Calculates the solution similarity based on the Hamming distance between two integer vectors.")] |
---|
30 | [StorableType("3784C4BD-8834-4A90-900C-0340C7F7BB47")] |
---|
31 | public sealed class HammingSimilarityCalculator : SingleObjectiveSolutionSimilarityCalculator { |
---|
32 | protected override bool IsCommutative { |
---|
33 | get { return true; } |
---|
34 | } |
---|
35 | |
---|
36 | [StorableConstructor] |
---|
37 | private HammingSimilarityCalculator(StorableConstructorFlag _) : base(_) { } |
---|
38 | private HammingSimilarityCalculator(HammingSimilarityCalculator original, Cloner cloner) : base(original, cloner) { } |
---|
39 | public HammingSimilarityCalculator() { } |
---|
40 | |
---|
41 | public override IDeepCloneable Clone(Cloner cloner) { |
---|
42 | return new HammingSimilarityCalculator(this, cloner); |
---|
43 | } |
---|
44 | |
---|
45 | public static double CalculateSimilarity(IntegerVector left, IntegerVector right) { |
---|
46 | if (left == null || right == null) |
---|
47 | throw new ArgumentException("Cannot calculate similarity because one or both of the provided solutions is null."); |
---|
48 | if (left.Length != right.Length) |
---|
49 | throw new ArgumentException("Cannot calculate similarity because the provided solutions have different lengths."); |
---|
50 | if (left.Length == 0) |
---|
51 | throw new ArgumentException("Cannot calculate similarity because solutions are of length 0."); |
---|
52 | if (ReferenceEquals(left, right)) return 1.0; |
---|
53 | |
---|
54 | double similarity = 0.0; |
---|
55 | for (int i = 0; i < left.Length; i++) |
---|
56 | if (left[i] == right[i]) similarity++; |
---|
57 | return similarity / left.Length; |
---|
58 | |
---|
59 | } |
---|
60 | |
---|
61 | public override double CalculateSolutionSimilarity(IScope leftSolution, IScope rightSolution) { |
---|
62 | var left = leftSolution.Variables[SolutionVariableName].Value as IntegerVector; |
---|
63 | var right = rightSolution.Variables[SolutionVariableName].Value as IntegerVector; |
---|
64 | |
---|
65 | return CalculateSimilarity(left, right); |
---|
66 | } |
---|
67 | } |
---|
68 | } |
---|