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.
 
 
 

321 lines
13 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>ForwardDifferenceGradientObjectiveFunction - 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">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" class="current">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.Optimization.ObjectiveFunctions</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm" class="current">ForwardDifferenceGradientObjectiveFunction</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/LazyObjectiveFunctionBase.htm">LazyObjectiveFunctionBase</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ObjectiveFunctionBase.htm">ObjectiveFunctionBase</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> ForwardDifferenceGradientObjectiveFunction</p>
<p><strong>Namespace</strong> MathNet.Numerics.Optimization.ObjectiveFunctions</p>
<p><strong>Interfaces</strong> <a href="../MathNet.Numerics.Optimization/IObjectiveFunction.htm">IObjectiveFunction</a></p>
</div>
<div class="sub-header">
<div id="summary">Adapts an objective function with only value implemented
to provide a gradient as well. Gradient calculation is
done using the finite difference method, specifically
forward differences.
For each gradient computed, the algorithm requires an
additional number of function evaluations equal to the
functions's number of input parameters.
</div>
<h3 class="section">Constructors</h3>
<ul>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#.ctor">ForwardDifferenceGradientObjectiveFunction</a></li>
</ul>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#CreateNew">CreateNew</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#EvaluateAt">EvaluateAt</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Fork">Fork</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Gradient">Gradient</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Hessian">Hessian</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#InnerObjectiveFunction">InnerObjectiveFunction</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#IsGradientSupported">IsGradientSupported</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#IsHessianSupported">IsHessianSupported</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#MinimumIncrement">MinimumIncrement</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Point">Point</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#RelativeIncrement">RelativeIncrement</a></li>
<li><a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/ForwardDifferenceGradientObjectiveFunction.htm#Value">Value</a></li>
</ul>
</div>
<h3 class="section">Public Constructors</h3>
<div id=".ctor" class="method">
<h4> <strong>ForwardDifferenceGradientObjectiveFunction</strong>(<a href="../MathNet.Numerics.Optimization/IObjectiveFunction.htm">IObjectiveFunction</a> valueOnlyObj, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> lowerBound, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> upperBound, <span title="System.double">double</span> relativeIncrement, <span title="System.double">double</span> minimumIncrement)</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public Methods</h3>
<div id="CreateNew" class="method">
<h4><a href="../MathNet.Numerics.Optimization/IObjectiveFunction.htm">IObjectiveFunction</a> <strong>CreateNew</strong>()</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="EvaluateAt" class="method">
<h4><span title="System.void">void</span> <strong>EvaluateAt</strong>(<a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> point)</h4>
<div class="content">
</div>
</div>
<div id="Fork" class="method">
<h4><a href="../MathNet.Numerics.Optimization/IObjectiveFunction.htm">IObjectiveFunction</a> <strong>Fork</strong>()</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="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="Gradient" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> <strong>Gradient</strong> get; set;</h4>
<div class="content">
</div>
</div>
<div id="Hessian" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> <strong>Hessian</strong> get; </h4>
<div class="content">
</div>
</div>
<div id="InnerObjectiveFunction" class="method">
<h4><a href="../MathNet.Numerics.Optimization/IObjectiveFunction.htm">IObjectiveFunction</a> <strong>InnerObjectiveFunction</strong> get; set;</h4>
<div class="content">
</div>
</div>
<div id="IsGradientSupported" class="method">
<h4><span title="System.bool">bool</span> <strong>IsGradientSupported</strong> get; </h4>
<div class="content">
</div>
</div>
<div id="IsHessianSupported" class="method">
<h4><span title="System.bool">bool</span> <strong>IsHessianSupported</strong> get; </h4>
<div class="content">
</div>
</div>
<div id="MinimumIncrement" class="method">
<h4><span title="System.double">double</span> <strong>MinimumIncrement</strong> get; set;</h4>
<div class="content">
</div>
</div>
<div id="Point" class="method">
<h4><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> <strong>Point</strong> get; set;</h4>
<div class="content">
</div>
</div>
<div id="RelativeIncrement" class="method">
<h4><span title="System.double">double</span> <strong>RelativeIncrement</strong> get; set;</h4>
<div class="content">
</div>
</div>
<div id="Value" class="method">
<h4><span title="System.double">double</span> <strong>Value</strong> get; </h4>
<div class="content">
</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>