2025-07-18 15:38:28 +08:00

344 lines
13 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class MathNetUtil | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class MathNetUtil | HiAPI-C# 2025 ">
<meta name="description" content="Utility class for MathNet.Numerics operations.">
<link rel="icon" href="../img/HiAPI.favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../img/HiAPI.logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Hi.Geom.MathNetUtil">
<h1 id="Hi_Geom_MathNetUtil" data-uid="Hi.Geom.MathNetUtil" class="text-break">
Class MathNetUtil
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Geom.html">Geom</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>Utility class for MathNet.Numerics operations.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class MathNetUtil</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">MathNetUtil</span></div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Geom_MathNetUtil_ClearFloatingZero_" data-uid="Hi.Geom.MathNetUtil.ClearFloatingZero*"></a>
<h3 id="Hi_Geom_MathNetUtil_ClearFloatingZero_MathNet_Numerics_LinearAlgebra_Matrix_System_Double__System_Double_" data-uid="Hi.Geom.MathNetUtil.ClearFloatingZero(MathNet.Numerics.LinearAlgebra.Matrix{System.Double},System.Double)">
ClearFloatingZero(Matrix&lt;double&gt;, double)
</h3>
<div class="markdown level1 summary"><p>the elements which the absolute value lower to <code class="paramref">gap</code> are set to zero.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void ClearFloatingZero(Matrix&lt;double&gt; mat, double gap = 1E-07)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>mat</code> <span class="xref">Matrix</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd><p>target matrix</p>
</dd>
<dt><code>gap</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>gap value</p>
</dd>
</dl>
<a id="Hi_Geom_MathNetUtil_GetCovMatByMultiThread_" data-uid="Hi.Geom.MathNetUtil.GetCovMatByMultiThread*"></a>
<h3 id="Hi_Geom_MathNetUtil_GetCovMatByMultiThread_System_Collections_Generic_IList_System_Double____System_Action_System_Double__System_Int32_" data-uid="Hi.Geom.MathNetUtil.GetCovMatByMultiThread(System.Collections.Generic.IList{System.Double[]},System.Action{System.Double},System.Int32)">
GetCovMatByMultiThread(IList&lt;double[]&gt;, Action&lt;double&gt;, int)
</h3>
<div class="markdown level1 summary"><p>Calculates the covariance matrix for a list of vectors using multi-threading.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static DenseMatrix GetCovMatByMultiThread(IList&lt;double[]&gt; vecs, Action&lt;double&gt; progressAction = null, int progressTickPerVec = 20)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>vecs</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]&gt;</dt>
<dd><p>The list of vectors to calculate covariance for.</p>
</dd>
<dt><code>progressAction</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd><p>Optional action to report progress.</p>
</dd>
<dt><code>progressTickPerVec</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Number of progress ticks per vector processed.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">DenseMatrix</span></dt>
<dd><p>A dense matrix representing the covariance.</p>
</dd>
</dl>
<a id="Hi_Geom_MathNetUtil_GetDiagonalString_" data-uid="Hi.Geom.MathNetUtil.GetDiagonalString*"></a>
<h3 id="Hi_Geom_MathNetUtil_GetDiagonalString_MathNet_Numerics_LinearAlgebra_Matrix_System_Double__" data-uid="Hi.Geom.MathNetUtil.GetDiagonalString(MathNet.Numerics.LinearAlgebra.Matrix{System.Double})">
GetDiagonalString(Matrix&lt;double&gt;)
</h3>
<div class="markdown level1 summary"><p>Gets a string representation of the diagonal elements of a matrix.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string GetDiagonalString(Matrix&lt;double&gt; src)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>src</code> <span class="xref">Matrix</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd><p>The source matrix to extract diagonal elements from.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>A comma-separated string of the diagonal elements with 6 significant digits.</p>
</dd>
</dl>
<a id="Hi_Geom_MathNetUtil_GetInversedWeightMat_" data-uid="Hi.Geom.MathNetUtil.GetInversedWeightMat*"></a>
<h3 id="Hi_Geom_MathNetUtil_GetInversedWeightMat_MathNet_Numerics_LinearAlgebra_Matrix_System_Double__System_Int32__System_Double_System_Double_" data-uid="Hi.Geom.MathNetUtil.GetInversedWeightMat(MathNet.Numerics.LinearAlgebra.Matrix{System.Double},System.Int32@,System.Double,System.Double)">
GetInversedWeightMat(Matrix&lt;double&gt;, out int, double, double)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Matrix&lt;double&gt; GetInversedWeightMat(Matrix&lt;double&gt; w, out int abandonedIndex, double minGap = 1E-05, double sumTerminate = 0.99999999)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>w</code> <span class="xref">Matrix</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd></dd>
<dt><code>abandonedIndex</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>abandoned index. Inclusive.</p>
</dd>
<dt><code>minGap</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
<dt><code>sumTerminate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Matrix</span>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>&gt;</dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
</div>
</div>
</footer>
</body>
</html>