Free cookie consent management tool by TermsFeed Policy Generator

source: branches/CloningRefactoring/HeuristicLab.Problems.Knapsack/3.3/KnapsackProblem.cs @ 4679

Last change on this file since 4679 was 4513, checked in by swinkler, 14 years ago

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