Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin
view libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/ode/sampling/StepInterpolator.html @ 28:0205c3f41d1d default tip
repackaging (separate textgridlab and dgilib local parts more rigorously
author | dwinter |
---|---|
date | Fri, 24 Aug 2012 09:42:57 +0200 |
parents | cbf34dd4d7e6 |
children |
line wrap: on
line source
<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> <a name="line.17"></a> <FONT color="green">018</FONT> package org.apache.commons.math.ode.sampling;<a name="line.18"></a> <FONT color="green">019</FONT> <a name="line.19"></a> <FONT color="green">020</FONT> import java.io.Externalizable;<a name="line.20"></a> <FONT color="green">021</FONT> <a name="line.21"></a> <FONT color="green">022</FONT> import org.apache.commons.math.ode.DerivativeException;<a name="line.22"></a> <FONT color="green">023</FONT> <a name="line.23"></a> <FONT color="green">024</FONT> /** This interface represents an interpolator over the last step<a name="line.24"></a> <FONT color="green">025</FONT> * during an ODE integration.<a name="line.25"></a> <FONT color="green">026</FONT> *<a name="line.26"></a> <FONT color="green">027</FONT> * <p>The various ODE integrators provide objects implementing this<a name="line.27"></a> <FONT color="green">028</FONT> * interface to the step handlers. These objects are often custom<a name="line.28"></a> <FONT color="green">029</FONT> * objects tightly bound to the integrator internal algorithms. The<a name="line.29"></a> <FONT color="green">030</FONT> * handlers can use these objects to retrieve the state vector at<a name="line.30"></a> <FONT color="green">031</FONT> * intermediate times between the previous and the current grid points<a name="line.31"></a> <FONT color="green">032</FONT> * (this feature is often called dense output).</p><a name="line.32"></a> <FONT color="green">033</FONT> * <p>One important thing to note is that the step handlers may be so<a name="line.33"></a> <FONT color="green">034</FONT> * tightly bound to the integrators that they often share some internal<a name="line.34"></a> <FONT color="green">035</FONT> * state arrays. This imply that one should <em>never</em> use a direct<a name="line.35"></a> <FONT color="green">036</FONT> * reference to a step interpolator outside of the step handler, either<a name="line.36"></a> <FONT color="green">037</FONT> * for future use or for use in another thread. If such a need arise, the<a name="line.37"></a> <FONT color="green">038</FONT> * step interpolator <em>must</em> be copied using the dedicated<a name="line.38"></a> <FONT color="green">039</FONT> * {@link #copy()} method.<a name="line.39"></a> <FONT color="green">040</FONT> * </p><a name="line.40"></a> <FONT color="green">041</FONT> *<a name="line.41"></a> <FONT color="green">042</FONT> * @see org.apache.commons.math.ode.FirstOrderIntegrator<a name="line.42"></a> <FONT color="green">043</FONT> * @see org.apache.commons.math.ode.SecondOrderIntegrator<a name="line.43"></a> <FONT color="green">044</FONT> * @see StepHandler<a name="line.44"></a> <FONT color="green">045</FONT> * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $<a name="line.45"></a> <FONT color="green">046</FONT> * @since 1.2<a name="line.46"></a> <FONT color="green">047</FONT> */<a name="line.47"></a> <FONT color="green">048</FONT> <a name="line.48"></a> <FONT color="green">049</FONT> public interface StepInterpolator extends Externalizable {<a name="line.49"></a> <FONT color="green">050</FONT> <a name="line.50"></a> <FONT color="green">051</FONT> /**<a name="line.51"></a> <FONT color="green">052</FONT> * Get the previous grid point time.<a name="line.52"></a> <FONT color="green">053</FONT> * @return previous grid point time<a name="line.53"></a> <FONT color="green">054</FONT> */<a name="line.54"></a> <FONT color="green">055</FONT> double getPreviousTime();<a name="line.55"></a> <FONT color="green">056</FONT> <a name="line.56"></a> <FONT color="green">057</FONT> /**<a name="line.57"></a> <FONT color="green">058</FONT> * Get the current grid point time.<a name="line.58"></a> <FONT color="green">059</FONT> * @return current grid point time<a name="line.59"></a> <FONT color="green">060</FONT> */<a name="line.60"></a> <FONT color="green">061</FONT> double getCurrentTime();<a name="line.61"></a> <FONT color="green">062</FONT> <a name="line.62"></a> <FONT color="green">063</FONT> /**<a name="line.63"></a> <FONT color="green">064</FONT> * Get the time of the interpolated point.<a name="line.64"></a> <FONT color="green">065</FONT> * If {@link #setInterpolatedTime} has not been called, it returns<a name="line.65"></a> <FONT color="green">066</FONT> * the current grid point time.<a name="line.66"></a> <FONT color="green">067</FONT> * @return interpolation point time<a name="line.67"></a> <FONT color="green">068</FONT> */<a name="line.68"></a> <FONT color="green">069</FONT> double getInterpolatedTime();<a name="line.69"></a> <FONT color="green">070</FONT> <a name="line.70"></a> <FONT color="green">071</FONT> /**<a name="line.71"></a> <FONT color="green">072</FONT> * Set the time of the interpolated point.<a name="line.72"></a> <FONT color="green">073</FONT> * <p>Setting the time outside of the current step is now allowed, but<a name="line.73"></a> <FONT color="green">074</FONT> * should be used with care since the accuracy of the interpolator will<a name="line.74"></a> <FONT color="green">075</FONT> * probably be very poor far from this step. This allowance has been<a name="line.75"></a> <FONT color="green">076</FONT> * added to simplify implementation of search algorithms near the<a name="line.76"></a> <FONT color="green">077</FONT> * step endpoints.</p><a name="line.77"></a> <FONT color="green">078</FONT> * <p>Setting the time changes the instance internal state. If a<a name="line.78"></a> <FONT color="green">079</FONT> * specific state must be preserved, a copy of the instance must be<a name="line.79"></a> <FONT color="green">080</FONT> * created using {@link #copy()}.</p><a name="line.80"></a> <FONT color="green">081</FONT> * @param time time of the interpolated point<a name="line.81"></a> <FONT color="green">082</FONT> */<a name="line.82"></a> <FONT color="green">083</FONT> void setInterpolatedTime(double time);<a name="line.83"></a> <FONT color="green">084</FONT> <a name="line.84"></a> <FONT color="green">085</FONT> /**<a name="line.85"></a> <FONT color="green">086</FONT> * Get the state vector of the interpolated point.<a name="line.86"></a> <FONT color="green">087</FONT> * <p>The returned vector is a reference to a reused array, so<a name="line.87"></a> <FONT color="green">088</FONT> * it should not be modified and it should be copied if it needs<a name="line.88"></a> <FONT color="green">089</FONT> * to be preserved across several calls.</p><a name="line.89"></a> <FONT color="green">090</FONT> * @return state vector at time {@link #getInterpolatedTime}<a name="line.90"></a> <FONT color="green">091</FONT> * @see #getInterpolatedDerivatives()<a name="line.91"></a> <FONT color="green">092</FONT> * @throws DerivativeException if this call induces an automatic<a name="line.92"></a> <FONT color="green">093</FONT> * step finalization that throws one<a name="line.93"></a> <FONT color="green">094</FONT> */<a name="line.94"></a> <FONT color="green">095</FONT> double[] getInterpolatedState() throws DerivativeException;<a name="line.95"></a> <FONT color="green">096</FONT> <a name="line.96"></a> <FONT color="green">097</FONT> /**<a name="line.97"></a> <FONT color="green">098</FONT> * Get the derivatives of the state vector of the interpolated point.<a name="line.98"></a> <FONT color="green">099</FONT> * <p>The returned vector is a reference to a reused array, so<a name="line.99"></a> <FONT color="green">100</FONT> * it should not be modified and it should be copied if it needs<a name="line.100"></a> <FONT color="green">101</FONT> * to be preserved across several calls.</p><a name="line.101"></a> <FONT color="green">102</FONT> * @return derivatives of the state vector at time {@link #getInterpolatedTime}<a name="line.102"></a> <FONT color="green">103</FONT> * @see #getInterpolatedState()<a name="line.103"></a> <FONT color="green">104</FONT> * @throws DerivativeException if this call induces an automatic<a name="line.104"></a> <FONT color="green">105</FONT> * step finalization that throws one<a name="line.105"></a> <FONT color="green">106</FONT> * @since 2.0<a name="line.106"></a> <FONT color="green">107</FONT> */<a name="line.107"></a> <FONT color="green">108</FONT> double[] getInterpolatedDerivatives() throws DerivativeException;<a name="line.108"></a> <FONT color="green">109</FONT> <a name="line.109"></a> <FONT color="green">110</FONT> /** Check if the natural integration direction is forward.<a name="line.110"></a> <FONT color="green">111</FONT> * <p>This method provides the integration direction as specified by<a name="line.111"></a> <FONT color="green">112</FONT> * the integrator itself, it avoid some nasty problems in<a name="line.112"></a> <FONT color="green">113</FONT> * degenerated cases like null steps due to cancellation at step<a name="line.113"></a> <FONT color="green">114</FONT> * initialization, step control or discrete events<a name="line.114"></a> <FONT color="green">115</FONT> * triggering.</p><a name="line.115"></a> <FONT color="green">116</FONT> * @return true if the integration variable (time) increases during<a name="line.116"></a> <FONT color="green">117</FONT> * integration<a name="line.117"></a> <FONT color="green">118</FONT> */<a name="line.118"></a> <FONT color="green">119</FONT> boolean isForward();<a name="line.119"></a> <FONT color="green">120</FONT> <a name="line.120"></a> <FONT color="green">121</FONT> /** Copy the instance.<a name="line.121"></a> <FONT color="green">122</FONT> * <p>The copied instance is guaranteed to be independent from the<a name="line.122"></a> <FONT color="green">123</FONT> * original one. Both can be used with different settings for<a name="line.123"></a> <FONT color="green">124</FONT> * interpolated time without any side effect.</p><a name="line.124"></a> <FONT color="green">125</FONT> * @return a deep copy of the instance, which can be used independently.<a name="line.125"></a> <FONT color="green">126</FONT> * @throws DerivativeException if this call induces an automatic<a name="line.126"></a> <FONT color="green">127</FONT> * step finalization that throws one<a name="line.127"></a> <FONT color="green">128</FONT> * @see #setInterpolatedTime(double)<a name="line.128"></a> <FONT color="green">129</FONT> */<a name="line.129"></a> <FONT color="green">130</FONT> StepInterpolator copy() throws DerivativeException;<a name="line.130"></a> <FONT color="green">131</FONT> <a name="line.131"></a> <FONT color="green">132</FONT> }<a name="line.132"></a> </PRE> </BODY> </HTML>