HiNC-2025-win-desktop-Deploy/App/wwwroot/HiAPI-docsite/api/Hi.Geom.Solvers.NumericalSolver.html
2025-07-18 15:38:28 +08:00

678 lines
22 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class NumericalSolver | HiAPI-C# 2025 </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class NumericalSolver | HiAPI-C# 2025 ">
<meta name="description" content="A numerical solver for systems of equations using the Jacobian matrix.">
<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.Solvers.NumericalSolver">
<h1 id="Hi_Geom_Solvers_NumericalSolver" data-uid="Hi.Geom.Solvers.NumericalSolver" class="text-break">
Class NumericalSolver
</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>.<a class="xref" href="Hi.Geom.Solvers.html">Solvers</a></dd></dl>
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
</div>
<div class="markdown summary"><p>A numerical solver for systems of equations using the Jacobian matrix.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class NumericalSolver</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">NumericalSolver</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>
<dl class="typelist extensionMethods">
<dt>Extension Methods</dt>
<dd>
<div>
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate&lt;TSelf&gt;(TSelf, params object[])</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke&lt;TSrc&gt;(TSrc, Action&lt;TSrc&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke&lt;TSrc, TDst&gt;(TSrc, Func&lt;TSrc, TDst&gt;)</a>
</div>
<div>
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
</div>
<div>
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
</div>
<div>
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
</div>
<div>
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Hi_Geom_Solvers_NumericalSolver__ctor_" data-uid="Hi.Geom.Solvers.NumericalSolver.#ctor*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver__ctor_Hi_Geom_Solvers_NumericalSolver_SetParasDelegate_System_Int32_Hi_Geom_Solvers_NumericalSolver_GetRepondsDelegate_System_Int32_System_Double_System_Double_System_Int32_" data-uid="Hi.Geom.Solvers.NumericalSolver.#ctor(Hi.Geom.Solvers.NumericalSolver.SetParasDelegate,System.Int32,Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate,System.Int32,System.Double,System.Double,System.Int32)">
NumericalSolver(SetParasDelegate, int, GetRepondsDelegate, int, double, double, int)
</h3>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Hi.Geom.Solvers.NumericalSolver.html">NumericalSolver</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NumericalSolver(NumericalSolver.SetParasDelegate setParasFunc, int paraNum, NumericalSolver.GetRepondsDelegate getResponsesFunc, int targetNum, double partialInterval, double tolerance, int iterationLimit = 12)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>setParasFunc</code> <a class="xref" href="Hi.Geom.Solvers.NumericalSolver.html">NumericalSolver</a>.<a class="xref" href="Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html">SetParasDelegate</a></dt>
<dd><p>Function to set parameter values</p>
</dd>
<dt><code>paraNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Number of parameters in the system</p>
</dd>
<dt><code>getResponsesFunc</code> <a class="xref" href="Hi.Geom.Solvers.NumericalSolver.html">NumericalSolver</a>.<a class="xref" href="Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html">GetRepondsDelegate</a></dt>
<dd><p>Function to get response values</p>
</dd>
<dt><code>targetNum</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Number of target values (equations) in the system</p>
</dd>
<dt><code>partialInterval</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Interval for calculating partial derivatives</p>
</dd>
<dt><code>tolerance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Tolerance for convergence</p>
</dd>
<dt><code>iterationLimit</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>Maximum number of iterations allowed</p>
</dd>
</dl>
<h2 class="section" id="properties">Properties
</h2>
<a id="Hi_Geom_Solvers_NumericalSolver_GetResponsesFunc_" data-uid="Hi.Geom.Solvers.NumericalSolver.GetResponsesFunc*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_GetResponsesFunc" data-uid="Hi.Geom.Solvers.NumericalSolver.GetResponsesFunc">
GetResponsesFunc
</h3>
<div class="markdown level1 summary"><p>Gets the function used to get response values.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NumericalSolver.GetRepondsDelegate GetResponsesFunc { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.NumericalSolver.html">NumericalSolver</a>.<a class="xref" href="Hi.Geom.Solvers.NumericalSolver.GetRepondsDelegate.html">GetRepondsDelegate</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_HalfPartialInterval_" data-uid="Hi.Geom.Solvers.NumericalSolver.HalfPartialInterval*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_HalfPartialInterval" data-uid="Hi.Geom.Solvers.NumericalSolver.HalfPartialInterval">
HalfPartialInterval
</h3>
<div class="markdown level1 summary"><p>Gets half of the partial interval value for optimization.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double HalfPartialInterval { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_IterationLimit_" data-uid="Hi.Geom.Solvers.NumericalSolver.IterationLimit*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_IterationLimit" data-uid="Hi.Geom.Solvers.NumericalSolver.IterationLimit">
IterationLimit
</h3>
<div class="markdown level1 summary"><p>Gets or sets the maximum number of iterations allowed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int IterationLimit { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_ParaNum_" data-uid="Hi.Geom.Solvers.NumericalSolver.ParaNum*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_ParaNum" data-uid="Hi.Geom.Solvers.NumericalSolver.ParaNum">
ParaNum
</h3>
<div class="markdown level1 summary"><p>Gets or sets the number of parameters in the system.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ParaNum { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_Paras_" data-uid="Hi.Geom.Solvers.NumericalSolver.Paras*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_Paras" data-uid="Hi.Geom.Solvers.NumericalSolver.Paras">
Paras
</h3>
<div class="markdown level1 summary"><p>Sets the parameter values in the system being solved.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double[] Paras { set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_PartialInterval_" data-uid="Hi.Geom.Solvers.NumericalSolver.PartialInterval*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_PartialInterval" data-uid="Hi.Geom.Solvers.NumericalSolver.PartialInterval">
PartialInterval
</h3>
<div class="markdown level1 summary"><p>Gets or sets the interval used for calculating partial derivatives.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double PartialInterval { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_Responses_" data-uid="Hi.Geom.Solvers.NumericalSolver.Responses*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_Responses" data-uid="Hi.Geom.Solvers.NumericalSolver.Responses">
Responses
</h3>
<div class="markdown level1 summary"><p>Gets the response values from the system being solved.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double[] Responses { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_SetParasFunc_" data-uid="Hi.Geom.Solvers.NumericalSolver.SetParasFunc*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_SetParasFunc" data-uid="Hi.Geom.Solvers.NumericalSolver.SetParasFunc">
SetParasFunc
</h3>
<div class="markdown level1 summary"><p>Gets the function used to set parameter values.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public NumericalSolver.SetParasDelegate SetParasFunc { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.NumericalSolver.html">NumericalSolver</a>.<a class="xref" href="Hi.Geom.Solvers.NumericalSolver.SetParasDelegate.html">SetParasDelegate</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_TargetNum_" data-uid="Hi.Geom.Solvers.NumericalSolver.TargetNum*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_TargetNum" data-uid="Hi.Geom.Solvers.NumericalSolver.TargetNum">
TargetNum
</h3>
<div class="markdown level1 summary"><p>Gets or sets the number of target values (equations) in the system.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int TargetNum { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_Tolerance_" data-uid="Hi.Geom.Solvers.NumericalSolver.Tolerance*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_Tolerance" data-uid="Hi.Geom.Solvers.NumericalSolver.Tolerance">
Tolerance
</h3>
<div class="markdown level1 summary"><p>Gets or sets the tolerance for convergence.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double Tolerance { get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Hi_Geom_Solvers_NumericalSolver_ErrorFunc_" data-uid="Hi.Geom.Solvers.NumericalSolver.ErrorFunc*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_ErrorFunc_System_Double___System_Double___" data-uid="Hi.Geom.Solvers.NumericalSolver.ErrorFunc(System.Double[],System.Double[])">
ErrorFunc(double[], double[])
</h3>
<div class="markdown level1 summary"><p>Calculates the error (difference) between the system responses and target values.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public double[] ErrorFunc(double[] paras, double[] targets)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>paras</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd><p>The parameter values to use</p>
</dd>
<dt><code>targets</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd><p>The target values to compare against</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd><p>An array of error values</p>
</dd>
</dl>
<a id="Hi_Geom_Solvers_NumericalSolver_Solve_" data-uid="Hi.Geom.Solvers.NumericalSolver.Solve*"></a>
<h3 id="Hi_Geom_Solvers_NumericalSolver_Solve_System_Double___System_Double___System_Double__System_Double_0__0____" data-uid="Hi.Geom.Solvers.NumericalSolver.Solve(System.Double[],System.Double[],System.Double@,System.Double[0:,0:]@)">
Solve(double[], double[], out double, out double[,])
</h3>
<div class="markdown level1 summary"><p>Solves the system of equations using numerical methods.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SolvingResultStatus Solve(double[] paras, double[] targets, out double minBias, out double[,] jacob)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>paras</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd><p>The initial parameter values, will be modified during solving</p>
</dd>
<dt><code>targets</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[]</dt>
<dd><p>The target values to solve for</p>
</dd>
<dt><code>minBias</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
<dd><p>Output parameter that will contain the minimum bias (error) found</p>
</dd>
<dt><code>jacob</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a>[,]</dt>
<dd><p>Output parameter that will contain the final Jacobian matrix</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Hi.Geom.Solvers.SolvingResultStatus.html">SolvingResultStatus</a></dt>
<dd><p>The status of the solving process</p>
</dd>
</dl>
<h4 class="section" id="Hi_Geom_Solvers_NumericalSolver_Solve_System_Double___System_Double___System_Double__System_Double_0__0_____remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Note that the <code class="paramref">paras</code> array will be modified during solving.</p>
</div>
</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>