Home | History | Annotate | Download | only in genetics
      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 pair of {@link Chromosome} objects.
     21  * @since 2.0
     22  *
     23  * @version $Revision: 811685 $ $Date: 2009-09-05 19:36:48 +0200 (sam. 05 sept. 2009) $
     24  */
     25 public class ChromosomePair {
     26     /** the first chromosome in the pair. */
     27     private final Chromosome first;
     28 
     29     /** the second chromosome in the pair. */
     30     private final Chromosome second;
     31 
     32     /**
     33      * Create a chromosome pair.
     34      *
     35      * @param c1 the first chromosome.
     36      * @param c2 the second chromosome.
     37      */
     38     public ChromosomePair(final Chromosome c1, final Chromosome c2) {
     39         super();
     40         first = c1;
     41         second = c2;
     42     }
     43 
     44     /**
     45      * Access the first chromosome.
     46      *
     47      * @return the first chromosome.
     48      */
     49     public Chromosome getFirst() {
     50         return first;
     51     }
     52 
     53     /**
     54      * Access the second chromosome.
     55      *
     56      * @return the second chromosome.
     57      */
     58     public Chromosome getSecond() {
     59         return second;
     60     }
     61 
     62     /**
     63      * {@inheritDoc}
     64      */
     65     @Override
     66     public String toString() {
     67         return String.format("(%s,%s)", getFirst(), getSecond());
     68     }
     69 }
     70