#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2015 Joseph Helm and 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.Encodings.PermutationEncoding;
using HeuristicLab.Optimization.Operators;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using HeuristicLab.Problems.BinPacking;

namespace HeuristicLab.Encodings.PackingEncoding.PackingSequence {
  [Item("Sequence tabu maker", "Declares a given Sequence move as tabu, by adding its attributes to the tabu list and also store the solution quality or the move quality (whichever is better).")]
  [StorableClass]
  public class SequenceTabuMaker : TabuMaker, IPackingSequenceMoveOperator {
    public ILookupParameter<IPackingMove<Permutation>> PackingMoveParameter {
      get { return (ILookupParameter<IPackingMove<Permutation>>)Parameters["PackingMove"]; }
    }
    public ILookupParameter<Permutation> PackingSequenceParameter {
      get { return (ILookupParameter<Permutation>)Parameters["PackingSequence"]; }
    }

    [StorableConstructor]
    protected SequenceTabuMaker(bool deserializing) : base(deserializing) { }
    protected SequenceTabuMaker(SequenceTabuMaker original, Cloner cloner) : base(original, cloner) { }
    public SequenceTabuMaker()
      : base() {
      Parameters.Add(new LookupParameter<IPackingMove<Permutation>>("PackingMove", "The move to evaluate."));
      Parameters.Add(new LookupParameter<Permutation>("PackingSequence", "The solution to evaluate."));
    }

    public override IDeepCloneable Clone(Cloner cloner) {
      return new SequenceTabuMaker(this, cloner);
    }

    protected override IItem GetTabuAttribute(bool maximization, double quality, double moveQuality) {
      var move = PackingMoveParameter.ActualValue;
      double baseQuality = moveQuality;
      if (maximization && quality > moveQuality || !maximization && quality < moveQuality)
        baseQuality = quality; // we make an uphill move, the lower bound is the solution quality

      var sMove = move as SequenceMove;

      if (sMove != null)
        return sMove.GetAttribute(baseQuality);
      else
        return move.GetSolutionAfterMove();
    }
  }
}