chore: improve MutableSolutionView API around list variables #2057

triceo · 2026-01-28T07:04:05Z

Updates Javadocs of several MutableSolutionView methods to better reflect the actual behavior.
Also introduces new assignValue options to support some corner cases.
Adds plenty of test coverage for each.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

triceo · 2026-01-28T09:15:30Z

Tagging @Christopher-Chianelli for review because I had to touch the multi-stage move.

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

core/src/main/java/ai/timefold/solver/core/impl/move/MoveDirector.java

core/src/main/java/ai/timefold/solver/core/preview/api/move/MutableSolutionView.java

zepfred

Looks good to me. My only suggestion is to include tests for scenarios where the source and destination entities are the same, as well as for the indexes.

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

winklerm

Thank you, that is very helpful!

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

core/src/main/java/ai/timefold/solver/core/preview/api/move/MutableSolutionView.java

core/src/main/java/ai/timefold/solver/core/preview/api/move/MoveRunner.java

triceo · 2026-01-28T12:06:36Z

Taking it back to draft again, because it still doesn't work right.
List variable listeners are a mess.

triceo · 2026-01-28T12:45:19Z

core/src/main/java/ai/timefold/solver/core/impl/move/MoveDirector.java

+        externalScoreDirector.beforeListVariableChanged(variableDescriptor, destinationEntity, destinationIndex,
+                destinationIndex + 1);
+        var actualOldValue = variableDescriptor.setElement(destinationEntity, destinationIndex, planningValue);
+        if (oldValue != actualOldValue) {
+            throw new IllegalStateException(
+                    "Impossible state: The value (%s) at index (%d) of entity (%s) is not as expected (%s)."
+                            .formatted(actualOldValue, destinationIndex, destinationEntity, oldValue));
+        }
+        externalScoreDirector.afterListVariableChanged(variableDescriptor, destinationEntity, destinationIndex,
+                destinationIndex + 1);


These notifications negate the performance benefit of this approach.
We only replace an element at a given place in the list, meaning nothing in the list needs to move back or forth; yet, these variable change notifications will still move things in the list.

I wonder if it could somehow be improved...

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

core/src/main/java/ai/timefold/solver/core/preview/api/move/MutableSolutionView.java

…oving and swapping items

sonarqubecloud · 2026-01-28T13:08:05Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
71.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Copilot AI review requested due to automatic review settings January 28, 2026 07:04

triceo temporarily deployed to internal January 28, 2026 07:04 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 07:04 — with GitHub Actions View deployment

triceo requested review from winklerm and zepfred January 28, 2026 07:04

Copilot started reviewing on behalf of triceo January 28, 2026 07:04 View session

triceo self-assigned this Jan 28, 2026

triceo added this to the v1.31.0 milestone Jan 28, 2026

Copilot AI reviewed Jan 28, 2026

View reviewed changes

triceo force-pushed the corner branch from e4a6910 to 3ad2e72 Compare January 28, 2026 08:16

triceo temporarily deployed to internal January 28, 2026 08:16 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 08:16 — with GitHub Actions View deployment

triceo removed the request for review from zepfred January 28, 2026 08:40

triceo marked this pull request as draft January 28, 2026 08:40

triceo force-pushed the corner branch from 3ad2e72 to 49ddc7d Compare January 28, 2026 09:15

triceo temporarily deployed to internal January 28, 2026 09:15 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 09:15 — with GitHub Actions View deployment

triceo requested a review from Christopher-Chianelli January 28, 2026 09:15

triceo marked this pull request as ready for review January 28, 2026 09:15

Copilot AI review requested due to automatic review settings January 28, 2026 09:15

Copilot started reviewing on behalf of triceo January 28, 2026 09:16 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

zepfred approved these changes Jan 28, 2026

View reviewed changes

Copilot AI reviewed Jan 28, 2026

View reviewed changes

triceo force-pushed the corner branch from 49ddc7d to b18e319 Compare January 28, 2026 10:41

triceo temporarily deployed to internal January 28, 2026 10:42 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 10:42 — with GitHub Actions View deployment

winklerm approved these changes Jan 28, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings January 28, 2026 11:02

triceo temporarily deployed to internal January 28, 2026 11:11 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 11:11 — with GitHub Actions View deployment

Copilot AI review requested due to automatic review settings January 28, 2026 11:16

triceo force-pushed the corner branch from 3c4a919 to 49bc9e2 Compare January 28, 2026 11:16

triceo temporarily deployed to internal January 28, 2026 11:16 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 11:16 — with GitHub Actions View deployment

Copilot started reviewing on behalf of triceo January 28, 2026 11:16 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

core/src/main/java/ai/timefold/solver/core/preview/api/move/MutableSolutionView.java Outdated Show resolved Hide resolved

core/src/main/java/ai/timefold/solver/core/preview/api/move/MoveRunner.java Outdated Show resolved Hide resolved

triceo force-pushed the corner branch from 49bc9e2 to f8b05cb Compare January 28, 2026 11:32

triceo temporarily deployed to internal January 28, 2026 11:33 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 11:33 — with GitHub Actions View deployment

triceo marked this pull request as draft January 28, 2026 12:06

triceo force-pushed the corner branch from f8b05cb to 55e5036 Compare January 28, 2026 12:37

triceo marked this pull request as ready for review January 28, 2026 12:37

Copilot AI review requested due to automatic review settings January 28, 2026 12:37

triceo temporarily deployed to internal January 28, 2026 12:37 — with GitHub Actions Inactive

triceo deployed to documentation (preview) January 28, 2026 12:37 — with GitHub Actions View deployment

Copilot started reviewing on behalf of triceo January 28, 2026 12:38 View session

triceo changed the title ~~chore: improve MutableSolutionView API description around list variable~~ chore: improve MutableSolutionView API around list variables Jan 28, 2026

triceo commented Jan 28, 2026

View reviewed changes

Copilot AI reviewed Jan 28, 2026

View reviewed changes

core/src/main/java/ai/timefold/solver/core/preview/api/move/MutableSolutionView.java Show resolved Hide resolved

chore: improve MutableSolutionView API description when it comes to m…

50244e1

…oving and swapping items

triceo force-pushed the corner branch from 55e5036 to 50244e1 Compare January 28, 2026 12:49

triceo temporarily deployed to internal January 28, 2026 12:49 — with GitHub Actions Inactive

triceo had a problem deploying to documentation (preview) January 28, 2026 12:50 — with GitHub Actions Failure

Christopher-Chianelli approved these changes Jan 28, 2026

View reviewed changes

triceo merged commit d9085ed into TimefoldAI:main Jan 28, 2026
33 of 34 checks passed

triceo deleted the corner branch January 28, 2026 15:31

chore: improve MutableSolutionView API around list variables #2057

chore: improve MutableSolutionView API around list variables #2057

Conversation

triceo commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

triceo commented Jan 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zepfred left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

winklerm left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

triceo commented Jan 28, 2026

Uh oh!

triceo Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 28, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

triceo commented Jan 28, 2026 •

edited

Loading

triceo Jan 28, 2026 •

edited

Loading