source: branches/ScatterSearch (trunk integration)/HeuristicLab.Optimization.Operators/3.3/SimilarityCalculator.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: 2.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.Persistence.Default.CompositeSerializers.Storable;
26
27namespace HeuristicLab.Optimization.Operators {
28  /// <summary>
29  /// A base class for items that perform similarity calculation between two solutions.
30  /// </summary>
31  [Item("SimilarityCalculator", "A base class for items that perform similarity calculation between two solutions.")]
32  [StorableClass]
33  public abstract class SimilarityCalculator : Item, ISimilarityCalculator {
34    #region Properties
35    [Storable]
36    private string target;
37    public string Target {
38      get { return target; }
39      set { target = value; }
40    }
41    #endregion
42
43    [StorableConstructor]
44    protected SimilarityCalculator(bool deserializing) : base(deserializing) { }
45    protected SimilarityCalculator(SimilarityCalculator original, Cloner cloner)
46      : base(original, cloner) {
47      if (original.Target != null)
48        this.target = (string)original.Target.Clone();
49    }
50    protected SimilarityCalculator() : base() { }
51
52    public double ExecuteCalculation(IScope left, IScope right) {
53      if (left == null || right == null)
54        throw new ArgumentException("Cannot calculate diversity because one or both of the provided scopes is null.");
55
56      if (left == right) return 1.0;
57      else return CalculateSimilarity(left, right);
58    }
59
60    protected abstract double CalculateSimilarity(IScope left, IScope right);
61  }
62}
Note: See TracBrowser for help on using the repository browser.