source: branches/HeuristicLab.EvolutionaryTracking/HeuristicLab.Problems.DataAnalysis.Symbolic/3.4/SlidingWindow/GenerationalSlidingWindowAnalyzer.cs @ 13401

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2012 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 <http://www.gnu.org/licenses/>.
 */
#endregion

using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Problems.DataAnalysis.Symbolic {
  [Item("Generational Sliding Window GP Analyzer", "Analyzer which moves a sliding window every n-th generation over the training partition.")]
  [StorableClass]
  public class GenerationalSlidingWindowAnalyzer : SlidingWindowAnalyzer, IIterationBasedOperator {
    private const string GenerationsIntervalParameterName = "Generation Interval";
    private const string GenerationsIntervalStartParameterName = "Generation Interval Start";
    private const string IterationsParameterName = "Iterations";
    private const string MaximumIterationsParameterName = "Maximum Iterations";

    #region parameter properties
    public ILookupParameter<IntValue> IterationsParameter {
      get { return (ILookupParameter<IntValue>)Parameters[IterationsParameterName]; }
    }
    public IValueLookupParameter<IntValue> MaximumIterationsParameter {
      get { return (IValueLookupParameter<IntValue>)Parameters[MaximumIterationsParameterName]; }
    }
    public IFixedValueParameter<IntValue> GenerationsIntervalParameter {
      get { return (IFixedValueParameter<IntValue>)Parameters[GenerationsIntervalParameterName]; }
    }
    public IFixedValueParameter<IntValue> GenerationsIntervalStartParameter {
      get { return (IFixedValueParameter<IntValue>)Parameters[GenerationsIntervalStartParameterName]; }
    }
    #endregion

    #region properties
    public IntValue GenerationsInterval {
      get { return GenerationsIntervalParameter.Value; }
    }
    public IntValue GenerationsIntervalStart {
      get { return GenerationsIntervalStartParameter.Value; }
    }
    #endregion


    [StorableConstructor]
    protected GenerationalSlidingWindowAnalyzer(bool deserializing) : base(deserializing) { }
    protected GenerationalSlidingWindowAnalyzer(GenerationalSlidingWindowAnalyzer original, Cloner cloner) : base(original, cloner) { }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new GenerationalSlidingWindowAnalyzer(this, cloner);
    }

    public GenerationalSlidingWindowAnalyzer() {
      Parameters.Add(new LookupParameter<IntValue>(IterationsParameterName, ""));
      Parameters.Add(new ValueLookupParameter<IntValue>(MaximumIterationsParameterName, ""));
      Parameters.Add(new FixedValueParameter<IntValue>(GenerationsIntervalParameterName, "", new IntValue(5)));
      Parameters.Add(new FixedValueParameter<IntValue>(GenerationsIntervalStartParameterName, "", new IntValue(0)));

      IterationsParameter.ActualName = "Generations";
      MaximumIterationsParameter.Hidden = true;
    }

    protected override bool CheckForUpdate() {
      var iteration = IterationsParameter.ActualValue.Value;
      var start = GenerationsIntervalStart.Value;
      var step = GenerationsInterval.Value;
      if (iteration == 0) return false;
      if (iteration < start) return false;
      if ((iteration - start) % step == 0) return true;

      return false;
    }

  }
}