Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/HeuristicLab.Problems.Knapsack/3.3/SimilarityCalculators/KnapsackSimilarityCalculator.cs @ 17218

Last change on this file since 17218 was 17180, checked in by swagner, 5 years ago

#2875: Removed years in copyrights

File size: 3.3 KB
Line 
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
22using System;
23using HEAL.Attic;
24using HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Encodings.BinaryVectorEncoding;
27using HeuristicLab.Optimization.Operators;
28using HeuristicLab.PluginInfrastructure;
29
30namespace HeuristicLab.Problems.Knapsack {
31  /// <summary>
32  /// An operator that performs similarity calculation between two knapsack solutions.
33  /// </summary>
34  /// <remarks>
35  /// The operator calculates the similarity based on the number of elements the two solutions have in common.
36  /// </remarks>
37  [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.")]
38  [NonDiscoverableType]
39  [Obsolete("Please use the HammingSimilarityCalculator in the HeuristicLab.Encodings.BinaryVector plugin.")]
40  [StorableType("27FD4466-6FDC-4420-A606-100FC0CDABF6")]
41  internal sealed class KnapsackSimilarityCalculator : SingleObjectiveSolutionSimilarityCalculator {
42    protected override bool IsCommutative { get { return true; } }
43
44    [StorableConstructor]
45    private KnapsackSimilarityCalculator(StorableConstructorFlag _) : base(_) { }
46    private KnapsackSimilarityCalculator(KnapsackSimilarityCalculator original, Cloner cloner) : base(original, cloner) { }
47    public KnapsackSimilarityCalculator() : base() { }
48
49    public override IDeepCloneable Clone(Cloner cloner) {
50      return new KnapsackSimilarityCalculator(this, cloner);
51    }
52
53    public static double CalculateSimilarity(BinaryVector left, BinaryVector right) {
54      if (left == null || right == null)
55        throw new ArgumentException("Cannot calculate similarity because one or both of the provided scopes is null.");
56      if (left.Length != right.Length)
57        throw new ArgumentException("Cannot calculate similarity because the provided solutions have different lengths.");
58      if (left == right) return 1.0;
59
60      double similarity = 0.0;
61      for (int i = 0; i < left.Length; i++)
62        if (left[i] == right[i]) similarity++;
63      return similarity / left.Length;
64    }
65
66    public override double CalculateSolutionSimilarity(IScope leftSolution, IScope rightSolution) {
67      var sol1 = leftSolution.Variables[SolutionVariableName].Value as BinaryVector;
68      var sol2 = rightSolution.Variables[SolutionVariableName].Value as BinaryVector;
69
70      return CalculateSimilarity(sol1, sol2);
71    }
72  }
73}
Note: See TracBrowser for help on using the repository browser.