Skip to content

Commit

Permalink
rename generic type Sol to Solution_ for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
ge0ffrey committed Dec 21, 2015
1 parent 6c1f236 commit ce9cec7
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 15 deletions.
Expand Up @@ -24,17 +24,17 @@
* Used for easy java {@link Score} calculation. This is non-incremental calculation, which is slow. * Used for easy java {@link Score} calculation. This is non-incremental calculation, which is slow.
* <p> * <p>
* An implementation must be stateless. * An implementation must be stateless.
* @param <Sol> Subclass of {@link Solution} * @param <Solution_> Subclass of {@link Solution}
* @see EasyScoreDirector * @see EasyScoreDirector
*/ */
public interface EasyScoreCalculator<Sol extends Solution> { public interface EasyScoreCalculator<Solution_ extends Solution> {


/** /**
* This method is only called if the {@link Score} cannot be predicted. * This method is only called if the {@link Score} cannot be predicted.
* The {@link Score} can be predicted for example after an undo {@link Move}. * The {@link Score} can be predicted for example after an undo {@link Move}.
* @param solution never null * @param solution never null
* @return never null * @return never null
*/ */
Score calculateScore(Sol solution); Score calculateScore(Solution_ solution);


} }
Expand Up @@ -22,6 +22,6 @@
* Abstract superclass for {@link IncrementalScoreCalculator}. * Abstract superclass for {@link IncrementalScoreCalculator}.
* @see IncrementalScoreCalculator * @see IncrementalScoreCalculator
*/ */
public abstract class AbstractIncrementalScoreCalculator<Sol extends Solution> implements IncrementalScoreCalculator<Sol> { public abstract class AbstractIncrementalScoreCalculator<Solution_ extends Solution> implements IncrementalScoreCalculator<Solution_> {


} }
Expand Up @@ -26,11 +26,11 @@
* Allows a {@link IncrementalScoreCalculator} to report {@link ConstraintMatchTotal}s * Allows a {@link IncrementalScoreCalculator} to report {@link ConstraintMatchTotal}s
* for explaining a score (= which score constraints match for how much) * for explaining a score (= which score constraints match for how much)
* and also for score corruption analysis. * and also for score corruption analysis.
* @param <Sol> Subclass of {@link Solution} * @param <Solution_> Subclass of {@link Solution}
* @see IncrementalScoreCalculator * @see IncrementalScoreCalculator
*/ */
public interface ConstraintMatchAwareIncrementalScoreCalculator<Sol extends Solution> public interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_ extends Solution>
extends IncrementalScoreCalculator<Sol> { extends IncrementalScoreCalculator<Solution_> {


/** /**
* Allows for increased performance by tracking only if constraintMatchEnabled is true. * Allows for increased performance by tracking only if constraintMatchEnabled is true.
Expand All @@ -40,7 +40,7 @@ public interface ConstraintMatchAwareIncrementalScoreCalculator<Sol extends Solu
* @param workingSolution never null, to pass to {@link #resetWorkingSolution(Solution)}. * @param workingSolution never null, to pass to {@link #resetWorkingSolution(Solution)}.
* @param constraintMatchEnabled true if {@link #getConstraintMatchTotals()} might be called. * @param constraintMatchEnabled true if {@link #getConstraintMatchTotals()} might be called.
*/ */
void resetWorkingSolution(Sol workingSolution, boolean constraintMatchEnabled); void resetWorkingSolution(Solution_ workingSolution, boolean constraintMatchEnabled);


/** /**
* @return never null * @return never null
Expand Down
Expand Up @@ -28,17 +28,17 @@
* This is much faster than {@link EasyScoreCalculator} but requires much more code to implement too. * This is much faster than {@link EasyScoreCalculator} but requires much more code to implement too.
* <p> * <p>
* Any implementation is naturally stateful. * Any implementation is naturally stateful.
* @param <Sol> Subclass of {@link Solution} * @param <Solution_> Subclass of {@link Solution}
* @see IncrementalScoreDirector * @see IncrementalScoreDirector
*/ */
public interface IncrementalScoreCalculator<Sol extends Solution> { public interface IncrementalScoreCalculator<Solution_ extends Solution> {


/** /**
* There are no {@link #beforeEntityAdded(Object)} and {@link #afterEntityAdded(Object)} calls * There are no {@link #beforeEntityAdded(Object)} and {@link #afterEntityAdded(Object)} calls
* for entities that are already present in the workingSolution. * for entities that are already present in the workingSolution.
* @param workingSolution never null * @param workingSolution never null
*/ */
void resetWorkingSolution(Sol workingSolution); void resetWorkingSolution(Solution_ workingSolution);


/** /**
* @param entity never null, an instance of a {@link PlanningEntity} class * @param entity never null, an instance of a {@link PlanningEntity} class
Expand Down
Expand Up @@ -28,7 +28,6 @@
import java.util.SortedSet; import java.util.SortedSet;
import java.util.TreeSet; import java.util.TreeSet;


import org.junit.Ignore;
import org.junit.Test; import org.junit.Test;
import org.optaplanner.core.api.domain.solution.Solution; import org.optaplanner.core.api.domain.solution.Solution;
import org.optaplanner.core.api.domain.solution.cloner.SolutionCloner; import org.optaplanner.core.api.domain.solution.cloner.SolutionCloner;
Expand Down Expand Up @@ -66,7 +65,7 @@


public abstract class AbstractSolutionClonerTest { public abstract class AbstractSolutionClonerTest {


protected abstract <Sol extends Solution> SolutionCloner<Sol> createSolutionCloner( protected abstract <Solution_ extends Solution> SolutionCloner<Solution_> createSolutionCloner(
SolutionDescriptor solutionDescriptor); SolutionDescriptor solutionDescriptor);


@Test @Test
Expand Down
Expand Up @@ -22,9 +22,9 @@
public class FieldAccessingSolutionClonerTest extends AbstractSolutionClonerTest { public class FieldAccessingSolutionClonerTest extends AbstractSolutionClonerTest {


@Override @Override
protected <Sol extends Solution> FieldAccessingSolutionCloner<Sol> createSolutionCloner( protected <Solution_ extends Solution> FieldAccessingSolutionCloner<Solution_> createSolutionCloner(
SolutionDescriptor solutionDescriptor) { SolutionDescriptor solutionDescriptor) {
return new FieldAccessingSolutionCloner<Sol>(solutionDescriptor); return new FieldAccessingSolutionCloner<Solution_>(solutionDescriptor);
} }


} }

0 comments on commit ce9cec7

Please sign in to comment.