mirror of
https://github.com/oliverbooth/X10D
synced 2024-11-13 00:45:42 +00:00
1392 lines
65 KiB
HTML
1392 lines
65 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class DoubleExtensions
|
|
| X10D </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class DoubleExtensions
|
|
| X10D ">
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.png">
|
|
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.7.2/font/bootstrap-icons.css" integrity="sha384-EvBWSlnoFgZlXJvpzS+MAUEjvN7+gcCwH+qh7GRFOGgZO0PuwOFro7qPOJnLfe7l" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="../styles/config.css">
|
|
<link rel="stylesheet" href="../styles/discord.css">
|
|
<link rel="stylesheet" href="../styles/singulink.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
<meta property="docfx:newtab" content="true">
|
|
</head>
|
|
<body>
|
|
<div class="top-navbar">
|
|
<a class="burger-icon" onclick="toggleMenu()">
|
|
<svg name="Hamburger" style="vertical-align: middle;" width="34" height="34" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
|
|
</a>
|
|
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/favicon.png" alt="X10D" class="logomark">
|
|
<span class="brand-title">X10D</span>
|
|
</a> </div>
|
|
|
|
<div class="body-content">
|
|
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
|
|
|
|
<nav id="sidebar" role="navigation">
|
|
<div class="sidebar">
|
|
|
|
<div>
|
|
<div class="mobile-hide">
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/favicon.png" alt="X10D" class="logomark">
|
|
<span class="brand-title">X10D</span>
|
|
</a> </div>
|
|
|
|
<div class="sidesearch">
|
|
<form id="search" role="search" class="search">
|
|
<i class="bi bi-search search-icon"></i>
|
|
<input type="text" id="search-query" placeholder="Search" autocomplete="off">
|
|
</form>
|
|
</div>
|
|
|
|
<div id="navbar">
|
|
</div>
|
|
</div> <div class="sidebar-item-separator"></div>
|
|
|
|
<div id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="footer">
|
|
<strong>DocFX + Singulink = ♥</strong>
|
|
|
|
</div> </nav>
|
|
|
|
<main class="main-panel">
|
|
|
|
<div id="search-results" style="display: none;">
|
|
<h1 class="search-list">Search Results for <span></span></h1>
|
|
<div class="sr-items">
|
|
<p><i class="bi bi-hourglass-split index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
|
|
</div>
|
|
<div role="main" class="hide-when-search">
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<article class="content wrap" id="_content" data-uid="X10D.Math.DoubleExtensions">
|
|
|
|
|
|
<h1 id="X10D_Math_DoubleExtensions" data-uid="X10D.Math.DoubleExtensions" class="text-break">Class DoubleExtensions
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Mathematical extension methods.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">DoubleExtensions</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="X10D.Math.html">X10D.Math</a></h6>
|
|
<h6><strong>Assembly</strong>: X10D.dll</h6>
|
|
<h5 id="X10D_Math_DoubleExtensions_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class DoubleExtensions : object</code></pre>
|
|
</div>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Acos_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Acos(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L23">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Acos_" data-uid="X10D.Math.DoubleExtensions.Acos*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Acos_System_Double_" data-uid="X10D.Math.DoubleExtensions.Acos(System.Double)">Acos(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the arccosine of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Acos(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a cosine, which must be greater than or equal to -1, but less than or equal to 1.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The arccosine of <code data-dev-comment-type="paramref" class="paramref">value</code>, θ, measured in radians; such that 0 ≤ θ ≤ π. If <code data-dev-comment-type="paramref" class="paramref">value</code>
|
|
is equal to <see cref="!:double.NaN"></see>, less than -1, or greater than 1, <see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Acosh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Acosh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Acosh_" data-uid="X10D.Math.DoubleExtensions.Acosh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Acosh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Acosh(System.Double)">Acosh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic arccosine of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Acosh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a hyperbolic cosine, which must be greater than or equal to 1, but less than or equal to
|
|
<see cref="!:double.PositiveInfinity"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic arccosine of <code data-dev-comment-type="paramref" class="paramref">value</code>, θ, measured in radians; such that 0 ≤ θ ≤ ∞. If
|
|
<code data-dev-comment-type="paramref" class="paramref">value</code> is less than 1 or equal to <see cref="!:double.NaN"></see>, <see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Asin_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Asin(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L59">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Asin_" data-uid="X10D.Math.DoubleExtensions.Asin*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Asin_System_Double_" data-uid="X10D.Math.DoubleExtensions.Asin(System.Double)">Asin(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the arcsine of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Asin(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a sine, which must be greater than or equal to -1, but less than or equal to 1.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The arccosine of <code data-dev-comment-type="paramref" class="paramref">value</code>, θ, measured in radians; such that π/2 ≤ θ ≤ π/2. If
|
|
<code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>, less than -1, or greater than 1,
|
|
<see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Asinh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Asinh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L77">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Asinh_" data-uid="X10D.Math.DoubleExtensions.Asinh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Asinh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Asinh(System.Double)">Asinh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic arcsine of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Asinh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a hyperbolic sine, which must be greater than or equal to 1, but less than or equal to
|
|
<see cref="!:double.PositiveInfinity"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic arccosine of <code data-dev-comment-type="paramref" class="paramref">value</code>, measured in radians. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.NaN"></see>, <see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Atan_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Atan(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L94">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Atan_" data-uid="X10D.Math.DoubleExtensions.Atan*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Atan_System_Double_" data-uid="X10D.Math.DoubleExtensions.Atan(System.Double)">Atan(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the arctangent of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Atan(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a tangent, which must be greater than or equal to -1, but less than or equal to 1.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The arctangent of <code data-dev-comment-type="paramref" class="paramref">value</code>, θ, measured in radians; such that π/2 ≤ θ ≤ π/2. If
|
|
<code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>, <see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Atanh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Atanh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L113">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Atanh_" data-uid="X10D.Math.DoubleExtensions.Atanh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Atanh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Atanh(System.Double)">Atanh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic arctangent of the specified value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Atanh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value representing a hyperbolic tangent, which must be greater than or equal to 1, but less than or equal to
|
|
<see cref="!:double.PositiveInfinity"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic arctangent of <code data-dev-comment-type="paramref" class="paramref">value</code>, θ, measured in radians; such that -∞ < θ < -1, or 1 <
|
|
θ < ∞. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>, less than -1, or greater than 1,
|
|
<see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_ComplexSqrt_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.ComplexSqrt(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L125">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_ComplexSqrt_" data-uid="X10D.Math.DoubleExtensions.ComplexSqrt*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_ComplexSqrt_System_Double_" data-uid="X10D.Math.DoubleExtensions.ComplexSqrt(System.Double)">ComplexSqrt(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the complex square root of this double-precision floating-point number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Complex ComplexSqrt(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The number whose square root is to be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Complex</span></td>
|
|
<td><p>The square root of <code data-dev-comment-type="paramref" class="paramref">value</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Cos_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Cos(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L155">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Cos_" data-uid="X10D.Math.DoubleExtensions.Cos*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Cos_System_Double_" data-uid="X10D.Math.DoubleExtensions.Cos(System.Double)">Cos(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the cosine of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Cos(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, measured in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The cosine of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>,
|
|
<see cref="!:double.NegativeInfinity"></see>, or <see cref="!:double.PositiveInfinity"></see>, this method returns
|
|
<see cref="!:double.NaN"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Cosh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Cosh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L172">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Cosh_" data-uid="X10D.Math.DoubleExtensions.Cosh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Cosh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Cosh(System.Double)">Cosh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic cosine of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Cosh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, measured in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic cosine of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.NegativeInfinity"></see> or <see cref="!:double.PositiveInfinity"></see>,
|
|
<see cref="!:double.PositiveInfinity"></see> is returned. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.NaN"></see>, <see cref="!:double.NaN"></see> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_DegreesToRadians_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.DegreesToRadians(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L184">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_DegreesToRadians_" data-uid="X10D.Math.DoubleExtensions.DegreesToRadians*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_DegreesToRadians_System_Double_" data-uid="X10D.Math.DoubleExtensions.DegreesToRadians(System.Double)">DegreesToRadians(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Converts the current angle in degrees to its equivalent represented in radians.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double DegreesToRadians(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle in degrees to convert.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The result of π * <code data-dev-comment-type="paramref" class="paramref">value</code> / 180.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_IsEven_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.IsEven(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L199">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_IsEven_" data-uid="X10D.Math.DoubleExtensions.IsEven*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_IsEven_System_Double_" data-uid="X10D.Math.DoubleExtensions.IsEven(System.Double)">IsEven(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns a value indicating whether the current value is evenly divisible by 2.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsEven(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value whose parity to check.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><span class="xref">true</span> if <code data-dev-comment-type="paramref" class="paramref">value</code> is evenly divisible by 2, or <span class="xref">false</span>
|
|
otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_IsOdd_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.IsOdd(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L214">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_IsOdd_" data-uid="X10D.Math.DoubleExtensions.IsOdd*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_IsOdd_System_Double_" data-uid="X10D.Math.DoubleExtensions.IsOdd(System.Double)">IsOdd(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns a value indicating whether the current value is not evenly divisible by 2.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static bool IsOdd(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value whose parity to check.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><span class="xref">true</span> if <code data-dev-comment-type="paramref" class="paramref">value</code> is not evenly divisible by 2, or <span class="xref">false</span>
|
|
otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_RadiansToDegrees_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.RadiansToDegrees(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L226">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_RadiansToDegrees_" data-uid="X10D.Math.DoubleExtensions.RadiansToDegrees*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_RadiansToDegrees_System_Double_" data-uid="X10D.Math.DoubleExtensions.RadiansToDegrees(System.Double)">RadiansToDegrees(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Converts the current angle in radians to its equivalent represented in degrees.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double RadiansToDegrees(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle in radians to convert.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The result of π * <code data-dev-comment-type="paramref" class="paramref">value</code> / 180.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Round_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Round(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L238">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Round_" data-uid="X10D.Math.DoubleExtensions.Round*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Round_System_Double_" data-uid="X10D.Math.DoubleExtensions.Round(System.Double)">Round(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Rounds the current value to the nearest whole number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Round(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value to round.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p><code data-dev-comment-type="paramref" class="paramref">value</code> rounded to the nearest whole number.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Round_System_Double_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Round(System.Double%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L251">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Round_" data-uid="X10D.Math.DoubleExtensions.Round*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Round_System_Double_System_Double_" data-uid="X10D.Math.DoubleExtensions.Round(System.Double,System.Double)">Round(Double, Double)</h4>
|
|
<div class="markdown level1 summary"><p>Rounds the current value to the nearest multiple of a specified number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Round(this double value, double nearest)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value to round.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">nearest</span></td>
|
|
<td><p>The nearest multiple to which <code data-dev-comment-type="paramref" class="paramref">value</code> should be rounded.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p><code data-dev-comment-type="paramref" class="paramref">value</code> rounded to the nearest multiple of <code data-dev-comment-type="paramref" class="paramref">nearest</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Saturate_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Saturate(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L264">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Saturate_" data-uid="X10D.Math.DoubleExtensions.Saturate*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Saturate_System_Double_" data-uid="X10D.Math.DoubleExtensions.Saturate(System.Double)">Saturate(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Saturates this double-precision floating-point number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Saturate(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value to saturate.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The saturated value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="X10D_Math_DoubleExtensions_Saturate_System_Double__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This method clamps <code data-dev-comment-type="paramref" class="paramref">value</code> between 0 and 1.</p>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Sign_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Sign(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L331">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Sign_" data-uid="X10D.Math.DoubleExtensions.Sign*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Sign_System_Double_" data-uid="X10D.Math.DoubleExtensions.Sign(System.Double)">Sign(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns an integer that indicates the sign of this double-precision floating-point number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static int Sign(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>A signed number.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><p>A number that indicates the sign of <code data-dev-comment-type="paramref" class="paramref">value</code>, as shown in the following table.</p>
|
|
<table><thead><tr><th>Return value</th><th>Meaning</th></tr></thead><tbody><tr><td>-1</td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is less than zero.</td></tr><tr><td>0</td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is equal to zero.</td></tr><tr><td>1</td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is greater than zero.</td></tr></tbody></table>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Sin_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Sin(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L280">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Sin_" data-uid="X10D.Math.DoubleExtensions.Sin*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Sin_System_Double_" data-uid="X10D.Math.DoubleExtensions.Sin(System.Double)">Sin(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the sine of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Sin(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The sine of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>,
|
|
<see cref="!:double.NegativeInfinity"></see>, or <see cref="!:double.PositiveInfinity"></see>, this method returns
|
|
<see cref="!:double.NaN"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Sinh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Sinh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L296">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Sinh_" data-uid="X10D.Math.DoubleExtensions.Sinh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Sinh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Sinh(System.Double)">Sinh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic sine of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Sinh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic sine of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>,
|
|
<see cref="!:double.NegativeInfinity"></see>, or <see cref="!:double.PositiveInfinity"></see>, this method returns
|
|
<see cref="!:double.NaN"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Sqrt_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Sqrt(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L367">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Sqrt_" data-uid="X10D.Math.DoubleExtensions.Sqrt*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Sqrt_System_Double_" data-uid="X10D.Math.DoubleExtensions.Sqrt(System.Double)">Sqrt(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the square root of this double-precision floating-point number.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Sqrt(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The number whose square root is to be found.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>One of the values in the following table.</p>
|
|
<table><thead><tr><th>Return value</th><th>Meaning</th></tr></thead><tbody><tr><td>The positive square root of <code data-dev-comment-type="paramref" class="paramref">value</code>.</td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is greater than or equal to 0.</td></tr><tr><td><see cref="!:double.NaN"></see></td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see> or is negative.</td></tr><tr><td><see cref="!:double.PositiveInfinity"></see></td><td><code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.PositiveInfinity"></see>.</td></tr></tbody></table>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Tan_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Tan(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L401">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Tan_" data-uid="X10D.Math.DoubleExtensions.Tan*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Tan_System_Double_" data-uid="X10D.Math.DoubleExtensions.Tan(System.Double)">Tan(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the tangent of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Tan(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, measured in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The tangent of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to <see cref="!:double.NaN"></see>,
|
|
<see cref="!:double.NegativeInfinity"></see>, or <see cref="!:double.PositiveInfinity"></see>, this method returns
|
|
<see cref="!:double.NaN"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Tanh_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Tanh(System.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L418">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Tanh_" data-uid="X10D.Math.DoubleExtensions.Tanh*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Tanh_System_Double_" data-uid="X10D.Math.DoubleExtensions.Tanh(System.Double)">Tanh(Double)</h4>
|
|
<div class="markdown level1 summary"><p>Returns the hyperbolic tangent of the specified angle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Tanh(this double value)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The angle, measured in radians.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The hyperbolic tangent of <code data-dev-comment-type="paramref" class="paramref">value</code>. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.NegativeInfinity"></see>, this method returns -1. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.PositiveInfinity"></see>, this method returns 1. If <code data-dev-comment-type="paramref" class="paramref">value</code> is equal to
|
|
<see cref="!:double.NaN"></see>, this method returns <see cref="!:double.NaN"></see>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Wrap_System_Double_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Wrap(System.Double%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L446">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Wrap_" data-uid="X10D.Math.DoubleExtensions.Wrap*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Wrap_System_Double_System_Double_" data-uid="X10D.Math.DoubleExtensions.Wrap(System.Double,System.Double)">Wrap(Double, Double)</h4>
|
|
<div class="markdown level1 summary"><p>Wraps the current double-precision floating-point number between 0 and a high value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Wrap(this double value, double length)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value to wrap.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">length</span></td>
|
|
<td><p>The exclusive upper bound.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The wrapped value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/oliverbooth/X10D/new/main/apiSpec/new?filename=X10D_Math_DoubleExtensions_Wrap_System_Double_System_Double_System_Double_.md&value=---%0Auid%3A%20X10D.Math.DoubleExtensions.Wrap(System.Double%2CSystem.Double%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/oliverbooth/X10D/blob/main/X10D/src/Math/DoubleExtensions.cs/#L432">View Source</a>
|
|
</span>
|
|
<a id="X10D_Math_DoubleExtensions_Wrap_" data-uid="X10D.Math.DoubleExtensions.Wrap*"></a>
|
|
<h4 id="X10D_Math_DoubleExtensions_Wrap_System_Double_System_Double_System_Double_" data-uid="X10D.Math.DoubleExtensions.Wrap(System.Double,System.Double,System.Double)">Wrap(Double, Double, Double)</h4>
|
|
<div class="markdown level1 summary"><p>Wraps the current double-precision floating-point number between a low and a high value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static double Wrap(this double value, double low, double high)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">value</span></td>
|
|
<td><p>The value to wrap.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">low</span></td>
|
|
<td><p>The inclusive lower bound.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><span class="parametername">high</span></td>
|
|
<td><p>The exclusive upper bound.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Double</span></td>
|
|
<td><p>The wrapped value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="copyright-footer">
|
|
<span>© Singulink. All rights reserved.</span>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
|
|
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
|
|
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
|
|
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
|
|
<script type="text/javascript" src="../styles/url.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/singulink.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script> </body>
|
|
</html>
|