source: trunk/sources/HeuristicLab.Optimization/3.3/Algorithms/EngineAlgorithm.cs @ 12012

Last change on this file since 12012 was 12012, checked in by ascheibe, 4 years ago

#2212 merged r12008, r12009, r12010 back into trunk

File size: 8.8 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 System.Linq;
24using HeuristicLab.Common;
25using HeuristicLab.Core;
26using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
27using HeuristicLab.PluginInfrastructure;
28
29namespace HeuristicLab.Optimization {
30  /// <summary>
31  /// A base class for algorithms which use an engine for execution.
32  /// </summary>
33  [Item("EngineAlgorithm", "A base class for algorithms which use an engine for execution.")]
34  [StorableClass]
35  public abstract class EngineAlgorithm : Algorithm {
36    [Storable]
37    private OperatorGraph operatorGraph;
38    public OperatorGraph OperatorGraph {
39      get { return operatorGraph; }
40      protected set {
41        if (value == null) throw new ArgumentNullException();
42        if (value != operatorGraph) {
43          operatorGraph.InitialOperatorChanged -= new EventHandler(OperatorGraph_InitialOperatorChanged);
44          operatorGraph = value;
45          operatorGraph.InitialOperatorChanged += new EventHandler(OperatorGraph_InitialOperatorChanged);
46          OnOperatorGraphChanged();
47          Prepare();
48        }
49      }
50    }
51
52    [Storable]
53    private IScope globalScope;
54    protected IScope GlobalScope {
55      get { return globalScope; }
56    }
57
58    [Storable]
59    private IEngine engine;
60    public IEngine Engine {
61      get { return engine; }
62      set {
63        if (engine != value) {
64          if (engine != null) DeregisterEngineEvents();
65          engine = value;
66          if (engine != null) RegisterEngineEvents();
67          OnEngineChanged();
68          Prepare();
69        }
70      }
71    }
72
73    public override ResultCollection Results {
74      get {
75        return (ResultCollection)globalScope.Variables["Results"].Value;
76      }
77    }
78
79    protected EngineAlgorithm()
80      : base() {
81      globalScope = new Scope("Global Scope");
82      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
83      operatorGraph = new OperatorGraph();
84      Initialize();
85    }
86    protected EngineAlgorithm(string name)
87      : base(name) {
88      globalScope = new Scope("Global Scope");
89      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
90      operatorGraph = new OperatorGraph();
91      Initialize();
92    }
93    protected EngineAlgorithm(string name, ParameterCollection parameters)
94      : base(name, parameters) {
95      globalScope = new Scope("Global Scope");
96      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
97      operatorGraph = new OperatorGraph();
98      Initialize();
99    }
100    protected EngineAlgorithm(string name, string description)
101      : base(name, description) {
102      globalScope = new Scope("Global Scope");
103      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
104      operatorGraph = new OperatorGraph();
105      Initialize();
106    }
107    protected EngineAlgorithm(string name, string description, ParameterCollection parameters)
108      : base(name, description, parameters) {
109      globalScope = new Scope("Global Scope");
110      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
111      operatorGraph = new OperatorGraph();
112      Initialize();
113    }
114    [StorableConstructor]
115    protected EngineAlgorithm(bool deserializing) : base(deserializing) { }
116    [StorableHook(HookType.AfterDeserialization)]
117    private void AfterDeserialization() {
118      Initialize();
119
120      // BackwardsCompatibility3.3
121      #region Backwards compatible code (remove with 3.4)
122      // clear global scope if it contains any sub-scopes or additional variables
123      if ((ExecutionState == Core.ExecutionState.Stopped) && ((globalScope.SubScopes.Count > 0) || (globalScope.Variables.Count > 1))) {
124        ResultCollection results = Results;
125        globalScope.Clear();
126        globalScope.Variables.Add(new Variable("Results", results));
127      }
128      #endregion
129    }
130
131    protected EngineAlgorithm(EngineAlgorithm original, Cloner cloner)
132      : base(original, cloner) {
133      globalScope = cloner.Clone(original.globalScope);
134      engine = cloner.Clone(original.engine);
135      operatorGraph = cloner.Clone(original.operatorGraph);
136      Initialize();
137    }
138
139    private void Initialize() {
140      operatorGraph.InitialOperatorChanged += new EventHandler(OperatorGraph_InitialOperatorChanged);
141      if (engine == null) {
142        var types = ApplicationManager.Manager.GetTypes(typeof(IEngine));
143        Type t = types.FirstOrDefault(x => x.Name.Equals("SequentialEngine"));
144        if (t == null) t = types.FirstOrDefault();
145        if (t != null) engine = (IEngine)Activator.CreateInstance(t);
146      }
147      if (engine != null) RegisterEngineEvents();
148    }
149
150    public virtual IAlgorithm CreateUserDefinedAlgorithm() {
151      return new UserDefinedAlgorithm(this, new Cloner());
152    }
153
154    public override void Prepare() {
155      base.Prepare();
156      globalScope.Clear();
157      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
158
159      if ((engine != null) && (operatorGraph.InitialOperator != null)) {
160        ExecutionContext context = null;
161        if (Problem != null) {
162          foreach (var item in Problem.ExecutionContextItems)
163            context = new ExecutionContext(context, item, globalScope);
164        }
165        context = new ExecutionContext(context, this, globalScope);
166        context = new ExecutionContext(context, operatorGraph.InitialOperator, globalScope);
167        engine.Prepare(context);
168      }
169    }
170    public override void Start() {
171      base.Start();
172      if (engine != null) engine.Start();
173    }
174    public override void Pause() {
175      base.Pause();
176      if (engine != null) engine.Pause();
177    }
178    public override void Stop() {
179      base.Stop();
180      if (engine != null) engine.Stop();
181    }
182
183    #region Events
184    public event EventHandler EngineChanged;
185    protected virtual void OnEngineChanged() {
186      EventHandler handler = EngineChanged;
187      if (handler != null) handler(this, EventArgs.Empty);
188    }
189    public event EventHandler OperatorGraphChanged;
190    protected virtual void OnOperatorGraphChanged() {
191      EventHandler handler = OperatorGraphChanged;
192      if (handler != null) handler(this, EventArgs.Empty);
193    }
194
195    private void RegisterEngineEvents() {
196      Engine.ExceptionOccurred += new EventHandler<EventArgs<Exception>>(Engine_ExceptionOccurred);
197      Engine.ExecutionTimeChanged += new EventHandler(Engine_ExecutionTimeChanged);
198      Engine.Paused += new EventHandler(Engine_Paused);
199      Engine.Prepared += new EventHandler(Engine_Prepared);
200      Engine.Started += new EventHandler(Engine_Started);
201      Engine.Stopped += new EventHandler(Engine_Stopped);
202    }
203    private void DeregisterEngineEvents() {
204      Engine.ExceptionOccurred -= new EventHandler<EventArgs<Exception>>(Engine_ExceptionOccurred);
205      Engine.ExecutionTimeChanged -= new EventHandler(Engine_ExecutionTimeChanged);
206      Engine.Paused -= new EventHandler(Engine_Paused);
207      Engine.Prepared -= new EventHandler(Engine_Prepared);
208      Engine.Started -= new EventHandler(Engine_Started);
209      Engine.Stopped -= new EventHandler(Engine_Stopped);
210    }
211    private void Engine_ExceptionOccurred(object sender, EventArgs<Exception> e) {
212      OnExceptionOccurred(e.Value);
213    }
214    private void Engine_ExecutionTimeChanged(object sender, EventArgs e) {
215      ExecutionTime = Engine.ExecutionTime;
216    }
217    private void Engine_Paused(object sender, EventArgs e) {
218      OnPaused();
219    }
220    private void Engine_Prepared(object sender, EventArgs e) {
221      OnPrepared();
222    }
223    private void Engine_Started(object sender, EventArgs e) {
224      OnStarted();
225    }
226    private void Engine_Stopped(object sender, EventArgs e) {
227      ResultCollection results = Results;
228      globalScope.Clear();
229      globalScope.Variables.Add(new Variable("Results", results));
230      OnStopped();
231    }
232
233    private void OperatorGraph_InitialOperatorChanged(object sender, EventArgs e) {
234      Prepare();
235    }
236    #endregion
237  }
238}
Note: See TracBrowser for help on using the repository browser.