source: branches/2521_ProblemRefactoring/HeuristicLab.Problems.Programmable/3.3/SingleObjectiveProgrammableProblem.cs @ 17226

Last change on this file since 17226 was 17226, checked in by mkommend, 3 years ago

#2521: Merged trunk changes into problem refactoring branch.

File size: 5.5 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.Collections.Generic;
23using System.Drawing;
24using HEAL.Attic;
25using HeuristicLab.Analysis;
26using HeuristicLab.Common;
27using HeuristicLab.Common.Resources;
28using HeuristicLab.Core;
29using HeuristicLab.Data;
30using HeuristicLab.Optimization;
31using HeuristicLab.Parameters;
32using HeuristicLab.Scripting;
33
34namespace HeuristicLab.Problems.Programmable {
35  [Item("Programmable Problem (single-objective)", "Represents a single-objective problem that can be programmed with a script.")]
36  [StorableType("44944E6B-E95E-4805-8F0A-0C0F7D761DB9")]
37  public abstract class SingleObjectiveProgrammableProblem<TEncoding, TEncodedSolution> : SingleObjectiveProblem<TEncoding, TEncodedSolution>, IProgrammableItem, IProgrammableProblem
38    where TEncoding : class, IEncoding<TEncodedSolution>
39    where TEncodedSolution : class, IEncodedSolution {
40    protected static readonly string ENCODING_NAMESPACE = "ENCODING_NAMESPACE";
41    protected static readonly string ENCODING_CLASS = "ENCODING_CLASS";
42    protected static readonly string SOLUTION_CLASS = "SOLUTION_CLASS";
43
44    public static new Image StaticItemImage {
45      get { return VSImageLibrary.Script; }
46    }
47
48    private FixedValueParameter<SingleObjectiveProblemDefinitionScript<TEncoding, TEncodedSolution>> SingleObjectiveProblemScriptParameter {
49      get { return (FixedValueParameter<SingleObjectiveProblemDefinitionScript<TEncoding, TEncodedSolution>>)Parameters["ProblemScript"]; }
50    }
51
52    Script IProgrammableProblem.ProblemScript {
53      get { return ProblemScript; }
54    }
55    public SingleObjectiveProblemDefinitionScript<TEncoding, TEncodedSolution> ProblemScript {
56      get { return SingleObjectiveProblemScriptParameter.Value; }
57    }
58
59    public ISingleObjectiveProblemDefinition<TEncoding, TEncodedSolution> ProblemDefinition {
60      get { return SingleObjectiveProblemScriptParameter.Value; }
61    }
62
63    protected SingleObjectiveProgrammableProblem(SingleObjectiveProgrammableProblem<TEncoding, TEncodedSolution> original, Cloner cloner)
64      : base(original, cloner) {
65      RegisterEvents();
66    }
67
68    [StorableConstructor]
69    protected SingleObjectiveProgrammableProblem(StorableConstructorFlag _) : base(_) { }
70    public SingleObjectiveProgrammableProblem(TEncoding encoding)
71      : base(encoding) {
72      Parameters.Add(new FixedValueParameter<SingleObjectiveProblemDefinitionScript<TEncoding, TEncodedSolution>>("ProblemScript", "Defines the problem.", new SingleObjectiveProblemDefinitionScript<TEncoding, TEncodedSolution>() { Name = Name }));
73      ProblemScript.Encoding = (TEncoding)encoding.Clone();
74
75      var codeTemplate = ScriptTemplates.SingleObjectiveProblem_Template;
76      codeTemplate = codeTemplate.Replace(ENCODING_NAMESPACE, typeof(TEncoding).Namespace);
77      codeTemplate = codeTemplate.Replace(ENCODING_CLASS, typeof(TEncoding).Name);
78      codeTemplate = codeTemplate.Replace(SOLUTION_CLASS, typeof(TEncodedSolution).Name);
79      ProblemScript.Code = codeTemplate;
80
81      Operators.Add(new BestScopeSolutionAnalyzer());
82      RegisterEvents();
83    }
84
85    [StorableHook(HookType.AfterDeserialization)]
86    private void AfterDeserialization() {
87      RegisterEvents();
88    }
89
90    private void RegisterEvents() {
91      ProblemScript.ProblemDefinitionChanged += (o, e) => OnProblemDefinitionChanged();
92      ProblemScript.NameChanged += (o, e) => OnProblemScriptNameChanged();
93    }
94
95    private void OnProblemDefinitionChanged() {
96      Parameters.Remove("Maximization");
97      Parameters.Add(new FixedValueParameter<BoolValue>("Maximization", "Set to false if the problem should be minimized.", (BoolValue)new BoolValue(Maximization).AsReadOnly()) { Hidden = true });
98      Encoding = (TEncoding)ProblemScript.Encoding.Clone();
99
100      OnOperatorsChanged();
101      OnReset();
102    }
103    protected override void OnNameChanged() {
104      base.OnNameChanged();
105      ProblemScript.Name = Name;
106    }
107    private void OnProblemScriptNameChanged() {
108      Name = ProblemScript.Name;
109    }
110
111    public override bool Maximization {
112      get { return Parameters.ContainsKey("ProblemScript") && ProblemDefinition.Maximization; }
113    }
114
115    public override double Evaluate(TEncodedSolution individual, IRandom random) {
116      return ProblemDefinition.Evaluate(individual, random);
117    }
118
119    public override void Analyze(TEncodedSolution[] individuals, double[] qualities, ResultCollection results, IRandom random) {
120      ProblemDefinition.Analyze(individuals, qualities, results, random);
121    }
122    public override IEnumerable<TEncodedSolution> GetNeighbors(TEncodedSolution individual, IRandom random) {
123      return ProblemDefinition.GetNeighbors(individual, random);
124    }
125  }
126}
Note: See TracBrowser for help on using the repository browser.