org.metacsp.framework.ValueChoiceFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of meta-csp-framework Show documentation

A Java API for Meta-CSP based reasoning

There is a newer version: 1.3.5

/*******************************************************************************
 * Copyright (c) 2010-2013 Federico Pecora 
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ******************************************************************************/
package org.metacsp.framework;

import java.io.Serializable;

/**
 * Basic abstract class for defining {@link ValueChoiceFunction}s of {@link Variable} {@link Domain}s.
 * @author Federico Pecora
 *
 */
public abstract class ValueChoiceFunction implements Serializable {
	
	private static final long serialVersionUID = 658591850210595281L;

	/**
	 * Method to be implemented by the {@link Domain} developer to choose a value. 
	 * @param dom The domain from which to choose a value.
	 * @return A value chosen from the given {@link Domain} according to this {@link ValueChoiceFunction}.
	 */
	public abstract Object getValue(Domain dom);
	
}