summaryrefslogtreecommitdiffstats
path: root/watchmaker/framework/src/java/test/org/uncommons/watchmaker/framework/factories/ObjectArrayPermutationFactoryTest.java
blob: e4145c1e6b0ff105e91fdcf10acc076f83824cb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
//=============================================================================
// Copyright 2006-2010 Daniel W. Dyer
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//=============================================================================
package org.uncommons.watchmaker.framework.factories;

import java.util.Arrays;
import java.util.List;
import org.testng.annotations.Test;
import org.uncommons.watchmaker.framework.CandidateFactory;
import org.uncommons.watchmaker.framework.FrameworkTestUtils;

/**
 * Unit test for the array permutation candidate factory.  Checks that it
 * correctly generates populations of permutations.
 * @author Daniel Dyer
 */
public class ObjectArrayPermutationFactoryTest
{
    private final int candidateLength = 10;
    private final int populationSize = 5;
    private final Integer[] elements = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10};


    /**
     * Generate a completely random population.  Checks to make
     * sure that the correct number of candidate solutions is
     * generated and that each is valid.
     */
    @Test
    public void testUnseededPopulation()
    {
        CandidateFactory<Integer[]> factory = new ObjectArrayPermutationFactory<Integer>(elements);
        List<Integer[]> population = factory.generateInitialPopulation(populationSize, FrameworkTestUtils.getRNG());
        assert population.size() == populationSize : "Wrong size population generated: " + population.size();

        validatePopulation(population);
    }


    /**
     * Generate a random population with some seed candidates.  Checks to make
     * sure that the correct number of candidate solutions is generated and that
     * each is valid.
     */
    @Test
    public void testSeededPopulation()
    {
        CandidateFactory<Integer[]> factory = new ObjectArrayPermutationFactory<Integer>(elements);

        Integer[] seed1 = elements.clone();
        Integer[] seed2 = {10, 9, 8, 7, 6, 5, 4, 3, 2, 1};

        List<Integer[]> population = factory.generateInitialPopulation(populationSize,
                                                                       Arrays.asList(seed1, seed2),
                                                                       FrameworkTestUtils.getRNG());
        // Check that the seed candidates appear in the generated population.
        assert population.contains(seed1) : "Population does not contain seed candidate 1.";
        assert population.contains(seed2) : "Population does not contain seed candidate 2.";

        validatePopulation(population);
    }


    /**
     * It is an error if the number of seed candidates is greater than the
     * population size.  In this case an exception should be thrown.  Not
     * throwing an exception is wrong because it would permit undetected bugs
     * in programs that use the factory.
     */
    @Test(expectedExceptions = IllegalArgumentException.class)
    public void testTooManySeedCandidates()
    {
        CandidateFactory<Integer[]> factory = new ObjectArrayPermutationFactory<Integer>(elements);
        // The following call should cause an exception since the 3 seed candidates
        // won't fit into a population of size 2.
        factory.generateInitialPopulation(2,
                                          Arrays.asList(elements, elements, elements),
                                          FrameworkTestUtils.getRNG());
    }


    /**
     * Make sure each candidate is valid (contains each element exactly once).
     * @param population The population to be validated.
     */
    private void validatePopulation(List<Integer[]> population)
    {
        assert population.size() == populationSize : "Wrong size population generated: " + population.size();
        for (Integer[] candidate : population)
        {
            assert candidate.length == candidateLength : "Wrong size candidate generated: " + candidate.length;
            for (int i = 1; i < candidateLength; i++)
            {
                assert contains(candidate, i) : "Candidate is missing element " + i + ".";
            }
        }
    }


    /**
     * Check whether the specified element occurs in the specified array.
     */
    private boolean contains(Integer[] array, int element)
    {
        for (int i : array)
        {
            if (i == element)
            {
                return true;
            }
        }
        return false;
    }
}