001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math4.genetics;
018
019/**
020 * A pair of {@link Chromosome} objects.
021 * @since 2.0
022 *
023 */
024public class ChromosomePair {
025    /** the first chromosome in the pair. */
026    private final Chromosome first;
027
028    /** the second chromosome in the pair. */
029    private final Chromosome second;
030
031    /**
032     * Create a chromosome pair.
033     *
034     * @param c1 the first chromosome.
035     * @param c2 the second chromosome.
036     */
037    public ChromosomePair(final Chromosome c1, final Chromosome c2) {
038        super();
039        first = c1;
040        second = c2;
041    }
042
043    /**
044     * Access the first chromosome.
045     *
046     * @return the first chromosome.
047     */
048    public Chromosome getFirst() {
049        return first;
050    }
051
052    /**
053     * Access the second chromosome.
054     *
055     * @return the second chromosome.
056     */
057    public Chromosome getSecond() {
058        return second;
059    }
060
061    /** {@inheritDoc} */
062    @Override
063    public String toString() {
064        return String.format("(%s,%s)", getFirst(), getSecond());
065    }
066}