/*
* Copyright 2012 JBoss Inc
*
* 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.optaplanner.core.config.heuristic.selector.value;
import org.junit.Test;
import org.optaplanner.core.config.heuristic.policy.HeuristicConfigPolicy;
import org.optaplanner.core.config.heuristic.selector.AbstractSelectorConfigTest;
import org.optaplanner.core.config.heuristic.selector.common.SelectionCacheType;
import org.optaplanner.core.config.heuristic.selector.common.SelectionOrder;
import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
import org.optaplanner.core.impl.heuristic.selector.value.FromSolutionPropertyValueSelector;
import org.optaplanner.core.impl.heuristic.selector.value.ValueSelector;
import org.optaplanner.core.impl.heuristic.selector.value.decorator.ShufflingValueSelector;
import org.optaplanner.core.impl.testdata.domain.TestdataEntity;
import static org.junit.Assert.assertEquals;
import static org.optaplanner.core.impl.testdata.util.PlannerAssert.*;
public class ValueSelectorConfigTest extends AbstractSelectorConfigTest {
@Test
public void phaseOriginal() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.PHASE);
valueSelectorConfig.setSelectionOrder(SelectionOrder.ORIGINAL);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
assertNotInstanceOf(ShufflingValueSelector.class, valueSelector);
assertEquals(SelectionCacheType.PHASE, valueSelector.getCacheType());
}
@Test
public void stepOriginal() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.STEP);
valueSelectorConfig.setSelectionOrder(SelectionOrder.ORIGINAL);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
assertNotInstanceOf(ShufflingValueSelector.class, valueSelector);
// PHASE instead of STEP because these values are cacheable, so there's no reason not to cache them?
assertEquals(SelectionCacheType.PHASE, valueSelector.getCacheType());
}
@Test
public void justInTimeOriginal() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.JUST_IN_TIME);
valueSelectorConfig.setSelectionOrder(SelectionOrder.ORIGINAL);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
// cacheType gets upgraded to STEP
// assertEquals(SelectionCacheType.JUST_IN_TIME, valueSelector.getCacheType());
}
@Test
public void phaseRandom() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.PHASE);
valueSelectorConfig.setSelectionOrder(SelectionOrder.RANDOM);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
assertNotInstanceOf(ShufflingValueSelector.class, valueSelector);
assertEquals(SelectionCacheType.PHASE, valueSelector.getCacheType());
}
@Test
public void stepRandom() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.STEP);
valueSelectorConfig.setSelectionOrder(SelectionOrder.RANDOM);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
assertNotInstanceOf(ShufflingValueSelector.class, valueSelector);
// PHASE instead of STEP because these values are cacheable, so there's no reason not to cache them?
assertEquals(SelectionCacheType.PHASE, valueSelector.getCacheType());
}
@Test
public void justInTimeRandom() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.JUST_IN_TIME);
valueSelectorConfig.setSelectionOrder(SelectionOrder.RANDOM);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(FromSolutionPropertyValueSelector.class, valueSelector);
// cacheType gets upgraded to STEP
// assertEquals(SelectionCacheType.JUST_IN_TIME, valueSelector.getCacheType());
}
@Test
public void phaseShuffled() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.PHASE);
valueSelectorConfig.setSelectionOrder(SelectionOrder.SHUFFLED);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(ShufflingValueSelector.class, valueSelector);
assertInstanceOf(FromSolutionPropertyValueSelector.class,
((ShufflingValueSelector) valueSelector).getChildValueSelector());
assertEquals(SelectionCacheType.PHASE, valueSelector.getCacheType());
}
@Test
public void stepShuffled() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.STEP);
valueSelectorConfig.setSelectionOrder(SelectionOrder.SHUFFLED);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
assertInstanceOf(ShufflingValueSelector.class, valueSelector);
assertInstanceOf(FromSolutionPropertyValueSelector.class,
((ShufflingValueSelector) valueSelector).getChildValueSelector());
assertEquals(SelectionCacheType.STEP, valueSelector.getCacheType());
}
@Test(expected = IllegalArgumentException.class)
public void justInTimeShuffled() {
HeuristicConfigPolicy configPolicy = buildHeuristicConfigPolicy();
EntityDescriptor entityDescriptor = configPolicy.getSolutionDescriptor()
.findEntityDescriptorOrFail(TestdataEntity.class);
ValueSelectorConfig valueSelectorConfig = new ValueSelectorConfig();
valueSelectorConfig.setCacheType(SelectionCacheType.JUST_IN_TIME);
valueSelectorConfig.setSelectionOrder(SelectionOrder.SHUFFLED);
ValueSelector valueSelector = valueSelectorConfig.buildValueSelector(
configPolicy, entityDescriptor,
SelectionCacheType.JUST_IN_TIME, SelectionOrder.RANDOM);
}
}