| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| EvolutionaryAlgorithm |
|
| 1.0;1 |
| 1 | /* | |
| 2 | ||
| 3 | dsh-evolve Framework for evolutionary algorithms. | |
| 4 | Copyright (c) 2005-2013 held jointly by the individual authors. | |
| 5 | ||
| 6 | This library is free software; you can redistribute it and/or modify it | |
| 7 | under the terms of the GNU Lesser General Public License as published | |
| 8 | by the Free Software Foundation; either version 3 of the License, or (at | |
| 9 | your option) any later version. | |
| 10 | ||
| 11 | This library is distributed in the hope that it will be useful, but WITHOUT | |
| 12 | ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or | |
| 13 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public | |
| 14 | License for more details. | |
| 15 | ||
| 16 | You should have received a copy of the GNU Lesser General Public License | |
| 17 | along with this library; if not, write to the Free Software Foundation, | |
| 18 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
| 19 | ||
| 20 | > http://www.fsf.org/licensing/licenses/lgpl.html | |
| 21 | > http://www.opensource.org/licenses/lgpl-license.php | |
| 22 | ||
| 23 | */ | |
| 24 | package org.dishevelled.evolve; | |
| 25 | ||
| 26 | import java.util.Collection; | |
| 27 | ||
| 28 | /** | |
| 29 | * An evolutionary algorithm function. | |
| 30 | * | |
| 31 | * @param <I> individual type | |
| 32 | * @author Michael Heuer | |
| 33 | */ | |
| 34 | public interface EvolutionaryAlgorithm<I> | |
| 35 | { | |
| 36 | ||
| 37 | /** | |
| 38 | * Evolve the specified population of individuals, using all of the specified | |
| 39 | * exit strategy, recombination, mutation, fitness, and selection functions. | |
| 40 | * | |
| 41 | * @param individuals population of individuals, must not be null and must contain | |
| 42 | * at least one individual | |
| 43 | * @param exitStrategy exit strategy function, must not be null | |
| 44 | * @param recombination recombination function, must not be null | |
| 45 | * @param mutation mutation function, must not be null | |
| 46 | * @param fitness fitness function, must not be null | |
| 47 | * @param selection selection function, must not be null | |
| 48 | * | |
| 49 | * @return evolved population of individuals that passes the conditions of the | |
| 50 | * specified exit strategy | |
| 51 | */ | |
| 52 | Collection<I> evolve(Collection<I> individuals, | |
| 53 | ExitStrategy<I> exitStrategy, | |
| 54 | Recombination<I> recombination, | |
| 55 | Mutation<I> mutation, | |
| 56 | Fitness<I> fitness, | |
| 57 | Selection<I> selection); | |
| 58 | ||
| 59 | /** | |
| 60 | * Add the specified evolutionary algorithm listener. | |
| 61 | * | |
| 62 | * @param l evolutionary algorithm listener to add | |
| 63 | */ | |
| 64 | void addEvolutionaryAlgorithmListener(EvolutionaryAlgorithmListener<I> l); | |
| 65 | ||
| 66 | /** | |
| 67 | * Remove the specified evolutionary algorithm listener. | |
| 68 | * | |
| 69 | * @param l evolutionary algorithm listener to remove | |
| 70 | */ | |
| 71 | void removeEvolutionaryAlgorithmListener(EvolutionaryAlgorithmListener<I> l); | |
| 72 | ||
| 73 | /** | |
| 74 | * Return the number of evolutionary algorithm listeners registered to this | |
| 75 | * evolutionary algorithm. | |
| 76 | * | |
| 77 | * @return the number of evolutionary algorithm listeners registered to this | |
| 78 | * evolutionary algorithm | |
| 79 | */ | |
| 80 | int getEvolutionaryAlgorithmListenerCount(); | |
| 81 | ||
| 82 | /** | |
| 83 | * Return an array of evolutionary algorithm listeners registered to this | |
| 84 | * evolutionary algorithm. | |
| 85 | * | |
| 86 | * @return an array of evolutionary algorithm listeners registered to this | |
| 87 | * evolutionary algorithm | |
| 88 | */ | |
| 89 | EvolutionaryAlgorithmListener<I>[] getEvolutionaryAlgorithmListeners(); | |
| 90 | } |