Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CalculationHelper | CapyKit Documentation </title>
|
||||
<title> Class CalculationHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CalculationHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CalculationHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Static class providing helper methods for various calculations.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,501 +70,155 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.CalculationHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_CalculationHelper" data-uid="CapyKit.Helpers.CalculationHelper" class="text-break">
|
||||
Class CalculationHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Static class providing helper methods for various calculations.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class CalculationHelper</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">CalculationHelper</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="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS" data-uid="CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS">
|
||||
EARTH_RADIUS_KILOMETERS
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The earth's radius in kilometers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int EARTH_RADIUS_KILOMETERS = 6371</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER" data-uid="CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER">
|
||||
MILES_PER_KILOMETER
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Ratio of miles per kilometer .</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const double MILES_PER_KILOMETER = 0.621371</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field 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="CapyKit_Helpers_CalculationHelper_CalculateHash_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHash*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)">
|
||||
CalculateHash(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Calculates the hash of a given string using an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.security.cryptography.md5">MD5</a> value as the first 32 bits.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int CalculateHash(string str)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string to be hashed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The calculated hash.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method is used for a quick and consistent hash function. It should not be considered
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_CalculationHelper"> Class CalculationHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Static class providing helper methods for various calculations.</p>
|
||||
<pre><code class="lang-csharp">public static class CalculationHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS"> EARTH_RADIUS_KILOMETERS</h3>
|
||||
<p>The earth's radius in kilometers.</p>
|
||||
<pre><code class="lang-csharp">public const int EARTH_RADIUS_KILOMETERS = 6371
|
||||
</code></pre>
|
||||
<h4 id="field-value">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"> MILES_PER_KILOMETER</h3>
|
||||
<p>Ratio of miles per kilometer .</p>
|
||||
<pre><code class="lang-csharp">public const double MILES_PER_KILOMETER = 0.621371
|
||||
</code></pre>
|
||||
<h4 id="field-value-1">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"> CalculateHash(string)</h3>
|
||||
<p>Calculates the hash of a given string using an <span class="xref">System.Security.Cryptography.MD5</span> value as the first 32 bits.</p>
|
||||
<pre><code class="lang-csharp">public static int CalculateHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The calculated hash.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method is used for a quick and consistent hash function. It should not be considered
|
||||
cryptographically sound or used in security contexts.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)">
|
||||
CalculateHexHash(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Calculates the hexadecimal hash.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string CalculateHexHash(string str)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string to be hashed.</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>The calculated 16 character hexadecimal hash.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_" data-uid="CapyKit.Helpers.CalculationHelper.DegreesToRadians*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)">
|
||||
DegreesToRadians(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Convers degrees to radians.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double DegreesToRadians(double degrees)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>degrees</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The degree value.</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>The value as radians.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_GetDistance_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)">
|
||||
GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>latitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The latitude origin.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The longitude origin.</p>
|
||||
</dd>
|
||||
<dt><code>latitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The latitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The longitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>measurementSystem</code> <a class="xref" href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></dt>
|
||||
<dd><p>(Optional) The measurement system.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The distance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_"> CalculateHexHash(string)</h3>
|
||||
<p>Calculates the hexadecimal hash.</p>
|
||||
<pre><code class="lang-csharp">public static string CalculateHexHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The calculated 16 character hexadecimal hash.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"> DegreesToRadians(double)</h3>
|
||||
<p>Convers degrees to radians.</p>
|
||||
<pre><code class="lang-csharp">public static double DegreesToRadians(double degrees)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>degrees</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The degree value.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as radians.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_">GetDistance(double, double, double, double, MeasurementSystem)</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_GetDistance_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)">
|
||||
GetDistance(double, double, double, double, MeasurementSystem)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>latitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The latitude of the origin.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The longitude of the origin.</p>
|
||||
</dd>
|
||||
<dt><code>latitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The latitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The longitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>measurementSystem</code> <a class="xref" href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></dt>
|
||||
<dd><p>(Optional) The measurement system.</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>The distance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a>.<a href="CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_">GetDistance</a>(<a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a>)</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(double, double, double, double, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude of the origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude of the origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)">
|
||||
KilometersToMiles(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts kilometers to miles.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double KilometersToMiles(double kilometers)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>kilometers</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in kilometers.</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>The value in miles.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_" data-uid="CapyKit.Helpers.CalculationHelper.MilesToKilometers*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)">
|
||||
MilesToKilometers(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts miles to kilometers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double MilesToKilometers(double miles)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>miles</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in miles.</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>The value in kilometers.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_" data-uid="CapyKit.Helpers.CalculationHelper.RadiansToDegrees*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)">
|
||||
RadiansToDegrees(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts radians to degrees.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double RadiansToDegrees(double radians)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>radians</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The radian value.</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>The value as degrees.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_"> KilometersToMiles(double)</h3>
|
||||
<p>Converts kilometers to miles.</p>
|
||||
<pre><code class="lang-csharp">public static double KilometersToMiles(double kilometers)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>kilometers</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"> MilesToKilometers(double)</h3>
|
||||
<p>Converts miles to kilometers.</p>
|
||||
<pre><code class="lang-csharp">public static double MilesToKilometers(double miles)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>miles</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"> RadiansToDegrees(double)</h3>
|
||||
<p>Converts radians to degrees.</p>
|
||||
<pre><code class="lang-csharp">public static double RadiansToDegrees(double radians)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>radians</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The radian value.</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as degrees.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue