Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceOverhaul/HeuristicLab.Problems.Knapsack/3.3/SimilarityCalculators/KnapsackSimilarityCalculator.cs @ 14713

Last change on this file since 14713 was 14713, checked in by gkronber, 7 years ago

#2520 work in progress to support loading/saving of all samples

File size: 3.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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.Encodings.BinaryVectorEncoding;
26using HeuristicLab.Optimization.Operators;
27using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
28
29namespace HeuristicLab.Problems.Knapsack {
30  /// <summary>
31  /// An operator that performs similarity calculation between two knapsack solutions.
32  /// </summary>
33  /// <remarks>
34  /// The operator calculates the similarity based on the number of elements the two solutions have in common.
35  /// </remarks>
36  [Item("KnapsackSimilarityCalculator", "An operator that performs similarity calculation between two knapsack solutions. The operator calculates the similarity based on the number of elements the two solutions have in common.")]
37  [StorableType("E335A90A-13BB-48C6-9BD3-4D183E8EB370")]
38  public sealed class KnapsackSimilarityCalculator : SingleObjectiveSolutionSimilarityCalculator {
39    protected override bool IsCommutative { get { return true; } }
40
41    private KnapsackSimilarityCalculator(bool deserializing) : base(deserializing) { }
42    private KnapsackSimilarityCalculator(KnapsackSimilarityCalculator original, Cloner cloner) : base(original, cloner) { }
43    public KnapsackSimilarityCalculator() : base() { }
44
45    public override IDeepCloneable Clone(Cloner cloner) {
46      return new KnapsackSimilarityCalculator(this, cloner);
47    }
48
49    public static double CalculateSimilarity(BinaryVector left, BinaryVector right) {
50      if (left == null || right == null)
51        throw new ArgumentException("Cannot calculate similarity because one or both of the provided scopes is null.");
52      if (left.Length != right.Length)
53        throw new ArgumentException("Cannot calculate similarity because the provided solutions have different lengths.");
54      if (left == right) return 1.0;
55
56      double similarity = 0.0;
57      for (int i = 0; i < left.Length; i++)
58        if (left[i] == right[i]) similarity++;
59      return similarity / left.Length;
60    }
61
62    public override double CalculateSolutionSimilarity(IScope leftSolution, IScope rightSolution) {
63      var sol1 = leftSolution.Variables[SolutionVariableName].Value as BinaryVector;
64      var sol2 = rightSolution.Variables[SolutionVariableName].Value as BinaryVector;
65
66      return CalculateSimilarity(sol1, sol2);
67    }
68  }
69}
Note: See TracBrowser for help on using the repository browser.