Changeset 7246 for trunk/sources/HeuristicLab.Algorithms.Benchmarks/3.3/BenchmarkAlgorithm.cs

Timestamp:

12/30/11 01:54:44 (12 years ago)

Author:

swagner

Message:

Changes due to review of benchmark algorithms (#1659):

• renamed Benchmark to BenchmarkAlgorithm and BenchmarkView to BenchmarkAlgorithmView
• removed unnecessary assembly references
• removed IBenchmarkView as the user should be informed that there is no specific view for benchmarks
• adapted descriptions of plugins and assemblies
• adapted assembly Guids
• sealed BenchmarkAlgorithm
• adapted item names and item descriptions
• adapted code formatting

Location:

trunk/sources/HeuristicLab.Algorithms.Benchmarks/3.3

Files:

• . (modified) (1 prop)
• BenchmarkAlgorithm.cs (moved) (moved from trunk/sources/HeuristicLab.Algorithms.Benchmarks/3.3/Benchmark.cs) (30 diffs)

trunk/sources/HeuristicLab.Algorithms.Benchmarks/3.3

@@ -3 +3 @@
 obj
 *.vs10x
+*.user

@@ -3 +3 @@
 obj
 *.vs10x
+*.user

trunk/sources/HeuristicLab.Algorithms.Benchmarks/3.3/BenchmarkAlgorithm.cs

@@ -36 +36 @@
 
 namespace HeuristicLab.Algorithms.Benchmarks {
-  /// <summary>
-  /// A base class for benchmarks.
-  /// </summary>
-  [Item("Benchmark", "A wrapper for benchmark algorithms.")]
+  [Item("Benchmark Algorithm", "An algorithm to execute performance benchmarks (Linpack, Dhrystone, Whetstone, etc.).")]
   [Creatable("Algorithms")]
   [StorableClass]
-  public class Benchmark : IAlgorithm {
+  public sealed class BenchmarkAlgorithm : IAlgorithm {
     private Random random = new Random();
+    private CancellationTokenSource cancellationTokenSource;
 
     [Storable]
@@ -49 +47 @@
 
     [Storable]
-    private IBenchmark benchmarkAlgorithm;
-    public IBenchmark BenchmarkAlgorithm {
-      get { return benchmarkAlgorithm; }
+    private IBenchmark benchmark;
+    public IBenchmark Benchmark {
+      get { return benchmark; }
       set {
         if (value == null) throw new ArgumentNullException();
-        benchmarkAlgorithm = value;
-      }
-    }
-
-    private CancellationTokenSource cancellationTokenSource;
+        benchmark = value;
+      }
+    }
 
     [Storable]
@@ -77 +73 @@
     public TimeSpan ExecutionTime {
       get { return executionTime; }
-      protected set {
+      private set {
         executionTime = value;
         OnExecutionTimeChanged();
@@ -96 +92 @@
 
     [Storable]
-    protected int runsCounter;
+    private int runsCounter;
 
     [Storable]
@@ -102 +98 @@
     public RunCollection Runs {
       get { return runs; }
-      protected set {
+      private set {
         if (value == null) throw new ArgumentNullException();
         if (runs != value) {
@@ -116 +112 @@
     public ResultCollection Results {
       get { return results; }
+    }
+
+    public Type ProblemType {
+      get { return typeof(IProblem); }
     }
 
@@ -134 +134 @@
     }
 
-    public Type ProblemType {
-      get { return typeof(IProblem); }
-    }
-
-    [Storable]
-    protected string name;
-
+    [Storable]
+    private string name;
     public string Name {
       get { return name; }
@@ -161 +156 @@
 
     [Storable]
-    protected string description;
+    private string description;
     public string Description {
       get { return description; }
@@ -224 +219 @@
     #region Parameter Properties
 
-    public ConstrainedValueParameter<IBenchmark> BenchmarkAlgorithmParameter {
-      get { return (ConstrainedValueParameter<IBenchmark>)Parameters["BenchmarkAlgorithm"]; }
+    public ConstrainedValueParameter<IBenchmark> BenchmarkParameter {
+      get { return (ConstrainedValueParameter<IBenchmark>)Parameters["Benchmark"]; }
     }
 
@@ -241 +236 @@
 
     [StorableConstructor]
-    public Benchmark(bool deserializing) { }
-
-    public Benchmark() {
+    public BenchmarkAlgorithm(bool deserializing) { }
+
+    public BenchmarkAlgorithm() {
       name = ItemName;
       description = ItemDescription;
@@ -259 +254 @@
     }
 
-    public Benchmark(Benchmark original, Cloner cloner) {
+    public BenchmarkAlgorithm(BenchmarkAlgorithm original, Cloner cloner) {
       cloner.RegisterClonedObject(original, this);
       name = original.name;
@@ -293 +288 @@
         values.Add(b);
       }
-      string paramName = "BenchmarkAlgorithm";
+      string paramName = "Benchmark";
       if (!Parameters.ContainsKey(paramName)) {
         if (values.Count > 0) {
@@ -308 +303 @@
     }
 
-    public virtual void Prepare() {
+    public void Prepare() {
       if ((ExecutionState != ExecutionState.Prepared) && (ExecutionState != ExecutionState.Paused) && (ExecutionState != ExecutionState.Stopped))
         throw new InvalidOperationException(string.Format("Prepare not allowed in execution state \"{0}\".", ExecutionState));
@@ -322 +317 @@
     }
 
-    public virtual void Pause() {
+    public void Pause() {
       if (ExecutionState != ExecutionState.Started)
         throw new InvalidOperationException(string.Format("Pause not allowed in execution state \"{0}\".", ExecutionState));
     }
-    public virtual void Stop() {
+    public void Stop() {
       if ((ExecutionState != ExecutionState.Started) && (ExecutionState != ExecutionState.Paused))
         throw new InvalidOperationException(string.Format("Stop not allowed in execution state \"{0}\".", ExecutionState));
@@ -332 +327 @@
     }
 
-    public virtual void Start() {
+    public void Start() {
       cancellationTokenSource = new CancellationTokenSource();
       OnStarted();
@@ -356 +351 @@
     }
 
-    protected virtual void Run(object state) {
+    private void Run(object state) {
       CancellationToken cancellationToken = (CancellationToken)state;
       lastUpdateTime = DateTime.Now;
@@ -364 +359 @@
       timer.Start();
       try {
-        BenchmarkAlgorithm = (IBenchmark)BenchmarkAlgorithmParameter.ActualValue;
+        Benchmark = (IBenchmark)BenchmarkParameter.ActualValue;
         int chunkSize = ((IntValue)ChunkSizeParameter.ActualValue).Value;
         if (chunkSize > 0) {
-          BenchmarkAlgorithm.ChunkData = CreateDataChuck(chunkSize);
+          Benchmark.ChunkData = CreateDataChuck(chunkSize);
         } else if (chunkSize < 0) {
           throw new ArgumentException("ChunkSize must not be negativ.");
@@ -375 +370 @@
           throw new ArgumentException("TimeLimit must not be negativ. ");
         }
-        BenchmarkAlgorithm.TimeLimit = timelimit;
-        BenchmarkAlgorithm.Run(cancellationToken, results);
+        Benchmark.TimeLimit = timelimit;
+        Benchmark.Run(cancellationToken, results);
       }
       catch (OperationCanceledException) {
@@ -396 +391 @@
     }
 
-    public virtual void CollectResultValues(IDictionary<string, IItem> values) {
+    public void CollectResultValues(IDictionary<string, IItem> values) {
       values.Add("Execution Time", new TimeSpanValue(ExecutionTime));
       CollectResultsRecursively("", Results, values);
@@ -411 +406 @@
     }
 
-    public virtual void CollectParameterValues(IDictionary<string, IItem> values) {
+    public void CollectParameterValues(IDictionary<string, IItem> values) {
       foreach (IValueParameter param in parameters.OfType<IValueParameter>()) {
         if (param.GetsCollected && param.Value != null) values.Add(param.Name, param.Value);
@@ -438 +433 @@
 
     public event EventHandler ExecutionStateChanged;
-    protected virtual void OnExecutionStateChanged() {
+    private void OnExecutionStateChanged() {
       EventHandler handler = ExecutionStateChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler ExecutionTimeChanged;
-    protected virtual void OnExecutionTimeChanged() {
+    private void OnExecutionTimeChanged() {
       EventHandler handler = ExecutionTimeChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler ProblemChanged;
-    protected virtual void OnProblemChanged() {
+    private void OnProblemChanged() {
       EventHandler handler = ProblemChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler StoreAlgorithmInEachRunChanged;
-    protected virtual void OnStoreAlgorithmInEachRunChanged() {
+    private void OnStoreAlgorithmInEachRunChanged() {
       EventHandler handler = StoreAlgorithmInEachRunChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler Prepared;
-    protected virtual void OnPrepared() {
+    private void OnPrepared() {
       ExecutionState = ExecutionState.Prepared;
       ExecutionTime = TimeSpan.Zero;
@@ -468 +463 @@
     }
     public event EventHandler Started;
-    protected virtual void OnStarted() {
+    private void OnStarted() {
       ExecutionState = ExecutionState.Started;
       EventHandler handler = Started;
@@ -474 +469 @@
     }
     public event EventHandler Paused;
-    protected virtual void OnPaused() {
+    private void OnPaused() {
       ExecutionState = ExecutionState.Paused;
       EventHandler handler = Paused;
@@ -480 +475 @@
     }
     public event EventHandler Stopped;
-    protected virtual void OnStopped() {
+    private void OnStopped() {
       ExecutionState = ExecutionState.Stopped;
       foreach (IStatefulItem statefulObject in this.GetObjectGraphObjects().OfType<IStatefulItem>()) {
@@ -491 +486 @@
     }
     public event EventHandler<EventArgs<Exception>> ExceptionOccurred;
-    protected virtual void OnExceptionOccurred(Exception exception) {
+    private void OnExceptionOccurred(Exception exception) {
       EventHandler<EventArgs<Exception>> handler = ExceptionOccurred;
       if (handler != null) handler(this, new EventArgs<Exception>(exception));
@@ -497 +492 @@
 
     public event EventHandler<CancelEventArgs<string>> NameChanging;
-    protected virtual void OnNameChanging(CancelEventArgs<string> e) {
+    private void OnNameChanging(CancelEventArgs<string> e) {
       var handler = NameChanging;
       if (handler != null) handler(this, e);
@@ -503 +498 @@
 
     public event EventHandler NameChanged;
-    protected virtual void OnNameChanged() {
+    private void OnNameChanged() {
       var handler = NameChanged;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -510 +505 @@
 
     public event EventHandler DescriptionChanged;
-    protected virtual void OnDescriptionChanged() {
+    private void OnDescriptionChanged() {
       var handler = DescriptionChanged;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -516 +511 @@
 
     public event EventHandler ItemImageChanged;
-    protected virtual void OnItemImageChanged() {
+    private void OnItemImageChanged() {
       EventHandler handler = ItemImageChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler ToStringChanged;
-    protected virtual void OnToStringChanged() {
+    private void OnToStringChanged() {
       EventHandler handler = ToStringChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
 
-    protected virtual void DeregisterProblemEvents() {
+    private void DeregisterProblemEvents() {
       problem.OperatorsChanged -= new EventHandler(Problem_OperatorsChanged);
       problem.Reset -= new EventHandler(Problem_Reset);
     }
-    protected virtual void RegisterProblemEvents() {
+    private void RegisterProblemEvents() {
       problem.OperatorsChanged += new EventHandler(Problem_OperatorsChanged);
       problem.Reset += new EventHandler(Problem_Reset);
     }
-    protected virtual void Problem_OperatorsChanged(object sender, EventArgs e) { }
-    protected virtual void Problem_Reset(object sender, EventArgs e) {
+    private void Problem_OperatorsChanged(object sender, EventArgs e) { }
+    private void Problem_Reset(object sender, EventArgs e) {
       Prepare();
     }
 
-    protected virtual void DeregisterRunsEvents() {
+    private void DeregisterRunsEvents() {
       runs.CollectionReset -= new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
     }
-    protected virtual void RegisterRunsEvents() {
+    private void RegisterRunsEvents() {
       runs.CollectionReset += new CollectionItemsChangedEventHandler<IRun>(Runs_CollectionReset);
     }
-    protected virtual void Runs_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
+    private void Runs_CollectionReset(object sender, CollectionItemsChangedEventArgs<IRun> e) {
       runsCounter = runs.Count;
     }
@@ -554 +549 @@
 
     public IDeepCloneable Clone(Cloner cloner) {
-      return new Benchmark(this, cloner);
+      return new BenchmarkAlgorithm(this, cloner);
     }
 

@@ -3 +3 @@
 obj
 *.vs10x
+*.user