View Javadoc

1   /*
2    * @(#) DifferentialEquationInterface.java Apr 20, 2004
3    * 
4    * Copyright (c) 2003 Delft University of Technology Jaffalaan 5, 2628 BX Delft,
5    * the Netherlands All rights reserved.
6    * 
7    * This software is proprietary information of Delft University of Technology
8    * The code is published under the General Public License
9    */
10  package nl.tudelft.simulation.jstats.ode;
11  
12  /***
13   * An interface for the DifferentialEquation.
14   * <p>
15   * (c) copyright 2003 <a href="http://www.simulation.tudelft.nl">Delft
16   * University of Technology </a>, the Netherlands. <br>
17   * See for project information <a
18   * href="http://www.simulation.tudelft.nl">www.simulation.tudelft.nl </a> <br>
19   * License of use: <a href="http://www.gnu.org/copyleft/gpl.html">General Public
20   * License (GPL) </a>, no warranty <br>
21   * 
22   * @author <a href="http://www.tbm.tudelft.nl/webstaf/peterja/index.htm">Peter
23   *         Jacobs </a>
24   * @version 1.2 Apr 20, 2004
25   * @since 1.4
26   */
27  public interface DifferentialEquationInterface
28  {
29  	/***
30  	 * initializes the differential equation
31  	 * 
32  	 * @param x the x-value
33  	 * @param y the y-value
34  	 */
35  	void initialize(double x, double[] y);
36  
37  	/***
38  	 * returns y as a function of x
39  	 * 
40  	 * @param x the x-value
41  	 * @return y
42  	 */
43  	double[] y(double x);
44  
45  	/***
46  	 * returns dy as a function of x,y
47  	 * 
48  	 * @param x the x-value
49  	 * @param y the y-value
50  	 * @return dy/dx as a function of x,y
51  	 */
52  	double[] dy(double x, double[] y);
53  }