org.jamesframework.core.problems.constraints.Constraint 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.problems.constraints;

import org.jamesframework.core.problems.solutions.Solution;

/**
 * Interface of a constraint that can be imposed on the solutions, based on underlying data.
 * 
 * @author Herman De Beukelaer
 * @param  solution type to which the constraint is applied, required to extend {@link Solution}
 * @param  underlying data type
 */
public interface Constraint {

    /**
     * Checks whether a given solution satisfies the imposed constraint, based on
     * the given underlying data.
     * 
     * @param solution solution to check
     * @param data underlying data
     * @return true if the constraint is satisfied for the given solution
     */
    public boolean isSatisfied(SolutionType solution, DataType data);
    
}