Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2864_PermutationProblems/HeuristicLab.Problems.Instances/3.3/Types/VRP/VRPData.cs @ 16003

Last change on this file since 16003 was 16003, checked in by fholzing, 6 years ago

#2864: Changed Copyright from -2016 to -2018

File size: 3.7 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22
23namespace HeuristicLab.Problems.Instances {
24  /// <summary>
25  /// Describes instances of the Vehicle Routing Problem (VRP).
26  /// </summary>
27  public class VRPData : IVRPData {
28    /// <summary>
29    /// The name of the instance
30    /// </summary>
31    public string Name { get; set; }
32    /// <summary>
33    /// Optional! The description of the instance
34    /// </summary>
35    public string Description { get; set; }
36
37    /// <summary>
38    /// The number of customers and the depot
39    /// </summary>
40    public int Dimension { get; set; }
41    /// <summary>
42    /// The distance measure that is used to calculate the distance between
43    ///the coordinates if no <see cref="Distances"/> is given.
44    /// </summary>
45    public DistanceMeasure DistanceMeasure { get; set; }
46    /// <summary>
47    /// Optional! The maximum number of vehicles that can be used.
48    /// </summary>
49    /// <remarks>
50    /// If no number is given, but a maximum is required, it can be assumed that
51    /// the maximum number of vehicles is equal to the number of customers as
52    /// there cannot be more than one vehicle per customer.
53    /// </remarks>
54    public double? MaximumVehicles { get; set; }
55    /// <remarks>
56    /// Either Distances or the <see cref="Coordinates"/> need to be specified along
57    /// with a distance measure.
58    /// </remarks>
59    public double[,] Distances { get; set; }
60    /// <summary>
61    /// Optional! A a matrix of dimension [N, 2] where each row is either the customer
62    /// or the depot and the columns represent x and y coordinates respectively.
63    /// </summary>
64    /// <remarks>
65    /// Either <see cref="Distances"/> or the Coordinates need to be specified along
66    /// with a distance measure.
67    /// </remarks>
68    public double[,] Coordinates { get; set; }
69    /// <summary>
70    /// The demand vector that specifies how many goods need to be delivered.
71    /// The vector has to include the depot, but with a demand of 0.
72    /// </summary>
73    public double[] Demands { get; set; }
74
75    /// <summary>
76    /// Optional! The best-known solution as a list of tours in path-encoding.
77    /// </summary>
78    public int[][] BestKnownTour { get; set; }
79    /// <summary>
80    /// Optional! Specifies the used vehicle for a given tour.
81    /// </summary>
82    public int[] BestKnownTourVehicleAssignment { get; set; }
83    /// <summary>
84    /// Optional! The quality of the best-known solution.
85    /// </summary>
86    public double? BestKnownQuality { get; set; }
87
88    /// <summary>
89    /// If only the coordinates are given, can calculate the distance matrix.
90    /// </summary>
91    /// <returns>A full distance matrix between all cities.</returns>
92    public double[,] GetDistanceMatrix() {
93      return DistanceHelper.GetDistanceMatrix(DistanceMeasure, Coordinates, Distances, Dimension);
94    }
95  }
96}
Note: See TracBrowser for help on using the repository browser.