BoundedGeneCreator.java
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.xml;
21 
22 /**
23  * Functional interface for creating bounded genes.
24  *
25  @param <A> the allele type
26  @param <G> the gene type
27  *
28  @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
29  @version 3.9
30  @since 3.9
31  */
32 @FunctionalInterface
33 public interface BoundedGeneCreator<A, G> {
34 
35     /**
36      * Create a new bounded gene from the given parameters.
37      *
38      <pre>{@code
39      * final BoundedGeneCreator<Long, LongGene> creator = LongGene::of;
40      * }</pre>
41      *
42      @param value the gene value
43      @param min the minimum value
44      @param max the maximum value
45      @return a newly created bounded gene
46      */
47     public G create(final A value, final A min, final A max);
48 }