View Javadoc
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.math4.legacy.genetics;
18  
19  /**
20   * A pair of {@link Chromosome} objects.
21   * @since 2.0
22   *
23   */
24  public class ChromosomePair {
25      /** the first chromosome in the pair. */
26      private final Chromosome first;
27  
28      /** the second chromosome in the pair. */
29      private final Chromosome second;
30  
31      /**
32       * Create a chromosome pair.
33       *
34       * @param c1 the first chromosome.
35       * @param c2 the second chromosome.
36       */
37      public ChromosomePair(final Chromosome c1, final Chromosome c2) {
38          super();
39          first = c1;
40          second = c2;
41      }
42  
43      /**
44       * Access the first chromosome.
45       *
46       * @return the first chromosome.
47       */
48      public Chromosome getFirst() {
49          return first;
50      }
51  
52      /**
53       * Access the second chromosome.
54       *
55       * @return the second chromosome.
56       */
57      public Chromosome getSecond() {
58          return second;
59      }
60  
61      /** {@inheritDoc} */
62      @Override
63      public String toString() {
64          return String.format("(%s,%s)", getFirst(), getSecond());
65      }
66  }