[3070] | 1 | #region License Information
|
---|
| 2 | /* HeuristicLab
|
---|
[12012] | 3 | * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
|
---|
[3070] | 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 | using System;
|
---|
| 23 | using System.Collections.Generic;
|
---|
| 24 | using System.Linq;
|
---|
[8720] | 25 | using HeuristicLab.Analysis;
|
---|
[3070] | 26 | using HeuristicLab.Common;
|
---|
| 27 | using HeuristicLab.Core;
|
---|
| 28 | using HeuristicLab.Data;
|
---|
| 29 | using HeuristicLab.Encodings.BinaryVectorEncoding;
|
---|
| 30 | using HeuristicLab.Optimization;
|
---|
[12102] | 31 | using HeuristicLab.Optimization.Operators;
|
---|
[3070] | 32 | using HeuristicLab.Parameters;
|
---|
| 33 | using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
|
---|
| 34 |
|
---|
| 35 | namespace HeuristicLab.Problems.Knapsack {
|
---|
[13173] | 36 | [Item("Knapsack Problem (KSP)", "Represents a Knapsack problem.")]
|
---|
[12504] | 37 | [Creatable(CreatableAttribute.Categories.CombinatorialProblems, Priority = 200)]
|
---|
[3070] | 38 | [StorableClass]
|
---|
[13404] | 39 | public sealed class KnapsackProblem : SingleObjectiveProblem<BinaryVectorEncoding, BinaryVector> {
|
---|
| 40 | public override bool Maximization { get { return true; } }
|
---|
[4419] | 41 |
|
---|
[3070] | 42 | #region Parameter Properties
|
---|
| 43 | public ValueParameter<IntValue> KnapsackCapacityParameter {
|
---|
| 44 | get { return (ValueParameter<IntValue>)Parameters["KnapsackCapacity"]; }
|
---|
| 45 | }
|
---|
| 46 | public ValueParameter<IntArray> WeightsParameter {
|
---|
| 47 | get { return (ValueParameter<IntArray>)Parameters["Weights"]; }
|
---|
| 48 | }
|
---|
| 49 | public ValueParameter<IntArray> ValuesParameter {
|
---|
| 50 | get { return (ValueParameter<IntArray>)Parameters["Values"]; }
|
---|
| 51 | }
|
---|
[3787] | 52 | public OptionalValueParameter<BinaryVector> BestKnownSolutionParameter {
|
---|
| 53 | get { return (OptionalValueParameter<BinaryVector>)Parameters["BestKnownSolution"]; }
|
---|
| 54 | }
|
---|
[3070] | 55 | #endregion
|
---|
| 56 |
|
---|
| 57 | #region Properties
|
---|
[13404] | 58 | public int KnapsackCapacity {
|
---|
| 59 | get { return KnapsackCapacityParameter.Value.Value; }
|
---|
| 60 | set { KnapsackCapacityParameter.Value.Value = value; }
|
---|
[3109] | 61 | }
|
---|
| 62 | public IntArray Weights {
|
---|
| 63 | get { return WeightsParameter.Value; }
|
---|
| 64 | set { WeightsParameter.Value = value; }
|
---|
| 65 | }
|
---|
| 66 | public IntArray Values {
|
---|
| 67 | get { return ValuesParameter.Value; }
|
---|
| 68 | set { ValuesParameter.Value = value; }
|
---|
| 69 | }
|
---|
[3787] | 70 | public BinaryVector BestKnownSolution {
|
---|
| 71 | get { return BestKnownSolutionParameter.Value; }
|
---|
| 72 | set { BestKnownSolutionParameter.Value = value; }
|
---|
| 73 | }
|
---|
[3667] | 74 | private BestKnapsackSolutionAnalyzer BestKnapsackSolutionAnalyzer {
|
---|
[6938] | 75 | get { return Operators.OfType<BestKnapsackSolutionAnalyzer>().FirstOrDefault(); }
|
---|
[3641] | 76 | }
|
---|
[3070] | 77 | #endregion
|
---|
| 78 |
|
---|
[4098] | 79 | [StorableConstructor]
|
---|
[4118] | 80 | private KnapsackProblem(bool deserializing) : base(deserializing) { }
|
---|
[4722] | 81 | private KnapsackProblem(KnapsackProblem original, Cloner cloner)
|
---|
| 82 | : base(original, cloner) {
|
---|
[7351] | 83 | RegisterEventHandlers();
|
---|
[4722] | 84 | }
|
---|
[3166] | 85 | public KnapsackProblem()
|
---|
[13404] | 86 | : base(new BinaryVectorEncoding("Selection")) {
|
---|
| 87 | Parameters.Add(new ValueParameter<IntValue>("KnapsackCapacity", "Capacity of the Knapsack.", new IntValue(1)));
|
---|
[3070] | 88 | Parameters.Add(new ValueParameter<IntArray>("Weights", "The weights of the items.", new IntArray(5)));
|
---|
| 89 | Parameters.Add(new ValueParameter<IntArray>("Values", "The values of the items.", new IntArray(5)));
|
---|
[3787] | 90 | Parameters.Add(new OptionalValueParameter<BinaryVector>("BestKnownSolution", "The best known solution of this Knapsack instance."));
|
---|
[3070] | 91 |
|
---|
[13404] | 92 | InitializeRandomKnapsackInstance();
|
---|
[3125] | 93 |
|
---|
[13404] | 94 | InitializeOperators();
|
---|
| 95 | RegisterEventHandlers();
|
---|
| 96 | }
|
---|
[6938] | 97 |
|
---|
[13404] | 98 | public override double Evaluate(BinaryVector solution, IRandom random) {
|
---|
| 99 | var totalWeight = 0.0;
|
---|
| 100 | var totalValue = 0.0;
|
---|
| 101 | for (var i = 0; i < solution.Length; i++) {
|
---|
| 102 | if (!solution[i]) continue;
|
---|
| 103 | totalWeight += Weights[i];
|
---|
| 104 | totalValue += Values[i];
|
---|
| 105 | }
|
---|
| 106 | return totalWeight > KnapsackCapacity ? KnapsackCapacity - totalWeight : totalValue;
|
---|
| 107 | }
|
---|
[5287] | 108 |
|
---|
[13404] | 109 | public override IDeepCloneable Clone(Cloner cloner) {
|
---|
| 110 | return new KnapsackProblem(this, cloner);
|
---|
| 111 | }
|
---|
[3070] | 112 |
|
---|
[13404] | 113 | [StorableHook(HookType.AfterDeserialization)]
|
---|
| 114 | private void AfterDeserialization() {
|
---|
[7351] | 115 | RegisterEventHandlers();
|
---|
[3070] | 116 | }
|
---|
| 117 |
|
---|
[13404] | 118 | private void RegisterEventHandlers() {
|
---|
| 119 | Evaluator.QualityParameter.ActualNameChanged += Evaluator_QualityParameter_ActualNameChanged;
|
---|
| 120 | KnapsackCapacityParameter.ValueChanged += KnapsackCapacityParameter_ValueChanged;
|
---|
| 121 | WeightsParameter.ValueChanged += WeightsParameter_ValueChanged;
|
---|
| 122 | WeightsParameter.Value.Reset += WeightsValue_Reset;
|
---|
| 123 | ValuesParameter.ValueChanged += ValuesParameter_ValueChanged;
|
---|
| 124 | ValuesParameter.Value.Reset += ValuesValue_Reset;
|
---|
| 125 | // TODO: There is no even to detect if the parameter itself was changed
|
---|
| 126 | Encoding.LengthParameter.ValueChanged += Encoding_LengthParameter_ValueChanged;
|
---|
| 127 | }
|
---|
| 128 |
|
---|
[3070] | 129 | #region Events
|
---|
[13404] | 130 | protected override void OnEncodingChanged() {
|
---|
| 131 | base.OnEncodingChanged();
|
---|
| 132 | Parameterize();
|
---|
| 133 | }
|
---|
[6938] | 134 | protected override void OnSolutionCreatorChanged() {
|
---|
| 135 | base.OnSolutionCreatorChanged();
|
---|
[13404] | 136 | Parameterize();
|
---|
[3070] | 137 | }
|
---|
[6938] | 138 | protected override void OnEvaluatorChanged() {
|
---|
| 139 | base.OnEvaluatorChanged();
|
---|
[13404] | 140 | Evaluator.QualityParameter.ActualNameChanged += Evaluator_QualityParameter_ActualNameChanged;
|
---|
| 141 | Parameterize();
|
---|
[3070] | 142 | }
|
---|
[13404] | 143 | private void Evaluator_QualityParameter_ActualNameChanged(object sender, EventArgs e) {
|
---|
| 144 | Parameterize();
|
---|
[3070] | 145 | }
|
---|
[6938] | 146 | private void KnapsackCapacityParameter_ValueChanged(object sender, EventArgs e) {
|
---|
[13404] | 147 | Parameterize();
|
---|
[3070] | 148 | }
|
---|
[6938] | 149 | private void WeightsParameter_ValueChanged(object sender, EventArgs e) {
|
---|
[13404] | 150 | Parameterize();
|
---|
| 151 | WeightsParameter.Value.Reset += WeightsValue_Reset;
|
---|
[3070] | 152 | }
|
---|
[6938] | 153 | private void WeightsValue_Reset(object sender, EventArgs e) {
|
---|
[13404] | 154 | if (WeightsParameter.Value != null && ValuesParameter.Value != null) {
|
---|
| 155 | ((IStringConvertibleArray)ValuesParameter.Value).Length = Weights.Length;
|
---|
| 156 | Encoding.Length = Weights.Length;
|
---|
| 157 | }
|
---|
| 158 | Parameterize();
|
---|
[3111] | 159 | }
|
---|
[6938] | 160 | private void ValuesParameter_ValueChanged(object sender, EventArgs e) {
|
---|
[13404] | 161 | Parameterize();
|
---|
| 162 | ValuesParameter.Value.Reset += ValuesValue_Reset;
|
---|
[3109] | 163 | }
|
---|
[6938] | 164 | private void ValuesValue_Reset(object sender, EventArgs e) {
|
---|
[13404] | 165 | if (WeightsParameter.Value != null && ValuesParameter.Value != null) {
|
---|
| 166 | ((IStringConvertibleArray)WeightsParameter.Value).Length = Values.Length;
|
---|
| 167 | Encoding.Length = Values.Length;
|
---|
| 168 | }
|
---|
| 169 | Parameterize();
|
---|
[3111] | 170 | }
|
---|
[13404] | 171 | private void Encoding_LengthParameter_ValueChanged(object sender, EventArgs e) {
|
---|
| 172 | if (Weights.Length != Encoding.Length) {
|
---|
| 173 | ((IStringConvertibleArray)WeightsParameter.Value).Length = Encoding.Length;
|
---|
[3124] | 174 | }
|
---|
[13404] | 175 | if (Values.Length != Encoding.Length) {
|
---|
| 176 | ((IStringConvertibleArray)ValuesParameter.Value).Length = Encoding.Length;
|
---|
| 177 | }
|
---|
| 178 | Parameterize();
|
---|
[3124] | 179 | }
|
---|
[3070] | 180 | #endregion
|
---|
| 181 |
|
---|
| 182 | #region Helpers
|
---|
[13404] | 183 | private void InitializeOperators() {
|
---|
| 184 | Operators.Add(new KnapsackImprovementOperator());
|
---|
| 185 | Operators.Add(new KnapsackPathRelinker());
|
---|
| 186 | Operators.Add(new KnapsackSimultaneousPathRelinker());
|
---|
| 187 | Operators.Add(new KnapsackSimilarityCalculator());
|
---|
| 188 | Operators.Add(new QualitySimilarityCalculator());
|
---|
| 189 | Operators.Add(new NoSimilarityCalculator());
|
---|
| 190 |
|
---|
| 191 | Operators.Add(new BestKnapsackSolutionAnalyzer());
|
---|
| 192 | Operators.Add(new PopulationSimilarityAnalyzer(Operators.OfType<ISolutionSimilarityCalculator>()));
|
---|
| 193 |
|
---|
| 194 | Parameterize();
|
---|
[4118] | 195 | }
|
---|
[13404] | 196 | private void Parameterize() {
|
---|
| 197 | var operators = new List<IItem>();
|
---|
[4118] | 198 |
|
---|
[8720] | 199 | if (BestKnapsackSolutionAnalyzer != null) {
|
---|
[13404] | 200 | operators.Add(BestKnapsackSolutionAnalyzer);
|
---|
[8720] | 201 | BestKnapsackSolutionAnalyzer.MaximizationParameter.ActualName = MaximizationParameter.Name;
|
---|
| 202 | BestKnapsackSolutionAnalyzer.MaximizationParameter.Hidden = true;
|
---|
| 203 | BestKnapsackSolutionAnalyzer.BestKnownQualityParameter.ActualName = BestKnownQualityParameter.Name;
|
---|
| 204 | BestKnapsackSolutionAnalyzer.BestKnownQualityParameter.Hidden = true;
|
---|
| 205 | BestKnapsackSolutionAnalyzer.BestKnownSolutionParameter.ActualName = BestKnownSolutionParameter.Name;
|
---|
| 206 | BestKnapsackSolutionAnalyzer.BestKnownSolutionParameter.Hidden = true;
|
---|
| 207 | BestKnapsackSolutionAnalyzer.KnapsackCapacityParameter.ActualName = KnapsackCapacityParameter.Name;
|
---|
| 208 | BestKnapsackSolutionAnalyzer.KnapsackCapacityParameter.Hidden = true;
|
---|
| 209 | BestKnapsackSolutionAnalyzer.WeightsParameter.ActualName = WeightsParameter.Name;
|
---|
| 210 | BestKnapsackSolutionAnalyzer.WeightsParameter.Hidden = true;
|
---|
| 211 | BestKnapsackSolutionAnalyzer.ValuesParameter.ActualName = ValuesParameter.Name;
|
---|
| 212 | BestKnapsackSolutionAnalyzer.ValuesParameter.Hidden = true;
|
---|
| 213 | }
|
---|
[13404] | 214 | foreach (var op in Operators.OfType<IKnapsackMoveEvaluator>()) {
|
---|
| 215 | operators.Add(op);
|
---|
[3124] | 216 | op.KnapsackCapacityParameter.ActualName = KnapsackCapacityParameter.Name;
|
---|
[6053] | 217 | op.KnapsackCapacityParameter.Hidden = true;
|
---|
[3124] | 218 | op.WeightsParameter.ActualName = WeightsParameter.Name;
|
---|
[6053] | 219 | op.WeightsParameter.Hidden = true;
|
---|
[3124] | 220 | op.ValuesParameter.ActualName = ValuesParameter.Name;
|
---|
[6053] | 221 | op.ValuesParameter.Hidden = true;
|
---|
[13404] | 222 |
|
---|
| 223 | var bitflipMoveEval = op as IKnapsackOneBitflipMoveEvaluator;
|
---|
| 224 | if (bitflipMoveEval != null) {
|
---|
| 225 | foreach (var moveOp in Encoding.Operators.OfType<IOneBitflipMoveQualityOperator>()) {
|
---|
| 226 | moveOp.MoveQualityParameter.ActualName = bitflipMoveEval.MoveQualityParameter.ActualName;
|
---|
| 227 | moveOp.MoveQualityParameter.Hidden = true;
|
---|
| 228 | }
|
---|
| 229 | }
|
---|
[3124] | 230 | }
|
---|
[13404] | 231 | foreach (var op in Operators.OfType<ISingleObjectiveImprovementOperator>()) {
|
---|
| 232 | operators.Add(op);
|
---|
| 233 | op.SolutionParameter.ActualName = Encoding.Name;
|
---|
[8334] | 234 | op.SolutionParameter.Hidden = true;
|
---|
| 235 | }
|
---|
[13404] | 236 | foreach (var op in Operators.OfType<ISingleObjectivePathRelinker>()) {
|
---|
| 237 | operators.Add(op);
|
---|
| 238 | op.ParentsParameter.ActualName = Encoding.Name;
|
---|
[8334] | 239 | op.ParentsParameter.Hidden = true;
|
---|
| 240 | }
|
---|
[13404] | 241 | foreach (var op in Operators.OfType<ISolutionSimilarityCalculator>()) {
|
---|
| 242 | operators.Add(op);
|
---|
| 243 | op.SolutionVariableName = Encoding.Name;
|
---|
[8334] | 244 | op.QualityVariableName = Evaluator.QualityParameter.ActualName;
|
---|
| 245 | }
|
---|
[13404] | 246 |
|
---|
| 247 | if (operators.Count > 0) Encoding.ConfigureOperators(Operators);
|
---|
[3070] | 248 | }
|
---|
| 249 | #endregion
|
---|
[4098] | 250 |
|
---|
| 251 | private void InitializeRandomKnapsackInstance() {
|
---|
[13404] | 252 | var sysrand = new System.Random();
|
---|
[4098] | 253 |
|
---|
[13404] | 254 | var itemCount = sysrand.Next(10, 100);
|
---|
[4098] | 255 | Weights = new IntArray(itemCount);
|
---|
| 256 | Values = new IntArray(itemCount);
|
---|
| 257 |
|
---|
| 258 | double totalWeight = 0;
|
---|
| 259 |
|
---|
| 260 | for (int i = 0; i < itemCount; i++) {
|
---|
[13404] | 261 | var value = sysrand.Next(1, 10);
|
---|
| 262 | var weight = sysrand.Next(1, 10);
|
---|
[4098] | 263 |
|
---|
| 264 | Values[i] = value;
|
---|
| 265 | Weights[i] = weight;
|
---|
| 266 | totalWeight += weight;
|
---|
| 267 | }
|
---|
| 268 |
|
---|
[13404] | 269 | KnapsackCapacity = (int)Math.Round(0.7 * totalWeight);
|
---|
[4098] | 270 | }
|
---|
[3070] | 271 | }
|
---|
| 272 | }
|
---|