Skip to content

docs: clarify CH need for Neighborhoods API #2288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
triceo merged 2 commits into from
May 5, 2026
Merged

docs: clarify CH need for Neighborhoods API #2288

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d42691
docs: clarify CH need for Neighborhoods API
TomCools May 5, 2026
8884128
Apply suggestions from code review
TomCools May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/src/modules/ROOT/pages/optimization-algorithms/neighborhoods.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -731,14 +731,19 @@ and reference the implementation class in the solver configuration like so:
[source,xml]
----
<solver xmlns="https://timefold.ai/xsd/solver">
<enablePreviewFeature>NEIGHBORHOODS</enablePreviewFeature>
...
<enablePreviewFeature>NEIGHBORHOODS</enablePreviewFeature>
<constructionHeuristic/> <!-- Often used before localSearch when the solution is not yet initialized -->

<localSearch>
<neighborhoodProviderClass>com.acme.MyNeighborhoodProvider</neighborhoodProviderClass>
</localSearch>
</solver>
----

NOTE: As the Neighborhoods API is a part of Local Search, it needs to be used on an initialized solution.
This usually means that a xref:optimization-algorithms/construction-heuristics.adoc[construction heuristic] precedes it.

The `NeighborhoodProvider` interface has a single method:

[source,java,options="nowrap"]
Expand Down
Loading