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.
 
 
 

507 lines
19 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>Control - 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" class="current">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">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.Properties/index.htm">MathNet.Numerics.Properties</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.Cuda/index.htm">MathNet.Numerics.Providers.Common.Cuda</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.Mkl/index.htm">MathNet.Numerics.Providers.Common.Mkl</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.OpenBlas/index.htm">MathNet.Numerics.Providers.Common.OpenBlas</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.LinearAlgebra.OpenBlas/index.htm">MathNet.Numerics.Providers.LinearAlgebra.OpenBlas</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</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics/Combinatorics.htm">Combinatorics</a>
</li>
<li>
<a href="../MathNet.Numerics/Complex32.htm">Complex32</a>
</li>
<li>
<a href="../MathNet.Numerics/ComplexExtensions.htm">ComplexExtensions</a>
</li>
<li>
<a href="../MathNet.Numerics/Constants.htm">Constants</a>
</li>
<li>
<a href="../MathNet.Numerics/ContourIntegrate.htm">ContourIntegrate</a>
</li>
<li>
<a href="../MathNet.Numerics/Control.htm" class="current">Control</a>
</li>
<li>
<a href="../MathNet.Numerics/Differentiate.htm">Differentiate</a>
</li>
<li>
<a href="../MathNet.Numerics/Distance.htm">Distance</a>
</li>
<li>
<a href="../MathNet.Numerics/Euclid.htm">Euclid</a>
</li>
<li>
<a href="../MathNet.Numerics/Evaluate.htm">Evaluate</a>
</li>
<li>
<a href="../MathNet.Numerics/ExcelFunctions.htm">ExcelFunctions</a>
</li>
<li>
<a href="../MathNet.Numerics/FindMinimum.htm">FindMinimum</a>
</li>
<li>
<a href="../MathNet.Numerics/FindRoots.htm">FindRoots</a>
</li>
<li>
<a href="../MathNet.Numerics/Fit.htm">Fit</a>
</li>
<li>
<a href="../MathNet.Numerics/Generate.htm">Generate</a>
</li>
<li>
<a href="../MathNet.Numerics/GoodnessOfFit.htm">GoodnessOfFit</a>
</li>
<li>
<a href="../MathNet.Numerics/Integrate.htm">Integrate</a>
</li>
<li>
<a href="../MathNet.Numerics/Interpolate.htm">Interpolate</a>
</li>
<li>
<a href="../MathNet.Numerics/InvalidParameterException.htm">InvalidParameterException</a>
</li>
<li>
<a href="../MathNet.Numerics/IPrecisionSupport`1.htm">IPrecisionSupport&lt;T&gt;</a>
</li>
<li>
<a href="../MathNet.Numerics/MemoryAllocationException.htm">MemoryAllocationException</a>
</li>
<li>
<a href="../MathNet.Numerics/NativeInterfaceException.htm">NativeInterfaceException</a>
</li>
<li>
<a href="../MathNet.Numerics/NonConvergenceException.htm">NonConvergenceException</a>
</li>
<li>
<a href="../MathNet.Numerics/NumericalBreakdownException.htm">NumericalBreakdownException</a>
</li>
<li>
<a href="../MathNet.Numerics/Permutation.htm">Permutation</a>
</li>
<li>
<a href="../MathNet.Numerics/Polynomial.htm">Polynomial</a>
</li>
<li>
<a href="../MathNet.Numerics/Precision.htm">Precision</a>
</li>
<li>
<a href="../MathNet.Numerics/SingularUMatrixException.htm">SingularUMatrixException</a>
</li>
<li>
<a href="../MathNet.Numerics/Sorting.htm">Sorting</a>
</li>
<li>
<a href="../MathNet.Numerics/SpecialFunctions.htm">SpecialFunctions</a>
</li>
<li>
<a href="../MathNet.Numerics/TestFunctions.htm">TestFunctions</a>
</li>
<li>
<a href="../MathNet.Numerics/Trig.htm">Trig</a>
</li>
<li>
<a href="../MathNet.Numerics/Window.htm">Window</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> Control</p>
<p><strong>Namespace</strong> MathNet.Numerics</p>
</div>
<div class="sub-header">
<div id="summary">Sets parameters for the library.
</div>
<h3 class="section">Static Functions</h3>
<ul>
<li><a href="../MathNet.Numerics/Control.htm#ConfigureAuto">ConfigureAuto</a></li>
<li><a href="../MathNet.Numerics/Control.htm#Describe">Describe</a></li>
<li><a href="../MathNet.Numerics/Control.htm#FreeResources">FreeResources</a></li>
<li><a href="../MathNet.Numerics/Control.htm#TryUseNative">TryUseNative</a></li>
<li><a href="../MathNet.Numerics/Control.htm#TryUseNativeCUDA">TryUseNativeCUDA</a></li>
<li><a href="../MathNet.Numerics/Control.htm#TryUseNativeMKL">TryUseNativeMKL</a></li>
<li><a href="../MathNet.Numerics/Control.htm#TryUseNativeOpenBLAS">TryUseNativeOpenBLAS</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseBestProviders">UseBestProviders</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseDefaultProviders">UseDefaultProviders</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseManaged">UseManaged</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseManagedReference">UseManagedReference</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseMultiThreading">UseMultiThreading</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseNativeCUDA">UseNativeCUDA</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseNativeMKL">UseNativeMKL</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseNativeMKL">UseNativeMKL</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseNativeOpenBLAS">UseNativeOpenBLAS</a></li>
<li><a href="../MathNet.Numerics/Control.htm#UseSingleThread">UseSingleThread</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics/Control.htm#CheckDistributionParameters">CheckDistributionParameters</a></li>
<li><a href="../MathNet.Numerics/Control.htm#MaxDegreeOfParallelism">MaxDegreeOfParallelism</a></li>
<li><a href="../MathNet.Numerics/Control.htm#NativeProviderPath">NativeProviderPath</a></li>
<li><a href="../MathNet.Numerics/Control.htm#TaskScheduler">TaskScheduler</a></li>
<li><a href="../MathNet.Numerics/Control.htm#ThreadSafeRandomNumberGenerators">ThreadSafeRandomNumberGenerators</a></li>
</ul>
</div>
<h3 class="section">Public Static Functions</h3>
<div id="ConfigureAuto" class="method">
<h4><span title="System.void">void</span> <strong>ConfigureAuto</strong>()</h4>
<div class="content">
</div>
</div>
<div id="Describe" class="method">
<h4><span title="System.string">string</span> <strong>Describe</strong>()</h4>
<div class="content">
</div>
</div>
<div id="FreeResources" class="method">
<h4><span title="System.void">void</span> <strong>FreeResources</strong>()</h4>
<div class="content">
</div>
</div>
<div id="TryUseNative" class="method">
<h4><span title="System.bool">bool</span> <strong>TryUseNative</strong>()</h4>
<div class="content">Try to use any available native provider in an undefined order.
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.bool">bool</span></code></h6>
<p>True if one of the native providers was found and successfully initialized.
False if it failed and the previous provider is still active. </p>
</div>
</div>
</div>
<div id="TryUseNativeCUDA" class="method">
<h4><span title="System.bool">bool</span> <strong>TryUseNativeCUDA</strong>()</h4>
<div class="content">Try to use the Nvidia CUDA native provider for linear algebra.
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.bool">bool</span></code></h6>
<p>True if the provider was found and initialized successfully.
False if it failed and the previous provider is still active. </p>
</div>
</div>
</div>
<div id="TryUseNativeMKL" class="method">
<h4><span title="System.bool">bool</span> <strong>TryUseNativeMKL</strong>()</h4>
<div class="content">Try to use the Intel MKL native provider for linear algebra.
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.bool">bool</span></code></h6>
<p>True if the provider was found and initialized successfully.
False if it failed and the previous provider is still active. </p>
</div>
</div>
</div>
<div id="TryUseNativeOpenBLAS" class="method">
<h4><span title="System.bool">bool</span> <strong>TryUseNativeOpenBLAS</strong>()</h4>
<div class="content">Try to use the OpenBLAS native provider for linear algebra.
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.bool">bool</span></code></h6>
<p>True if the provider was found and initialized successfully.
False if it failed and the previous provider is still active. </p>
</div>
</div>
</div>
<div id="UseBestProviders" class="method">
<h4><span title="System.void">void</span> <strong>UseBestProviders</strong>()</h4>
<div class="content">Use the best provider available.
</div>
</div>
<div id="UseDefaultProviders" class="method">
<h4><span title="System.void">void</span> <strong>UseDefaultProviders</strong>()</h4>
<div class="content">Use a specific provider if configured, e.g. using
environment variables, or fall back to the best providers.
</div>
</div>
<div id="UseManaged" class="method">
<h4><span title="System.void">void</span> <strong>UseManaged</strong>()</h4>
<div class="content">
</div>
</div>
<div id="UseManagedReference" class="method">
<h4><span title="System.void">void</span> <strong>UseManagedReference</strong>()</h4>
<div class="content">
</div>
</div>
<div id="UseMultiThreading" class="method">
<h4><span title="System.void">void</span> <strong>UseMultiThreading</strong>()</h4>
<div class="content">
</div>
</div>
<div id="UseNativeCUDA" class="method">
<h4><span title="System.void">void</span> <strong>UseNativeCUDA</strong>()</h4>
<div class="content">Use the Nvidia CUDA native provider for linear algebra.
Throws if it is not available or failed to initialize, in which case the previous provider is still active.
</div>
</div>
<div id="UseNativeMKL" class="method">
<h4><span title="System.void">void</span> <strong>UseNativeMKL</strong>()</h4>
<div class="content">Use the Intel MKL native provider for linear algebra.
Throws if it is not available or failed to initialize, in which case the previous provider is still active.
</div>
</div>
<div id="UseNativeMKL" class="method">
<h4><span title="System.void">void</span> <strong>UseNativeMKL</strong>(<a href="../MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm">MklConsistency</a> consistency, <a href="../MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm">MklPrecision</a> precision, <a href="../MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm">MklAccuracy</a> accuracy)</h4>
<div class="content">Use the Intel MKL native provider for linear algebra, with the specified configuration parameters.
Throws if it is not available or failed to initialize, in which case the previous provider is still active.
</div>
</div>
<div id="UseNativeOpenBLAS" class="method">
<h4><span title="System.void">void</span> <strong>UseNativeOpenBLAS</strong>()</h4>
<div class="content">Use the OpenBLAS native provider for linear algebra.
Throws if it is not available or failed to initialize, in which case the previous provider is still active.
</div>
</div>
<div id="UseSingleThread" class="method">
<h4><span title="System.void">void</span> <strong>UseSingleThread</strong>()</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public Properties</h3>
<div id="CheckDistributionParameters" class="method">
<h4><span title="System.bool">bool</span> <strong>CheckDistributionParameters</strong> get; set;</h4>
<div class="content">Gets or sets a value indicating whether the distribution classes check validate each parameter.
For the multivariate distributions this could involve an expensive matrix factorization.
The default setting of this property is <code>true</code>.
</div>
</div>
<div id="MaxDegreeOfParallelism" class="method">
<h4><span title="System.int">int</span> <strong>MaxDegreeOfParallelism</strong> get; set;</h4>
<div class="content">Gets or sets a value indicating how many parallel worker threads shall be used
when parallelization is applicable. <blockquote class="remarks">
Default to the number of processor cores, must be between 1 and 1024 (inclusive).
</blockquote>
</div>
</div>
<div id="NativeProviderPath" class="method">
<h4><span title="System.string">string</span> <strong>NativeProviderPath</strong> get; set;</h4>
<div class="content">Optional path to try to load native provider binaries from.
</div>
</div>
<div id="TaskScheduler" class="method">
<h4><span title="System.Threading.Tasks.TaskScheduler">TaskScheduler</span> <strong>TaskScheduler</strong> get; set;</h4>
<div class="content">Gets or sets the TaskScheduler used to schedule the worker tasks.
</div>
</div>
<div id="ThreadSafeRandomNumberGenerators" class="method">
<h4><span title="System.bool">bool</span> <strong>ThreadSafeRandomNumberGenerators</strong> get; set;</h4>
<div class="content">Gets or sets a value indicating whether to use thread safe random number generators (RNG).
Thread safe RNG about two and half time slower than non-thread safe RNG.
<blockquote class="value">
<strong>Value: </strong>
</blockquote>
</div>
</div>
<div id="footer">
<p>Based on v4.9.1.0 of MathNet.Numerics (Math.NET Numerics)</p>
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
</div>
</body>
</html>