io.jenetics.ext.WeaselProgram Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jenetics.ext Show documentation
Jenetics Extension
The newest version!
/*
 * Java Genetic Algorithm Library (jenetics-8.1.0).
 * Copyright (c) 2007-2024 Franz Wilhelmstötter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Author:
 *    Franz Wilhelmstötter ([email protected])
 */
package io.jenetics.ext;

import io.jenetics.Gene;
import io.jenetics.engine.Engine.Builder;
import io.jenetics.engine.Engine.Setup;
import io.jenetics.internal.util.Requires;

/**
 * Configures the evolution engine to execute the
 * Weasel program
 * algorithm.
 *
 * {@snippet lang="java":
 * final Engine engine = Engine.builder(problem)
 *     .setup(new WeaselProgram<>())
 *     .build();
 * }
 *
 * @see WeaselSelector
 * @see WeaselMutator
 * @see io.jenetics.engine.Engine.Builder#setup(Setup)
 *
 * @param  the gene type
 * @param  the fitness result type
 *
 * @author Franz Wilhelmstötter
 * @version 6.0
 * @since 6.0
 */
public final class WeaselProgram<
	G extends Gene,
	C extends Comparable
>
	implements Setup
{

	private final double _mutationProbability;

	/**
	 * Create a new weasel program setup with the give mutation probability.
	 *
	 * @param mutationProbability the mutation probability
	 * @throws IllegalArgumentException if the {@code mutationProbability} is
	 *         not in the valid range of {@code [0, 1]}.
	 */
	public WeaselProgram(final double mutationProbability) {
		_mutationProbability = Requires.probability(mutationProbability);
	}

	/**
	 * Create a new weasel program setup with the default mutation
	 * probability of {@code 0.05}.
	 */
	public WeaselProgram() {
		this(0.05);
	}

	@Override
	public void apply(final Builder builder) {
		builder
			.selector(new WeaselSelector<>())
			.offspringFraction(1)
			.alterers(new WeaselMutator<>(_mutationProbability));
	}

}