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 import java.util.List;
20
21 /**
22 * Interface indicating that the chromosome represents a permutation of objects.
23 *
24 * @param <T> type of the permuted objects
25 * @since 2.0
26 */
27 public interface PermutationChromosome<T> {
28
29 /**
30 * Permutes the <code>sequence</code> of objects of type T according to the
31 * permutation this chromosome represents. For example, if this chromosome
32 * represents a permutation (3,0,1,2), and the unpermuted sequence is
33 * (a,b,c,d), this yields (d,a,b,c).
34 *
35 * @param sequence the unpermuted (original) sequence of objects
36 * @return permutation of <code>sequence</code> represented by this permutation
37 */
38 List<T> decode(List<T> sequence);
39 }