org.jpmml.evaluator.Function Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2014 Villu Ruusmann
 *
 * This file is part of JPMML-Evaluator
 *
 * JPMML-Evaluator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JPMML-Evaluator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with JPMML-Evaluator.  If not, see .
 */
package org.jpmml.evaluator;

import java.util.List;

/**
 * 
 * A common superinterface for PMML built-in functions and Java user-defined functions.
 * 
 *
 * @see FunctionRegistry
 */
public interface Function {

	/**
	 * 
	 * Gets the default name of this function.
	 * 
	 *
	 * 
	 * The default name should be unique in application scope.
	 * Currently, the JPMML library does not check or enforce this constraint in any way.
	 * 
	 */
	String getName();

	/**
	 * 
	 * Evaluates this function with the specified arguments.
	 * 
	 *
	 * @throws FunctionException If the arguments do not match the formal parameters of this function.
	 */
	FieldValue evaluate(List arguments);
}