org.jamesframework.core.search.neigh.Neighbourhood Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of james-core Show documentation

The James core module is part of the James framework for optimization using local search metaheuristics in Java. The core contains general components to model problems, objectives and constraints, as well as generic algorithms to solve the problems. Moreover, the core provides implementations of specific utilities for subset selection.

There is a newer version: 1.2

Show newest version

//  Copyright 2014 Herman De Beukelaer
//
//  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.jamesframework.core.search.neigh;

import java.util.Set;
import org.jamesframework.core.problems.solutions.Solution;

/**
 * Interface of a neighbourhood that generates moves to transform a given solution into a neighbouring solution.
 * 
 * @param  solution type for which this neighbourhood can be applied, required to extend {@link Solution}
 * @author Herman De Beukelaer
 */
public interface Neighbourhood {

    /**
     * Generates a move that transforms the given solution into a random neighbour
     * contained in this specific neighbourhood. If the neighbourhood does not
     * contain any neighbours for the given solution, null is returned.
     * 
     * @param solution solution to which the move is to be applied
     * @return random move transforming the given solution into a random neighbour,
     *         null if the given solution does not have any neighbours
     */
    public Move getRandomMove(SolutionType solution);
    
    /**
     * Get a set of all moves that can be applied to the given solution to transform
     * it into each of the neighbouring solutions contained in this specific neighbourhood.
     * The returned set may be empty, in case the given solution does not have any neighbours.
     * 
     * @param solution solution to which the moves are to be applied
     * @return set of all moves for this neighbourhood, may be empty if the
     *         given solution does not have any neighbours
     */
    public Set> getAllMoves(SolutionType solution);
    
}