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     */
017    package org.apache.commons.math3.genetics;
018    
019    import java.util.List;
020    
021    /**
022     * Interface indicating that the chromosome represents a permutation of objects.
023     *
024     * @param <T> type of the permuted objects
025     * @since 2.0
026     * @version $Id: PermutationChromosome.java 1416643 2012-12-03 19:37:14Z tn $
027     */
028    public interface PermutationChromosome<T> {
029    
030        /**
031         * Permutes the <code>sequence</code> of objects of type T according to the
032         * permutation this chromosome represents. For example, if this chromosome
033         * represents a permutation (3,0,1,2), and the unpermuted sequence is
034         * (a,b,c,d), this yields (d,a,b,c).
035         *
036         * @param sequence the unpermuted (original) sequence of objects
037         * @return permutation of <code>sequence</code> represented by this permutation
038         */
039        List<T> decode(List<T> sequence);
040    
041    }