01 /*
02 * Java Genetic Algorithm Library (jenetics-4.1.0).
03 * Copyright (c) 2007-2018 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 * @see BoundedChromosome
27 *
28 * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
29 * @since 1.6
30 * @version 3.0
31 */
32 public interface BoundedGene<
33 A extends Comparable<? super A>,
34 G extends BoundedGene<A, G>
35 >
36 extends Gene<A, G>, Comparable<G>
37 {
38
39 /**
40 * Return the allowed min value.
41 *
42 * @return The allowed min value.
43 */
44 public A getMin();
45
46 /**
47 * Return the allowed max value.
48 *
49 * @return The allowed max value.
50 */
51 public A getMax();
52
53 @Override
54 public default boolean isValid() {
55 return
56 getAllele().compareTo(getMin()) >= 0 &&
57 getAllele().compareTo(getMax()) <= 0;
58 }
59
60 @Override
61 public default int compareTo(final G other) {
62 return getAllele().compareTo(other.getAllele());
63 }
64
65 /**
66 * Create a new gene from the given {@code value} and the current bounds.
67 *
68 * @param value the value of the new gene.
69 * @return a new gene with the given value.
70 */
71 @Override
72 public G newInstance(final A value);
73
74 }
|