oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 03:25:41 +00:00
Code Issues
gh-pages
X10D/api/X10D.Math.BigIntegerExtensions.html

735 lines
34 KiB
HTML
Raw Permalink Normal View History

Deploy to GitHub Pages
2024-06-12 14:17:02 +01:00
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class BigIntegerExtensions
| X10D </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class BigIntegerExtensions
| 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.BigIntegerExtensions">
<h1 id="X10D_Math_BigIntegerExtensions" data-uid="X10D.Math.BigIntegerExtensions" class="text-break">Class BigIntegerExtensions
</h1>
<div class="markdown level0 summary"><p>Math-related extension methods for <see cref="!:BigInteger"></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">BigIntegerExtensions</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_BigIntegerExtensions_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class BigIntegerExtensions : 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_BigIntegerExtensions_CountDigits_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.CountDigits(BigInteger)%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/BigIntegerExtensions.cs/#L19">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_CountDigits_" data-uid="X10D.Math.BigIntegerExtensions.CountDigits*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_CountDigits_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.CountDigits(BigInteger)">CountDigits(BigInteger)</h4>
<div class="markdown level1 summary"><p>Returns the number of digits in the current integer.</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 CountDigits(this BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value whose digit count to compute.</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>The number of digits in <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_BigIntegerExtensions_DigitalRoot_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.DigitalRoot(BigInteger)%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/BigIntegerExtensions.cs/#L39">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_DigitalRoot_" data-uid="X10D.Math.BigIntegerExtensions.DigitalRoot*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_DigitalRoot_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.DigitalRoot(BigInteger)">DigitalRoot(BigInteger)</h4>
<div class="markdown level1 summary"><p>Computes the digital root of this 8-bit integer.</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 DigitalRoot(this BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value whose digital root to compute.</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>The digital root of <code data-dev-comment-type="paramref" class="paramref">value</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="X10D_Math_BigIntegerExtensions_DigitalRoot_BigInteger__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The digital root is defined as the recursive sum of digits until that result is a single digit.</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_BigIntegerExtensions_Factorial_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.Factorial(BigInteger)%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/BigIntegerExtensions.cs/#L54">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_Factorial_" data-uid="X10D.Math.BigIntegerExtensions.Factorial*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_Factorial_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.Factorial(BigInteger)">Factorial(BigInteger)</h4>
<div class="markdown level1 summary"><p>Returns the factorial of the current 64-bit signed integer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BigInteger Factorial(this BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value whose factorial to compute.</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">BigInteger</span></td>
<td><p>The factorial 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_BigIntegerExtensions_GreatestCommonFactor_BigInteger_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.GreatestCommonFactor(BigInteger%2CBigInteger)%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/BigIntegerExtensions.cs/#L83">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_GreatestCommonFactor_" data-uid="X10D.Math.BigIntegerExtensions.GreatestCommonFactor*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_GreatestCommonFactor_BigInteger_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.GreatestCommonFactor(BigInteger,BigInteger)">GreatestCommonFactor(BigInteger, BigInteger)</h4>
<div class="markdown level1 summary"><p>Calculates the greatest common factor between this, and another, <see cref="!:BigInteger"></see>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BigInteger GreatestCommonFactor(this BigInteger value, BigInteger other)</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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The first value.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</span></td>
<td><span class="parametername">other</span></td>
<td><p>The second value.</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">BigInteger</span></td>
<td><p>The greatest common factor between <code data-dev-comment-type="paramref" class="paramref">value</code> and <code data-dev-comment-type="paramref" class="paramref">other</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_BigIntegerExtensions_IsOdd_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.IsOdd(BigInteger)%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/BigIntegerExtensions.cs/#L103">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_IsOdd_" data-uid="X10D.Math.BigIntegerExtensions.IsOdd*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_IsOdd_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.IsOdd(BigInteger)">IsOdd(BigInteger)</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 BigInteger 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">BigInteger</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_BigIntegerExtensions_IsPrime_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.IsPrime(BigInteger)%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/BigIntegerExtensions.cs/#L117">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_IsPrime_" data-uid="X10D.Math.BigIntegerExtensions.IsPrime*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_IsPrime_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.IsPrime(BigInteger)">IsPrime(BigInteger)</h4>
<div class="markdown level1 summary"><p>Returns a value indicating whether the current value is a prime 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 bool IsPrime(this BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value whose primality 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 prime; otherwise, <span class="xref">false</span>.</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_BigIntegerExtensions_LowestCommonMultiple_BigInteger_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.LowestCommonMultiple(BigInteger%2CBigInteger)%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/BigIntegerExtensions.cs/#L153">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_LowestCommonMultiple_" data-uid="X10D.Math.BigIntegerExtensions.LowestCommonMultiple*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_LowestCommonMultiple_BigInteger_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.LowestCommonMultiple(BigInteger,BigInteger)">LowestCommonMultiple(BigInteger, BigInteger)</h4>
<div class="markdown level1 summary"><p>Calculates the lowest common multiple between the current 64-bit signed integer, and another 64-bit signed integer.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BigInteger LowestCommonMultiple(this BigInteger value, BigInteger other)</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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The first value.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</span></td>
<td><span class="parametername">other</span></td>
<td><p>The second value.</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">BigInteger</span></td>
<td><p>The lowest common multiple between <code data-dev-comment-type="paramref" class="paramref">value</code> and <code data-dev-comment-type="paramref" class="paramref">other</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_BigIntegerExtensions_Mod_BigInteger_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.Mod(BigInteger%2CBigInteger)%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/BigIntegerExtensions.cs/#L190">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_Mod_" data-uid="X10D.Math.BigIntegerExtensions.Mod*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_Mod_BigInteger_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.Mod(BigInteger,BigInteger)">Mod(BigInteger, BigInteger)</h4>
<div class="markdown level1 summary"><p>Performs a modulo operation which supports a negative dividend.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BigInteger Mod(this BigInteger dividend, BigInteger divisor)</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">BigInteger</span></td>
<td><span class="parametername">dividend</span></td>
<td><p>The dividend.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</span></td>
<td><span class="parametername">divisor</span></td>
<td><p>The divisor.</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">BigInteger</span></td>
<td><p>The result of <code>dividend mod divisor</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="X10D_Math_BigIntegerExtensions_Mod_BigInteger_BigInteger__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The <code>%</code> operator (commonly called the modulo operator) in C# is not defined to be modulo, but is instead
remainder. This quirk inherently makes it difficult to use modulo in a negative context, as <code>x % y</code> where x is
negative will return a negative value, akin to <code>-(x % y)</code>, even if precedence is forced. This method provides a
modulo operation which supports negative dividends.</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_BigIntegerExtensions_MultiplicativePersistence_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.MultiplicativePersistence(BigInteger)%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/BigIntegerExtensions.cs/#L207">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_MultiplicativePersistence_" data-uid="X10D.Math.BigIntegerExtensions.MultiplicativePersistence*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_MultiplicativePersistence_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.MultiplicativePersistence(BigInteger)">MultiplicativePersistence(BigInteger)</h4>
<div class="markdown level1 summary"><p>Returns the multiplicative persistence of a 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 int MultiplicativePersistence(this BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value whose multiplicative persistence to calculate.</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>The multiplicative persistence.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="X10D_Math_BigIntegerExtensions_MultiplicativePersistence_BigInteger__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Multiplicative persistence is defined as the recursive digital product until that product is a single digit.</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_BigIntegerExtensions_Wrap_BigInteger_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.Wrap(BigInteger%2CBigInteger)%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/BigIntegerExtensions.cs/#L266">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_Wrap_" data-uid="X10D.Math.BigIntegerExtensions.Wrap*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_Wrap_BigInteger_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.Wrap(BigInteger,BigInteger)">Wrap(BigInteger, BigInteger)</h4>
<div class="markdown level1 summary"><p>Wraps the current integer 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 BigInteger Wrap(this BigInteger value, BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value to wrap.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</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">BigInteger</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_BigIntegerExtensions_Wrap_BigInteger_BigInteger_BigInteger_.md&amp;value=---%0Auid%3A%20X10D.Math.BigIntegerExtensions.Wrap(BigInteger%2CBigInteger%2CBigInteger)%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/BigIntegerExtensions.cs/#L252">View Source</a>
</span>
<a id="X10D_Math_BigIntegerExtensions_Wrap_" data-uid="X10D.Math.BigIntegerExtensions.Wrap*"></a>
<h4 id="X10D_Math_BigIntegerExtensions_Wrap_BigInteger_BigInteger_BigInteger_" data-uid="X10D.Math.BigIntegerExtensions.Wrap(BigInteger,BigInteger,BigInteger)">Wrap(BigInteger, BigInteger, BigInteger)</h4>
<div class="markdown level1 summary"><p>Wraps the current integer 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 BigInteger Wrap(this BigInteger value, BigInteger low, BigInteger 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">BigInteger</span></td>
<td><span class="parametername">value</span></td>
<td><p>The value to wrap.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</span></td>
<td><span class="parametername">low</span></td>
<td><p>The inclusive lower bound.</p>
</td>
</tr>
<tr>
<td><span class="xref">BigInteger</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">BigInteger</span></td>
<td><p>The wrapped value.</p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="copyright-footer">
<span>&#169; 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>
Copy Permalink