#645: Deprecate getter for EvolutionStart.

jenetics · Jan 23, 2020 · 1a0e139 · 1a0e139
1 parent a9db688
commit 1a0e139
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 13 deletions.
diff --git a/jenetics.ext/src/test/java/io/jenetics/ext/engine/ConcatEngineTest.java b/jenetics.ext/src/test/java/io/jenetics/ext/engine/ConcatEngineTest.java
@@ -94,7 +94,7 @@ public void concat1b() {
 		EvolutionInit<IntegerGene> init = EvolutionInit.of(
 			EvolutionStreams.result(5)
 				.toEvolutionStart()
-				.getPopulation().stream()
+				.population().stream()
 				.map(Phenotype::genotype)
 				.collect(ISeq.toISeq()),
 			1

diff --git a/jenetics.ext/src/test/java/io/jenetics/ext/engine/EvolutionStreamables.java b/jenetics.ext/src/test/java/io/jenetics/ext/engine/EvolutionStreamables.java
@@ -49,10 +49,10 @@ static EvolutionStreamable<IntegerGene, Integer> streamable(final int size) {
 						@Override
 						public Integer get() {
 							if (value == null) {
-								value  = start.get().getPopulation().isEmpty()
+								value  = start.get().population().isEmpty()
 									? 0
 									: start.get()
-										.getPopulation()
+										.population()
 										.get(0)
 										.genotype()
 										.gene()

diff --git a/jenetics/src/main/java/io/jenetics/engine/Engine.java b/jenetics/src/main/java/io/jenetics/engine/Engine.java
@@ -218,7 +218,7 @@ public EvolutionResult<G, C> apply(final EvolutionStart<G, C> start) {
 	@Override
 	public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 		// Create initial population if `start` is empty.
-		final EvolutionStart<G, C> es = start.getPopulation().isEmpty()
+		final EvolutionStart<G, C> es = start.population().isEmpty()
 			? evolutionStart(start)
 			: start;
 
@@ -227,7 +227,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 
 		// Initial evaluation of the population.
 		final ISeq<Phenotype<G, C>> evaluated = timing.evaluation.timing(() ->
-			evaluate(es.getPopulation())
+			evaluate(es.population())
 		);
 
 		// Select the offspring population.
@@ -252,7 +252,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 		final CompletableFuture<AltererResult<G, C>> alteredOffspring =
 			offspring.thenApplyAsync(off ->
 				timing.offspringAlter.timing(() ->
-					_alterer.alter(off, es.getGeneration())
+					_alterer.alter(off, es.generation())
 				),
 				_executor
 			);
@@ -261,7 +261,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 		final CompletableFuture<FilterResult<G, C>> filteredSurvivors =
 			survivors.thenApplyAsync(sur ->
 				timing.survivorFilter.timing(() ->
-					filter(sur, es.getGeneration())
+					filter(sur, es.generation())
 				),
 				_executor
 			);
@@ -270,7 +270,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 		final CompletableFuture<FilterResult<G, C>> filteredOffspring =
 			alteredOffspring.thenApplyAsync(off ->
 				timing.offspringFilter.timing(() ->
-					filter(off.population(), es.getGeneration())
+					filter(off.population(), es.generation())
 				),
 				_executor
 			);
@@ -302,7 +302,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 		EvolutionResult<G, C> er = EvolutionResult.of(
 			_optimize,
 			result,
-			es.getGeneration(),
+			es.generation(),
 			timing.toDurations(),
 			killCount,
 			invalidCount,
@@ -422,8 +422,8 @@ public EvolutionStream<G, C> stream(final EvolutionInit<G> init) {
 
 	private EvolutionStart<G, C>
 	evolutionStart(final EvolutionStart<G, C> start) {
-		final ISeq<Phenotype<G, C>> population = start.getPopulation();
-		final long gen = start.getGeneration();
+		final ISeq<Phenotype<G, C>> population = start.population();
+		final long gen = start.generation();
 
 		final Stream<Phenotype<G, C>> stream = Stream.concat(
 			population.stream(),

diff --git a/jenetics/src/main/java/io/jenetics/engine/EvolutionStart.java b/jenetics/src/main/java/io/jenetics/engine/EvolutionStart.java
@@ -45,7 +45,7 @@
  *
  * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
  * @since 3.1
- * @version 5.1
+ * @version !__version__!
  */
 public final class EvolutionStart<
 	G extends Gene<?, G>,
@@ -68,6 +68,17 @@ private EvolutionStart(
 	 *
 	 * @return the start population
 	 */
+	public ISeq<Phenotype<G, C>> population() {
+		return _population;
+	}
+
+	/**
+	 * Return the population before the evolution step.
+	 *
+	 * @return the start population
+	 * @deprecated Use {@link #population()} instead
+	 */
+	@Deprecated
 	public ISeq<Phenotype<G, C>> getPopulation() {
 		return _population;
 	}
@@ -77,6 +88,17 @@ public ISeq<Phenotype<G, C>> getPopulation() {
 	 *
 	 * @return the start generation
 	 */
+	public long generation() {
+		return _generation;
+	}
+
+	/**
+	 * Return the generation of the start population.
+	 *
+	 * @return the start generation
+	 * @deprecated Use {@link #generation()} instead
+	 */
+	@Deprecated
 	public long getGeneration() {
 		return _generation;
 	}

diff --git a/jenetics/src/test/java/io/jenetics/engine/EvolutionStreamTest.java b/jenetics/src/test/java/io/jenetics/engine/EvolutionStreamTest.java
@@ -84,7 +84,7 @@ public void ofAdjustableEvolution() {
 
 	private static double var(final EvolutionStart<DoubleGene, Double> result) {
 		return result != null
-			? result.getPopulation().stream()
+			? result.population().stream()
 				.map(Phenotype::fitness)
 				.collect(DoubleMoments.toDoubleMoments())
 				.variance()