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