Math.NET Numerics
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.
 
 
 

336 lines
12 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>StepType - 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">NumericalJacobian</a>
</li>
<li>
<a href="../MathNet.Numerics.Differentiation/StepType.htm" class="current">StepType</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> StepType</p>
<p><strong>Namespace</strong> MathNet.Numerics.Differentiation</p>
<p><strong>Parent</strong> <span title="System.Enum">Enum</span></p>
</div>
<div class="sub-header">
<div id="summary">Type of finite different step size.
</div>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#CompareTo">CompareTo</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#GetTypeCode">GetTypeCode</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#HasFlag">HasFlag</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#ToString">ToString</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#ToString">ToString</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#ToString">ToString</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Fields</h3>
<ul>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#value__">value__</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#Absolute">Absolute</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#RelativeX">RelativeX</a></li>
<li><a href="../MathNet.Numerics.Differentiation/StepType.htm#Relative">Relative</a></li>
</ul>
</div>
<h3 class="section">Public Methods</h3>
<div id="CompareTo" class="method">
<h4><span title="System.int">int</span> <strong>CompareTo</strong>(<span title="System.object">object</span> target)</h4>
<div class="content">
</div>
</div>
<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="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="GetTypeCode" class="method">
<h4><span title="System.TypeCode">TypeCode</span> <strong>GetTypeCode</strong>()</h4>
<div class="content">
</div>
</div>
<div id="HasFlag" class="method">
<h4><span title="System.bool">bool</span> <strong>HasFlag</strong>(<span title="System.Enum">Enum</span> flag)</h4>
<div class="content">
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
<div class="content">
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>(<span title="System.string">string</span> format, <span title="System.IFormatProvider">IFormatProvider</span> provider)</h4>
<div class="content">
<div id="warning">
<b>Obsolete:</b> The provider argument is not used. Please use ToString(String).
</div>
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>(<span title="System.IFormatProvider">IFormatProvider</span> provider)</h4>
<div class="content">
<div id="warning">
<b>Obsolete:</b> The provider argument is not used. Please use ToString().
</div>
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>(<span title="System.string">string</span> format)</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public fields</h3>
<div id="value__" class="method">
<h4>int <strong>value__</strong></h4>
<div class="content">
<table>
<tr>
<td>
<code>return <span title="System.int">int</span></code>
</td>
</tr>
</table>
</div>
</div>
<div id="Absolute" class="method">
<h4>StepType <strong>Absolute</strong></h4>
<div class="content">The absolute step size value will be used in numerical derivatives, regardless of order or function parameters.
<table>
<tr>
<td>
<code>return <a href="../MathNet.Numerics.Differentiation/StepType.htm">StepType</a></code>
</td>
</tr>
</table>
</div>
</div>
<div id="RelativeX" class="method">
<h4>StepType <strong>RelativeX</strong></h4>
<div class="content">A base step size value, h, will be scaled according to the function input parameter. A common example is hx = h*(1+abs(x)), however
this may vary depending on implementation. This definition only guarantees that the only scaling will be relative to the
function input parameter and not the order of the finite difference derivative.
<table>
<tr>
<td>
<code>return <a href="../MathNet.Numerics.Differentiation/StepType.htm">StepType</a></code>
</td>
</tr>
</table>
</div>
</div>
<div id="Relative" class="method">
<h4>StepType <strong>Relative</strong></h4>
<div class="content">A base step size value, eps (typically machine precision), is scaled according to the finite difference coefficient order
and function input parameter. The initial scaling according to finite different coefficient order can be thought of as producing a
base step size, h, that is equivalent to <a href="../MathNet.Numerics.Differentiation/StepType.htm#RelativeX">RelativeX</a> scaling. This step size is then scaled according to the function
input parameter. Although implementation may vary, an example of second order accurate scaling may be (eps)^(1/3)*(1+abs(x)).
<table>
<tr>
<td>
<code>return <a href="../MathNet.Numerics.Differentiation/StepType.htm">StepType</a></code>
</td>
</tr>
</table>
</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>