<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math.ode;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    /** This interface represents a first order differential equations set<a name="line.20"></a>
<FONT color="green">021</FONT>     * with a main set of equations and an extension set.<a name="line.21"></a>
<FONT color="green">022</FONT>     *<a name="line.22"></a>
<FONT color="green">023</FONT>     * &lt;p&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     * This interface is a simple extension on the {@link<a name="line.24"></a>
<FONT color="green">025</FONT>     * FirstOrderDifferentialEquations} that allows to identify which part<a name="line.25"></a>
<FONT color="green">026</FONT>     * of a complete set of differential equations correspond to the main<a name="line.26"></a>
<FONT color="green">027</FONT>     * set and which part correspond to the extension set.<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;/p&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     * One typical use case is the computation of Jacobians. The main<a name="line.30"></a>
<FONT color="green">031</FONT>     * set of equations correspond to the raw ode, and we add to this set<a name="line.31"></a>
<FONT color="green">032</FONT>     * another bunch of equations which represent the jacobians of the<a name="line.32"></a>
<FONT color="green">033</FONT>     * main set. In that case, we want the integrator to use &lt;em&gt;only&lt;/em&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     * the main set to estimate the errors and hence the step sizes. It should<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;em&gt;not&lt;/em&gt; use the additional equations in this computation. If the<a name="line.35"></a>
<FONT color="green">036</FONT>     * complete ode implements this interface, the {@link FirstOrderIntegrator<a name="line.36"></a>
<FONT color="green">037</FONT>     * integrator} will be able to know where the main set ends and where the<a name="line.37"></a>
<FONT color="green">038</FONT>     * extended set begins.<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;/p&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * We consider that the main set always corresponds to the first equations<a name="line.41"></a>
<FONT color="green">042</FONT>     * and the extended set to the last equations.<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;/p&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     *<a name="line.44"></a>
<FONT color="green">045</FONT>     * @see FirstOrderDifferentialEquations<a name="line.45"></a>
<FONT color="green">046</FONT>     *<a name="line.46"></a>
<FONT color="green">047</FONT>     * @version $Revision: 980981 $ $Date: 2010-07-31 00:03:04 +0200 (sam. 31 juil. 2010) $<a name="line.47"></a>
<FONT color="green">048</FONT>     * @since 2.2<a name="line.48"></a>
<FONT color="green">049</FONT>     */<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>    public interface ExtendedFirstOrderDifferentialEquations extends FirstOrderDifferentialEquations {<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        /** Return the dimension of the main set of equations.<a name="line.53"></a>
<FONT color="green">054</FONT>         * &lt;p&gt;<a name="line.54"></a>
<FONT color="green">055</FONT>         * The main set of equations represent the first part of an ODE state.<a name="line.55"></a>
<FONT color="green">056</FONT>         * The error estimations and adaptive step size computation should be<a name="line.56"></a>
<FONT color="green">057</FONT>         * done on this first part only, not on the final part of the state<a name="line.57"></a>
<FONT color="green">058</FONT>         * which represent an extension set of equations which are considered<a name="line.58"></a>
<FONT color="green">059</FONT>         * secondary.<a name="line.59"></a>
<FONT color="green">060</FONT>         * &lt;/p&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>         * @return dimension of the main set of equations, must be lesser than or<a name="line.61"></a>
<FONT color="green">062</FONT>         * equal to the {@link #getDimension() total dimension}<a name="line.62"></a>
<FONT color="green">063</FONT>         */<a name="line.63"></a>
<FONT color="green">064</FONT>        int getMainSetDimension();<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>    }<a name="line.66"></a>




























































</PRE>
</BODY>
</HTML>
