001/*
002 * Java Genetic Algorithm Library (jenetics-8.1.0).
003 * Copyright (c) 2007-2024 Franz Wilhelmstötter
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 *
017 * Author:
018 *    Franz Wilhelmstötter (franz.wilhelmstoetter@gmail.com)
019 */
020package io.jenetics;
021
022import io.jenetics.util.Mean;
023
024/**
025 * Alters a chromosome by replacing two genes by its mean value.
026 *
027 * <p>
028 * The order ({@link #order()}) of this recombination implementation is two.
029 * </p>
030 *
031 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
032 * @since 1.0
033 * @version 6.0
034 */
035public class MeanAlterer<
036        G extends Gene<?, G> & Mean<G>,
037        C extends Comparable<? super C>
038>
039        extends CombineAlterer<G, C>
040{
041
042        /**
043         * Constructs an alterer with a given recombination probability.
044         *
045         * @param probability the crossover probability.
046         * @throws IllegalArgumentException if the {@code probability} is not in the
047         *         valid range of {@code [0, 1]}.
048         */
049        public MeanAlterer(final double probability) {
050                super(Mean::mean, probability);
051        }
052
053        /**
054         * Create a new alterer with alter probability of {@code 0.05}.
055         */
056        public MeanAlterer() {
057                this(0.05);
058        }
059
060}