Refactor Problem/Encoding

[abeham]

• HL 3.3.16 merge
  • Check all added files for StorableTypes and GUIDs
  • Check all license headers of added files

• Introduce base problems for each encoding
• SingleObjective- & MultiObjectiveProblem introduce virtual member calls in their ctor to get the Maximization value, which poses a problem as the value might not be known at this time
  • Changed event for maximization
  • ForceValue(value) for OptionalValueParameter that ignores ReadOnly
• Cancellation token in Evaluate function of Problems
• Introduce new parameter type that can look up problems and algorithms
• Introduce SolutionParameter in ISolutionCreator<TSolution>
  • Create new interface that specifies solution parameter
  • Adapt all operators to this interface
• Return additional data from Evaluate (see discussion in #2774)
  • Refactor Evaluate methods to return IEvaluationResult instead of void
  • Adapt ISingleObjectiveOperators (from double to IEvaluationResult)
  • Identify simple pattern for comparison of IEvaluationResult
  • Adapt unit tests and external evaluation problems
  • Provide view for evaluation result & solution context
  • Adapt all multi-objective problems and operators
• Use ResultsParamater for storing results from the problem (evaluate, analyze) so that a defined output behavior is established (requirement for JSON converter)
  • New results have been implemented that define the output behavior.
  • Implement results for basic problems.
  • implement results for operators.
  • Combined results of algorithms, problems, operators (analyzers) in result collection.
  • Adapt parameters view to separate results parameter from all other parameters to define an input / output behavior.

• Make encoding parameters readonly per default to avoid manipulation
  • When using a combined encoding all parameters of nested encodings have to be set to readonly = false.

• Separate icons for single- and multi-objective problems and algorithms
• Adapt unit tests
  • Check for commented tests (Scheduling, BinPacking)
• Evaluate method in QAP is slow due to parameter access, check other problems too
  • Improved speed in r17232
• Memory leak when replacing parameters in the encoding instance with those of the problem instance -> the encoding might not live as long as the problem, but the parameter in the problem has a reference to the Encoding's parameter collection. This has been fixed with the usage of reference parameters.
• Change Gaussian Processes from engine algorithm to basic algorithm
• Add special parameters for algorithm and problem discovery

Refactoring of Plugins =

• HL.Problems.BinPacking
• HL.Problems.GraphColoring
• HL.Problems.PTSP
  • Evaluate composition vs inheritance
• HL.Problems.Scheduling
• HL.Problems.TestFunctions.MultiObjective mkommend
  • status has to be checked
• HL.Algorithms.MOCMAEvolutionStrategy
  • status has to be checked
• HL.Problems.GrammaticalEvolution.DataAnalysis
• HL.Problems.TravelingSalesman
• HL.Problems.VehicleRouting
• HL.Problems.DataAnalysis.* mkommend

• Change NCA, GPR & GPC, and BFGS to basic algorithms.

Compare with trunk (after mering in r17226):

• Knapsack Problem - Hamming Similartiy Calculator
• QAP
• External Evaluation
• P3 EvaluationTracker
• PSOSwarmUpdater & Initializer Boundsparameter

To discuss:

• Merge HeuristicOptimizationProblem with BasicProblem
  • Add new() constraint on TEncoding and TSolution of the Problem classes to forbid the creation of a Problem with abstract or not instantiable type parameters.
  • Provide specialized code templates, which are compiled, for programmable problems (e.g. RealVectorProblem that configures the bounds correctly)
  • Change name of result for best scope solution analyzer due to name clashes with programmable problems' analyze method.
  • AckleyEvaluator change from evaluator to problem? stays the storable type GUID the same

[mkommend]

r13327: Branched whole trunk for problem refactoring.

[mkommend]

r13330: Deleted wrongly created for problem refactoring.

[mkommend]

r13331: Branched trunk/sources for problem refactoring.

[mkommend]

r13336: Refactored encodings and problems.

[mkommend]

r13337: Added new class for problem refactoring.

[mkommend]

r13339: Rectored problems and encodings.

[mkommend]

r13345: refactored programmable problem

[mkommend]

r13348: Refactored single-objective programmable problem.

[abeham]

r13351: Adapted multi-encoding for new infrastructure

TODO: Evaluator, Analyzer, ... need to be copied

[abeham]

r13356: working on multi-encoding

[abeham]

r13357: changed solution name of combined encoding

[abeham]

r13359: worked on multi-encoding (it works again). Some issues are still present:

• The programmable template needs to be slightly updated for multi-encoding
• The encoding is recreated every time it is compiled making it impossible to configure operators

[mkommend]

r13350: Adapted multi-objective programmable problem. r13361: Adapted real vector encoding, test function problems, P3, CMA-ES and optimization.

[mkommend]

r13362: Forgot to commit IMultiObjectiveProblem.

[mkommend]

r13364: Refactored IntegerVectorEncoding, KnapsackProblem, and P3.

[abeham]

r13365: fixed recreation of programmable problem's encoding

[mkommend]

r13366: Adapted PermutationEncoding and TSP.

[mkommend]

r13372: Fixed all problems.

[abeham]

r13373: adapted templates, fixed missing reference in outdated plugin lawnmower

[abeham]

r13374: removed obsolete file

[abeham]

r13376: working on refactoring

[mkommend]

r13377: Added missing interfaces to problems.

[abeham]

r13380: updated categories, template

[abeham]

r13382: added default ctor to SymbolicExpressionTreeEncoding (otherwise the parameter in Problem<..> cannot create it)

[abeham]

r13385: fixed plugin dependencies and updated samples

[abeham]

r13388:

• Readded excluded views
• Removed ProblemInstanceProviderView which was not referenced in the project file
• Fixed plugin dependency

[abeham]

r13390: fixed template and bug in programmable problem with multi encoding

[abeham]

r13396:

• Refactored QuadraticAssignmentProblem to use new SingleObjectiveProblem
  • Removed QAPEvaluator
  • Adapted RobustTabooSearch
• Introduced several interfaces in PermutationEncoding necessary for wiring
• Changed all Encodings to use IItem instead of IOperator in ConfigureOperators (name still unchanged)
• Added a protected MaximizationParameter property in SingleObjectiveProblem (necessary for wiring)
• Changed AlleleFrequencyAnalyzer to use ISolution interface instead of IItem
• Added a comment to ISolutionCreator<TSolution> of some changes that would be welcomed

[abeham]

r13403:

• Adapted single-objective test function problem to new problem infrastructure
• Added additional interfaces to RealVectorEncoding
• Fixed IParticleUpdater interface (must implement IStochasticOperator if it contains a Random parameter)

[abeham]

I'd like to suggest that we swap the generic type parameters from Problem<TEncoding, TSolution> to Problem<TSolution, TEncoding>. The reason is that TSolution is limiting TEncoding and not vice versa. It feels strange to write the more limiting generic type parameter first.

[abeham]

r13404:

• Adapted Knapsack problem to new problem infrastructure
• Introduced additional interfaces in binary vector encoding
• Improved KnapsackImprovementOperator which requires less evaluated solutions in case of an infeasible start solution

Loosely related change:

• All LookupParameters are now shown by default
• Wiring code should make sure that wired parameters are hidden

[abeham]

r13405: Implemented SchafferF6 test function

[mkommend]

r13408: Adapted unit tests in problem refactoring branch.

All compile, some fail:

• SA Rastrigin example (missing move evaluators?)
• LS Knapsack example

[mkommend]

r13422: Adapted type discovery and type selector to allow the creation of generic programmable problems.

[mkommend]

r13435: Intermediate version of schedule encoding refactoring.

[mkommend]

r13436: Minor improvements in SchedulingEncoding.

[mkommend]

r13437: Added encodings for schedules.

[mkommend]

r13443: Adapted decoders for SchedulingProblem.

[pfleck]

r13449

• Replaced JSMDecodingErrorPolicy and JSMForcingStrategy with EnumValues.
• Removed obsolete views for the scheduling enums.

[mkommend]

r13469: Refactored problem base classes and adapted scheduling encoding, scheduling problem and unit tests.

[abeham]

r14684: added clean script

[abeham]

r15697: renamed branch according to guidelines

[abeham]

r16532: reverted r14429

[abeham]

r16692: merged trunk changes up to r15681 into branch (removal of trunk/sources)

[abeham]

r16723: merged changes from r15684 to trunk HEAD (r16716) and resolved all merge conflicts

• it doesn't build

[mkommend]

r16724: Corrected compilation errors in some projects.

[abeham]

r16725:

• Adapt Encodings.ScheduleEncoding to new persistence
• Adapt Problems.Programmable to new persistence

[abeham]

r16726: fixed single-objective test functions

[abeham]

r16749: fixed RealVectorEncoding

[mkommend]

r16750: Renamed SingleObjectiveProgrammableProblemView to ProgrammableProblemView.

[mkommend]

r16751: Renamed Solution to EncodedSolution.

[abeham]

r16752: added comment to P3

• removed todos from EvaluationServiceClientView

[mkommend]

r16753: Made basic problem specific operators internal and sealed.

[abeham]

r16767: Adapted graph coloring problem

[mkommend]

r16801: Merged trunk changes and adapted programmable problem templates for combined solutions.

[mkommend]

r16806: Added StorableType attributes to interfaces and adapted basic problems.
r16807: Adapted test functions to new architecture and partly MOCMAES.

[mkommend]

r16808: Added StorableType to FitnessFunction enum of GraphColoringProblem.

[abeham]

r16811: Removed usage of default constructor

[abeham]

r16812: fixed naming

[mkommend]

r16813: Changed base ctor call in all GeneticProgrammingProblems.

[mkommend]

r16814: Adapted binary problems and moved to abstract base class to encoding.

[mkommend]

r16815: Made programmable problem base classes abstract.

[abeham]

r16816: Refactored external evaluation problem

[abeham]

r16874: separated single-objective and multi-objective categories

[abeham]

r16876:

• Added abstract multi-objective problem class for binary vector encoding
• Added abstract problem classes for integer vector encoding

[mkommend]

r16946: Merged trunk changes up to r16945 into branch.

[mkommend]

r16947: Adapted GP basic problems to use read-only value parameters.

[abeham]

r16948: Added and modified encoding-specific abstract base classes

[abeham]

r16949: Adapted test function problems to new real vector problem

• Made encoding readonly in symbolic expression tree problem

[abeham]

r16950: Refactor Analyze method of encoding-specific problems, simplify Analyze of SO-TF

[mkommend]

r17225: Integrated changes of #2943 into problem refactoring branch.

[mkommend]

r17226: Merged trunk changes into problem refactoring branch.

[abeham]

r17229: Refactored ParetoFrontScatterPlot (moved from TestFunctions.MultiObjective to Analysis)

• Introduced generic type that may work with all solution encodings

[abeham]

r17230: add multi-objective analysis to all multi-objective encoding-base problems

[abeham]

r17232: Improve speed of Evaluate() in QuadraticAssignmentProblem

[abeham]

r17239: working on refactoring TSP

[abeham]

r17241: worked on refactoring TSP

[abeham]

r17248: working on TSP refactoring

[abeham]

r17251: finished refactoring TSP

[abeham]

r17252: made QAP problem data readonly

• Also refactored instance providers slightly to specify file extension for importing and exporting data and fixing dialogs

[abeham]

r17253: worked on refactoring PTSP

[abeham]

r17254: Added context lookup parameter

• Refactored tests
• Fixed duplicate GUID

[abeham]

r17257: Refactored ContextLookupParameter with suggestions from mkommend

• Add StorableType attribute to some types

[mkommend]

r17258: Removed failing projects from solution.

[abeham]

r17259: fixed bug in lookup paramater introduced in refactoring

[abeham]

r17260: Worked on PTSP refactoring

[mkommend]

r17261: Refactored multi-obj test functions and CMA-ES.

[mkommend]

r17262: Adapted unit tests for multi-objective analysis.

[abeham]

r17264:17265:

• Finished refactoring pTSP
• Remove usage of solutions or best-known quality when converting TSPLIB instances to pTSP instances

[abeham]

r17270: worked on removing virtual from Maximization for single-objective problems

[mkommend]

r17279: Updated single-objective problem to include a static is better method and fixed setter of maximization property.

[abeham]

r17309: Refactored maximization property for multi-objective problems

[abeham]

r17315: : reverted r17309

[abeham]

r17317: refactored multi-objective problems' maximization

• Add ForceValue method to IValueParameter to perform changes even when it is read-only
• Add MaximizationChanged event handler

[mkommend]

r17320: Added cancellation token to evaluate function of problems.

@abeham please review (especially the changes in the external evaluation problem and cache).

[abeham]

Changes look good.

[abeham]

r17321: fixed compile errors in Tests

[mkommend]

r17333: Updated branch with most recent trunk changes.

[mkommend]

r17334: Moved IStorableContent from generic problem implementation to IProblem.

[abeham]

r17335:17336: Refactored pTSP to use compositional pattern

[bwerth]

r17338 fixed crowding unit tests, moved CrowdingTest, HyperVolumeTests and FastHyperVolumeTests to their own subfolder

[bwerth]

reversed unintentional description modification

[bwerth]

r17340 forgot to commit changes to HeuristicLab.Optimization-3.3.csproj

[abeham]

r17355: removed obsolete files and fixed compilation error in VnsTspSampleTest

[abeham]

r17356: fixed some problems in Samples.Create unit tests and updated samples

[mkommend]

r17357: Added solution context and evaluation results.

[mkommend]

r17358: Corrected cloning method of solution contexts.

[abeham]

r17359: fix bugs in unit tests, add vns_tsp sample

[abeham]

r17360: fixed some unit tests

[abeham]

r17361: fixed further unit tests (plugin dependencies)

[mkommend]

r17363: First version of contexts in problem evaluation.

[mkommend]

r17366: Fixed bugs in solution context and adapted programmable problem template to include a cancellation token in the evaluate function.

[abeham]

r17373: changed dependency

[mkommend]

r17381: Fixed single-objective evaluation results and scope contexts.

[mkommend]

r17382: Refactored single-objective problems to use EvaluationResult instead of double as return type from Evaluate.

[mkommend]

r17383: Adapted analyze methods of single-obj problems.

[gkronber]

Would like to discuss the need to pass the CancellationToken from the algorithm to the Evaluate() method. This would be useful for problems where an evaluation involves a long-running simulation.

Currently, the engine passes the CancellationToken as an argument when calling Execute() for operators. However, for evaluators the CancellationToken is not passed on.

[mkommend]

r17457: Merged trunk changes from 15684-HEAD into the branch.

Fully automated merges are not possible due to the removal of the sources folder in r15683.

[mkommend]

r17459: Added storable type attributes to interfaces.

[abeham]

r17461: worked on scheduling problem

[abeham]

r17462: worked on JSSP

[mkommend]

r17513: Splitted problems into several problem and encoded problems.

[mkommend]

r17514: Merged trunk changes into branch.

[abeham]

r17516: fixed build fail in tests

[mkommend]

r17515: Added interface for supervised dataanalysis problem data.

[abeham]

r17517: Worked on ResultParameter for Problem and Algorithms

• Add ResultParameter to TSP, BinaryVectorProblem, and HillClimber
• Refactor ResultParameter to allow presetting the ResultCollection instead of having to discover it (e.g. for use in BasicAlgorithms)
• Unify Results property among EngineAlgorithm and BasicAlgorithm
  • There is now only a single instance which is storable

[mkommend]

r17518: Added ctor in implementations of data analysis problems and sealed the basic versions.

[mkommend]

r17520: Removed parameter for problemData in IDataAnalysisProblem.

[mkommend]

r17521: Fixed loading of start page samples due to missing types.

[abeham]

r17522: WIP refactoring: Introduce nicer type IResultDefinition for API users to avoid complex IParameter interface (hide ActualValue) Change result parameter to contexts (need quality and solution): only implemented for BinaryVectorProblem

r17525: working on porting orienteering problem Open points include:

• Visualization of OrienteeringProblemData
• Fix visualization of solution
• Cleanup unused classes

[abeham]

r17526: Completed porting of OrienteeringProblem

• Adapted unit tests
• Commented non-working unit test

[abeham]

r17527: commented test

[abeham]

r17528:

• Adapted plugin dependencies

[abeham]

r17529: some fixes and reusing handling of distance measure as defined in TSP

[abeham]

r17530: Refactored linear assignment problem

[abeham]

r17531: fixed duplicate guid

[mkommend]

r17532: Added first implementation of new reference parameters and corrected fixed value parameter.

[abeham]

r17533: Unified architecture

[mkommend]

r17543: Merged trunk changes into branch (+ corrected type in unit test).

[abeham]

r17544: worked on refactoring, worked a lot on binary encoding / problems

[abeham]

r17545: Reverse default behavior of readonly parameters (adapt MO binary problem too)

[abeham]

r17546: Introduce class to make parameter change handling easier, fix bug in SingleObjectiveProblem regarding MaximizationChanged

[abeham]

r17567: work in progress

[mkommend]

r17566: Decoupled readonly state of ReferenceParameter from the referenced parameter and corrected cloning.

[mkommend]

r17569: Merged trunk changes into branch.

[abeham]

r17570: work in progress

[mkommend]

r17571: Changed parameters to use readonly only for GUI manipulation.

[abeham]

r17577: remove scope-based contexts, add helper methods to ScopeUtil, adapt operators

[abeham]

r17578: changed initialization (C# 7.0 compliant)

[abeham]

r17587: refactoring in progress

[abeham]

r17586: Merged trunk changes into problem refactoring branch. (by mkommend)

[abeham]

r17592: changed order to prevent overwriting of quality

[mkommend]

r17594: Added first version of new results. The first algorithm that has been adapted for testing purposes is the hill climber.

[mkommend]

r17595: Added storable type attribute to Result.

[gkronber]

I can take over this task 'Change NCA, GPR & GPC, and BFGS to basic algorithms.'

[abeham]

Thanks! That would be great. We'll keep you updated when we perceive the infrastructure as stable enough for these tasks.

Michael is currently working on adding an indication of the results that the algorithm will produce when it is run (name and type basically).

[mkommend]

r17598: Deleted old problem interface.

[mkommend]

r17610: Removed unnecessary default ctors from problem base classes.

[mkommend]

r17612: Added first version of problem results.

[mkommend]

r17613: Corrected storable property for problem results.

[abeham]

r17614: work in progress (removed solution creator parameter from encoding), OrienteeringProblem and test functions are broken

[abeham]

r17620:

• Fixed orienteering problem
• Corrected ParameterizeOperators in all encoding-specific problem base classes
• Added new interfaces and wiring code to IntegerVectorEncoding

[abeham]

r17625:

• Changed IParticleCreator to not derive from ISolutionCreator (it calls the solution creator itself, thus leading to an infinite loop)
• Remove ForceValue method and added method to set value in constrained value parameters from valid values
• Fix ScopeTreeLookupParameter not caching the actual value
• Fixed single-objective test functions and removed lots of parameterize code

[abeham]

r17654: removed NonDicoverableType attribute from tree creators in the symbolic expression tree encoding

[abeham]

r17655: adapted readonly of reference parameters

[abeham]

r17656: fixed unit test compile error

[abeham]

r17680: working on problems / fixing P3

[abeham]

r17690: worked on multi-objective test function

[abeham]

r17694: fixed encoding change of JSSP, added tostring and itemimage change to ValueChanged event of ReferenceParameter

[abeham]

Big change, solution creator has been moved to algorithm

r17695:

• Moving solution creator parameter from problems to algorithms (breaking wiring in some HeuristicOptimizationProblems)
• Disallowing evaluator or encoding changes in encoding-specific base problems (to avoid confusion in derived problems whether this needs to be handled or not)
• Added private set to ReferenceParameter property (serialization)

[abeham]

r17696:

• fixed bug in EngineAlgorithm in Problem setter
• Added storable type to IEncodedProblem
• fixed some bugs and tests

[abeham]

r17697: changed parameterization in TSP

[abeham]

r17698: working on VRP (WIP)

[abeham]

r17699: Made encodings non-generic classes (the TEncodedSolution type parameter is not actually used), this will make it considerably easier to port the VRP to the new architecture

[abeham]

r17704: worked on VRP

[abeham]

r17706: working on VRP

[abeham]

r17708: working on VRP

[abeham]

r17709: working on VRP

[abeham]

r17710: working on VRP

[abeham]

r17711: working on VRP

[abeham]

r17712: working on VRP

[abeham]

r17713: fixed bug

[abeham]

r17714: fixed some issues in tests, renamed classes

[abeham]

r17715: working on VRP (analyzers)

[abeham]

r17716: changed storable type guids

[abeham]

r17717: working on VRP (refactoring all the capabilities, features, and operator discovery)

[abeham]

r17718: completed port of VRP (needs testing though)

[mkommend]

r17745: Added first draft of results implementation and problem adaptation.

[mkommend]

r17746: Added missing files.

[abeham]

r17747 worked on refactoring

• add results to problem base classes
• fix external evaluation problem
• Add result descriptions

[abeham]

r17748: fixed code so that unit test runs

[abeham]

r17778: working on refactoring

[abeham]

r17952: working on graph coloring problem

[mkommend]

r17953: Added first version (draft) of ResultsProducingItem, an according view and a refactored ProblemView.

[mkommend]

r17955: Removed obsolete problem views (Orienteering, QAP, Scheduling).

[abeham]

r17956: Create view for solution context

[mkommend]

r17957: Fixed bugs in resultsProducingItemView (toString changes of items, removing of parametes / results not working).

[abeham]

r18085: added algorithm and problem lookup parameters

[mkommend]

r18086: Merged trunk changes into branch.

[mkommend]

r18087: Merged latest trunk changes part II.

[mkommend]

r18088: Added storable type attribute to SupervisedDataAnalysisProblemData and license info to SupervisedDataAnalysisProblemData and GSEMO.

[abeham]

r18089: Add evaluation result views

[abeham]

r18090: made reference to HEAL.Attic private