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.
 
 
 

314 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>MklProvider - 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">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" class="current">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.Providers.Common.Mkl</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics.Providers.Common.Mkl/MklAccuracy.htm">MklAccuracy</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.Mkl/MklConsistency.htm">MklConsistency</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.Mkl/MklPrecision.htm">MklPrecision</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm" class="current">MklProvider</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> MklProvider</p>
<p><strong>Namespace</strong> MathNet.Numerics.Providers.Common.Mkl</p>
</div>
<div class="sub-header">
<h3 class="section">Static Functions</h3>
<ul>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#Describe">Describe</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#DisableMemoryPool">DisableMemoryPool</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#DisablePeakMemoryStatistics">DisablePeakMemoryStatistics</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#EnablePeakMemoryStatistics">EnablePeakMemoryStatistics</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#FreeBuffers">FreeBuffers</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#FreeResources">FreeResources</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#IsAvailable">IsAvailable</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#Load">Load</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#Load">Load</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#MemoryStatistics">MemoryStatistics</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#PeakMemoryStatistics">PeakMemoryStatistics</a></li>
<li><a href="../MathNet.Numerics.Providers.Common.Mkl/MklProvider.htm#ThreadFreeBuffers">ThreadFreeBuffers</a></li>
</ul>
</div>
<h3 class="section">Public Static Functions</h3>
<div id="Describe" class="method">
<h4><span title="System.string">string</span> <strong>Describe</strong>()</h4>
<div class="content">
</div>
</div>
<div id="DisableMemoryPool" class="method">
<h4><span title="System.void">void</span> <strong>DisableMemoryPool</strong>()</h4>
<div class="content">Disable the MKL memory pool. May impact performance.
</div>
</div>
<div id="DisablePeakMemoryStatistics" class="method">
<h4><span title="System.void">void</span> <strong>DisablePeakMemoryStatistics</strong>()</h4>
<div class="content">Disable gathering of peak memory statistics of the MKL memory pool.
</div>
</div>
<div id="EnablePeakMemoryStatistics" class="method">
<h4><span title="System.void">void</span> <strong>EnablePeakMemoryStatistics</strong>()</h4>
<div class="content">Enable gathering of peak memory statistics of the MKL memory pool.
</div>
</div>
<div id="FreeBuffers" class="method">
<h4><span title="System.void">void</span> <strong>FreeBuffers</strong>()</h4>
<div class="content">Frees the memory allocated to the MKL memory pool.
</div>
</div>
<div id="FreeResources" class="method">
<h4><span title="System.void">void</span> <strong>FreeResources</strong>()</h4>
<div class="content">Frees memory buffers, caches and handles allocated in or to the provider.
Does not unload the provider itself, it is still usable afterwards.
This method is safe to call, even if the provider is not loaded.
</div>
</div>
<div id="IsAvailable" class="method">
<h4><span title="System.bool">bool</span> <strong>IsAvailable</strong>(<span title="System.string">string</span> hintPath)</h4>
<div class="content">
</div>
</div>
<div id="Load" class="method">
<h4><span title="System.int">int</span> <strong>Load</strong>(<span title="System.string">string</span> hintPath)</h4>
<div class="content">
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.int">int</span></code></h6>
<p>Revision </p>
</div>
</div>
</div>
<div id="Load" class="method">
<h4><span title="System.int">int</span> <strong>Load</strong>(<span title="System.string">string</span> hintPath, <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">
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.int">int</span></code></h6>
<p>Revision </p>
</div>
</div>
</div>
<div id="MemoryStatistics" class="method">
<h4><span title="System.long">long</span> <strong>MemoryStatistics</strong>(<span title="System.Int32&">Int32&amp;</span> allocatedBuffers)</h4>
<div class="content">
</div>
</div>
<div id="PeakMemoryStatistics" class="method">
<h4><span title="System.long">long</span> <strong>PeakMemoryStatistics</strong>(<span title="System.bool">bool</span> reset)</h4>
<div class="content">Measures peak memory usage of the MKL memory pool.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><span title="System.bool">bool</span></code> reset</h6>
<p class="comments">Whether the usage counter should be reset. </p>
</div>
<div class="return">
<h5>Return</h5>
<h6><code><span title="System.long">long</span></code></h6>
<p>The peak number of bytes allocated to all memory buffers. </p>
</div>
</div>
</div>
<div id="ThreadFreeBuffers" class="method">
<h4><span title="System.void">void</span> <strong>ThreadFreeBuffers</strong>()</h4>
<div class="content">Frees the memory allocated to the MKL memory pool on the current thread.
</div>
</div>
<div id="footer">
<p>Based on v4.8.1.0 of MathNet.Numerics (Math.NET Numerics)</p>
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
</div>
</body>
</html>