01 /*
02 * Java Genetic Algorithm Library (jenetics-6.0.0).
03 * Copyright (c) 2007-2020 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 /**
23 * Base interface for genes where the alleles are bound by a minimum and a
24 * maximum value.
25 *
26 * @implSpec
27 * <em>Jenetics</em> requires that the individuals ({@link Genotype} and
28 * {@link Phenotype}) are not changed after they have been created. Therefore,
29 * all implementations of the {@code BoundedGene} interface must also be
30 * <em>immutable</em>.
31 *
32 * @see BoundedChromosome
33 *
34 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
35 * @since 1.6
36 * @version 6.0
37 */
38 public interface BoundedGene<
39 A extends Comparable<? super A>,
40 G extends BoundedGene<A, G>
41 >
42 extends Gene<A, G>, Comparable<G>
43 {
44
45 /**
46 * Return the allowed min value.
47 *
48 * @return The allowed min value.
49 */
50 A min();
51
52 /**
53 * Return the allowed max value.
54 *
55 * @return The allowed max value.
56 */
57 A max();
58
59 @Override
60 default boolean isValid() {
61 return
62 allele().compareTo(min()) >= 0 &&
63 allele().compareTo(max()) <= 0;
64 }
65
66 @Override
67 default int compareTo(final G other) {
68 return allele().compareTo(other.allele());
69 }
70
71 /**
72 * Create a new gene from the given {@code value} and the current bounds.
73 *
74 * @param value the value of the new gene.
75 * @return a new gene with the given value.
76 */
77 @Override
78 G newInstance(final A value);
79
80 }
|