#645: Deprecate getter for AltererResult.

jenetics · Jan 23, 2020 · 0ec0ea4 · 0ec0ea4
1 parent 269f6c3
commit 0ec0ea4
Show file tree

Hide file tree

Showing 15 changed files with 43 additions and 21 deletions.
diff --git a/jenetics.prog/src/test/java/io/jenetics/prog/MathTreePruneAltererTest.java b/jenetics.prog/src/test/java/io/jenetics/prog/MathTreePruneAltererTest.java
@@ -74,7 +74,7 @@ public void prune() {
 			alterer.alter(Seq.of(pt), 1);
 
 		final ProgramGene<Double> program = result
-			.getPopulation().get(0)
+			.population().get(0)
 			.genotype()
 			.gene();
 

diff --git a/jenetics/src/main/java/io/jenetics/AltererResult.java b/jenetics/src/main/java/io/jenetics/AltererResult.java
@@ -71,6 +71,17 @@ private AltererResult(
 	 *
 	 * @return the altered population
 	 */
+	public ISeq<Phenotype<G, C>> population() {
+		return _population;
+	}
+
+	/**
+	 * Return the altered population.
+	 *
+	 * @return the altered population
+	 * @deprecated Use {@link #population()} instead
+	 */
+	@Deprecated
 	public ISeq<Phenotype<G, C>> getPopulation() {
 		return _population;
 	}
@@ -80,6 +91,17 @@ public ISeq<Phenotype<G, C>> getPopulation() {
 	 *
 	 * @return the number of altered individuals
 	 */
+	public int alterations() {
+		return _alterations;
+	}
+
+	/**
+	 * Return the number of altered individuals.
+	 *
+	 * @return the number of altered individuals
+	 * @deprecated Use {@link #alterations()} instead
+	 */
+	@Deprecated
 	public int getAlterations() {
 		return _alterations;
 	}

diff --git a/jenetics/src/main/java/io/jenetics/CompositeAlterer.java b/jenetics/src/main/java/io/jenetics/CompositeAlterer.java
@@ -76,13 +76,13 @@ public AltererResult<G, C> alter(
 		AltererResult<G, C> result = AltererResult.of(population.asISeq());
 		for (Alterer<G, C> alterer : _alterers) {
 			final AltererResult<G, C> as = alterer.alter(
-				result.getPopulation(),
+				result.population(),
 				generation
 			);
 
 			result = AltererResult.of(
-				as.getPopulation(),
-				as.getAlterations() + result.getAlterations()
+				as.population(),
+				as.alterations() + result.alterations()
 			);
 		}
 

diff --git a/jenetics/src/main/java/io/jenetics/PartialAlterer.java b/jenetics/src/main/java/io/jenetics/PartialAlterer.java
@@ -95,8 +95,8 @@ private PartialAlterer(final Alterer<G, C> alterer, final Section section) {
 			final AltererResult<G, C> result = _alterer.alter(split, generation);
 
 			return AltererResult.of(
-				_section.merge(result.getPopulation(), population),
-				result.getAlterations()
+				_section.merge(result.population(), population),
+				result.alterations()
 			);
 		} else {
 			return AltererResult.of(population.asISeq(), 0);

diff --git a/jenetics/src/main/java/io/jenetics/engine/Engine.java b/jenetics/src/main/java/io/jenetics/engine/Engine.java
@@ -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.getPopulation(), es.getGeneration())
+					filter(off.population(), es.getGeneration())
 				),
 				_executor
 			);
@@ -297,7 +297,7 @@ public EvolutionResult<G, C> evolve(final EvolutionStart<G, C> start) {
 			filteredOffspring.join().invalidCount +
 			filteredSurvivors.join().invalidCount;
 
-		final int alterationCount = alteredOffspring.join().getAlterations();
+		final int alterationCount = alteredOffspring.join().alterations();
 
 		EvolutionResult<G, C> er = EvolutionResult.of(
 			_optimize,

diff --git a/jenetics/src/test/java/io/jenetics/CompositeAltererTest.java b/jenetics/src/test/java/io/jenetics/CompositeAltererTest.java
@@ -54,8 +54,8 @@ public void alterCount(
 		final AltererResult<DoubleGene, Double> result = mutator.alter(p1, 1);
 
 		Assert.assertEquals(
-			result.getAlterations(),
-			diff(p1, result.getPopulation())
+			result.alterations(),
+			diff(p1, result.population())
 		);
 	}
 

diff --git a/jenetics/src/test/java/io/jenetics/IntermediateCrossoverTest.java b/jenetics/src/test/java/io/jenetics/IntermediateCrossoverTest.java
@@ -62,7 +62,7 @@ public void populationRecombine() {
 			final IntermediateCrossover<DoubleGene, Double> recombinator =
 				new IntermediateCrossover<>(1);
 
-			pop = recombinator.alter(pop, 10).getPopulation();
+			pop = recombinator.alter(pop, 10).population();
 
 			for (int i = 0; i < pop.size(); ++i) {
 				final BaseSeq<DoubleGene> genes = pop.get(i)

diff --git a/jenetics/src/test/java/io/jenetics/LineCrossoverTest.java b/jenetics/src/test/java/io/jenetics/LineCrossoverTest.java
@@ -62,7 +62,7 @@ public void populationRecombine() {
 			final LineCrossover<DoubleGene, Double> recombinator =
 				new LineCrossover<>(1);
 
-			pop = recombinator.alter(pop, 10).getPopulation();
+			pop = recombinator.alter(pop, 10).population();
 
 			for (int i = 0; i < pop.size(); ++i) {
 				final BaseSeq<DoubleGene> genes = pop.get(i)

diff --git a/jenetics/src/test/java/io/jenetics/MeanAltererTest.java b/jenetics/src/test/java/io/jenetics/MeanAltererTest.java
@@ -86,7 +86,7 @@ public void alterProbability(
 		for (int i = 0; i < N; ++i) {
 			final long alterations = crossover
 				.alter(population, 1)
-				.getAlterations();
+				.alterations();
 			histogram.accept(alterations);
 			variance.accept(alterations);
 		}

diff --git a/jenetics/src/test/java/io/jenetics/MutatorTester.java b/jenetics/src/test/java/io/jenetics/MutatorTester.java
@@ -48,8 +48,8 @@ public void alterCount(
 		final Alterer<DoubleGene, Double> mutator = newAlterer(0.01);
 		final AltererResult<DoubleGene, Double> result = mutator.alter(p1, 1);
 
-		int mutations = result.getAlterations();
-		int difference = diff(p1, result.getPopulation());
+		int mutations = result.alterations();
+		int difference = diff(p1, result.population());
 
 		Assert.assertEquals(
 			mutations, difference,
@@ -84,7 +84,7 @@ public void alterProbability(
 		for (int i = 0; i < N; ++i) {
 			final long alterations = mutator
 				.alter(population.copy(), 1)
-				.getAlterations();
+				.alterations();
 
 			histogram.accept(alterations);
 			variance.accept(alterations);

diff --git a/jenetics/src/test/java/io/jenetics/PartialAltererTest.java b/jenetics/src/test/java/io/jenetics/PartialAltererTest.java
@@ -119,7 +119,7 @@ public void alterer() {
 
 		for (int i = 0; i < population.length(); ++i) {
 			final Phenotype<DoubleGene, Double> pt1 = population.get(0);
-			final Phenotype<DoubleGene, Double> pt2 = result.getPopulation().get(0);
+			final Phenotype<DoubleGene, Double> pt2 = result.population().get(0);
 
 			Assert.assertEquals(pt1.genotype().get(0), pt2.genotype().get(0));
 			Assert.assertNotEquals(pt1.genotype().get(1), pt2.genotype().get(1));

diff --git a/jenetics/src/test/java/io/jenetics/PartiallyMatchedCrossoverTest.java b/jenetics/src/test/java/io/jenetics/PartiallyMatchedCrossoverTest.java
@@ -112,7 +112,7 @@ public void alterProbability(
 		for (int i = 0; i < N; ++i) {
 			final long alterations = crossover
 				.alter(population, 1)
-				.getAlterations();
+				.alterations();
 			histogram.accept(alterations);
 			variance.accept(alterations);
 		}

diff --git a/jenetics/src/test/java/io/jenetics/SinglePointCrossoverTest.java b/jenetics/src/test/java/io/jenetics/SinglePointCrossoverTest.java
@@ -147,7 +147,7 @@ public void alterProbability(
 		for (int i = 0; i < N; ++i) {
 			final long alterations = crossover
 				.alter(population, 1)
-				.getAlterations();
+				.alterations();
 			histogram.accept(alterations);
 			variance.accept(alterations);
 		}

diff --git a/jenetics/src/test/java/io/jenetics/SwapMutatorTest.java b/jenetics/src/test/java/io/jenetics/SwapMutatorTest.java
@@ -53,7 +53,7 @@ public void alterCount(
 
 		final Alterer<DoubleGene, Double> mutator = newAlterer(0.01);
 
-		final int alterations = mutator.alter(p2, 1).getAlterations();
+		final int alterations = mutator.alter(p2, 1).alterations();
 		//final int diff = diff(p1, p2);
 
 		if (ngenes == 1) {

diff --git a/jenetics/src/test/java/io/jenetics/engine/RepairingAlterer.java b/jenetics/src/test/java/io/jenetics/engine/RepairingAlterer.java
@@ -64,7 +64,7 @@ public AltererResult<G, C> alter(
 				pop.set(i, repair(pop.get(i)));
 			}
 		}
-		return AltererResult.of(pop.toISeq(), result.getAlterations());
+		return AltererResult.of(pop.toISeq(), result.alterations());
 	}
 
 	private Phenotype<G, C> repair(final Phenotype<G, C> pt) {