#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

namespace HeuristicLab.Problems.Instances {
  /// <summary>
  /// Describes an instance of the Generalized Quadratic Assignment Problem (GQAP).
  /// </summary>
  public interface IGQAPInstance {
    /// <summary>
    /// The name of the instance.
    /// </summary>
    string Name { get; }
    /// <summary>
    /// A description of the instance.
    /// </summary>
    string Description { get; }

    /// <summary>
    /// |E| = The number of equipments are to be assigned in this instance.
    /// </summary>
    int Equipments { get; }
    /// <summary>
    /// |L| = The number of locations that are available for the equipments.
    /// </summary>
    int Locations { get; }
    /// <summary>
    /// Vector of length |E| that describes the space demand for the equipments.
    /// </summary>
    double[] Demands { get; }
    /// <summary>
    /// Vector of length |L| that describes the space capacity for the locations.
    /// </summary>
    double[] Capacities { get; }
    /// <summary>
    /// |E|x|E| matrix with the weights (flows) between the equipments. These describe the strength of the respective bonding.
    /// </summary>
    double[,] Weights { get; }
    /// <summary>
    /// |L|x|L| matrix with the distances between the locations.
    /// </summary>
    double[,] Distances { get; }
    /// <summary>
    /// |E|x|L| matrix that describes the costs of installing equipment x at location y.
    /// </summary>
    double[,] InstallationCosts { get; }
    /// <summary>
    /// A factor that scales the weights.
    /// </summary>
    double TransportationCosts { get; }

    /// <summary>
    /// Optional! The best-known assignment is a vector of length |E| with numbers ranging from 0 to |L| - 1
    /// </summary>
    int[] BestKnownAssignment { get; }
    /// <summary>
    /// Optional! The quality of the best-known assignment.
    /// </summary>
    double? BestKnownQuality { get; }
  }
}