indii/ml/ode/FunctionStatic.hpp

00001 #ifndef INDII_ML_ODE_FUNCTIONSTATIC_HPP
00002 #define INDII_ML_ODE_FUNCTIONSTATIC_HPP
00003 
00004 namespace indii {
00005   namespace ml {
00006     namespace ode {
00007 
00008 /**
00009  * Function specification. This specifies the static signature of a
00010  * time-dependent function. It is one way in which a function may be
00011  * supplied to a FunctionCollection object, the other being by
00012  * instantiating an object of type FunctionModel.
00013  *
00014  * @param t The time.
00015  * @param y State variable values at time t.
00016  * @param object Object passed to the function via the calling
00017  * object. This is usually the calling object itself, allowing
00018  * convenient access to related parameters and functions that may be
00019  * required during evaluation.
00020  *
00021  * @return The calculated value of the function given the arguments.
00022  */
00023 typedef double f_t(double t, const double y[], void* object);
00024 
00025     }
00026   }
00027 }
00028 
00029 #endif

Generated on Wed Dec 17 15:11:57 2008 for dysii Dynamical Systems Library by  doxygen 1.5.3