#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.Collections.Generic;
using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Encodings.CombinedIntegerVectorEncoding;
using HeuristicLab.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Algorithms.LearningClassifierSystems {
  [Item("ActionSelector", "A base class for action selection operators.")]
  [StorableClass]
  public abstract class ActionSelector : SingleSuccessorOperator {

    protected ScopeParameter CurrentScopeParameter {
      get { return (ScopeParameter)Parameters["CurrentScope"]; }
    }
    public ILookupParameter<ItemArray<IMatching>> MatchParameter {
      get { return (ILookupParameter<ItemArray<IMatching>>)Parameters["MatchParameter"]; }
    }
    public IValueLookupParameter<IMatching> SelectedActionParameter {
      get { return (IValueLookupParameter<IMatching>)Parameters["SelectedAction"]; }
    }

    public IScope CurrentScope {
      get { return CurrentScopeParameter.ActualValue; }
    }

    [StorableConstructor]
    protected ActionSelector(bool deserializing) : base(deserializing) { }
    protected ActionSelector(ActionSelector original, Cloner cloner) : base(original, cloner) { }

    protected ActionSelector()
      : base() {
      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope from which sub-scopes should be selected."));
      Parameters.Add(new ScopeTreeLookupParameter<IMatching>("MatchParameter", "The matching encoding contained in each sub-scope which is used for selection."));
      Parameters.Add(new ValueLookupParameter<IMatching>("SelectedAction", "Action, which has been selected."));
    }

    public sealed override IOperation Apply() {
      List<IScope> scopes = new List<IScope>(CurrentScope.SubScopes);
      SelectedActionParameter.ActualValue = SelectAction(scopes);
      return base.Apply();
    }

    protected abstract IMatching SelectAction(List<IScope> scopes);
  }
}