#region License Information
/* HeuristicLab
* Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
*
* This file is part of HeuristicLab.
*
* HeuristicLab is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* HeuristicLab is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with HeuristicLab. If not, see .
*/
#endregion
using System;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Optimization.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
namespace HeuristicLab.Analysis {
///
/// An operator which analyzes the minimum, average and maximum of a value in the scope tree.
///
[Item("MinAverageMaxValueAnalyzer", "An operator which analyzes the minimum, average and maximum of a value in the scope tree.")]
[StorableClass]
public sealed class MinAverageMaxValueAnalyzer : AlgorithmOperator, IAnalyzer {
#region Parameter properties
public ScopeTreeLookupParameter ValueParameter {
get { return (ScopeTreeLookupParameter)Parameters["Value"]; }
}
public ValueLookupParameter MinValueParameter {
get { return (ValueLookupParameter)Parameters["MinValue"]; }
}
public ValueLookupParameter AverageValueParameter {
get { return (ValueLookupParameter)Parameters["AverageValue"]; }
}
public ValueLookupParameter MaxValueParameter {
get { return (ValueLookupParameter)Parameters["MaxValue"]; }
}
public ValueLookupParameter ValuesParameter {
get { return (ValueLookupParameter)Parameters["Values"]; }
}
public ValueLookupParameter ResultsParameter {
get { return (ValueLookupParameter)Parameters["Results"]; }
}
public ValueParameter CollectMinValueInResultsParameter {
get { return (ValueParameter)Parameters["CollectMinValueInResults"]; }
}
public ValueParameter CollectMaxValueInResultsParameter {
get { return (ValueParameter)Parameters["CollectMaxValueInResults"]; }
}
public ValueParameter CollectAverageValueInResultsParameter {
get { return (ValueParameter)Parameters["CollectAverageValueInResults"]; }
}
#endregion
#region Properties
public bool EnabledByDefault {
get { return true; }
}
private MinAverageMaxValueCalculator MinAverageMaxValueCalculator {
get { return (MinAverageMaxValueCalculator)OperatorGraph.InitialOperator; }
}
private BoolValue CollectMinValueInResults {
get { return CollectMinValueInResultsParameter.Value; }
}
private BoolValue CollectMaxValueInResults {
get { return CollectMaxValueInResultsParameter.Value; }
}
private BoolValue CollectAverageValueInResults {
get { return CollectAverageValueInResultsParameter.Value; }
}
#endregion
[Storable]
private ResultsCollector resultsCollector;
#region Storing & Cloning
[StorableConstructor]
private MinAverageMaxValueAnalyzer(bool deserializing) : base(deserializing) { }
private MinAverageMaxValueAnalyzer(MinAverageMaxValueAnalyzer original, Cloner cloner)
: base(original, cloner) {
resultsCollector = cloner.Clone(original.resultsCollector);
RegisterEventHandlers();
}
public override IDeepCloneable Clone(Cloner cloner) {
return new MinAverageMaxValueAnalyzer(this, cloner);
}
#endregion
public MinAverageMaxValueAnalyzer()
: base() {
#region Create parameters
Parameters.Add(new ScopeTreeLookupParameter("Value", "The value contained in the scope tree which should be analyzed."));
Parameters.Add(new ValueLookupParameter("MinValue", "The minimum of the value."));
Parameters.Add(new ValueParameter("CollectMinValueInResults", "Determines if the minimum of the value should also be stored in the results.", new BoolValue(true)));
Parameters.Add(new ValueLookupParameter("AverageValue", "The average of the value."));
Parameters.Add(new ValueParameter("CollectAverageValueInResults", "Determines if the average of the value should also be stored in the results.", new BoolValue(true)));
Parameters.Add(new ValueLookupParameter("MaxValue", "The maximum of the value."));
Parameters.Add(new ValueParameter("CollectMaxValueInResults", "Determines if the maximum of the value should also be stored in the results.", new BoolValue(true)));
Parameters.Add(new ValueLookupParameter("Values", "The data table to store the minimum, average and maximum of the value."));
Parameters.Add(new ValueLookupParameter("Results", "The results collection where the analysis values should be stored."));
#endregion
#region Create operators
MinAverageMaxValueCalculator minAverageMaxValueCalculator = new MinAverageMaxValueCalculator();
DataTableValuesCollector dataTableValuesCollector = new DataTableValuesCollector();
resultsCollector = new ResultsCollector();
minAverageMaxValueCalculator.AverageValueParameter.ActualName = AverageValueParameter.Name;
minAverageMaxValueCalculator.MaxValueParameter.ActualName = MaxValueParameter.Name;
minAverageMaxValueCalculator.MinValueParameter.ActualName = MinValueParameter.Name;
minAverageMaxValueCalculator.ValueParameter.ActualName = ValueParameter.Name;
minAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
dataTableValuesCollector.CollectedValues.Add(new LookupParameter("MinValue", null, MinValueParameter.Name));
dataTableValuesCollector.CollectedValues.Add(new LookupParameter("AverageValue", null, AverageValueParameter.Name));
dataTableValuesCollector.CollectedValues.Add(new LookupParameter("MaxValue", null, MaxValueParameter.Name));
dataTableValuesCollector.DataTableParameter.ActualName = ValuesParameter.Name;
if (CollectMinValueInResults.Value)
resultsCollector.CollectedValues.Add(new LookupParameter("MinValue", null, MinValueParameter.Name));
if (CollectAverageValueInResults.Value)
resultsCollector.CollectedValues.Add(new LookupParameter("AverageValue", null, AverageValueParameter.Name));
if (CollectMaxValueInResults.Value)
resultsCollector.CollectedValues.Add(new LookupParameter("MaxValue", null, MaxValueParameter.Name));
resultsCollector.CollectedValues.Add(new LookupParameter(ValuesParameter.Name));
resultsCollector.ResultsParameter.ActualName = ResultsParameter.Name;
#endregion
#region Create operator graph
OperatorGraph.InitialOperator = minAverageMaxValueCalculator;
minAverageMaxValueCalculator.Successor = dataTableValuesCollector;
dataTableValuesCollector.Successor = resultsCollector;
resultsCollector.Successor = null;
#endregion
RegisterEventHandlers();
}
[StorableHook(HookType.AfterDeserialization)]
private void AfterDeserialization() {
RegisterEventHandlers();
}
private void RegisterEventHandlers() {
ValueParameter.DepthChanged += new EventHandler(ValueParameter_DepthChanged);
CollectMinValueInResultsParameter.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_ValueChanged);
CollectMinValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_Value_ValueChanged);
CollectMaxValueInResultsParameter.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_ValueChanged);
CollectMaxValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_Value_ValueChanged);
CollectAverageValueInResultsParameter.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_ValueChanged);
CollectAverageValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_Value_ValueChanged);
}
private void CollectAverageValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
IParameter avgValueParameter;
resultsCollector.CollectedValues.TryGetValue("AverageValue", out avgValueParameter);
if (CollectAverageValueInResults.Value && avgValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("AverageValue", null, AverageValueParameter.Name));
else if (!CollectAverageValueInResults.Value && avgValueParameter != null)
resultsCollector.CollectedValues.Remove(avgValueParameter);
CollectAverageValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectAverageValueInResultsParameter_Value_ValueChanged);
}
private void CollectAverageValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
IParameter avgValueParameter;
resultsCollector.CollectedValues.TryGetValue("AverageValue", out avgValueParameter);
if (CollectAverageValueInResults.Value && avgValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("AverageValue", null, AverageValueParameter.Name));
else if (!CollectAverageValueInResults.Value && avgValueParameter != null)
resultsCollector.CollectedValues.Remove(avgValueParameter);
}
private void CollectMaxValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
IParameter maxValueParameter;
resultsCollector.CollectedValues.TryGetValue("MaxValue", out maxValueParameter);
if (CollectMaxValueInResults.Value && maxValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("MaxValue", null, MaxValueParameter.Name));
else if (!CollectMaxValueInResults.Value && maxValueParameter != null)
resultsCollector.CollectedValues.Remove(maxValueParameter);
CollectMaxValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMaxValueInResultsParameter_Value_ValueChanged);
}
private void CollectMaxValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
IParameter maxValueParameter;
resultsCollector.CollectedValues.TryGetValue("MaxValue", out maxValueParameter);
if (CollectMaxValueInResults.Value && maxValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("MaxValue", null, MaxValueParameter.Name));
else if (!CollectMaxValueInResults.Value && maxValueParameter != null)
resultsCollector.CollectedValues.Remove(maxValueParameter);
}
private void CollectMinValueInResultsParameter_ValueChanged(object sender, EventArgs e) {
IParameter minValueParameter;
resultsCollector.CollectedValues.TryGetValue("MinValue", out minValueParameter);
if (CollectMinValueInResults.Value && minValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("MinValue", null, MinValueParameter.Name));
else if (!CollectMinValueInResults.Value && minValueParameter != null)
resultsCollector.CollectedValues.Remove(minValueParameter);
CollectMinValueInResultsParameter.Value.ValueChanged += new EventHandler(CollectMinValueInResultsParameter_Value_ValueChanged);
}
private void CollectMinValueInResultsParameter_Value_ValueChanged(object sender, EventArgs e) {
IParameter minValueParameter;
resultsCollector.CollectedValues.TryGetValue("MinValue", out minValueParameter);
if (CollectMinValueInResults.Value && minValueParameter == null)
resultsCollector.CollectedValues.Add(new LookupParameter("MinValue", null, MinValueParameter.Name));
else if (!CollectMinValueInResults.Value && minValueParameter != null)
resultsCollector.CollectedValues.Remove(minValueParameter);
}
private void ValueParameter_DepthChanged(object sender, System.EventArgs e) {
MinAverageMaxValueCalculator.ValueParameter.Depth = ValueParameter.Depth;
}
}
}