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.NumberIsTooLargeException;
20
21
22 /**
23 * A collection of chromosomes that facilitates generational evolution.
24 *
25 * @since 2.0
26 */
27 public interface Population extends Iterable<Chromosome> {
28 /**
29 * Access the current population size.
30 * @return the current population size.
31 */
32 int getPopulationSize();
33
34 /**
35 * Access the maximum population size.
36 * @return the maximum population size.
37 */
38 int getPopulationLimit();
39
40 /**
41 * Start the population for the next generation.
42 * @return the beginnings of the next generation.
43 */
44 Population nextGeneration();
45
46 /**
47 * Add the given chromosome to the population.
48 * @param chromosome the chromosome to add.
49 * @throws NumberIsTooLargeException if the population would exceed the population limit when adding
50 * this chromosome
51 */
52 void addChromosome(Chromosome chromosome) throws NumberIsTooLargeException;
53
54 /**
55 * Access the fittest chromosome in this population.
56 * @return the fittest chromosome.
57 */
58 Chromosome getFittestChromosome();
59 }