- (Breaking) Simplify VNS implementation. New doc page for VNS.
- (Breaking) Minimum required Java version is now Java 25 LTS.
- (New) Support tar and tar.gz compressed instance files, in addition to existing zip and 7z formats.
- (New) #129: Faster Excel serializer and allow users to easily extend the raw data.
- (New) Python tools module, refactor complexity analysis & instance selector scripts
- (Fix) Irace v4.2 integration
- (Fix) #228: Instance selector failed to copy instances if they were not in the root instance folder
- (Fix) #300: Use algorithmName in Algorithm::toString when possible, fallback to current class name.
- (Fix) #301: Warning if SOLVER_NWORKERS exceeds physical CPU cores in configuration
- (New) #129: New Excel serializer, allows users to extend the raw data and should have better performance in most cases.
- (New) Update dependencies, biggest change is migration to Spring Boot 4 and Jackson 3.
- (New) Objective class: a class that represents an objective function of a problem. Each Objective has a name, a direction (minimize or maximize), and functions for extracting the value of the objective from Moves and from Solutions. See docs for a detailed description.
- (New) Util methods: CollectionUtil::getBest(Iterable,ToDoubleFunction), ArrayUtil::stats(double[]), ArrayUtil::stats(int[]), ArrayUtil::stats(long[]), ReferenceResult::setScore(String, double)
- (New) Validator methods: getFailCount, getReasonsFailed
- (New) Allow users to enable or disable validations for the current thread. New methods: Context.Configurator.enableValidations(), Context.Configurator.disableValidations()
- (New) Support for AspectJ, first magic annotation @TimeStats implemented to measure the time of any method.
- (New) Ablation test: run ablation test by default after autoconfig procedure.
- (New) Irace plots: generate an HTML report with the results of running the autoconfig procedure.
- (New) Two ParetoSet implementations are provided: a simple list based (should be correct, but slow) and a NDTree based implementation (should be fast, but may contain bugs).
- (New) ValidationResult: allow accumulating errors.
- (New) PythonUtil: easily run Python commands inside a virtual environment
- (New) When we report an unhandled exception, filter some stackframes that are not relevant to the user code. Full stacktrace still logged at trace level.
- (New) Add option to use AUC when using Irace in manual mode
- (Breaking) Due to changes in how objectives are handled, ReferenceResult methods have been renamed for clarity.
- (Breaking) Removed Improver::_improve, please implement Improver::improve directly instead. To migrate, just rename the method and make it public.
- (Breaking) DoubleComparator epsilon is now relative to the values being compared, not an absolute value.
- (Fix) Best solution per algorithm is not exported if repetitions = 1
- (Fix) Best solution per instance is not exported if there is only one algorithm
- (Fix) Math.random, Collections.shuffle now blocked using AspectJ instead of reflection. --add-opens no longer necessary.
- (Fix) Add @JsonIgnore to instance in solution class already exists in getter, but serializer may be configured to use fields instead of methods.
- (Fix) Gracefully handle experiment declarations with 0 algorithms.
- (Fix) #222 by @jmcolmenar: Local serializers.yml has no preference
- (Fix) #229 by @scaverod: Solution properties are not exported to JSON
- (Fix) Allow null customProperties in solution
- (Deleted) Solution::isBetterThan, unused and not necessary.
- (Deleted) Solution::getScore, Solution::recalculateScore: score recalculation should now be done in the solution validator implementation, and getScore can be any method the user wants, as long as it is declared as an Objective.
- (Deleted) LazyMove & EagerMove: mostly unused and can be replaced by a normal Move. See SwapNeighborhood in TSP module for an example lazy implementation.
- (New) Add support for 7Z and ZIP compressed instances, with no configuration required.
- (New) Add support for instance index files, for more info see the docs, inside the Features -> Instance Manager section.
- (New) Added Solution::notifyUpdate(long), the difference with the existing Solution::notifyUpdate() is that users may notify that the solution was last updated at a different time
- (New) Added Solution::lastExecutesMovesAsString(): generate a string representation of the last executed moves, useful when something goes wrong.
- (New) Added FMode::comparatorMove(): returns a comparator that sorts moves from best to worse, taking into account if we are maximizing or minimizing.
- (Fix) #239: Metrics tracking did not work in some circumstances when autoconfig was disabled but Irace was manually enabled.
- (Fix) #257: Delay ReflectiveSolutionBuilder initialization, in case the user provides a custom SolutionBuilder implementation.
- (Fix) Always execute user provided solution validator after each (instance, algorithm, repetition) if the validator is available
- (Fix) Cannot export boolean instance properties to Excel sheets
- (New) Java 21 compatibility. After extended testing, Java 21 will become the minimum required version.
- (New) Autoconfig: /auto/debug/tree display accumulated tree sizes
- (New) Allow usage of Java 21+ preview APIs by default, such as ScopedValues and string templates
- (Fix) Autoconfig: JSON deserialization limit
- (New) Autoconfig: configurable relationship blocks
- (Breaking) Reorganized Autoconfig classes, reimporting them in existing projects may be necessary if upgrading the Mork version.
- (Fix) Metrics: throw exception during AUC calculation if metric has negative values
- (Fix) Math.random() patch, enable its test
- (New) Metrics: add parameter to optionally calculate natural log of metric AUC.
- (New) Logging: improve default logging configuration
- (New) Add Algorithm::setName to allow changing the algorithm name after creation, util for example for algorithms built by the autoconfig components. In any case, this method should never be called after the algorithm has started.
- (New) AbstractMetric::getReferenceNanoTime to get current reference nano time
- Various small bug fixes and improvements
- (New) Property
solver.max-derivation-repetitionallows restricting algorithms generated from the grammar by limiting the number of time any derivation can be applied. Refactor algorithm generator in autoconfig module. - (New) Instance selector: any Mork executable can now be invoked with the "--instance-selector" switch that will generate the necessary data to perform automatic preliminary instances selection.
- (New) Metrics refactor: simplify, modularize and make easy to extend by using the AbstractMetric class.
Example, adding a new datapoint NOW to the best objective metric, changed from:
to simply
if(scores actually improves best value) { Metrics.add(Metrics.BEST_OBJECTIVE_FUNCTION, score); }
and the metric internally will only add the point if it actually improves the score. To implement any custom metric, just extend theMetrics.add(BestObjective.class, score);
AbstractMetricclass. - (Change) Minor bugfixes and improvements
- (Change) Upgrade dependencies
- (New) Autoconfig module: automatically build and test algorithms, using Irace as the parameter optimizer.
- (New) StringUtil reverse, longestCommonPrefix, longestCommonSuffix
- (New) Remove lcp and lcs from instance names
- (New) BitSet implementation compatible with JDK APIs
- (New) Implement #102: Instance custom properties
- (Breaking change) maximize as a boolean has been changed in all algorithm components to FMode.MINIMIZE and FMode.MAXIMIZE
- (Change): Update all dependencies
- (Change): Improve ScatterSearch internals: refactor code and improve performance, implement missing unit tests
- (Change): Improve Docker builds: simplify and use multistage
- (Fix) #107 Autoconfig: Cannot assign integer values to double parameters in algorithm components
- (Fix) #158: Add TimeControl to SimmulatedAnnealing @isaaclo97
- (Fix) #163: ArrayUtil sum method truncates double values in some cases @JavierYuste
- (Fix) #180 Autoconfig: Improve type conversions for algorithm components
- (Fix) #169 Autoconfig: Remove middleware.sh and improve parallelism
- (Fix) #172: Update URL for the project generator
- (Fix) #130: Remove mandatory implementation of all component types in algorithm components
- And many more small fixes and improvements
- (New) Generic ScatterSearch algorithm implementation.
- (New) More methods in StringUtil + missing tests.
- (New) Custom solution properties.
- (New) Default readme in generated projects
- (New) Validate that no solution improves optimal value if known in any ReferenceResultProvider
- (Change) Improve progress bar and logging
- (Change) Upgrade dependencies
- (Change) Improve handling of missing ReferenceValues when comparing results
- (Fix) Max line length in InstanceManager
- (Fix) Multiple improvements to autoconfig module
- (Change) Remove autoconfig enable/disable from config files, use --autoconfig param
- (Fix) Autoconfig bugfix: more robust @CategorialParam serializing for irace
- (Fix) Autoconfig bugfix: recursive generation context when children is empty
- (Fix) Autoconfig bugfix: automatically remove single quotes from parameter values before running parser
- (New) API endpoint /autoconfig/debug/slow returns slow executions that did not respect the time limit
- (Change) Rename some autoconfig related method and classes, simplify their API
- (New) Metrics class to keep track of different metrics while any algorithm is executing. Calculate hypervolume of any metric in given range.
- (New) ArrayUtil::max, ArrayUtil::min util methods for int, long and double primitives
- (New) DoubleComparator util functions
- (New) Warn on slow solution serialization (> 500ms)
- (New) Add option to choose how frequently any solution serializer should execute: best_per_instance, best_per_alg_instance and all iterations.
- (New) Solving progress bar, logging improvement
- (New) Add solution exporter to template project
- (New) Profile activation via --{profilename}, example: --irace --autoconfig
- (Change) All irace related classes moved to autoconfig module
- (Change) Refactored GRASP Algorithm: Use builder pattern, add option to provide a custom greedy function.
- (Change) Refactored LocalSearch, enhance and simplify its behaviour.
- (Change) Improve SolutionSerializer::export method
- (Change) Solution::updateLastModifiedTime renamed to Solution::notifyUpdate
- (Change) Split configuration in different files
- (Removed) IteratedImprover, MoveComparator, DefaultMoveComparator, Move::improves
- (Fix) Irace bug when parsing args separated by multiple spaces
- (New) Algorithms can be magically built from strings without user interaction, using the new autoconfig project. See AlgComponentService and AlgorithmBuilderUtil classes for more details.
- (New) Algorithms can be manually built from strings using an IraceAlgorithmGenerator implementation. See IraceAlgorithmGenerator::buildFromString for more details
- (New) Benchmark enabled by default, using cached results file.
- (New) Add Other info Excel sheet
- (New) ReferenceResult::isOptimalValue
- (New) Default Instance::toString
- (New) Measure instance load time, add to Excel as a instance property by default
- (Change) Template project: Add base Move, ReferenceResultProvider, better comments
- (Change) dynamically generate scenario.txt for Irace. Use seed, instances, parallel config etc loaded from application.yml or environment.
- (Change) Neighborhoods refactor: delete eager and lazy neighborhoods, randomizable as subclass, always return ExploreResult.
- (Change) IraceAlgorithmGenerator refactor and cleanup, improve validation.
- (Change) Move::execute now must return boolean, stating if current solution has changed after executing it or not. There are moves that may leave the solution exactly the same in certain problems.
- (Change) Upgrade dependencies
- (Remove) Move::isValid, not practical in its current implementation.
- (Remove) NoOPConstructive, replaced by Constructive::nul
- (Fix) #88: Filename bug in SolutionSerializer, by @ea2809
- (Fix) #63: Bug parallel irace with randoms, by @scaverod
- (Fix) RawSheetWriter::writeCell add float and long value handling
- (New) Neighborhood.empty(), Neighborhood.concat(n1, n2), Neighborhood.interleave(n1, n2)
- (New) Modular Angular 13 frontend
- (New) Custom instance properties. See Instance::getProperty and setProperty for more info.
- (New) ExecutionStartedEvent::isMaximizing
- (New) Instance preload by default, set solve order by default to instance path, override by implementing Instance::compareTo.
- (New) Root package name can be optionally customized
- (New) TimeUtil class
- (Change) Improved logging, lot less noise
- (Change) Simplify algorithms constructors, create no-op components with Constructive::null, Improver::null, Shake::nul
- (Change) Removed maximizing config parameter, now must be set when calling Mork.start from main method.
- (Change) Remove logging properties from configuration file, mostly unused, but can still be overridden.
- (Change) Remove advanced properties from configuration file, try patch and skip if not possible.
- (Change) Add "common" submodule. More submodules will be added soon.
- (Fix) ExcelSerializer: If a value to write is null then write empty cell instead of failing
- (Fix) #77: Use reference results in all ResultSerializers instead of only when exporting to XLSX.
- (Fix) #31: Frontend mixed experiment data under some circumstances.
- (Fix) #51: Frontend instance table alignment was wrong if a custom solution was bigger than a chart.
- (Fix) #40: Frontend displayed wrong data for maximization problems.
- (New) GRASP::afterGRASP: Optionally execute anything after the GRASP constructive finishes
- (New) Verify move changes solution score as expected
- (New) Option to enable/disable instance preload
- (New) Warn if IteratedImproved appears stuck
- (New) Added SolutionValidator to template project by default
- (Refactor) Results Serializers: CSV, XLSX
- (Fix) Workload hard limit 1mk
- (Fix) Benchmark should use seed configured via properties
- (Fix) Missing return in SimulatedAnnealingBuilder method
- (Fix) Export all generated solutions by default if a solution serializer is enabled instead of only best for pair (alg, instance)
- (New) Swap methods in ArrayUtil
- (New) Events: AlgorithmProcessingStartedEvent, AlgorithmProcessingEndedEvent
- (Improvement) AbstractExperiment now requires SolverConfig instead of a "strange" boolean value.
- (Improvement) IteratedGreedy
- (Improvement) SimulatedAnnealing: Customizable Acceptance Criteria
- (Improvement) Irace: return both objetive function and elapsed time.
- (Fix) Run configurations in template project
- (Fix) Disable websockets logging by default
- (Fix) Excel logger gave the impression to be stuck
- (Fix) Potential classpath conflict with JSONObject
- (Docs) Events and result export / solution serialization
Mainly internal changes, refactored some critical components
- (New) Refactor Executors: ConcurrentExecutor can be as much as 8 times faster for certain workloads.
- (New) Refactor solutions serializers: Easily extend and customize how solutions should be exported to disk. Disable or keep default JSON serializer.
- (New) Refactor results serializers: New features, the most prominent one now they can export after solving each instance to provide instant feedback instead of waiting until the whole experiment ends.
- (New) Added TSP example and documentation.
- (New) Detect in some cases when user does not update TTB and throw exception.
- (Fix) Added missing irace file during project generation via web.
- (Fix) Irace logs were not included in log files.
- (Fix) Irace middleware.sh now works properly in Mac.
- (Fix) Max length for algorithms short names, throws exception before experiment starts if any algorithm is longer.
- (Fix) PatchMathRandom and PatchCollections for Java 11 and newer.
- (New) MultiStartAlgorithm
- (New) Simulated Annealing
- (New) Customizable random implementations. RandomManager::getRandom now returns an instance of RandomGenerator.
- (Deprecated) SimpleMultiStartAlgorithm
- Java 17 as minimum required version
- Replaced Solution::getBetterSolution with Solution::isBetterThan
- Better generic usage in Solution --> Solution<Self,Instance>
- (NEW) Easily create Docker containers
- Internal Maven changes
- Changed ReferenceResultProvider, now multiple instances can be provided in order to automatically compare against several approaches.
- Improved Excel serializer: Configurable metrics in pivot table, better generation in raw table. All calculated values are not generated by Excel.
- Fixed several bugs and other minor improvements
- Irace integration, see Wiki for more details.
- Algorithm::getBuilder: get current SolutionBuilder.
- Two types of neighborhoods, normal and lazy. Lazy generated movements under demand, while eager returns a collection of movements.
- New event type: ErrorEvent, when an unhandled exception is propagated inside an Executor.
- Telegram bot, if enabled, sends message onErrorEvent.
- Added Telegram integration, see Wiki for more information and how to use.
- Fixed bug in IteratedGreedy
- Added option to allow users to decide if the backend should stop and the application be killed after all experiments are finished.