package jcgp.backend.modules.mutator;

import jcgp.backend.resources.Resources;
import jcgp.backend.resources.parameters.BooleanParameter;
import jcgp.backend.resources.parameters.IntegerParameter;
import jcgp.backend.resources.parameters.Parameter;
import jcgp.backend.resources.parameters.ParameterStatus;

/**
 * Fixed point mutator
 * <br><br>
 * This operator uses the point mutator 
 * algorithm to mutate a user-defined fixed
 * number of genes.
 * 
 * 
 * @see PointMutator
 * @author Eduardo Pedroni
 *
 */
public class FixedPointMutator extends PointMutator {

	private IntegerParameter geneMutated;
	private BooleanParameter report;

	/**
	 * Creates a new instance of FixedPointMutator. 
	 * 
	 * @param resources a reference to the experiment's resources.
	 */
	public FixedPointMutator(final Resources resources) {
		geneMutated = new IntegerParameter(5, "Genes mutated", false, false) {
			@Override
			public void validate(Number newValue) {
				if (newValue.intValue() <= 0) {
					status = ParameterStatus.INVALID;
					status.setDetails("At least 1 mutation must take place.");
				} else if (newValue.intValue() > (resources.nodes() * (resources.arity() + 1)) + resources.outputs()) {
					status = ParameterStatus.WARNING;
					status.setDetails("More genes are mutated than there are genes in the genotype.");
				} else {
					status = ParameterStatus.VALID;
				}
			}
		};
		report = new BooleanParameter(false, "Report") {
			@Override
			public void validate(Boolean newValue) {
				// blank
			}
		};
	}

	@Override
	public Parameter<?>[] getLocalParameters() {
		return new Parameter[] {geneMutated, report};
	}

	@Override
	public String toString() {
		return "Fixed point mutation";
	}

}