Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2521_ProblemRefactoring/HeuristicLab.Optimization/3.3/BasicProblems/Encoding.cs @ 16692

Last change on this file since 16692 was 16692, checked in by abeham, 5 years ago

#2521: merged trunk changes up to r15681 into branch (removal of trunk/sources)

File size: 5.0 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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 System.Collections.Generic;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Parameters;
28using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
29
30namespace HeuristicLab.Optimization {
31  [Item("Encoding", "Base class for describing different encodings.")]
32  [StorableClass]
33  public abstract class Encoding<TSolution> : ParameterizedNamedItem, IEncoding<TSolution>
34    where TSolution : class,ISolution {
35    public override sealed bool CanChangeName {
36      get { return false; }
37    }
38
39    private ItemSet<IOperator> encodingOperators = new ItemSet<IOperator>(new TypeEqualityComparer<IOperator>());
40
41    [Storable(Name = "Operators")]
42    private IEnumerable<IOperator> StorableOperators {
43      get { return encodingOperators; }
44      set { encodingOperators = new ItemSet<IOperator>(value, new TypeEqualityComparer<IOperator>()); ; }
45    }
46
47    public IEnumerable<IOperator> Operators {
48      get { return encodingOperators; }
49      set {
50        if (!value.OfType<ISolutionCreator<TSolution>>().Any())
51          throw new ArgumentException("The provided operators contain no suitable solution creator");
52        encodingOperators.Clear();
53        foreach (var op in value) encodingOperators.Add(op);
54
55        ISolutionCreator<TSolution> newSolutionCreator = (ISolutionCreator<TSolution>)encodingOperators.FirstOrDefault(o => o.GetType() == SolutionCreator.GetType()) ??
56                               encodingOperators.OfType<ISolutionCreator<TSolution>>().First();
57        SolutionCreator = newSolutionCreator;
58        OnOperatorsChanged();
59      }
60    }
61
62    public IValueParameter SolutionCreatorParameter {
63      get { return (IValueParameter)Parameters[Name + ".SolutionCreator"]; }
64    }
65
66    ISolutionCreator IEncoding.SolutionCreator {
67      get { return SolutionCreator; }
68    }
69    public ISolutionCreator<TSolution> SolutionCreator {
70      get { return (ISolutionCreator<TSolution>)SolutionCreatorParameter.Value; }
71      set {
72        if (value == null) throw new ArgumentNullException("SolutionCreator must not be null.");
73        encodingOperators.Remove(SolutionCreator);
74        encodingOperators.Add(value);
75        SolutionCreatorParameter.Value = value;
76        OnSolutionCreatorChanged();
77      }
78    }
79
80
81    [StorableConstructor]
82    protected Encoding(bool deserializing) : base(deserializing) { }
83    [StorableHook(HookType.AfterDeserialization)]
84    private void AfterDeserialization() {
85      RegisterEventHandlers();
86    }
87
88    protected Encoding(Encoding<TSolution> original, Cloner cloner)
89      : base(original, cloner) {
90      encodingOperators = cloner.Clone(original.encodingOperators);
91
92      RegisterEventHandlers();
93    }
94
95    protected Encoding(string name)
96      : base(name) {
97      Parameters.Add(new ValueParameter<ISolutionCreator<TSolution>>(name + ".SolutionCreator", "The operator to create a solution."));
98      Parameters.Add(new FixedValueParameter<ReadOnlyItemSet<IOperator>>(name + ".Operators", "The operators that the encoding specifies.", encodingOperators.AsReadOnly()));
99
100      RegisterEventHandlers();
101    }
102
103    private void RegisterEventHandlers() {
104      SolutionCreatorParameter.ValueChanged += (o, e) => OnSolutionCreatorChanged();
105    }
106
107    protected bool AddOperator(IOperator @operator) {
108      return encodingOperators.Add(@operator);
109    }
110
111    protected bool RemoveOperator(IOperator @operator) {
112      return encodingOperators.Remove(@operator);
113    }
114
115    public void ConfigureOperator(IItem @operator) { ConfigureOperators(new[] { @operator }); }
116    public abstract void ConfigureOperators(IEnumerable<IItem> operators);
117
118    public event EventHandler SolutionCreatorChanged;
119    protected virtual void OnSolutionCreatorChanged() {
120      ConfigureOperator(SolutionCreator);
121      var handler = SolutionCreatorChanged;
122      if (handler != null) handler(this, EventArgs.Empty);
123    }
124
125    public event EventHandler OperatorsChanged;
126    protected virtual void OnOperatorsChanged() {
127      ConfigureOperators(Operators);
128      var handler = OperatorsChanged;
129      if (handler != null) handler(this, EventArgs.Empty);
130    }
131  }
132}
Note: See TracBrowser for help on using the repository browser.