Renamed SearchParameters.getLow to getLowerBound + javadoc

Author: fathzer

src/main/java/com/fathzer/games/ai/SearchParameters.java

@@ -74,18 +74,30 @@ public int getAccuracy() {
 	 */
 	public void setAccuracy(int accuracy) {
 		if (accuracy<0) {
-			throw new IllegalArgumentException("Accuracy should be strictly positive");
+			throw new IllegalArgumentException(ACCURACY_SHOULD_BE_POSITIVE);
 		}
 		this.accuracy = accuracy;
 	}
 
-	public <M> int getLow(List<EvaluatedMove<M>> moves) {
+	/** Gets the lower bound score under which moves will not be considered as one of the best moves returned by {@link #getBestMoves(List)}.
+	 * <br>An {@link AI} can returned the lower bound score instead of the real one if it is sure that its real score is lower than the lower bound score.
+	 * <br>This is because such a move is guaranteed not to be among the best {@link #getSize()} moves returned by {@link #getBestMoves(List)}.
+	 * @param moves A ordered (best first) list of moves. If this list is not sorted, the result is unpredictable.
+	 * @return an int
+	 */
+	public <M> int getLowerBound(List<EvaluatedMove<M>> moves) {
 		return moves.size()>=size ? moves.get(size-1).getScore() - accuracy -1 : Integer.MIN_VALUE;
 	}
 
+	/** Gets the best moves of a sorted move list according to the {@link #getSize()} and {@link #getAccuracy()} of this search parameter.
+	 * @param moves The list of moves to cut. This list must be sorted (best first). If it is not sorted, the result is unpredictable.
+	 * @return a list of moves restricted to the size and accuracy of this search parameter.
+     * <br>Please note that the returned list may have more than {@link #getSize()} elements in case of equivalent moves or almost equivalent moves (according to {@link #getAccuracy()}).
+     * It can also have less than {@link #getSize()} elements if there's less than {@link #getSize()} legal moves or search was interrupted before it finished. 
+	 */
 	public <M> List<EvaluatedMove<M>> getBestMoves(List<EvaluatedMove<M>> moves) {
 		final List<EvaluatedMove<M>> cut = new ArrayList<>(moves.size());
-		final int low = getLow(moves);
+		final int low = getLowerBound(moves);
 		int currentCount = 0;
 		for (EvaluatedMove<M> ev : moves) {
 			if (ev.getScore()>low || currentCount<size) {

src/main/java/com/fathzer/games/ai/SearchResult.java

@@ -27,7 +27,7 @@ public SearchParameters getSearchParameters() {
 	}
 
 	synchronized int getLow() {
-		return params.getLow(result);
+		return params.getLowerBound(result);
 	}
 
 	public synchronized void add(M move, Evaluation value) {

src/main/java/com/fathzer/games/ai/iterativedeepening/DeepeningPolicy.java

@@ -191,7 +191,7 @@ public <M> Optional<SearchResult<M>> mergeInterrupted(SearchHistory<M> history,
 			return Optional.empty();
 		}
 		final List<EvaluatedMove<M>> historyMoves = history.getLastList();
-		final int previousLow = this.getLow(historyMoves);
+		final int previousLow = this.getLowerBound(historyMoves);
 		final boolean trap = partialList.get(partialList.size()-1).getScore()<=previousLow;
 		final SearchResult<M> mergedResult = new SearchResult<>(this);
 		if (trap) {