org.opt4j.optimizers.ea.ConstantCrossoverRate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opt4j-optimizers Show documentation
A set of optimizers for Opt4J
The newest version!
/*******************************************************************************
 * Copyright (c) 2014 Opt4J
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *******************************************************************************/


package org.opt4j.optimizers.ea;

import org.opt4j.core.start.Constant;

import com.google.inject.Inject;

/**
 * The {@link ConstantCrossoverRate} represents a crossover rate that is
 * constant during the whole optimization.
 * 
 * @author glass
 * 
 */
public class ConstantCrossoverRate implements CrossoverRate {
	protected final double crossoverRate;

	/**
	 * Constructs a {@link ConstantCrossoverRate} with a given crossover rate.
	 * 
	 * @param crossoverRate
	 *            the crossover rate
	 */
	@Inject
	public ConstantCrossoverRate(@Constant(value = "rate", namespace = ConstantCrossoverRate.class) double crossoverRate) {
		this.crossoverRate = crossoverRate;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.opt4j.operator.crossover.CrossoverRate#get()
	 */
	@Override
	public double get() {
		return crossoverRate;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.opt4j.operator.crossover.CrossoverRate#set(double)
	 */
	@Override
	public void set(double value) {
		// the crossover rate should remain constant
	}

}