001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022package org.biojavax.ga.functions;
023
024import org.biojava.bio.symbol.PointLocation;
025import org.biojava.bio.symbol.SymbolList;
026
027/**
028 * <p>Holds the results of a CrossOver event, objects of this type are made by
029 * <code>CrossOverFunctions</code></p>
030 * 
031 * @author Mark Schreiber
032 * @version 1.0
033 * @since 1.5
034 */
035
036public interface GACrossResult {
037
038/**
039 * Returns the collection of cross over locations from the last cross
040 * @return null if there has been no call to performCrossOver, a zero length
041 * array if there was no cross overs or an array of <code>PointLocations</code>
042 * describing the cross over points.
043 */
044  public PointLocation[] getCrossOverPositions();
045
046/**
047 * Gets the chromosomes after the cross
048 * @return the two Chromosomes, by convention the first will be chromA and
049 * the second chromB
050 */
051  public SymbolList[] getChromosomes();
052}