source: branches/GeneralizedQAP/HeuristicLab.Problems.GeneralizedQuadraticAssignment/3.3/Evaluators/GQAPNMoveEvaluator.cs @ 11290

#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.Encodings.IntegerVectorEncoding;
using HeuristicLab.Operators;
using HeuristicLab.Optimization;
using HeuristicLab.Parameters;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;

namespace HeuristicLab.Problems.GeneralizedQuadraticAssignment {
  [Item("N-Move Evaluator", "Evaluates an N-Move.")]
  [StorableClass]
  public class GQAPNMoveEvaluator : SingleSuccessorOperator, IGQAPNMoveEvaluator, IAssignmentAwareGQAPOperator,
  IQualityAwareGQAPOperator, ITransportationCostsAwareGQAPOperator,
  IExpectedRandomQualityAwareGQAPOperator, IWeightsAwareGQAPOperator, IDistancesAwareGQAPOperator,
  IInstallationCostsAwareGQAPOperator, IDemandsAwareGQAPOperator, ICapacitiesAwareGQAPOperator,
  IEvaluatorAwareGQAPOperator {

    #region Parameter Descriptions
    public static readonly string MoveQualityDescription = "The quality of the move if it would be applied.";
    public static readonly string MoveFlowDistanceQualityDescription = "The quality of the move regarding the flow-distance criteria.";
    public static readonly string MoveInstallationQualityDescription = "The quality of the move regarding the installation costs.";
    public static readonly string MoveOverbookedCapacityDescription = "The sum of the overbooked capacities of the move relative to the capacity of each location.";
    #endregion

    #region Parameter Properties
    ILookupParameter<BoolValue> IQualityAwareGQAPOperator.MaximizationParameter {
      get { return MaximizationParameter; }
    }
    ILookupParameter<BoolValue> IGQAPMoveEvaluator.MaximizationParameter {
      get { return MaximizationParameter; }
    }
    public ILookupParameter<BoolValue> MaximizationParameter {
      get { return (ILookupParameter<BoolValue>)Parameters["Maximization"]; }
    }
    public ILookupParameter<DoubleValue> MoveQualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["MoveQuality"]; }
    }
    public ILookupParameter<DoubleValue> MoveFlowDistanceQualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["MoveFlowDistanceQuality"]; }
    }
    public ILookupParameter<DoubleValue> MoveInstallationQualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["MoveInstallationQuality"]; }
    }
    public ILookupParameter<DoubleValue> MoveOverbookedCapacityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["MoveOverbookedCapacity"]; }
    }
    public ILookupParameter<NMove> MoveParameter {
      get { return (ILookupParameter<NMove>)Parameters["Move"]; }
    }
    public ILookupParameter<IntegerVector> AssignmentParameter {
      get { return (ILookupParameter<IntegerVector>)Parameters["Assignment"]; }
    }
    ILookupParameter<DoubleValue> ISingleObjectiveMoveEvaluator.QualityParameter {
      get { return QualityParameter; }
    }
    ILookupParameter<DoubleValue> IQualityAwareGQAPOperator.QualityParameter {
      get { return QualityParameter; }
    }
    public ILookupParameter<DoubleValue> QualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["Quality"]; }
    }
    public ILookupParameter<DoubleValue> FlowDistanceQualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["FlowDistanceQuality"]; }
    }
    public ILookupParameter<DoubleValue> InstallationQualityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["InstallationQuality"]; }
    }
    public ILookupParameter<DoubleValue> OverbookedCapacityParameter {
      get { return (ILookupParameter<DoubleValue>)Parameters["OverbookedCapacity"]; }
    }
    public IValueLookupParameter<DoubleValue> TransportationCostsParameter {
      get { return (IValueLookupParameter<DoubleValue>)Parameters["TransportationCosts"]; }
    }
    public IValueLookupParameter<DoubleValue> ExpectedRandomQualityParameter {
      get { return (IValueLookupParameter<DoubleValue>)Parameters["ExpectedRandomQuality"]; }
    }
    public ILookupParameter<DoubleMatrix> WeightsParameter {
      get { return (ILookupParameter<DoubleMatrix>)Parameters["Weights"]; }
    }
    public ILookupParameter<DoubleMatrix> DistancesParameter {
      get { return (ILookupParameter<DoubleMatrix>)Parameters["Distances"]; }
    }
    public ILookupParameter<DoubleMatrix> InstallationCostsParameter {
      get { return (ILookupParameter<DoubleMatrix>)Parameters["InstallationCosts"]; }
    }
    public ILookupParameter<DoubleArray> DemandsParameter {
      get { return (ILookupParameter<DoubleArray>)Parameters["Demands"]; }
    }
    public ILookupParameter<DoubleArray> CapacitiesParameter {
      get { return (ILookupParameter<DoubleArray>)Parameters["Capacities"]; }
    }
    public IValueLookupParameter<IGQAPEvaluator> EvaluatorParameter {
      get { return (IValueLookupParameter<IGQAPEvaluator>)Parameters["Evaluator"]; }
    }
    #endregion

    [StorableConstructor]
    protected GQAPNMoveEvaluator(bool deserializing) : base(deserializing) { }
    protected GQAPNMoveEvaluator(GQAPNMoveEvaluator original, Cloner cloner) : base(original, cloner) { }
    public GQAPNMoveEvaluator()
      : base() {
      Parameters.Add(new LookupParameter<IntegerVector>("Assignment", GQAPSolutionCreator.AssignmentDescription));
      Parameters.Add(new LookupParameter<NMove>("Move", GQAPNMoveGenerator.MoveDescription));
      Parameters.Add(new LookupParameter<BoolValue>("Maximization", GeneralizedQuadraticAssignmentProblem.MaximizationDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("Quality", GQAPEvaluator.QualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("FlowDistanceQuality", GQAPEvaluator.FlowDistanceQualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("InstallationQuality", GQAPEvaluator.InstallationQualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("OverbookedCapacity", GQAPEvaluator.OverbookedCapacityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("MoveQuality", MoveQualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("MoveFlowDistanceQuality", MoveFlowDistanceQualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("MoveInstallationQuality", MoveInstallationQualityDescription));
      Parameters.Add(new LookupParameter<DoubleValue>("MoveOverbookedCapacity", MoveOverbookedCapacityDescription));
      Parameters.Add(new ValueLookupParameter<DoubleValue>("ExpectedRandomQuality", GeneralizedQuadraticAssignmentProblem.ExpectedRandomQualityDescription));
      Parameters.Add(new ValueLookupParameter<DoubleValue>("TransportationCosts", GeneralizedQuadraticAssignmentProblem.TransportationCostsDescription));
      Parameters.Add(new LookupParameter<DoubleMatrix>("Weights", GeneralizedQuadraticAssignmentProblem.WeightsDescription));
      Parameters.Add(new LookupParameter<DoubleMatrix>("Distances", GeneralizedQuadraticAssignmentProblem.DistancesDescription));
      Parameters.Add(new LookupParameter<DoubleMatrix>("InstallationCosts", GeneralizedQuadraticAssignmentProblem.InstallationCostsDescription));
      Parameters.Add(new LookupParameter<DoubleArray>("Demands", GeneralizedQuadraticAssignmentProblem.DemandsDescription));
      Parameters.Add(new LookupParameter<DoubleArray>("Capacities", GeneralizedQuadraticAssignmentProblem.CapacitiesDescription));
      Parameters.Add(new ValueLookupParameter<IGQAPEvaluator>("Evaluator", "The evaluator that is used to evaluate GQAP solutions."));
    }

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

    public static double Evaluate(NMove move, IntegerVector assignment, DoubleMatrix weights, DoubleMatrix distances, DoubleMatrix installationCosts,
      DoubleArray demands, DoubleArray capacities, double transportationCosts, double expectedRandomQuality, IGQAPEvaluator evaluator) {
      double moveFlowDistanceQuality, moveInstallationQuality, moveOverbookedCapacity;
      Evaluate(move, assignment, weights, distances, installationCosts, demands, capacities, evaluator,
        out moveFlowDistanceQuality, out moveInstallationQuality, out moveOverbookedCapacity);
      return evaluator.GetFitness(moveFlowDistanceQuality, moveInstallationQuality, moveOverbookedCapacity,
        transportationCosts, expectedRandomQuality);
    }

    public static void Evaluate(NMove move, IntegerVector assignment, DoubleMatrix weights, DoubleMatrix distances, DoubleMatrix installationCosts,
      DoubleArray demands, DoubleArray capacities, IGQAPEvaluator evaluator, out double moveFlowDistanceQuality, out double moveInstallationQuality, out double moveOverbookedCapacity) {
      moveFlowDistanceQuality = moveInstallationQuality = moveOverbookedCapacity = 0.0;
      int moves = move.N;
      var slack = (DoubleArray)capacities.Clone();
      var oldSlack = (DoubleArray)slack.Clone();
      bool first = true;
      foreach (var kvp in move.NewAssignments) {
        int equip = kvp.Key;
        int newLoc = kvp.Value;
        moveInstallationQuality -= installationCosts[equip, assignment[equip]];
        moveInstallationQuality += installationCosts[equip, newLoc];
        for (int j = 0; j < assignment.Length; j++) {
          if (!move.NewAssignments.ContainsKey(j)) {
            moveFlowDistanceQuality += weights[equip, j] * distances[newLoc, assignment[j]];
            moveFlowDistanceQuality -= weights[equip, j] * distances[assignment[equip], assignment[j]];
            moveFlowDistanceQuality += weights[j, equip] * distances[assignment[j], newLoc];
            moveFlowDistanceQuality -= weights[j, equip] * distances[assignment[j], assignment[equip]];
            if (first) { // only once for each untouched equipment deduct the demand from the capacity
              slack[assignment[j]] -= demands[j];
              oldSlack[assignment[j]] -= demands[j];
            }
          } else {
            moveFlowDistanceQuality += weights[equip, j] * distances[newLoc, move.NewAssignments[j]];
            moveFlowDistanceQuality -= weights[equip, j] * distances[assignment[equip], assignment[j]];
          }
        }
        first = false;
        slack[newLoc] -= demands[equip];
        oldSlack[assignment[equip]] -= demands[equip];
      }

      moveOverbookedCapacity = evaluator.EvaluateOverbooking(slack, capacities) - evaluator.EvaluateOverbooking(oldSlack, capacities);
    }

    public override IOperation Apply() {
      var evaluator = EvaluatorParameter.ActualValue;
      double moveFlowDistanceQuality, moveInstallationQuality, moveOverbookedCapacity;
      double quality = QualityParameter.ActualValue.Value;
      double transportationCosts = TransportationCostsParameter.ActualValue.Value;
      double expectedRandomQuality = ExpectedRandomQualityParameter.ActualValue.Value;

      double flowDistanceQuality = FlowDistanceQualityParameter.ActualValue.Value;
      double installationQuality = InstallationQualityParameter.ActualValue.Value;
      double overbookedCapacity = OverbookedCapacityParameter.ActualValue.Value;

      Evaluate(MoveParameter.ActualValue,
               AssignmentParameter.ActualValue,
               WeightsParameter.ActualValue, DistancesParameter.ActualValue,
               InstallationCostsParameter.ActualValue,
               DemandsParameter.ActualValue, CapacitiesParameter.ActualValue,
               evaluator,
               out moveFlowDistanceQuality, out moveInstallationQuality, out moveOverbookedCapacity);

      MoveFlowDistanceQualityParameter.ActualValue = new DoubleValue(flowDistanceQuality + moveFlowDistanceQuality);
      MoveInstallationQualityParameter.ActualValue = new DoubleValue(installationQuality + moveInstallationQuality);
      MoveOverbookedCapacityParameter.ActualValue = new DoubleValue(overbookedCapacity + moveOverbookedCapacity);

      MoveQualityParameter.ActualValue = new DoubleValue(evaluator.GetFitness(
        flowDistanceQuality + moveFlowDistanceQuality,
        installationQuality + moveInstallationQuality,
        overbookedCapacity + moveOverbookedCapacity,
        transportationCosts, expectedRandomQuality));
      return base.Apply();
    }
  }
}