Google Git
Sign in
vanadium / third_party / f3f8ecf501af34dcff5dc09ab99fbc11aab47945 / . / java / commons-math3-3.3 / docs / apidocs / org / apache / commons / math3 / ode / JacobianMatrices.html
blob: c6362d08a0ba7d4ce8a5d72b36eaa2927153d04f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JacobianMatrices (Apache Commons Math 3.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JacobianMatrices (Apache Commons Math 3.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JacobianMatrices.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderIntegrator.html" title="interface in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.MismatchedEquations.html" title="class in org.apache.commons.math3.ode"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/math3/ode/JacobianMatrices.html" target="_top">Frames</a></li>
<li><a href="JacobianMatrices.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.math3.ode</div>
<h2 title="Class JacobianMatrices" class="title">Class JacobianMatrices</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.ode.JacobianMatrices</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">JacobianMatrices</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class defines a set of <a href="../../../../../org/apache/commons/math3/ode/SecondaryEquations.html" title="interface in org.apache.commons.math3.ode"><code>secondary equations</code></a> to
compute the Jacobian matrices with respect to the initial state vector and, if
any, to some parameters of the primary ODE set.
<p>
It is intended to be packed into an <a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html" title="class in org.apache.commons.math3.ode"><code>ExpandableStatefulODE</code></a>
in conjunction with a primary set of ODE, which may be:
<ul>
<li>a <a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderDifferentialEquations</code></a></li>
<li>a <a href="../../../../../org/apache/commons/math3/ode/MainStateJacobianProvider.html" title="interface in org.apache.commons.math3.ode"><code>MainStateJacobianProvider</code></a></li>
</ul>
In order to compute Jacobian matrices with respect to some parameters of the
primary ODE set, the following parameter Jacobian providers may be set:
<ul>
<li>a <a href="../../../../../org/apache/commons/math3/ode/ParameterJacobianProvider.html" title="interface in org.apache.commons.math3.ode"><code>ParameterJacobianProvider</code></a></li>
<li>a <a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode"><code>ParameterizedODE</code></a></li>
</ul>
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: JacobianMatrices.java 1538354 2013-11-03 12:48:40Z tn $</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html" title="class in org.apache.commons.math3.ode"><code>ExpandableStatefulODE</code></a>,
<a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderDifferentialEquations</code></a>,
<a href="../../../../../org/apache/commons/math3/ode/MainStateJacobianProvider.html" title="interface in org.apache.commons.math3.ode"><code>MainStateJacobianProvider</code></a>,
<a href="../../../../../org/apache/commons/math3/ode/ParameterJacobianProvider.html" title="interface in org.apache.commons.math3.ode"><code>ParameterJacobianProvider</code></a>,
<a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode"><code>ParameterizedODE</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.MismatchedEquations.html" title="class in org.apache.commons.math3.ode">JacobianMatrices.MismatchedEquations</a></strong></code>
<div class="block">Special exception for equations mismatch.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#JacobianMatrices(org.apache.commons.math3.ode.FirstOrderDifferentialEquations, double[], java.lang.String...)">JacobianMatrices</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a>&nbsp;fode,
double[]&nbsp;hY,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</code>
<div class="block">Simple constructor for a secondary equations set computing Jacobian matrices.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#JacobianMatrices(org.apache.commons.math3.ode.MainStateJacobianProvider, java.lang.String...)">JacobianMatrices</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/MainStateJacobianProvider.html" title="interface in org.apache.commons.math3.ode">MainStateJacobianProvider</a>&nbsp;jode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</code>
<div class="block">Simple constructor for a secondary equations set computing Jacobian matrices.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#addParameterJacobianProvider(org.apache.commons.math3.ode.ParameterJacobianProvider)">addParameterJacobianProvider</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/ParameterJacobianProvider.html" title="interface in org.apache.commons.math3.ode">ParameterJacobianProvider</a>&nbsp;provider)</code>
<div class="block">Add a parameter Jacobian provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#getCurrentMainSetJacobian(double[][])">getCurrentMainSetJacobian</a></strong>(double[][]&nbsp;dYdY0)</code>
<div class="block">Get the current value of the Jacobian matrix with respect to state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#getCurrentParameterJacobian(java.lang.String, double[])">getCurrentParameterJacobian</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pName,
double[]&nbsp;dYdP)</code>
<div class="block">Get the current value of the Jacobian matrix with respect to one parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#registerVariationalEquations(org.apache.commons.math3.ode.ExpandableStatefulODE)">registerVariationalEquations</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html" title="class in org.apache.commons.math3.ode">ExpandableStatefulODE</a>&nbsp;expandable)</code>
<div class="block">Register the variational equations for the Jacobians matrices to the expandable set.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#setInitialMainStateJacobian(double[][])">setInitialMainStateJacobian</a></strong>(double[][]&nbsp;dYdY0)</code>
<div class="block">Set the initial value of the Jacobian matrix with respect to state.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#setInitialParameterJacobian(java.lang.String, double[])">setInitialParameterJacobian</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pName,
double[]&nbsp;dYdP)</code>
<div class="block">Set the initial value of a column of the Jacobian matrix with respect to one parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#setParameterizedODE(org.apache.commons.math3.ode.ParameterizedODE)">setParameterizedODE</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode">ParameterizedODE</a>&nbsp;parameterizedOde)</code>
<div class="block">Set a parameter Jacobian provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html#setParameterStep(java.lang.String, double)">setParameterStep</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter,
double&nbsp;hP)</code>
<div class="block">Set the step associated to a parameter in order to compute by finite
difference the Jacobian matrix.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JacobianMatrices(org.apache.commons.math3.ode.FirstOrderDifferentialEquations, double[], java.lang.String...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JacobianMatrices</h4>
<pre>public&nbsp;JacobianMatrices(<a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a>&nbsp;fode,
double[]&nbsp;hY,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)
throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre>
<div class="block">Simple constructor for a secondary equations set computing Jacobian matrices.
<p>
Parameters must belong to the supported ones given by <a href="../../../../../org/apache/commons/math3/ode/Parameterizable.html#getParametersNames()"><code>Parameterizable.getParametersNames()</code></a>, so the primary set of differential
equations must be <a href="../../../../../org/apache/commons/math3/ode/Parameterizable.html" title="interface in org.apache.commons.math3.ode"><code>Parameterizable</code></a>.
</p>
<p>Note that each selection clears the previous selected parameters.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fode</code> - the primary first order differential equations set to extend</dd><dd><code>hY</code> - step used for finite difference computation with respect to state vector</dd><dd><code>parameters</code> - parameters to consider for Jacobian matrices processing
(may be null if parameters Jacobians is not desired)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if there is a dimension mismatch between
the steps array <code>hY</code> and the equation dimension</dd></dl>
</li>
</ul>
<a name="JacobianMatrices(org.apache.commons.math3.ode.MainStateJacobianProvider, java.lang.String...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JacobianMatrices</h4>
<pre>public&nbsp;JacobianMatrices(<a href="../../../../../org/apache/commons/math3/ode/MainStateJacobianProvider.html" title="interface in org.apache.commons.math3.ode">MainStateJacobianProvider</a>&nbsp;jode,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;parameters)</pre>
<div class="block">Simple constructor for a secondary equations set computing Jacobian matrices.
<p>
Parameters must belong to the supported ones given by <a href="../../../../../org/apache/commons/math3/ode/Parameterizable.html#getParametersNames()"><code>Parameterizable.getParametersNames()</code></a>, so the primary set of differential
equations must be <a href="../../../../../org/apache/commons/math3/ode/Parameterizable.html" title="interface in org.apache.commons.math3.ode"><code>Parameterizable</code></a>.
</p>
<p>Note that each selection clears the previous selected parameters.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jode</code> - the primary first order differential equations set to extend</dd><dd><code>parameters</code> - parameters to consider for Jacobian matrices processing
(may be null if parameters Jacobians is not desired)</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="registerVariationalEquations(org.apache.commons.math3.ode.ExpandableStatefulODE)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerVariationalEquations</h4>
<pre>public&nbsp;void&nbsp;registerVariationalEquations(<a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html" title="class in org.apache.commons.math3.ode">ExpandableStatefulODE</a>&nbsp;expandable)
throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a>,
<a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.MismatchedEquations.html" title="class in org.apache.commons.math3.ode">JacobianMatrices.MismatchedEquations</a></pre>
<div class="block">Register the variational equations for the Jacobians matrices to the expandable set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>expandable</code> - expandable set into which variational equations should be registered</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of the partial state does not
match the selected equations set dimension</dd>
<dd><code><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.MismatchedEquations.html" title="class in org.apache.commons.math3.ode">JacobianMatrices.MismatchedEquations</a></code> - if the primary set of the expandable set does
not match the one used to build the instance</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)"><code>ExpandableStatefulODE.addSecondaryEquations(SecondaryEquations)</code></a></dd></dl>
</li>
</ul>
<a name="addParameterJacobianProvider(org.apache.commons.math3.ode.ParameterJacobianProvider)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addParameterJacobianProvider</h4>
<pre>public&nbsp;void&nbsp;addParameterJacobianProvider(<a href="../../../../../org/apache/commons/math3/ode/ParameterJacobianProvider.html" title="interface in org.apache.commons.math3.ode">ParameterJacobianProvider</a>&nbsp;provider)</pre>
<div class="block">Add a parameter Jacobian provider.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>provider</code> - the parameter Jacobian provider to compute exactly the parameter Jacobian matrix</dd></dl>
</li>
</ul>
<a name="setParameterizedODE(org.apache.commons.math3.ode.ParameterizedODE)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterizedODE</h4>
<pre>public&nbsp;void&nbsp;setParameterizedODE(<a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode">ParameterizedODE</a>&nbsp;parameterizedOde)</pre>
<div class="block">Set a parameter Jacobian provider.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameterizedOde</code> - the parameterized ODE to compute the parameter Jacobian matrix using finite differences</dd></dl>
</li>
</ul>
<a name="setParameterStep(java.lang.String, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParameterStep</h4>
<pre>public&nbsp;void&nbsp;setParameterStep(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;parameter,
double&nbsp;hP)
throws <a href="../../../../../org/apache/commons/math3/ode/UnknownParameterException.html" title="class in org.apache.commons.math3.ode">UnknownParameterException</a></pre>
<div class="block">Set the step associated to a parameter in order to compute by finite
difference the Jacobian matrix.
<p>
Needed if and only if the primary ODE set is a <a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode"><code>ParameterizedODE</code></a>.
</p>
<p>
Given a non zero parameter value pval for the parameter, a reasonable value
for such a step is <code>pval * FastMath.sqrt(Precision.EPSILON)</code>.
</p>
<p>
A zero value for such a step doesn't enable to compute the parameter Jacobian matrix.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - parameter to consider for Jacobian processing</dd><dd><code>hP</code> - step for Jacobian finite difference computation w.r.t. the specified parameter</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/ode/UnknownParameterException.html" title="class in org.apache.commons.math3.ode">UnknownParameterException</a></code> - if the parameter is not supported</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/ParameterizedODE.html" title="interface in org.apache.commons.math3.ode"><code>ParameterizedODE</code></a></dd></dl>
</li>
</ul>
<a name="setInitialMainStateJacobian(double[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialMainStateJacobian</h4>
<pre>public&nbsp;void&nbsp;setInitialMainStateJacobian(double[][]&nbsp;dYdY0)
throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre>
<div class="block">Set the initial value of the Jacobian matrix with respect to state.
<p>
If this method is not called, the initial value of the Jacobian
matrix with respect to state is set to identity.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dYdY0</code> - initial Jacobian matrix w.r.t. state</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if matrix dimensions are incorrect</dd></dl>
</li>
</ul>
<a name="setInitialParameterJacobian(java.lang.String, double[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialParameterJacobian</h4>
<pre>public&nbsp;void&nbsp;setInitialParameterJacobian(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pName,
double[]&nbsp;dYdP)
throws <a href="../../../../../org/apache/commons/math3/ode/UnknownParameterException.html" title="class in org.apache.commons.math3.ode">UnknownParameterException</a>,
<a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre>
<div class="block">Set the initial value of a column of the Jacobian matrix with respect to one parameter.
<p>
If this method is not called for some parameter, the initial value of
the column of the Jacobian matrix with respect to this parameter is set to zero.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pName</code> - parameter name</dd><dd><code>dYdP</code> - initial Jacobian column vector with respect to the parameter</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/ode/UnknownParameterException.html" title="class in org.apache.commons.math3.ode">UnknownParameterException</a></code> - if a parameter is not supported</dd>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the column vector does not match state dimension</dd></dl>
</li>
</ul>
<a name="getCurrentMainSetJacobian(double[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentMainSetJacobian</h4>
<pre>public&nbsp;void&nbsp;getCurrentMainSetJacobian(double[][]&nbsp;dYdY0)</pre>
<div class="block">Get the current value of the Jacobian matrix with respect to state.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dYdY0</code> - current Jacobian matrix with respect to state.</dd></dl>
</li>
</ul>
<a name="getCurrentParameterJacobian(java.lang.String, double[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCurrentParameterJacobian</h4>
<pre>public&nbsp;void&nbsp;getCurrentParameterJacobian(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pName,
double[]&nbsp;dYdP)</pre>
<div class="block">Get the current value of the Jacobian matrix with respect to one parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pName</code> - name of the parameter for the computed Jacobian matrix</dd><dd><code>dYdP</code> - current Jacobian matrix with respect to the named parameter</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JacobianMatrices.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderIntegrator.html" title="interface in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.MismatchedEquations.html" title="class in org.apache.commons.math3.ode"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/math3/ode/JacobianMatrices.html" target="_top">Frames</a></li>
<li><a href="JacobianMatrices.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>