01 /*
02 * Java Genetic Algorithm Library (jenetics-4.4.0).
03 * Copyright (c) 2007-2019 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 static io.jenetics.internal.util.Hashes.hash;
23
24 import io.jenetics.internal.util.require;
25
26 /**
27 * Abstract implementation of the alterer interface.
28 *
29 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
30 * @since 1.0
31 * @version 3.0
32 */
33 public abstract class AbstractAlterer<
34 G extends Gene<?, G>,
35 C extends Comparable<? super C>
36 >
37 implements Alterer<G, C>
38 {
39
40 /**
41 * The altering probability.
42 */
43 protected final double _probability;
44
45 /**
46 * Constructs an alterer with a given recombination probability.
47 *
48 * @param probability The recombination probability.
49 * @throws IllegalArgumentException if the {@code probability} is not in the
50 * valid range of {@code [0, 1]}.
51 */
52 protected AbstractAlterer(final double probability) {
53 _probability = require.probability(probability);
54 }
55
56 /**
57 * Return the recombination/alter probability for this alterer.
58 *
59 * @return The recombination probability.
60 */
61 public double getProbability() {
62 return _probability;
63 }
64
65 @Override
66 public int hashCode() {
67 return hash(_probability);
68 }
69
70 @Override
71 public boolean equals(final Object obj) {
72 return obj == this ||
73 obj != null &&
74 getClass() == obj.getClass() &&
75 Double.compare(_probability, ((AbstractAlterer)obj)._probability) == 0;
76 }
77
78 }
|