source: branches/LearningClassifierSystems/HeuristicLab.Encodings.ConditionActionEncoding/3.3/Covering/CoveringOperator.cs @ 16657

#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 System;
using System.Linq;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Data;
using HeuristicLab.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Encodings.ConditionActionEncoding {
  [Item("CoveringOperator", "")]
  [StorableClass]
  public class CoveringOperator : SingleSuccessorOperator, ICovering {

    #region Parameter Properties
    public ILookupParameter<IItemSet<IAction>> ActionsInMatchSetParameter {
      get { return (ILookupParameter<IItemSet<IAction>>)Parameters["ActionsInMatchSet"]; }
    }
    public ILookupParameter<IItemSet<IAction>> PossibleActionsParameter {
      get { return (ILookupParameter<IItemSet<IAction>>)Parameters["PossibleActions"]; }
    }
    public ILookupParameter<IntValue> MinimalNumberOfUniqueActionsParameter {
      get { return (ILookupParameter<IntValue>)Parameters["MinimalNumberOfUniqueActions"]; }
    }
    public IValueLookupParameter<IOperator> EvaluatorParameter {
      get { return (IValueLookupParameter<IOperator>)Parameters["Evaluator"]; }
    }
    public IValueLookupParameter<ICoveringSolutionCreator> SolutionCreatorParameter {
      get { return (IValueLookupParameter<ICoveringSolutionCreator>)Parameters["SolutionCreator"]; }
    }
    public ILookupParameter<IRandom> RandomParameter {
      get { return (ILookupParameter<IRandom>)Parameters["Random"]; }
    }
    public ILookupParameter<IntValue> CurrentPopulationSizeParameter {
      get { return (ILookupParameter<IntValue>)Parameters["CurrentPopulationSize"]; }
    }
    public IValueLookupParameter<BoolValue> ParallelParameter {
      get { return (IValueLookupParameter<BoolValue>)Parameters["Parallel"]; }
    }
    private ScopeParameter CurrentScopeParameter {
      get { return (ScopeParameter)Parameters["CurrentScope"]; }
    }
    public IScope CurrentScope {
      get { return CurrentScopeParameter.ActualValue; }
    }
    #endregion

    [StorableConstructor]
    protected CoveringOperator(bool deserializing) : base(deserializing) { }
    protected CoveringOperator(CoveringOperator original, Cloner cloner)
      : base(original, cloner) {
    }
    public override IDeepCloneable Clone(Cloner cloner) {
      return new CoveringOperator(this, cloner);
    }
    public CoveringOperator()
      : base() {
      Parameters.Add(new LookupParameter<IItemSet<IAction>>("ActionsInMatchSet"));
      Parameters.Add(new LookupParameter<IItemSet<IAction>>("PossibleActions"));
      Parameters.Add(new LookupParameter<IntValue>("MinimalNumberOfUniqueActions"));
      Parameters.Add(new ValueLookupParameter<IOperator>("Evaluator"));
      Parameters.Add(new ValueLookupParameter<ICoveringSolutionCreator>("SolutionCreator"));
      Parameters.Add(new LookupParameter<IRandom>("Random"));
      Parameters.Add(new ValueLookupParameter<BoolValue>("Parallel", "True if the operator should be applied in parallel on all sub-scopes, otherwise false.", new BoolValue(true)));
      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope to which the new solutions are added as sub-scopes."));
      Parameters.Add(new LookupParameter<IntValue>("CurrentPopulationSize"));
    }

    public override IOperation Apply() {
      int count = MinimalNumberOfUniqueActionsParameter.ActualValue.Value - ActionsInMatchSetParameter.ActualValue.Count;
      ICoveringSolutionCreator creator = SolutionCreatorParameter.ActualValue;
      IOperator evaluator = EvaluatorParameter.ActualValue;
      bool parallel = ParallelParameter.ActualValue.Value;

      IItemSet<IAction> clone = (IItemSet<IAction>)PossibleActionsParameter.ActualValue.Clone();
      clone.ExceptWith(ActionsInMatchSetParameter.ActualValue);

      if (count > clone.Count) {
        throw new ArgumentException("More classifiers with unique actions shall be created than unique actions are available.");
      }
      if (count > 0) {
        CurrentPopulationSizeParameter.ActualValue.Value += count;

        int current = CurrentScope.SubScopes.Count;
        for (int i = 0; i < count; i++) {
          CurrentScope.SubScopes.Add(new Scope((current + i).ToString()));
        }

        creator.ActionParameter.ActualName = "Action";
        OperationCollection variableCreation = new OperationCollection() { Parallel = parallel };
        OperationCollection creation = new OperationCollection();
        OperationCollection evaluation = new OperationCollection() { Parallel = parallel };
        for (int i = 0; i < count; i++) {
          VariableCreator variableCreator = new VariableCreator();
          int pos = RandomParameter.ActualValue.Next(clone.Count);
          IAction action = clone.ElementAt(pos);
          clone.Remove(action);
          variableCreator.CollectedValues.Add(new ValueParameter<IAction>("Action", action));
          variableCreation.Add(ExecutionContext.CreateOperation(variableCreator, CurrentScope.SubScopes[current + i]));
          creation.Add(ExecutionContext.CreateOperation(creator, CurrentScope.SubScopes[current + i]));
          evaluation.Add(ExecutionContext.CreateOperation(evaluator, CurrentScope.SubScopes[current + i]));
        }
        OperationCollection next = new OperationCollection();
        next.Add(variableCreation);
        next.Add(creation);
        next.Add(evaluation);
        next.Add(base.Apply());
        return next;
      } else {
        return base.Apply();
      }
    }
  }
}