doc updated and constraint renames

Author: RandomCyberCoder

java/hello-world/README.md

@@ -109,6 +109,7 @@ the lecture units and lab/act units will be bundled together into a lesson insta
 Other things to consider:
 - If a studio course instance is scheduled to have all it's lab/act time to be in **one** block, then the constraint
 enforcing that lab/act time must be immediately after lecture will not be enforced for this lesson.
+- When setting the instructor preference, the key (aka the instructor's name) should be their canonical name.
 
 
 

java/hello-world/src/main/java/org/acme/schooltimetabling/solver/TimetableConstraintProvider.java

@@ -35,10 +35,10 @@ public Constraint[] defineConstraints(ConstraintFactory constraintFactory) {
         //universal constraints
         List<Constraint> solver_constraints = new ArrayList<>(Arrays.asList(
                 // Hard constraints
-                sameClassSameDays(constraintFactory),
+                teacherSameCourseSamePattern(constraintFactory),
                 teacherLessonConflict(constraintFactory),
                 lessonConflict(constraintFactory),
-                labActRoomConflict(constraintFactory),
+                roomConflict(constraintFactory),
                 wrongHoursAmount(constraintFactory),
                 wrongRoomType(constraintFactory),
                 timeslotPatternMatch(constraintFactory),
@@ -145,7 +145,7 @@ Constraint primeTime50Plus(ConstraintFactory constraintFactory){
      *
      * @return Penalize by {@link HardMediumSoftScore#ONE_HARD}
      */
-    Constraint sameClassSameDays(ConstraintFactory constraintFactory){
+    Constraint teacherSameCourseSamePattern(ConstraintFactory constraintFactory){
         return constraintFactory
                 .forEachUniquePair(Lesson.class,
                     Joiners.equal(lesson -> lesson.getTeacherObj().getId()),
@@ -217,7 +217,7 @@ Constraint lessonConflict(ConstraintFactory constraintFactory){
      * This constraint will penalize any unique pair of lessons (w/ lab/act) that use the same room
      * at the same time
      */
-    Constraint labActRoomConflict(ConstraintFactory constraintFactory){
+    Constraint roomConflict(ConstraintFactory constraintFactory){
         return constraintFactory
                 //for each lesson
                 .forEachUniquePair(Lesson.class,

java/hello-world/src/test/java/org/acme/schooltimetabling/solver/TestConstraintPropStudio.java

@@ -46,7 +46,7 @@ void pen_PropDiffTchPttrn(){
                 ConstraintTestHelper.DUMMY_TEACHER, ts_TR_TR, ConstraintTestHelper.DUMMY_ROOM);
 
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::sameClassSameDays)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::teacherSameCourseSamePattern)
                 .given(ls1_MWF_TR, ls2_TR_TR
                 )
                 /*Note this takes into account weight of rewards*/
@@ -67,7 +67,7 @@ void noPen_PropSameTchPttrn(){
                 "", "3-1-0", Constants.COURSE_ID_BIMAP.get(ConstraintTestHelper.DUMMY_STUDIO),
                 ConstraintTestHelper.DUMMY_TEACHER, ts_MWF_MWF, ConstraintTestHelper.DUMMY_ROOM);
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::sameClassSameDays)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::teacherSameCourseSamePattern)
                 .given(ls1_MWF_TR, ls2_MWF_MWF
                 )
                 /*Note this takes into account weight of rewards*/
@@ -116,7 +116,7 @@ void pen_PropCoursesSameRoom() throws Exception{
                 "", "3-1-0", Constants.COURSE_ID_BIMAP.get(ConstraintTestHelper.DUMMY_STUDIO),
                 ConstraintTestHelper.DUMMY_TEACHER, ts_TR_830AM_3blcks_10AM_3blcks, ConstraintTestHelper.DUMMY_ROOM);
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::labActRoomConflict)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::roomConflict)
                 .given(combo1_st1, combo1_non_st1,
                         combo2_st2, combo2_st3)
                 .penalizesBy(2);
@@ -147,7 +147,7 @@ void noPen_PropCoursesSameRoom() throws Exception{
                 ConstraintTestHelper.DUMMY_ROOM);
 
         //reasoning: proper studios use lab room for lec and lab/act portions, but non proper doesn't use it during lec
-        constraintVerifier.verifyThat(TimetableConstraintProvider::labActRoomConflict)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::roomConflict)
                 .given(combo1_st1, combo1_non_st1)
                 .penalizesBy(NO_PENALTY);
 

java/hello-world/src/test/java/org/acme/schooltimetabling/solver/TestConstraints.java

@@ -1,6 +1,5 @@
 package org.acme.schooltimetabling.solver;
 
-import ai.timefold.solver.core.api.score.stream.Constraint;
 import org.acme.schooltimetabling.builders.lessons.LessonBuilder;
 import org.acme.schooltimetabling.builders.teachers.TeacherBuilder;
 import org.acme.schooltimetabling.builders.teachers.policies.DefaultTeachingPolicy;
@@ -80,7 +79,7 @@ void sameLessonNTeacher(){
                 .build();
 
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::sameClassSameDays)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::teacherSameCourseSamePattern)
                 .given(ls1, ls2, ls3, ls4, ls5)
                 /*Note this takes into account weight of rewards*/
                 .penalizesBy(3);
@@ -265,7 +264,7 @@ void roomMultiLessons(){
                 "3-0-0", 2, ConstraintTestHelper.DUMMY_TEACHER, ts_mwf_11,
                 ConstraintTestHelper.DUMMY_ROOM);
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::labActRoomConflict)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::roomConflict)
                 .given(lesson1, lesson2, lesson3, lesson4studio)
                 .penalizesBy(2);
     }
@@ -287,7 +286,7 @@ void roomMultiLessons2(){
                 , "", "3-1-0", 1, ConstraintTestHelper.DUMMY_TEACHER, timeslot2,
                 ConstraintTestHelper.DUMMY_ROOM);
 
-        constraintVerifier.verifyThat(TimetableConstraintProvider::labActRoomConflict)
+        constraintVerifier.verifyThat(TimetableConstraintProvider::roomConflict)
                 .given(lesson1, lesson2)
                 .penalizesBy(1);
     }