SwapMutation.java

package net.bmahe.genetics4j.core.spec.mutation;

import org.apache.commons.lang3.Validate;
import org.immutables.value.Value;

@Value.Immutable
public abstract class SwapMutation implements MutationPolicy {

	@Value.Parameter
	public abstract double populationMutationProbability();

	@Value.Parameter
	public abstract int numSwap();

	@Value.Parameter
	public abstract boolean isNumSwapFixed();

	@Value.Check
	protected void check() {
		Validate.inclusiveBetween(0.0, 1.0, populationMutationProbability());
		Validate.isTrue(numSwap() > 0);
	}

	/**
	 * Construct a new immutable {@code SwapMutation} instance.
	 * 
	 * @param populationMutationProbability The value for the {@code populationMutationProbability} attribute
	 * @param numSwap                       The value for the {@code numSwap} attribute
	 * @param isNumSwapFixed                Whether the number of swap is fixed or taken randomly between 1 and
	 *                                      {@code numSwap}
	 * @return An immutable SwapMutation instance
	 */
	public static SwapMutation of(double populationMutationProbability, int numSwap, boolean isNumSwapFixed) {
		return ImmutableSwapMutation.of(populationMutationProbability, numSwap, isNumSwapFixed);
	}

	/**
	 * Construct a new immutable {@code SwapMutation} instance.
	 *
	 * @param populationMutationProbability The value for the {@code populationMutationProbability} attribute
	 * @param numSwap                       The value for the {@code numSwap} attribute
	 * @return An immutable SwapMutation instance
	 */
	public static SwapMutation ofFixedNumSwap(double populationMutationProbability, int numSwap) {
		return ImmutableSwapMutation.of(populationMutationProbability, numSwap, true);
	}

}