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

Last change on this file since 3280 was 3280, checked in by swagner, 11 years ago

Continued work on algorithm batch processing (#947).

File size: 8.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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    protected OperatorGraph OperatorGraph {
39      get { return operatorGraph; }
40      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    internal EngineAlgorithm(EngineAlgorithm algorithm, Cloner cloner)
115      : base(algorithm, cloner) {
116      globalScope = (IScope)cloner.Clone(algorithm.globalScope);
117      operatorGraph = (OperatorGraph)cloner.Clone(algorithm.operatorGraph);
118      engine = (IEngine)cloner.Clone(algorithm.engine);
119      Initialize();
120    }
121    [StorableConstructor]
122    protected EngineAlgorithm(bool deserializing) : base(deserializing) { }
123
124    [StorableHook(HookType.AfterDeserialization)]
125    private void Initialize() {
126      operatorGraph.InitialOperatorChanged += new EventHandler(OperatorGraph_InitialOperatorChanged);
127      if ((engine == null) && (ApplicationManager.Manager != null)) {
128        var types = ApplicationManager.Manager.GetTypes(typeof(IEngine));
129        Type t = types.FirstOrDefault(x => x.Name.Equals("SequentialEngine"));
130        if (t == null) t = types.FirstOrDefault();
131        if (t != null) engine = (IEngine)Activator.CreateInstance(t);
132      }
133      if (engine != null) RegisterEngineEvents();
134    }
135
136    public override IDeepCloneable Clone(Cloner cloner) {
137      EngineAlgorithm clone = (EngineAlgorithm)base.Clone(cloner);
138      clone.globalScope = (IScope)cloner.Clone(globalScope);
139      clone.engine = (IEngine)cloner.Clone(engine);
140      clone.operatorGraph = (OperatorGraph)cloner.Clone(operatorGraph);
141      clone.Initialize();
142      return clone;
143    }
144
145    public UserDefinedAlgorithm CreateUserDefinedAlgorithm() {
146      return new UserDefinedAlgorithm(this, new Cloner());
147    }
148
149    public override void Prepare() {
150      base.Prepare();
151      globalScope.Clear();
152      globalScope.Variables.Add(new Variable("Results", new ResultCollection()));
153
154      if (engine != null) {
155        ExecutionContext context = null;
156        if (operatorGraph.InitialOperator != null) {
157          if (Problem != null) {
158            context = new ExecutionContext(context, Problem, globalScope);
159            foreach (IParameter param in Problem.Parameters)
160              param.ExecutionContext = context;
161          }
162          context = new ExecutionContext(context, this, globalScope);
163          foreach (IParameter param in this.Parameters)
164            param.ExecutionContext = context;
165          context = new ExecutionContext(context, operatorGraph.InitialOperator, globalScope);
166        }
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      if (EngineChanged != null)
187        EngineChanged(this, EventArgs.Empty);
188    }
189    protected virtual void OnOperatorGraphChanged() { }
190
191    private void RegisterEngineEvents() {
192      Engine.ExceptionOccurred += new EventHandler<EventArgs<Exception>>(Engine_ExceptionOccurred);
193      Engine.ExecutionTimeChanged += new EventHandler(Engine_ExecutionTimeChanged);
194      Engine.Paused += new EventHandler(Engine_Paused);
195      Engine.Prepared += new EventHandler(Engine_Prepared);
196      Engine.Started += new EventHandler(Engine_Started);
197      Engine.Stopped += new EventHandler(Engine_Stopped);
198    }
199    private void DeregisterEngineEvents() {
200      Engine.ExceptionOccurred -= new EventHandler<EventArgs<Exception>>(Engine_ExceptionOccurred);
201      Engine.ExecutionTimeChanged -= new EventHandler(Engine_ExecutionTimeChanged);
202      Engine.Paused -= new EventHandler(Engine_Paused);
203      Engine.Prepared -= new EventHandler(Engine_Prepared);
204      Engine.Started -= new EventHandler(Engine_Started);
205      Engine.Stopped -= new EventHandler(Engine_Stopped);
206    }
207    private void Engine_ExceptionOccurred(object sender, EventArgs<Exception> e) {
208      OnExceptionOccurred(e.Value);
209    }
210    private void Engine_ExecutionTimeChanged(object sender, EventArgs e) {
211      ExecutionTime = Engine.ExecutionTime;
212    }
213    private void Engine_Paused(object sender, EventArgs e) {
214      OnPaused();
215    }
216    private void Engine_Prepared(object sender, EventArgs e) {
217      OnPrepared();
218    }
219    private void Engine_Started(object sender, EventArgs e) {
220      OnStarted();
221    }
222    private void Engine_Stopped(object sender, EventArgs e) {
223      OnStopped();
224    }
225
226    private void OperatorGraph_InitialOperatorChanged(object sender, EventArgs e) {
227      Prepare();
228    }
229    #endregion
230  }
231}
Note: See TracBrowser for help on using the repository browser.