csharpfftfsharpintegrationinterpolationlinear-algebramathdifferentiationmatrixnumericsrandomregressionstatisticsmathnet
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
361 lines
14 KiB
361 lines
14 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>NumericalJacobian - Math.NET Numerics Documentation</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
|
<link type="text/css" rel="stylesheet" href="../main.css"/>
|
|
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
|
|
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
|
|
<script type="text/javascript" src="../js/navigation.js"></script>
|
|
<script type="text/javascript" src="../js/example.js"></script>
|
|
</head>
|
|
<body><div id="namespaces">
|
|
<h2 class="fixed">Namespaces</h2>
|
|
<div class="scroll">
|
|
<ul>
|
|
<li>
|
|
<a href="../MathNet.Numerics/index.htm">MathNet.Numerics</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/index.htm" class="current">MathNet.Numerics.Differentiation</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Distributions/index.htm">MathNet.Numerics.Distributions</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Financial/index.htm">MathNet.Numerics.Financial</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.IntegralTransforms/index.htm">MathNet.Numerics.IntegralTransforms</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Integration/index.htm">MathNet.Numerics.Integration</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Interpolation/index.htm">MathNet.Numerics.Interpolation</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra/index.htm">MathNet.Numerics.LinearAlgebra</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex/index.htm">MathNet.Numerics.LinearAlgebra.Complex</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex32/index.htm">MathNet.Numerics.LinearAlgebra.Complex32</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex32.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Double/index.htm">MathNet.Numerics.LinearAlgebra.Double</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Double.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Factorization/index.htm">MathNet.Numerics.LinearAlgebra.Factorization</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Single/index.htm">MathNet.Numerics.LinearAlgebra.Single</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Single.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Solvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearAlgebra.Storage/index.htm">MathNet.Numerics.LinearAlgebra.Storage</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.LinearRegression/index.htm">MathNet.Numerics.LinearRegression</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.OdeSolvers/index.htm">MathNet.Numerics.OdeSolvers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization/index.htm">MathNet.Numerics.Optimization</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.LineSearch/index.htm">MathNet.Numerics.Optimization.LineSearch</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm">MathNet.Numerics.Optimization.ObjectiveFunctions</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Optimization.TrustRegion/index.htm">MathNet.Numerics.Optimization.TrustRegion</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers/index.htm">MathNet.Numerics.Providers</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.FourierTransform/index.htm">MathNet.Numerics.Providers.FourierTransform</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.LinearAlgebra/index.htm">MathNet.Numerics.Providers.LinearAlgebra</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Providers.SparseSolver/index.htm">MathNet.Numerics.Providers.SparseSolver</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Random/index.htm">MathNet.Numerics.Random</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.RootFinding/index.htm">MathNet.Numerics.RootFinding</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Statistics/index.htm">MathNet.Numerics.Statistics</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Statistics.Mcmc/index.htm">MathNet.Numerics.Statistics.Mcmc</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><div id="types">
|
|
<h2 class="fixed">Types in MathNet.Numerics.Differentiation</h2>
|
|
<div class="scroll">
|
|
<ul>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/FiniteDifferenceCoefficients.htm">FiniteDifferenceCoefficients</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/NumericalDerivative.htm">NumericalDerivative</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/NumericalHessian.htm">NumericalHessian</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm" class="current">NumericalJacobian</a>
|
|
</li>
|
|
<li>
|
|
<a href="../MathNet.Numerics.Differentiation/StepType.htm">StepType</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<p class="class"><strong>Type</strong> NumericalJacobian</p>
|
|
<p><strong>Namespace</strong> MathNet.Numerics.Differentiation</p>
|
|
</div>
|
|
<div class="sub-header">
|
|
<div id="summary">Class for evaluating the Jacobian of a function using finite differences.
|
|
By default, a central 3-point method is used.
|
|
</div>
|
|
|
|
<h3 class="section">Constructors</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#.ctor">NumericalJacobian</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#.ctor">NumericalJacobian</a></li>
|
|
</ul>
|
|
|
|
<h3 class="section">Methods</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Equals">Equals</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Evaluate">Evaluate</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Evaluate">Evaluate</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Evaluate">Evaluate</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Evaluate">Evaluate</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#Evaluate">Evaluate</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#GetHashCode">GetHashCode</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#GetType">GetType</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#ResetFunctionEvaluations">ResetFunctionEvaluations</a></li>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#ToString">ToString</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3 class="section">Properties</h3>
|
|
<ul>
|
|
<li><a href="../MathNet.Numerics.Differentiation/NumericalJacobian.htm#FunctionEvaluations">FunctionEvaluations</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Constructors</h3>
|
|
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>NumericalJacobian</strong>()</h4>
|
|
<div class="content">Creates a numerical Jacobian object with a three point central difference method.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id=".ctor" class="method">
|
|
<h4> <strong>NumericalJacobian</strong>(<span title="System.int">int</span> points, <span title="System.int">int</span> center)</h4>
|
|
<div class="content">Creates a numerical Jacobian with a specified differentiation scheme.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.int">int</span></code> points</h6>
|
|
<p class="comments">Number of points for Jacobian evaluation. </p>
|
|
<h6><code><span title="System.int">int</span></code> center</h6>
|
|
<p class="comments">Center point for differentiation. </p>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h3 class="section">Public Methods</h3>
|
|
|
|
<div id="Equals" class="method">
|
|
<h4><span title="System.bool">bool</span> <strong>Equals</strong>(<span title="System.object">object</span> obj)</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Evaluate" class="method">
|
|
<h4><span title="System.Double[]">Double[]</span> <strong>Evaluate</strong>(<span title="System.Func<double, double>">Func<double, double></span> f, <span title="System.double">double</span> x)</h4>
|
|
<div class="content">Evaluates the Jacobian of scalar univariate function f at point x.
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.Func<double, double>">Func<double, double></span></code> f</h6>
|
|
<p class="comments">Scalar univariate function handle. </p>
|
|
<h6><code><span title="System.double">double</span></code> x</h6>
|
|
<p class="comments">Point at which to evaluate Jacobian. </p>
|
|
</div>
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.Double[]">Double[]</span></code></h6>
|
|
<p>Jacobian vector. </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Evaluate" class="method">
|
|
<h4><span title="System.Double[]">Double[]</span> <strong>Evaluate</strong>(<span title="System.Func<Double[], double>">Func<Double[], double></span> f, <span title="System.Double[]">Double[]</span> x)</h4>
|
|
<div class="content">Evaluates the Jacobian of a multivariate function f at vector x. <blockquote class="remarks">
|
|
This function assumes that the length of vector x consistent with the argument count of f.
|
|
</blockquote>
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.Func<Double[], double>">Func<Double[], double></span></code> f</h6>
|
|
<p class="comments">Multivariate function handle. </p>
|
|
<h6><code><span title="System.Double[]">Double[]</span></code> x</h6>
|
|
<p class="comments">Points at which to evaluate Jacobian. </p>
|
|
</div>
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.Double[]">Double[]</span></code></h6>
|
|
<p>Jacobian vector. </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Evaluate" class="method">
|
|
<h4><span title="System.Double[]">Double[]</span> <strong>Evaluate</strong>(<span title="System.Func<Double[], double>">Func<Double[], double></span> f, <span title="System.Double[]">Double[]</span> x, <span title="System.double">double</span> currentValue)</h4>
|
|
<div class="content">Evaluates the Jacobian of a multivariate function f at vector x given a current function value. <blockquote class="remarks">
|
|
To minimize the number of function evaluations, a user can supply the current value of the function
|
|
to be used in computing the Jacobian. This value must correspond to the "center" location for the
|
|
finite differencing. If a scheme is used where the center value is not evaluated, this will provide no
|
|
added efficiency. This method also assumes that the length of vector x consistent with the argument count of f.
|
|
</blockquote>
|
|
|
|
|
|
<div class="parameters">
|
|
<h5>Parameters</h5>
|
|
|
|
<h6><code><span title="System.Func<Double[], double>">Func<Double[], double></span></code> f</h6>
|
|
<p class="comments">Multivariate function handle. </p>
|
|
<h6><code><span title="System.Double[]">Double[]</span></code> x</h6>
|
|
<p class="comments">Points at which to evaluate Jacobian. </p>
|
|
<h6><code><span title="System.double">double</span></code> currentValue</h6>
|
|
<p class="comments">Current function value at finite difference center. </p>
|
|
</div>
|
|
|
|
<div class="return">
|
|
<h5>Return</h5>
|
|
<h6><code><span title="System.Double[]">Double[]</span></code></h6>
|
|
<p>Jacobian vector. </p>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Evaluate" class="method">
|
|
<h4><span title="System.Double[,]">Double[,]</span> <strong>Evaluate</strong>(<span title="System.Func`2[]">Func`2[]</span> f, <span title="System.Double[]">Double[]</span> x)</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="Evaluate" class="method">
|
|
<h4><span title="System.Double[,]">Double[,]</span> <strong>Evaluate</strong>(<span title="System.Func`2[]">Func`2[]</span> f, <span title="System.Double[]">Double[]</span> x, <span title="System.Double[]">Double[]</span> currentValues)</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="GetHashCode" class="method">
|
|
<h4><span title="System.int">int</span> <strong>GetHashCode</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="GetType" class="method">
|
|
<h4><span title="System.Type">Type</span> <strong>GetType</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="ResetFunctionEvaluations" class="method">
|
|
<h4><span title="System.void">void</span> <strong>ResetFunctionEvaluations</strong>()</h4>
|
|
<div class="content">Resets the function evaluation counter for the Jacobian.
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div id="ToString" class="method">
|
|
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
|
|
<div class="content">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<h3 class="section">Public Properties</h3>
|
|
|
|
<div id="FunctionEvaluations" class="method">
|
|
<h4><span title="System.int">int</span> <strong>FunctionEvaluations</strong> get; </h4>
|
|
<div class="content">Number of function evaluations.
|
|
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<p>Based on v5.0.0.0 of MathNet.Numerics (Math.NET Numerics)</p>
|
|
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
|
|
</div>
|
|
</body>
|
|
</html>
|