Skip to content
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

Jump to bottom

feat: add support for fairness constraints #918

Merged
merged 18 commits into from
Jul 8, 2024
Merged

feat: add support for fairness constraints #918

merged 18 commits into from
Jul 8, 2024

Conversation

triceo
Copy link
Contributor

@triceo triceo commented Jun 25, 2024 •
edited
Loading

This PR introduces fairness support. To that end, it:

  • Enables custom padding for concat().
  • Allows if(Not)Exists to be used with a stream.
  • Introduces a new CS building block complement().
  • Adds the fairness collector.
  • Introduces ConstraintVerifier capability to check for more/less penalties/rewards.

This PR is part of an ensemble:

TimefoldAI/timefold-solver-python#94
TimefoldAI/timefold-quickstarts#496

@triceo
Copy link
Contributor Author

triceo commented Jun 25, 2024

@lee-carlon The PR will continue evolving, but the docs part is probably already stable. Feedback is appreciated.

lee-carlon
lee-carlon reviewed Jun 26, 2024
View reviewed changes
Copy link
Contributor

@lee-carlon lee-carlon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@triceo I've added some minor language suggestions.

docs/src/modules/ROOT/pages/constraints-and-score/overview.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/score-calculation.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/score-calculation.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/score-calculation.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/score-calculation.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/load-balancing-and-fairness.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/load-balancing-and-fairness.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/load-balancing-and-fairness.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/load-balancing-and-fairness.adoc Outdated Show resolved Hide resolved
docs/src/modules/ROOT/pages/constraints-and-score/load-balancing-and-fairness.adoc Outdated Show resolved Hide resolved
@triceo triceo mentioned this pull request Jun 27, 2024
Merged
9 tasks
@triceo triceo added this to the v1.12.0 milestone Jun 27, 2024
@triceo triceo force-pushed the fairness2 branch 4 times, most recently from 3dc442f to 84e1136 Compare June 28, 2024 10:38
@triceo triceo marked this pull request as ready for review July 1, 2024 05:36
Christopher-Chianelli
Christopher-Chianelli approved these changes Jul 3, 2024
View reviewed changes
Copy link
Contributor

@Christopher-Chianelli Christopher-Chianelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logic looks good; comments about naming and possible future methods

...java/ai/timefold/solver/core/impl/score/stream/bavet/uni/BavetConcatUniConstraintStream.java Show resolved Hide resolved
.../ai/timefold/solver/core/impl/score/stream/collector/bi/InnerBiConstraintCollectorsTest.java Show resolved Hide resolved
test/src/main/java/ai/timefold/solver/test/api/score/stream/SingleConstraintAssertion.java Show resolved Hide resolved
@triceo triceo mentioned this pull request Jul 8, 2024
Open
triceo and others added 16 commits July 8, 2024 09:00
@triceo
feat: allow custom padding for concat()
90f25de
@triceo
feat: allow if(Not)Exists() with streams
1b90a24
@triceo
fix: share lambdas in distinct()
0615760
@triceo
feat: introduce complement()
3ae0c0c
@triceo
docs: add complement() and introduce fairness
453e3b5
@triceo
feat: add the loadBalance() constraint collector
3dd256c
@triceo
feat: ConstraintVerifier capability to test for more or less than.
1199492
@triceo
test: add tests for the new collectors
dd4dd42
@triceo
test: add tests for CS complement()
9d07db7
@triceo @lee-carlon
docs: apply suggestions from code review
7f04644 
Co-authored-by: lee-carlon <lee@timefold.ai>
@triceo
chore: fix Javadoc
51bd556
@triceo
chore: fix LoadBalance serialization
a3b9f30
@triceo
fix: ConstraintVerifier more/less correct type handling
d62492b
@triceo
fix: support for zero values
48049bb
@triceo
fix: loadBalance() didn't do sqrt()
d2ed451
@triceo
chore: switch to 6 decimal places
227d25e
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Jul 8, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
68.3% Coverage on New Code (required ≥ 75%)
12.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

@triceo triceo merged commit d07cfb2 into TimefoldAI:main Jul 8, 2024
23 of 24 checks passed
@triceo triceo deleted the fairness2 branch July 8, 2024 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lee-carlon lee-carlon lee-carlon left review comments

@Christopher-Chianelli Christopher-Chianelli Christopher-Chianelli approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.12.0
Development

Successfully merging this pull request may close these issues.
3 participants
@triceo @Christopher-Chianelli @lee-carlon