• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.math.genetics;
18 
19 /**
20  * A collection of chromosomes that facilitates generational evolution.
21  *
22  * @since 2.0
23  * @version $Revision: 811685 $ $Date: 2009-09-05 19:36:48 +0200 (sam. 05 sept. 2009) $
24  */
25 public interface Population extends Iterable<Chromosome> {
26     /**
27      * Access the current population size.
28      * @return the current population size.
29      */
getPopulationSize()30     int getPopulationSize();
31 
32     /**
33      * Access the maximum population size.
34      * @return the maximum population size.
35      */
getPopulationLimit()36     int getPopulationLimit();
37 
38     /**
39      * Start the population for the next generation.
40      * @return the beginnings of the next generation.
41      */
nextGeneration()42     Population nextGeneration();
43 
44     /**
45      * Add the given chromosome to the population.
46      * @param chromosome the chromosome to add.
47      */
addChromosome(Chromosome chromosome)48     void addChromosome(Chromosome chromosome);
49 
50     /**
51      * Access the fittest chromosome in this population.
52      * @return the fittest chromosome.
53      */
getFittestChromosome()54     Chromosome getFittestChromosome();
55 }
56