Free cookie consent management tool by TermsFeed Policy Generator

source: branches/ProblemRefactoring/HeuristicLab.Problems.Knapsack/3.3/KnapsackProblem.cs @ 13364

Last change on this file since 13364 was 13364, checked in by mkommend, 8 years ago

#2521: Refactored IntegerVectorEncoding, KnapsackProblem, and P3.
File size: 15.5 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 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
22using System;
23using System.Collections.Generic;
24using System.Linq;
25using HeuristicLab.Analysis;
26using HeuristicLab.Common;
27using HeuristicLab.Core;
28using HeuristicLab.Data;
29using HeuristicLab.Encodings.BinaryVectorEncoding;
30using HeuristicLab.Optimization;
31using HeuristicLab.Optimization.Operators;
32using HeuristicLab.Parameters;
33using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
34using HeuristicLab.PluginInfrastructure;
35
36namespace HeuristicLab.Problems.Knapsack {
37  [Item("Knapsack Problem (KSP)", "Represents a Knapsack problem.")]
38  [Creatable(CreatableAttribute.Categories.CombinatorialProblems, Priority = 200)]
39  [StorableClass]
40  public sealed class KnapsackProblem : SingleObjectiveHeuristicOptimizationProblem<IKnapsackEvaluator, IBinaryVectorCreator>,
41    ISingleObjectiveProblem<BinaryVectorEncoding, BinaryVector>, IStorableContent {
42    public string Filename { get; set; }
43
44    #region Parameter Properties
45    public ValueParameter<IntValue> KnapsackCapacityParameter {
46      get { return (ValueParameter<IntValue>)Parameters["KnapsackCapacity"]; }
47    }
48    public ValueParameter<IntArray> WeightsParameter {
49      get { return (ValueParameter<IntArray>)Parameters["Weights"]; }
50    }
51    public ValueParameter<IntArray> ValuesParameter {
52      get { return (ValueParameter<IntArray>)Parameters["Values"]; }
53    }
54    public ValueParameter<DoubleValue> PenaltyParameter {
55      get { return (ValueParameter<DoubleValue>)Parameters["Penalty"]; }
56    }
57    public OptionalValueParameter<BinaryVector> BestKnownSolutionParameter {
58      get { return (OptionalValueParameter<BinaryVector>)Parameters["BestKnownSolution"]; }
59    }
60    #endregion
61
62    #region Properties
63    public IntValue KnapsackCapacity {
64      get { return KnapsackCapacityParameter.Value; }
65      set { KnapsackCapacityParameter.Value = value; }
66    }
67    public IntArray Weights {
68      get { return WeightsParameter.Value; }
69      set { WeightsParameter.Value = value; }
70    }
71    public IntArray Values {
72      get { return ValuesParameter.Value; }
73      set { ValuesParameter.Value = value; }
74    }
75    public DoubleValue Penalty {
76      get { return PenaltyParameter.Value; }
77      set { PenaltyParameter.Value = value; }
78    }
79    public BinaryVector BestKnownSolution {
80      get { return BestKnownSolutionParameter.Value; }
81      set { BestKnownSolutionParameter.Value = value; }
82    }
83    private BestKnapsackSolutionAnalyzer BestKnapsackSolutionAnalyzer {
84      get { return Operators.OfType<BestKnapsackSolutionAnalyzer>().FirstOrDefault(); }
85    }
86    #endregion
87
88    // BackwardsCompatibility3.3
89    #region Backwards compatible code, remove with 3.4
90    [Obsolete]
91    [Storable(Name = "operators")]
92    private IEnumerable<IOperator> oldOperators {
93      get { return null; }
94      set {
95        if (value != null && value.Any())
96          Operators.AddRange(value);
97      }
98    }
99    #endregion
100
101    [StorableConstructor]
102    private KnapsackProblem(bool deserializing) : base(deserializing) { }
103    private KnapsackProblem(KnapsackProblem original, Cloner cloner)
104      : base(original, cloner) {
105      RegisterEventHandlers();
106    }
107    public override IDeepCloneable Clone(Cloner cloner) {
108      return new KnapsackProblem(this, cloner);
109    }
110    public KnapsackProblem()
111      : base(new KnapsackEvaluator(), new RandomBinaryVectorCreator()) {
112      Parameters.Add(new ValueParameter<IntValue>("KnapsackCapacity", "Capacity of the Knapsack.", new IntValue(0)));
113      Parameters.Add(new ValueParameter<IntArray>("Weights", "The weights of the items.", new IntArray(5)));
114      Parameters.Add(new ValueParameter<IntArray>("Values", "The values of the items.", new IntArray(5)));
115      Parameters.Add(new ValueParameter<DoubleValue>("Penalty", "The penalty value for each unit of overweight.", new DoubleValue(1)));
116      Parameters.Add(new OptionalValueParameter<BinaryVector>("BestKnownSolution", "The best known solution of this Knapsack instance."));
117
118      Maximization.Value = true;
119      MaximizationParameter.Hidden = true;
120
121      SolutionCreator.BinaryVectorParameter.ActualName = "KnapsackSolution";
122
123      InitializeRandomKnapsackInstance();
124
125      ParameterizeSolutionCreator();
126      ParameterizeEvaluator();
127
128      InitializeOperators();
129      RegisterEventHandlers();
130    }
131
132    #region Events
133    protected override void OnSolutionCreatorChanged() {
134      base.OnSolutionCreatorChanged();
135      SolutionCreator.BinaryVectorParameter.ActualNameChanged += new EventHandler(SolutionCreator_BinaryVectorParameter_ActualNameChanged);
136      ParameterizeSolutionCreator();
137      ParameterizeEvaluator();
138      ParameterizeAnalyzer();
139      ParameterizeOperators();
140    }
141    protected override void OnEvaluatorChanged() {
142      base.OnEvaluatorChanged();
143      ParameterizeEvaluator();
144      ParameterizeAnalyzer();
145    }
146    private void SolutionCreator_BinaryVectorParameter_ActualNameChanged(object sender, EventArgs e) {
147      ParameterizeEvaluator();
148      ParameterizeAnalyzer();
149      ParameterizeOperators();
150    }
151    private void KnapsackCapacityParameter_ValueChanged(object sender, EventArgs e) {
152      ParameterizeEvaluator();
153      ParameterizeAnalyzer();
154    }
155    private void WeightsParameter_ValueChanged(object sender, EventArgs e) {
156      ParameterizeEvaluator();
157      ParameterizeAnalyzer();
158      ParameterizeSolutionCreator();
159
160      WeightsParameter.Value.Reset += new EventHandler(WeightsValue_Reset);
161    }
162    private void WeightsValue_Reset(object sender, EventArgs e) {
163      ParameterizeSolutionCreator();
164
165      if (WeightsParameter.Value != null && ValuesParameter.Value != null)
166        ((IStringConvertibleArray)ValuesParameter.Value).Length = WeightsParameter.Value.Length;
167    }
168    private void ValuesParameter_ValueChanged(object sender, EventArgs e) {
169      ParameterizeEvaluator();
170      ParameterizeAnalyzer();
171      ParameterizeSolutionCreator();
172
173      ValuesParameter.Value.Reset += new EventHandler(ValuesValue_Reset);
174    }
175    private void ValuesValue_Reset(object sender, EventArgs e) {
176      ParameterizeSolutionCreator();
177
178      if (WeightsParameter.Value != null && ValuesParameter.Value != null)
179        ((IStringConvertibleArray)WeightsParameter.Value).Length = ValuesParameter.Value.Length;
180    }
181    private void PenaltyParameter_ValueChanged(object sender, EventArgs e) {
182      ParameterizeEvaluator();
183    }
184    private void OneBitflipMoveParameter_ActualNameChanged(object sender, EventArgs e) {
185      string name = ((ILookupParameter<OneBitflipMove>)sender).ActualName;
186      foreach (IOneBitflipMoveOperator op in Operators.OfType<IOneBitflipMoveOperator>()) {
187        op.OneBitflipMoveParameter.ActualName = name;
188      }
189    }
190    #endregion
191
192    #region Helpers
193    [StorableHook(HookType.AfterDeserialization)]
194    private void AfterDeserialization() {
195      // BackwardsCompatibility3.3
196      #region Backwards compatible code (remove with 3.4)
197      if (Operators.Count == 0) InitializeOperators();
198      #endregion
199      RegisterEventHandlers();
200    }
201
202    private void RegisterEventHandlers() {
203      SolutionCreator.BinaryVectorParameter.ActualNameChanged += new EventHandler(SolutionCreator_BinaryVectorParameter_ActualNameChanged);
204      KnapsackCapacityParameter.ValueChanged += new EventHandler(KnapsackCapacityParameter_ValueChanged);
205      WeightsParameter.ValueChanged += new EventHandler(WeightsParameter_ValueChanged);
206      WeightsParameter.Value.Reset += new EventHandler(WeightsValue_Reset);
207      ValuesParameter.ValueChanged += new EventHandler(ValuesParameter_ValueChanged);
208      ValuesParameter.Value.Reset += new EventHandler(ValuesValue_Reset);
209      PenaltyParameter.ValueChanged += new EventHandler(PenaltyParameter_ValueChanged);
210    }
211    private void ParameterizeSolutionCreator() {
212      if (SolutionCreator.LengthParameter.Value == null ||
213        SolutionCreator.LengthParameter.Value.Value != WeightsParameter.Value.Length)
214        SolutionCreator.LengthParameter.Value = new IntValue(WeightsParameter.Value.Length);
215    }
216    private void ParameterizeEvaluator() {
217      if (Evaluator is KnapsackEvaluator) {
218        KnapsackEvaluator knapsackEvaluator =
219          (KnapsackEvaluator)Evaluator;
220        knapsackEvaluator.BinaryVectorParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
221        knapsackEvaluator.BinaryVectorParameter.Hidden = true;
222        knapsackEvaluator.KnapsackCapacityParameter.ActualName = KnapsackCapacityParameter.Name;
223        knapsackEvaluator.KnapsackCapacityParameter.Hidden = true;
224        knapsackEvaluator.WeightsParameter.ActualName = WeightsParameter.Name;
225        knapsackEvaluator.WeightsParameter.Hidden = true;
226        knapsackEvaluator.ValuesParameter.ActualName = ValuesParameter.Name;
227        knapsackEvaluator.ValuesParameter.Hidden = true;
228        knapsackEvaluator.PenaltyParameter.ActualName = PenaltyParameter.Name;
229        knapsackEvaluator.PenaltyParameter.Hidden = true;
230      }
231    }
232    private void ParameterizeAnalyzer() {
233      if (BestKnapsackSolutionAnalyzer != null) {
234        BestKnapsackSolutionAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
235        BestKnapsackSolutionAnalyzer.MaximizationParameter.Hidden = true;
236        BestKnapsackSolutionAnalyzer.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
237        BestKnapsackSolutionAnalyzer.BestKnownQualityParameter.Hidden = true;
238        BestKnapsackSolutionAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
239        BestKnapsackSolutionAnalyzer.BestKnownSolutionParameter.Hidden = true;
240        BestKnapsackSolutionAnalyzer.BinaryVectorParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
241        BestKnapsackSolutionAnalyzer.BinaryVectorParameter.Hidden = true;
242        BestKnapsackSolutionAnalyzer.KnapsackCapacityParameter.ActualName = KnapsackCapacityParameter.Name;
243        BestKnapsackSolutionAnalyzer.KnapsackCapacityParameter.Hidden = true;
244        BestKnapsackSolutionAnalyzer.WeightsParameter.ActualName = WeightsParameter.Name;
245        BestKnapsackSolutionAnalyzer.WeightsParameter.Hidden = true;
246        BestKnapsackSolutionAnalyzer.ValuesParameter.ActualName = ValuesParameter.Name;
247        BestKnapsackSolutionAnalyzer.ValuesParameter.Hidden = true;
248      }
249    }
250    private void InitializeOperators() {
251      Operators.Add(new KnapsackImprovementOperator());
252      Operators.Add(new KnapsackPathRelinker());
253      Operators.Add(new KnapsackSimultaneousPathRelinker());
254      Operators.Add(new KnapsackSimilarityCalculator());
255      Operators.Add(new QualitySimilarityCalculator());
256      Operators.Add(new NoSimilarityCalculator());
257
258      Operators.Add(new BestKnapsackSolutionAnalyzer());
259      Operators.Add(new PopulationSimilarityAnalyzer(Operators.OfType<ISolutionSimilarityCalculator>()));
260      ParameterizeAnalyzer();
261      foreach (IBinaryVectorOperator op in ApplicationManager.Manager.GetInstances<IBinaryVectorOperator>()) {
262        if (!(op is ISingleObjectiveMoveEvaluator) || (op is IKnapsackMoveEvaluator)) {
263          Operators.Add(op);
264        }
265      }
266      ParameterizeOperators();
267      InitializeMoveGenerators();
268    }
269    private void InitializeMoveGenerators() {
270      foreach (IOneBitflipMoveOperator op in Operators.OfType<IOneBitflipMoveOperator>()) {
271        if (op is IMoveGenerator) {
272          op.OneBitflipMoveParameter.ActualNameChanged += new EventHandler(OneBitflipMoveParameter_ActualNameChanged);
273        }
274      }
275    }
276    private void ParameterizeOperators() {
277      foreach (IBinaryVectorCrossover op in Operators.OfType<IBinaryVectorCrossover>()) {
278        op.ParentsParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
279        op.ParentsParameter.Hidden = true;
280        op.ChildParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
281        op.ChildParameter.Hidden = true;
282      }
283      foreach (IBinaryVectorManipulator op in Operators.OfType<IBinaryVectorManipulator>()) {
284        op.BinaryVectorParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
285        op.BinaryVectorParameter.Hidden = true;
286      }
287      foreach (IBinaryVectorMoveOperator op in Operators.OfType<IBinaryVectorMoveOperator>()) {
288        op.BinaryVectorParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
289        op.BinaryVectorParameter.Hidden = true;
290      }
291      foreach (IKnapsackMoveEvaluator op in Operators.OfType<IKnapsackMoveEvaluator>()) {
292        op.KnapsackCapacityParameter.ActualName = KnapsackCapacityParameter.Name;
293        op.KnapsackCapacityParameter.Hidden = true;
294        op.PenaltyParameter.ActualName = PenaltyParameter.Name;
295        op.PenaltyParameter.Hidden = true;
296        op.WeightsParameter.ActualName = WeightsParameter.Name;
297        op.WeightsParameter.Hidden = true;
298        op.ValuesParameter.ActualName = ValuesParameter.Name;
299        op.ValuesParameter.Hidden = true;
300      }
301      foreach (IBinaryVectorMultiNeighborhoodShakingOperator op in Operators.OfType<IBinaryVectorMultiNeighborhoodShakingOperator>()) {
302        op.BinaryVectorParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
303        op.BinaryVectorParameter.Hidden = true;
304      }
305      foreach (ISingleObjectiveImprovementOperator op in Operators.OfType<ISingleObjectiveImprovementOperator>()) {
306        op.SolutionParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
307        op.SolutionParameter.Hidden = true;
308      }
309      foreach (ISingleObjectivePathRelinker op in Operators.OfType<ISingleObjectivePathRelinker>()) {
310        op.ParentsParameter.ActualName = SolutionCreator.BinaryVectorParameter.ActualName;
311        op.ParentsParameter.Hidden = true;
312      }
313      foreach (ISolutionSimilarityCalculator op in Operators.OfType<ISolutionSimilarityCalculator>()) {
314        op.SolutionVariableName = SolutionCreator.BinaryVectorParameter.ActualName;
315        op.QualityVariableName = Evaluator.QualityParameter.ActualName;
316      }
317    }
318    #endregion
319
320    private void InitializeRandomKnapsackInstance() {
321      System.Random rand = new System.Random();
322
323      int itemCount = rand.Next(10, 100);
324      Weights = new IntArray(itemCount);
325      Values = new IntArray(itemCount);
326
327      double totalWeight = 0;
328
329      for (int i = 0; i < itemCount; i++) {
330        int value = rand.Next(1, 10);
331        int weight = rand.Next(1, 10);
332
333        Values[i] = value;
334        Weights[i] = weight;
335        totalWeight += weight;
336      }
337
338      int capacity = (int)Math.Round(0.7 * totalWeight);
339      KnapsackCapacity = new IntValue(capacity);
340    }
341  }
342}
Note: See TracBrowser for help on using the repository browser.