001    package org.jaga.reproduction;
002    
003    import org.jaga.definitions.*;
004    
005    
006    
007    /**
008     * TODO: Complete these comments.
009     *
010     * <p><u>Project:</u> JAGA - Java API for Genetic Algorithms.</p>
011     *
012     * <p><u>Company:</u> University College London and JAGA.Org
013     *    (<a href="http://www.jaga.org" target="_blank">http://www.jaga.org</a>).
014     * </p>
015     *
016     * <p><u>Copyright:</u> (c) 2004 by G. Paperin.<br/>
017     *    This program is free software; you can redistribute it and/or modify
018     *    it under the terms of the GNU General Public License as published by
019     *    the Free Software Foundation, ONLY if you include a note of the original
020     *    author(s) in any redistributed/modified copy.<br/>
021     *    This program is distributed in the hope that it will be useful,
022     *    but WITHOUT ANY WARRANTY; without even the implied warranty of
023     *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024     *    GNU General Public License for more details.<br/>
025     *    You should have received a copy of the GNU General Public License
026     *    along with this program; if not, write to the Free Software
027     *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
028     *    or see http://www.gnu.org/licenses/gpl.html</p>
029     *
030     * @author Greg Paperin (greg@jaga.org)
031     *
032     * @version JAGA public release 1.0 beta
033     */
034    
035    abstract public class Mutation implements ReproductionAlgorithm {
036    
037            private double mutationProbability = 0.05;
038    
039            public Mutation() {}
040    
041            public Mutation(double mutProb) {
042                    setMutationProbability(mutProb);
043            }
044    
045            public int getRequiredNumberOfParents() {
046                    return -1;
047            }
048    
049            public void setMutationProbability(double mutProb) {
050                    if (mutProb < 0.0)
051                            throw new IllegalArgumentException("MutationProbability may not be below 0 (is "
052                                                                                               + mutProb + ")");
053                    if (mutProb > 1.0)
054                            throw new IllegalArgumentException("MutationProbability may not be above 1 (is "
055                                                                                               + mutProb + ")");
056                    this.mutationProbability = mutProb;
057            }
058    
059            public double getMutationProbability() {
060                    return this.mutationProbability;
061            }
062    
063            abstract public Class getApplicableClass();
064    
065            abstract public Individual[] reproduce(Individual[] parents, GAParameterSet params);
066    
067    }