Free cookie consent management tool by TermsFeed Policy Generator

source: branches/PersistenceReintegration/HeuristicLab.Optimization.Operators/3.3/SolutionsCreator.cs @ 15018

Last change on this file since 15018 was 15018, checked in by gkronber, 7 years ago

#2520 introduced StorableConstructorFlag type for StorableConstructors

File size: 5.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2016 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 HeuristicLab.Common;
23using HeuristicLab.Core;
24using HeuristicLab.Data;
25using HeuristicLab.Operators;
26using HeuristicLab.Parameters;
27using HeuristicLab.Persistence;
28
29namespace HeuristicLab.Optimization.Operators {
30  /// <summary>
31  /// An operator which creates new solutions. Evaluation of the new solutions is executed in parallel, if an engine is used which supports parallelization.
32  /// </summary>
33  [Item("SolutionsCreator", "An operator which creates new solutions. Evaluation of the new solutions is executed in parallel, if an engine is used which supports parallelization.")]
34  [StorableType("b5d3260c-c9e2-4845-a136-79b089bf9156")]
35  public sealed class SolutionsCreator : SingleSuccessorOperator {
36    public ValueLookupParameter<IntValue> NumberOfSolutionsParameter {
37      get { return (ValueLookupParameter<IntValue>)Parameters["NumberOfSolutions"]; }
38    }
39    public ValueLookupParameter<IOperator> SolutionCreatorParameter {
40      get { return (ValueLookupParameter<IOperator>)Parameters["SolutionCreator"]; }
41    }
42    public ValueLookupParameter<IOperator> EvaluatorParameter {
43      get { return (ValueLookupParameter<IOperator>)Parameters["Evaluator"]; }
44    }
45    public ValueLookupParameter<BoolValue> ParallelParameter {
46      get { return (ValueLookupParameter<BoolValue>)Parameters["Parallel"]; }
47    }
48    private ScopeParameter CurrentScopeParameter {
49      get { return (ScopeParameter)Parameters["CurrentScope"]; }
50    }
51    public IScope CurrentScope {
52      get { return CurrentScopeParameter.ActualValue; }
53    }
54    public IntValue NumberOfSolutions {
55      get { return NumberOfSolutionsParameter.Value; }
56      set { NumberOfSolutionsParameter.Value = value; }
57    }
58
59    [StorableConstructor]
60    private SolutionsCreator(StorableConstructorFlag deserializing) : base(deserializing) { }
61    private SolutionsCreator(SolutionsCreator original, Cloner cloner) : base(original, cloner) { }
62    public SolutionsCreator()
63      : base() {
64      Parameters.Add(new ValueLookupParameter<IntValue>("NumberOfSolutions", "The number of solutions that should be created."));
65      Parameters.Add(new ValueLookupParameter<IOperator>("SolutionCreator", "The operator which is used to create new solutions."));
66      Parameters.Add(new ValueLookupParameter<IOperator>("Evaluator", "The operator which is used to evaluate new solutions. This operator is executed in parallel, if an engine is used which supports parallelization."));
67      Parameters.Add(new ValueLookupParameter<BoolValue>("Parallel", "True if the operator should be applied in parallel on all sub-scopes, otherwise false.", new BoolValue(true)));
68      Parameters.Add(new ScopeParameter("CurrentScope", "The current scope to which the new solutions are added as sub-scopes."));
69    }
70    [StorableHook(HookType.AfterDeserialization)]
71    private void AfterDeserialization() {
72      if (!Parameters.ContainsKey("Parallel")) Parameters.Add(new ValueLookupParameter<BoolValue>("Parallel", "True if the operator should be applied in parallel on all sub-scopes, otherwise false.", new BoolValue(true))); // backwards compatibility
73    }
74
75    public override IDeepCloneable Clone(Cloner cloner) {
76      return new SolutionsCreator(this, cloner);
77    }
78
79    public override IOperation Apply() {
80      int count = NumberOfSolutionsParameter.ActualValue.Value;
81      IOperator creator = SolutionCreatorParameter.ActualValue;
82      IOperator evaluator = EvaluatorParameter.ActualValue;
83      bool parallel = ParallelParameter.ActualValue.Value;
84
85      int current = CurrentScope.SubScopes.Count;
86      for (int i = 0; i < count; i++)
87        CurrentScope.SubScopes.Add(new Scope((current + i).ToString()));
88
89      OperationCollection creation = new OperationCollection();
90      OperationCollection evaluation = new OperationCollection() { Parallel = parallel };
91      for (int i = 0; i < count; i++) {
92        if (creator != null) creation.Add(ExecutionContext.CreateOperation(creator, CurrentScope.SubScopes[current + i]));
93        if (evaluator != null) evaluation.Add(ExecutionContext.CreateOperation(evaluator, CurrentScope.SubScopes[current + i]));
94      }
95      OperationCollection next = new OperationCollection();
96      next.Add(creation);
97      next.Add(evaluation);
98      next.Add(base.Apply());
99      return next;
100    }
101  }
102}
Note: See TracBrowser for help on using the repository browser.