View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      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  package org.apache.commons.math4.legacy.genetics;
18  
19  import org.apache.commons.math4.legacy.exception.MathIllegalArgumentException;
20  
21  /**
22   * Policy used to create a pair of new chromosomes by performing a crossover
23   * operation on a source pair of chromosomes.
24   *
25   * @since 2.0
26   */
27  public interface CrossoverPolicy {
28  
29      /**
30       * Perform a crossover operation on the given chromosomes.
31       *
32       * @param first the first chromosome.
33       * @param second the second chromosome.
34       * @return the pair of new chromosomes that resulted from the crossover.
35       * @throws MathIllegalArgumentException if the given chromosomes are not compatible with this {@link CrossoverPolicy}
36       */
37      ChromosomePair crossover(Chromosome first, Chromosome second) throws MathIllegalArgumentException;
38  }