#region License Information
/* HeuristicLab
* Copyright (C) 2002-2016 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.Parameters;
using HeuristicLab.Persistence;
namespace HeuristicLab.Optimization.Operators {
[Item("TabuMaker", "Base class for all operators that set a move tabu.")]
[StorableType("749a1048-7c75-4cc6-b383-accfa0a685f5")]
public abstract class TabuMaker : SingleSuccessorOperator, ITabuMaker, ISingleObjectiveOperator {
public override bool CanChangeName {
get { return false; }
}
public LookupParameter> TabuListParameter {
get { return (LookupParameter>)Parameters["TabuList"]; }
}
public ValueLookupParameter TabuTenureParameter {
get { return (ValueLookupParameter)Parameters["TabuTenure"]; }
}
public ILookupParameter MoveQualityParameter {
get { return (ILookupParameter)Parameters["MoveQuality"]; }
}
public ILookupParameter QualityParameter {
get { return (ILookupParameter)Parameters["Quality"]; }
}
public IValueLookupParameter MaximizationParameter {
get { return (IValueLookupParameter)Parameters["Maximization"]; }
}
[StorableConstructor]
protected TabuMaker(StorableConstructorFlag deserializing) : base(deserializing) { }
protected TabuMaker(TabuMaker original, Cloner cloner) : base(original, cloner) { }
protected TabuMaker()
: base() {
Parameters.Add(new LookupParameter>("TabuList", "The tabu list where move attributes are stored."));
Parameters.Add(new ValueLookupParameter("TabuTenure", "The tenure of the tabu list."));
Parameters.Add(new LookupParameter("MoveQuality", "The quality of the move."));
Parameters.Add(new LookupParameter("Quality", "The quality of the solution."));
Parameters.Add(new ValueLookupParameter("Maximization", "True if the problem is a maximization problem, else if it is a minimization problem."));
}
public override IOperation Apply() {
ItemList tabuList = TabuListParameter.ActualValue;
int tabuTenure = TabuTenureParameter.ActualValue.Value;
if (tabuTenure == 0) return base.Apply();
if (tabuTenure < 0) throw new InvalidOperationException("A TabuTenure of less than 0 is not allowed.");
int overlength = tabuList.Count - tabuTenure;
if (overlength >= 0) {
for (int i = 0; i < tabuTenure - 1; i++)
tabuList[i] = tabuList[i + overlength + 1];
while (tabuList.Count >= tabuTenure)
tabuList.RemoveAt(tabuList.Count - 1);
}
tabuList.Add(GetTabuAttribute(MaximizationParameter.ActualValue.Value, QualityParameter.ActualValue.Value, MoveQualityParameter.ActualValue.Value));
return base.Apply();
}
protected abstract IItem GetTabuAttribute(bool maximization, double quality, double moveQuality);
}
}