Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Optimization/3.3/MetaOptimizers/Experiment.cs @ 11641

Last change on this file since 11641 was 11171, checked in by ascheibe, 10 years ago

#2115 merged r11170 (copyright update) into trunk
File size: 18.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2014 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.Drawing;
25using System.Linq;
26using HeuristicLab.Collections;
27using HeuristicLab.Common;
28using HeuristicLab.Core;
29using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
30
31namespace HeuristicLab.Optimization {
32  /// <summary>
33  /// An experiment which contains multiple algorithms, batch runs or other experiments.
34  /// </summary>
35  [Item("Experiment", "An experiment which contains multiple algorithms, batch runs or other experiments.")]
36  [Creatable("Testing & Analysis")]
37  [StorableClass]
38  public sealed class Experiment : NamedItem, IOptimizer, IStorableContent {
39    public string Filename { get; set; }
40
41    public static new Image StaticItemImage {
42      get { return HeuristicLab.Common.Resources.VSImageLibrary.Event; }
43    }
44    public override Image ItemImage {
45      get {
46        if (ExecutionState == ExecutionState.Prepared) return HeuristicLab.Common.Resources.VSImageLibrary.ExperimentPrepared;
47        else if (ExecutionState == ExecutionState.Started) return HeuristicLab.Common.Resources.VSImageLibrary.ExperimentStarted;
48        else if (ExecutionState == ExecutionState.Paused) return HeuristicLab.Common.Resources.VSImageLibrary.ExperimentPaused;
49        else if (ExecutionState == ExecutionState.Stopped) return HeuristicLab.Common.Resources.VSImageLibrary.ExperimentStopped;
50        else return base.ItemImage;
51      }
52    }
53
54    [Storable]
55    private ExecutionState executionState;
56    public ExecutionState ExecutionState {
57      get { return executionState; }
58      private set {
59        if (executionState != value) {
60          executionState = value;
61          OnExecutionStateChanged();
62          OnItemImageChanged();
63        }
64      }
65    }
66
67    [Storable]
68    private TimeSpan executionTime;
69    public TimeSpan ExecutionTime {
70      get { return executionTime; }
71      private set {
72        executionTime = value;
73        OnExecutionTimeChanged();
74      }
75    }
76
77    [Storable]
78    private OptimizerList optimizers;
79    public OptimizerList Optimizers {
80      get { return optimizers; }
81    }
82
83    [Storable]
84    private RunCollection runs;
85    public RunCollection Runs {
86      get { return runs; }
87      private set {
88        if (value == null) throw new ArgumentNullException();
89        if (runs != value) {
90          if (runs != null) DeregisterRunsEvents();
91          runs = value;
92          if (runs != null) RegisterRunsEvents();
93        }
94      }
95    }
96
97    public IEnumerable<IOptimizer> NestedOptimizers {
98      get {
99        if (Optimizers == null) yield break;
100
101        foreach (IOptimizer opt in Optimizers) {
102          yield return opt;
103          foreach (IOptimizer nestedOpt in opt.NestedOptimizers)
104            yield return nestedOpt;
105        }
106      }
107    }
108
109    private bool experimentStarted = false;
110    private bool experimentStopped = false;
111
112    public Experiment()
113      : base() {
114      name = ItemName;
115      description = ItemDescription;
116      executionState = ExecutionState.Stopped;
117      executionTime = TimeSpan.Zero;
118      optimizers = new OptimizerList();
119      Runs = new RunCollection { OptimizerName = Name };
120      Initialize();
121    }
122    public Experiment(string name)
123      : base(name) {
124      description = ItemDescription;
125      executionState = ExecutionState.Stopped;
126      executionTime = TimeSpan.Zero;
127      optimizers = new OptimizerList();
128      Runs = new RunCollection { OptimizerName = Name };
129      Initialize();
130    }
131    public Experiment(string name, string description)
132      : base(name, description) {
133      executionState = ExecutionState.Stopped;
134      executionTime = TimeSpan.Zero;
135      optimizers = new OptimizerList();
136      Runs = new RunCollection { OptimizerName = Name };
137      Initialize();
138    }
139    [StorableConstructor]
140    private Experiment(bool deserializing) : base(deserializing) { }
141    [StorableHook(HookType.AfterDeserialization)]
142    private void AfterDeserialization() {
143      Initialize();
144    }
145    private Experiment(Experiment original, Cloner cloner)
146      : base(original, cloner) {
147      executionState = original.executionState;
148      executionTime = original.executionTime;
149      optimizers = cloner.Clone(original.optimizers);
150      runs = cloner.Clone(original.runs);
151
152      experimentStarted = original.experimentStarted;
153      experimentStopped = original.experimentStopped;
154      Initialize();
155    }
156    public override IDeepCloneable Clone(Cloner cloner) {
157      if (ExecutionState == ExecutionState.Started) throw new InvalidOperationException(string.Format("Clone not allowed in execution state \"{0}\".", ExecutionState));
158      return new Experiment(this, cloner);
159    }
160
161    private void Initialize() {
162      RegisterOptimizersEvents();
163      foreach (IOptimizer optimizer in optimizers)
164        RegisterOptimizerEvents(optimizer);
165      if (runs != null) RegisterRunsEvents();
166    }
167
168    public void Prepare() {
169      Prepare(false);
170    }
171    public void Prepare(bool clearRuns) {
172      if ((ExecutionState != ExecutionState.Prepared) && (ExecutionState != ExecutionState.Paused) && (ExecutionState != ExecutionState.Stopped))
173        throw new InvalidOperationException(string.Format("Prepare not allowed in execution state \"{0}\".", ExecutionState));
174      if (Optimizers.Count == 0) return;
175
176      if (clearRuns) runs.Clear();
177
178      experimentStarted = false;
179      experimentStopped = false;
180      foreach (IOptimizer optimizer in Optimizers.Where(x => x.ExecutionState != ExecutionState.Started)) {
181        // a race-condition may occur when the optimizer has changed the state by itself in the meantime
182        try { optimizer.Prepare(clearRuns); } catch (InvalidOperationException) { }
183      }
184    }
185    public void Start() {
186      if ((ExecutionState != ExecutionState.Prepared) && (ExecutionState != ExecutionState.Paused))
187        throw new InvalidOperationException(string.Format("Start not allowed in execution state \"{0}\".", ExecutionState));
188      if (Optimizers.Count == 0) return;
189
190      experimentStarted = true;
191      experimentStopped = false;
192      IOptimizer optimizer = Optimizers.FirstOrDefault(x => (x.ExecutionState == ExecutionState.Prepared) || (x.ExecutionState == ExecutionState.Paused));
193      if (optimizer != null) {
194        // a race-condition may occur when the optimizer has changed the state by itself in the meantime
195        try { optimizer.Start(); } catch (InvalidOperationException) { }
196      }
197    }
198    public void Pause() {
199      if (ExecutionState != ExecutionState.Started)
200        throw new InvalidOperationException(string.Format("Pause not allowed in execution state \"{0}\".", ExecutionState));
201      if (Optimizers.Count == 0) return;
202
203      experimentStarted = false;
204      experimentStopped = false;
205      foreach (IOptimizer optimizer in Optimizers.Where(x => x.ExecutionState == ExecutionState.Started)) {
206        // a race-condition may occur when the optimizer has changed the state by itself in the meantime
207        try { optimizer.Pause(); } catch (InvalidOperationException) { }
208      }
209    }
210    public void Stop() {
211      if ((ExecutionState != ExecutionState.Started) && (ExecutionState != ExecutionState.Paused))
212        throw new InvalidOperationException(string.Format("Stop not allowed in execution state \"{0}\".", ExecutionState));
213      if (Optimizers.Count == 0) return;
214
215      experimentStarted = false;
216      experimentStopped = true;
217      if (Optimizers.Any(x => (x.ExecutionState == ExecutionState.Started) || (x.ExecutionState == ExecutionState.Paused))) {
218        foreach (var optimizer in Optimizers.Where(x => (x.ExecutionState == ExecutionState.Started) || (x.ExecutionState == ExecutionState.Paused))) {
219          // a race-condition may occur when the optimizer has changed the state by itself in the meantime
220          try { optimizer.Stop(); } catch (InvalidOperationException) { }
221        }
222      } else {
223        OnStopped();
224      }
225    }
226
227    #region Events
228    protected override void OnNameChanged() {
229      base.OnNameChanged();
230      Runs.OptimizerName = Name;
231    }
232
233    public event EventHandler ExecutionStateChanged;
234    private void OnExecutionStateChanged() {
235      EventHandler handler = ExecutionStateChanged;
236      if (handler != null) handler(this, EventArgs.Empty);
237    }
238    public event EventHandler ExecutionTimeChanged;
239    private void OnExecutionTimeChanged() {
240      EventHandler handler = ExecutionTimeChanged;
241      if (handler != null) handler(this, EventArgs.Empty);
242    }
243    public event EventHandler Prepared;
244    private void OnPrepared() {
245      ExecutionState = ExecutionState.Prepared;
246      EventHandler handler = Prepared;
247      if (handler != null) handler(this, EventArgs.Empty);
248    }
249    public event EventHandler Started;
250    private void OnStarted() {
251      ExecutionState = ExecutionState.Started;
252      EventHandler handler = Started;
253      if (handler != null) handler(this, EventArgs.Empty);
254    }
255    public event EventHandler Paused;
256    private void OnPaused() {
257      ExecutionState = ExecutionState.Paused;
258      EventHandler handler = Paused;
259      if (handler != null) handler(this, EventArgs.Empty);
260    }
261    public event EventHandler Stopped;
262    private void OnStopped() {
263      ExecutionState = ExecutionState.Stopped;
264      EventHandler handler = Stopped;
265      if (handler != null) handler(this, EventArgs.Empty);
266    }
267    public event EventHandler<EventArgs<Exception>> ExceptionOccurred;
268    private void OnExceptionOccurred(Exception exception) {
269      EventHandler<EventArgs<Exception>> handler = ExceptionOccurred;
270      if (handler != null) handler(this, new EventArgs<Exception>(exception));
271    }
272
273    private void RegisterOptimizersEvents() {
274      Optimizers.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_CollectionReset);
275      Optimizers.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsAdded);
276      Optimizers.ItemsRemoved += new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsRemoved);
277      Optimizers.ItemsReplaced += new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsReplaced);
278    }
279    private void DeregisterOptimizersEvents() {
280      Optimizers.CollectionReset -= new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_CollectionReset);
281      Optimizers.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsAdded);
282      Optimizers.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsRemoved);
283      Optimizers.ItemsReplaced -= new CollectionItemsChangedEventHandler<IndexedItem<IOptimizer>>(Optimizers_ItemsReplaced);
284    }
285    private void Optimizers_CollectionReset(object sender, CollectionItemsChangedEventArgs<IndexedItem<IOptimizer>> e) {
286      foreach (IndexedItem<IOptimizer> item in e.OldItems)
287        RemoveOptimizer(item.Value);
288      foreach (IndexedItem<IOptimizer> item in e.Items)
289        AddOptimizer(item.Value);
290    }
291    private void Optimizers_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IndexedItem<IOptimizer>> e) {
292      foreach (IndexedItem<IOptimizer> item in e.Items)
293        AddOptimizer(item.Value);
294    }
295    private void Optimizers_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IndexedItem<IOptimizer>> e) {
296      foreach (IndexedItem<IOptimizer> item in e.Items)
297        RemoveOptimizer(item.Value);
298    }
299    private void Optimizers_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IndexedItem<IOptimizer>> e) {
300      foreach (IndexedItem<IOptimizer> item in e.OldItems)
301        RemoveOptimizer(item.Value);
302      foreach (IndexedItem<IOptimizer> item in e.Items)
303        AddOptimizer(item.Value);
304    }
305    private void AddOptimizer(IOptimizer optimizer) {
306      RegisterOptimizerEvents(optimizer);
307      Runs.AddRange(optimizer.Runs);
308      optimizer.Prepare();
309      if (ExecutionState == ExecutionState.Stopped && optimizer.ExecutionState == ExecutionState.Prepared)
310        OnPrepared();
311    }
312    private void RemoveOptimizer(IOptimizer optimizer) {
313      DeregisterOptimizerEvents(optimizer);
314      Runs.RemoveRange(optimizer.Runs);
315      if (ExecutionState == ExecutionState.Prepared && !optimizers.Any(opt => opt.ExecutionState == ExecutionState.Prepared))
316        OnStopped();
317    }
318
319    private void RegisterOptimizerEvents(IOptimizer optimizer) {
320      optimizer.ExceptionOccurred += new EventHandler<EventArgs<Exception>>(optimizer_ExceptionOccurred);
321      optimizer.ExecutionTimeChanged += new EventHandler(optimizer_ExecutionTimeChanged);
322      optimizer.Paused += new EventHandler(optimizer_Paused);
323      optimizer.Prepared += new EventHandler(optimizer_Prepared);
324      optimizer.Started += new EventHandler(optimizer_Started);
325      optimizer.Stopped += new EventHandler(optimizer_Stopped);
326      optimizer.Runs.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_CollectionReset);
327      optimizer.Runs.ItemsAdded += new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_ItemsAdded);
328      optimizer.Runs.ItemsRemoved += new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_ItemsRemoved);
329    }
330    private void DeregisterOptimizerEvents(IOptimizer optimizer) {
331      optimizer.ExceptionOccurred -= new EventHandler<EventArgs<Exception>>(optimizer_ExceptionOccurred);
332      optimizer.ExecutionTimeChanged -= new EventHandler(optimizer_ExecutionTimeChanged);
333      optimizer.Paused -= new EventHandler(optimizer_Paused);
334      optimizer.Prepared -= new EventHandler(optimizer_Prepared);
335      optimizer.Started -= new EventHandler(optimizer_Started);
336      optimizer.Stopped -= new EventHandler(optimizer_Stopped);
337      optimizer.Runs.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_CollectionReset);
338      optimizer.Runs.ItemsAdded -= new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_ItemsAdded);
339      optimizer.Runs.ItemsRemoved -= new CollectionItemsChangedEventHandler<IRun>(optimizer_Runs_ItemsRemoved);
340    }
341
342    private readonly object locker = new object();
343    private void optimizer_ExceptionOccurred(object sender, EventArgs<Exception> e) {
344      lock (locker)
345        OnExceptionOccurred(e.Value);
346    }
347    private void optimizer_ExecutionTimeChanged(object sender, EventArgs e) {
348      lock (locker)
349        ExecutionTime = Optimizers.Aggregate(TimeSpan.Zero, (t, o) => t + o.ExecutionTime);
350    }
351    private void optimizer_Paused(object sender, EventArgs e) {
352      lock (locker)
353        if (Optimizers.All(x => x.ExecutionState != ExecutionState.Started)) OnPaused();
354    }
355    private void optimizer_Prepared(object sender, EventArgs e) {
356      lock (locker)
357        if (Optimizers.All(x => x.ExecutionState == ExecutionState.Prepared)) OnPrepared();
358    }
359    private void optimizer_Started(object sender, EventArgs e) {
360      lock (locker)
361        if (ExecutionState != ExecutionState.Started) OnStarted();
362    }
363    private void optimizer_Stopped(object sender, EventArgs e) {
364      lock (locker) {
365        if (experimentStopped) {
366          if (Optimizers.All(x => (x.ExecutionState == ExecutionState.Stopped) || (x.ExecutionState == ExecutionState.Prepared))) OnStopped();
367        } else {
368          if (experimentStarted && Optimizers.Any(x => (x.ExecutionState == ExecutionState.Prepared) || (x.ExecutionState == ExecutionState.Paused))) {
369            Optimizers.First(x => (x.ExecutionState == ExecutionState.Prepared) || (x.ExecutionState == ExecutionState.Paused)).Start();
370          } else if (Optimizers.All(x => x.ExecutionState == ExecutionState.Stopped)) OnStopped();
371          else if (Optimizers.Any(x => (x.ExecutionState == ExecutionState.Prepared) || (x.ExecutionState == ExecutionState.Paused)) && Optimizers.All(o => o.ExecutionState != ExecutionState.Started)) OnPaused();
372        }
373      }
374    }
375    private void optimizer_Runs_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
376      lock (locker) {
377        Runs.RemoveRange(e.OldItems);
378        Runs.AddRange(e.Items);
379      }
380    }
381    private void optimizer_Runs_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IRun> e) {
382      lock (locker)
383        Runs.AddRange(e.Items);
384    }
385    private void optimizer_Runs_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IRun> e) {
386      lock (locker)
387        Runs.RemoveRange(e.Items);
388    }
389
390    private void RegisterRunsEvents() {
391      runs.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
392      runs.ItemsRemoved += new CollectionItemsChangedEventHandler<IRun>(Runs_ItemsRemoved);
393    }
394    private void DeregisterRunsEvents() {
395      runs.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
396      runs.ItemsRemoved -= new CollectionItemsChangedEventHandler<IRun>(Runs_ItemsRemoved);
397    }
398    private void Runs_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
399      foreach (IOptimizer optimizer in Optimizers)
400        optimizer.Runs.RemoveRange(e.OldItems);
401    }
402    private void Runs_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IRun> e) {
403      foreach (IOptimizer optimizer in Optimizers)
404        optimizer.Runs.RemoveRange(e.Items);
405    }
406    #endregion
407  }
408}
Note: See TracBrowser for help on using the repository browser.