/*
 * Java Genetic Algorithm Library (@!identifier!@).
 * Copyright (c) @!year!@ Franz Wilhelmstötter
 *  
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Author:
 *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmx.at)
 *
 */
package org.jenetics;

import static org.jenetics.util.object.checkProbability;
import static org.jenetics.util.object.eq;
import static org.jenetics.util.object.hashCodeOf;

/**
 * Abstract implementation of the alterer interface.
 * 
 * @author <a href="mailto:franz.wilhelmstoetter@gmx.at">Franz Wilhelmstötter</a>
 * @version $Id$
 */
public abstract class AbstractAlterer<G extends Gene<?, G>> 
	implements Alterer<G> 
{
	public static final double DEFAULT_ALTER_PROBABILITY = 0.2;
	
	/**
	 * The altering probability. 
	 */
	protected final double _probability;
	
	/**
	 * Constructs an alterer with a given recombination probability.
	 * 
	 * @param probability The recombination probability.
	 * @throws IllegalArgumentException if the {@code probability} is not in the
	 *         valid range of {@code [0, 1]}.
	 */
	protected AbstractAlterer(final double probability) {
		_probability = checkProbability(probability);
	}
	
	/**
	 * Return the recombination/alter probability for this alterer.
	 * 
	 * @return The recombination probability.
	 */
	public double getProbability() {
		return _probability;
	}
	
	@Override
	public int hashCode() {
		return hashCodeOf(getClass()).and(_probability).value();
	}
	
	@Override
	public boolean equals(final Object obj) {
		if (obj == this) {
			return true;
		}
		if (!(obj instanceof AbstractAlterer<?>)) {
			return false;
		}
		
		final AbstractAlterer<?> alterer = (AbstractAlterer<?>)obj;
		return eq(_probability, alterer._probability);
	}
}





@@ -101,11 +101,9 @@
 r%0A *
-  
 %0A
+
  * T
@@ -357,25 +357,24 @@
  version.%0A *
- 
 %0A * This lib
@@ -612,25 +612,24 @@
  details.%0A *
- 
 %0A * You shou
@@ -1147,17 +1147,16 @@
 face.%0A *
- 
 %0A * @aut
@@ -1310,17 +1310,16 @@
 e%3C?, G%3E%3E
- 
 %0A%09implem
@@ -1333,17 +1333,16 @@
 terer%3CG%3E
- 
 %0A%7B%0A%09publ
@@ -1397,18 +1397,17 @@
  = 0.2;%0A
-%09
 %0A
+
 %09/**%0A%09 *
@@ -1432,17 +1432,16 @@
 ability.
- 
 %0A%09 */%0A%09p
@@ -1476,18 +1476,17 @@
 bility;%0A
-%09
 %0A
+
 %09/**%0A%09 *
@@ -1547,25 +1547,24 @@
 ability.%0A%09 *
- 
 %0A%09 * @param 
@@ -1838,18 +1838,17 @@
 ty);%0A%09%7D%0A
-%09
 %0A
+
 %09/**%0A%09 *
@@ -1912,17 +1912,16 @@
 rer.%0A%09 *
- 
 %0A%09 * @re
@@ -2017,26 +2017,25 @@
 ability;%0A%09%7D%0A
-%09
 %0A
+
 %09@Override%0A%09
@@ -2120,18 +2120,17 @@
 e();%0A%09%7D%0A
-%09
 %0A
+
 %09@Overri
@@ -2283,18 +2283,16 @@
 se;%0A%09%09%7D%0A
-%09%09
 %0A%09%09final

Remove trailing spaces.