mirror of
https://github.com/oliverbooth/X10D
synced 2024-11-24 21:48:48 +00:00
667 lines
31 KiB
HTML
667 lines
31 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 DecimalExtensions
|
|||
|
|
| X10D </title>
|
|||
|
|
<meta name="viewport" content="width=device-width">
|
|||
|
|
<meta name="title" content="Class DecimalExtensions
|
|||
|
|
| 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.DecimalExtensions">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<h1 id="X10D_Math_DecimalExtensions" data-uid="X10D.Math.DecimalExtensions" class="text-break">Class DecimalExtensions
|
|||
|
|
</h1>
|
|||
|
|
<div class="markdown level0 summary"><p>Extension methods for <see cref="!:System.Decimal"></see>.</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">DecimalExtensions</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_DecimalExtensions_syntax">Syntax</h5>
|
|||
|
|
<div class="codewrapper">
|
|||
|
|
<pre><code class="lang-csharp hljs">public static class DecimalExtensions : 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_DecimalExtensions_ComplexSqrt_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.ComplexSqrt(System.Decimal)%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/DecimalExtensions.cs/#L18">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_ComplexSqrt_" data-uid="X10D.Math.DecimalExtensions.ComplexSqrt*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_ComplexSqrt_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.ComplexSqrt(System.Decimal)">ComplexSqrt(Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Returns the complex square root of this decimal 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 decimal 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.Decimal</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_DecimalExtensions_IsEven_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.IsEven(System.Decimal)%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/DecimalExtensions.cs/#L33">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_IsEven_" data-uid="X10D.Math.DecimalExtensions.IsEven*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_IsEven_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.IsEven(System.Decimal)">IsEven(Decimal)</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 decimal 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.Decimal</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_DecimalExtensions_IsOdd_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.IsOdd(System.Decimal)%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/DecimalExtensions.cs/#L48">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_IsOdd_" data-uid="X10D.Math.DecimalExtensions.IsOdd*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_IsOdd_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.IsOdd(System.Decimal)">IsOdd(Decimal)</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 decimal 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.Decimal</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_DecimalExtensions_Round_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Round(System.Decimal)%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/DecimalExtensions.cs/#L60">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Round_" data-uid="X10D.Math.DecimalExtensions.Round*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Round_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Round(System.Decimal)">Round(Decimal)</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 decimal Round(this decimal 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.Decimal</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.Decimal</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_DecimalExtensions_Round_System_Decimal_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Round(System.Decimal%2CSystem.Decimal)%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/DecimalExtensions.cs/#L73">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Round_" data-uid="X10D.Math.DecimalExtensions.Round*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Round_System_Decimal_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Round(System.Decimal,System.Decimal)">Round(Decimal, Decimal)</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 decimal Round(this decimal value, decimal 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.Decimal</span></td>
|
|||
|
|
<td><span class="parametername">value</span></td>
|
|||
|
|
<td><p>The value to round.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><span class="xref">System.Decimal</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.Decimal</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_DecimalExtensions_Saturate_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Saturate(System.Decimal)%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/DecimalExtensions.cs/#L86">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Saturate_" data-uid="X10D.Math.DecimalExtensions.Saturate*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Saturate_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Saturate(System.Decimal)">Saturate(Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Saturates this decimal 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 decimal Saturate(this decimal 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.Decimal</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.Decimal</span></td>
|
|||
|
|
<td><p>The saturated value.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<h5 id="X10D_Math_DecimalExtensions_Saturate_System_Decimal__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_DecimalExtensions_Sign_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Sign(System.Decimal)%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/DecimalExtensions.cs/#L120">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Sign_" data-uid="X10D.Math.DecimalExtensions.Sign*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Sign_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Sign(System.Decimal)">Sign(Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Returns an integer that indicates the sign of this decimal 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 decimal 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.Decimal</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_DecimalExtensions_Sqrt_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Sqrt(System.Decimal)%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/DecimalExtensions.cs/#L155">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Sqrt_" data-uid="X10D.Math.DecimalExtensions.Sqrt*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Sqrt_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Sqrt(System.Decimal)">Sqrt(Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Returns the square root of this decimal 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 decimal Sqrt(this decimal 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.Decimal</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.Decimal</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_DecimalExtensions_Wrap_System_Decimal_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Wrap(System.Decimal%2CSystem.Decimal)%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/DecimalExtensions.cs/#L199">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Wrap_" data-uid="X10D.Math.DecimalExtensions.Wrap*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Wrap_System_Decimal_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Wrap(System.Decimal,System.Decimal)">Wrap(Decimal, Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Wraps the current decimal 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 decimal Wrap(this decimal value, decimal 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.Decimal</span></td>
|
|||
|
|
<td><span class="parametername">value</span></td>
|
|||
|
|
<td><p>The value to wrap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><span class="xref">System.Decimal</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.Decimal</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_DecimalExtensions_Wrap_System_Decimal_System_Decimal_System_Decimal_.md&value=---%0Auid%3A%20X10D.Math.DecimalExtensions.Wrap(System.Decimal%2CSystem.Decimal%2CSystem.Decimal)%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/DecimalExtensions.cs/#L185">View Source</a>
|
|||
|
|
</span>
|
|||
|
|
<a id="X10D_Math_DecimalExtensions_Wrap_" data-uid="X10D.Math.DecimalExtensions.Wrap*"></a>
|
|||
|
|
<h4 id="X10D_Math_DecimalExtensions_Wrap_System_Decimal_System_Decimal_System_Decimal_" data-uid="X10D.Math.DecimalExtensions.Wrap(System.Decimal,System.Decimal,System.Decimal)">Wrap(Decimal, Decimal, Decimal)</h4>
|
|||
|
|
<div class="markdown level1 summary"><p>Wraps the current decimal 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 decimal Wrap(this decimal value, decimal low, decimal 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.Decimal</span></td>
|
|||
|
|
<td><span class="parametername">value</span></td>
|
|||
|
|
<td><p>The value to wrap.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><span class="xref">System.Decimal</span></td>
|
|||
|
|
<td><span class="parametername">low</span></td>
|
|||
|
|
<td><p>The inclusive lower bound.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><span class="xref">System.Decimal</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.Decimal</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>
|