001/*
002 *   BasisFunction  -- Interface that defines a basis function as used by ModelData.
003 *
004 *   Copyright (C) 2002-2014 by Joseph A. Huwaldt
005 *   All rights reserved.
006 *   
007 *   This library is free software; you can redistribute it and/or
008 *   modify it under the terms of the GNU Lesser General Public
009 *   License as published by the Free Software Foundation; either
010 *   version 2 of the License, or (at your option) any later version.
011 *   
012 *   This library is distributed in the hope that it will be useful,
013 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
014 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015 *   Lesser General Public License for more details.
016 *
017 *   You should have received a copy of the GNU Lesser General Public License
018 *   along with this program; if not, write to the Free Software
019 *   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
020 *   Or visit:  http://www.gnu.org/licenses/lgpl.html
021 */
022package jahuwaldt.tools.math;
023
024/**
025 * Defines the interface for a basis function as required by the ModelData class.
026 * 
027 * <p> Modified by: Joseph A. Huwaldt </p>
028 * 
029 * @author Joseph A. Huwaldt    Date:   October 21, 2002
030 * @version February 14, 2014
031 */
032public interface BasisFunction {
033
034    /**
035     * Method that returns the minimum number of coefficients allowed by this basis
036     * function.
037     */
038    public int getMinNumCoef();
039
040    /**
041     * Basis function that takes an input x and calculates the parameters of the function
042     * placing them in p[].
043     */
044    public void func(double x, double[] p);
045}