01 /*
02 * Java Genetic Algorithm Library (jenetics-6.2.0).
03 * Copyright (c) 2007-2021 Franz Wilhelmstötter
04 *
05 * Licensed under the Apache License, Version 2.0 (the "License");
06 * you may not use this file except in compliance with the License.
07 * You may obtain a copy of the License at
08 *
09 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author:
18 * Franz Wilhelmstötter (franz.wilhelmstoetter@gmail.com)
19 */
20 package io.jenetics;
21
22 import io.jenetics.internal.util.Requires;
23
24 /**
25 * Abstract implementation of the alterer interface.
26 *
27 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
28 * @since 1.0
29 * @version 6.0
30 */
31 public abstract class AbstractAlterer<
32 G extends Gene<?, G>,
33 C extends Comparable<? super C>
34 >
35 implements Alterer<G, C>
36 {
37
38 /**
39 * The altering probability.
40 */
41 protected final double _probability;
42
43 /**
44 * Constructs an alterer with a given recombination probability.
45 *
46 * @param probability The recombination probability.
47 * @throws IllegalArgumentException if the {@code probability} is not in the
48 * valid range of {@code [0, 1]}.
49 */
50 protected AbstractAlterer(final double probability) {
51 _probability = Requires.probability(probability);
52 }
53
54 /**
55 * Return the recombination/alter probability for this alterer.
56 *
57 * @return The recombination probability.
58 */
59 public double probability() {
60 return _probability;
61 }
62
63 }
|