| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-cryptojs/fp"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v2.2.0"> |
| <title data-rh="true">FP | Apache Milagro</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://milagro.apache.org/docs/cryptojs/fp"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="FP | Apache Milagro"><meta data-rh="true" name="description" content="FP"><meta data-rh="true" property="og:description" content="FP"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://milagro.apache.org/docs/cryptojs/fp"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/fp" hreflang="en"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/fp" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache Milagro RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache Milagro Atom Feed"> |
| |
| |
| |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.13.24/dist/katex.min.css" integrity="sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM" crossorigin="anonymous"> |
| <script src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/assets/css/styles.e187d088.css"> |
| <link rel="preload" href="/assets/js/runtime~main.2c187651.js" as="script"> |
| <link rel="preload" href="/assets/js/main.98efe6b5.js" as="script"> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
| <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/milagro.svg" alt="" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/milagro.svg" alt="" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache Milagro</b></a><a class="navbar__item navbar__link" href="/docs/milagro-intro">Docs</a><a class="navbar__item navbar__link" href="/docs/support">Support</a><a class="navbar__item navbar__link" href="/docs/contributor-guide">Contributing</a><a class="navbar__item navbar__link" href="/docs/downloads">Downloads</a></div><div class="navbar__items navbar__items--right"><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/milagro-intro">About Milagro</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/amcl-overview">AMCL Library</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/amcl-overview">AMCL Overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/amcl-c-api-2.0.0">AMCL C API 2.0.0</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/docs/cryptojs/amcl-javascript-api">AMCL JavaScript API 1.0.0</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/amcl-javascript-api">AMCL JavaScript API</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/aes">AES</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/big">BIG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls">BLS</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls192">BLS192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/bls256">BLS256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/dbig">DBIG</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecdh">ECDH</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp">ECP</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp2">ECP2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp4">ECP4</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ecp8">ECP8</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/ff">FF</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/cryptojs/fp">FP</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp2">FP2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp4">FP4</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp8">FP8</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp12">FP12</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp16">FP16</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp24">FP24</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/fp48">FP48</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/gcm">GCM</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash256">HASH256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash384">HASH384</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/hash512">HASH512</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin">MPIN</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin192">MPIN192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/mpin256">MPIN256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair">PAIR</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair192">PAIR192</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/pair256">PAIR256</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/rand">RAND</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/rsa">RSA</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/sha3">SHA3</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/cryptojs/unit64">UInt64</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/d-ta-overview">D-TA</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/mpc-api-0.1">MPC Library</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/zkp-mfa-overview">ZKP-MFA Clients/Servers</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributor-guide">Project Info</a></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">AMCL Library</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">AMCL JavaScript API 1.0.0</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">FP</span><meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>FP</h1></header><a name="FP"></a><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fp">FP<a class="hash-link" href="#fp" title="Direct link to heading"></a></h2><p><strong>Kind</strong>: global class<br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><ul><li><a href="#FP">FP</a><ul><li><a href="#new_FP_new">new FP(x)</a></li><li><em>instance</em><ul><li><a href="#FP+zero">.zero()</a></li><li><a href="#FP+rcopy">.rcopy(x)</a></li><li><a href="#FP+bcopy">.bcopy(x)</a></li><li><a href="#FP+copy">.copy(x)</a></li><li><a href="#FP+cswap">.cswap()</a></li><li><a href="#FP+cmove">.cmove(g, d)</a></li><li><a href="#FP+nres">.nres()</a></li><li><a href="#FP+redc">.redc()</a></li><li><a href="#FP+toString">.toString()</a></li><li><a href="#FP+iszilch">.iszilch()</a></li><li><a href="#FP+reduce">.reduce()</a></li><li><a href="#FP+one">.one()</a></li><li><a href="#FP+norm">.norm()</a></li><li><a href="#FP+mul">.mul(b)</a></li><li><a href="#FP+imul">.imul(s)</a></li><li><a href="#FP+sqr">.sqr()</a></li><li><a href="#FP+neg">.neg(x)</a></li><li><a href="#FP+sub">.sub(x)</a></li><li><a href="#FP+div2">.div2()</a></li><li><a href="#FP+fpow">.fpow()</a></li><li><a href="#FP+inverse">.inverse()</a></li><li><a href="#FP+equals">.equals(x)</a></li><li><a href="#FP+pow">.pow(e)</a></li><li><a href="#FP+jacobi">.jacobi()</a></li><li><a href="#FP+sqrt">.sqrt()</a></li></ul></li><li><em>static</em><ul><li><a href="#FP.mod">.mod()</a></li></ul></li></ul></li></ul><a name="new_FP_new"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-fpx">new FP(x)<a class="hash-link" href="#new-fpx" title="Direct link to heading"></a></h3><p>Creates an instance of FP.</p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP / BIG instance</td></tr></tbody></table><a name="FP+zero"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpzero">fP.zero()<a class="hash-link" href="#fpzero" title="Direct link to heading"></a></h3><p>Set FP to zero</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+rcopy"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fprcopyx">fP.rcopy(x)<a class="hash-link" href="#fprcopyx" title="Direct link to heading"></a></h3><p>copy from a ctx.BIG in ROM</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance to be copied</td></tr></tbody></table><a name="FP+bcopy"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpbcopyx">fP.bcopy(x)<a class="hash-link" href="#fpbcopyx" title="Direct link to heading"></a></h3><p>copy from another ctx.BIG</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance to be copied</td></tr></tbody></table><a name="FP+copy"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpcopyx">fP.copy(x)<a class="hash-link" href="#fpcopyx" title="Direct link to heading"></a></h3><p>Copy FP to another FP</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance to be copied</td></tr></tbody></table><a name="FP+cswap"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpcswap">fP.cswap()<a class="hash-link" href="#fpcswap" title="Direct link to heading"></a></h3><p>Conditional constant time swap of two FP numbers</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}BIG{"}"}</code><br> |
| <strong>Parameter</strong>: b FP number<br> |
| <strong>Parameter</strong>: d Integer </p><a name="FP+cmove"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpcmoveg-d">fP.cmove(g, d)<a class="hash-link" href="#fpcmoveg-d" title="Direct link to heading"></a></h3><p>Conditional copy of FP number</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>g</td><td>FP instance</td></tr><tr><td>d</td><td>copy depends on this value</td></tr></tbody></table><a name="FP+nres"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpnres">fP.nres()<a class="hash-link" href="#fpnres" title="Direct link to heading"></a></h3><p>Converts from BIG integer to residue form mod Modulus</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+redc"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpredc">fP.redc()<a class="hash-link" href="#fpredc" title="Direct link to heading"></a></h3><p>Converts from residue form back to BIG integer form</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+toString"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fptostring">fP.toString()<a class="hash-link" href="#fptostring" title="Direct link to heading"></a></h3><p>convert to hex string</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+iszilch"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpiszilch">fP.iszilch()<a class="hash-link" href="#fpiszilch" title="Direct link to heading"></a></h3><p>Tests for FP equal to zero</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+reduce"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpreduce">fP.reduce()<a class="hash-link" href="#fpreduce" title="Direct link to heading"></a></h3><p>Reduces all components of possibly unreduced FP mod Modulus</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+one"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpone">fP.one()<a class="hash-link" href="#fpone" title="Direct link to heading"></a></h3><p>Set FP to unity</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+norm"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpnorm">fP.norm()<a class="hash-link" href="#fpnorm" title="Direct link to heading"></a></h3><p>Normalises the components of an FP</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+mul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpmulb">fP.mul(b)<a class="hash-link" href="#fpmulb" title="Direct link to heading"></a></h3><p>Fast Modular multiplication of two FPs, mod Modulus</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>b</td><td>FP number, the multiplier</td></tr></tbody></table><a name="FP+imul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpimuls">fP.imul(s)<a class="hash-link" href="#fpimuls" title="Direct link to heading"></a></h3><p>Multiplication of an FP by a small integer</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>s</td><td>integer</td></tr></tbody></table><a name="FP+sqr"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpsqr">fP.sqr()<a class="hash-link" href="#fpsqr" title="Direct link to heading"></a></h3><p>Fast Squaring of an FP</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+neg"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpnegx">fP.neg(x)<a class="hash-link" href="#fpnegx" title="Direct link to heading"></a></h3><p>negate this</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance to be set to one</td></tr></tbody></table><a name="FP+sub"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpsubx">fP.sub(x)<a class="hash-link" href="#fpsubx" title="Direct link to heading"></a></h3><p>subtraction of two FPs</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance</td></tr></tbody></table><a name="FP+div2"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpdiv2">fP.div2()<a class="hash-link" href="#fpdiv2" title="Direct link to heading"></a></h3><p>Divide an FP by 2</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+fpow"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpfpow">fP.fpow()<a class="hash-link" href="#fpfpow" title="Direct link to heading"></a></h3><p>return this^(p-3)/4 or this^(p-5)/8</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+inverse"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpinverse">fP.inverse()<a class="hash-link" href="#fpinverse" title="Direct link to heading"></a></h3><p>Inverting an FP</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+equals"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpequalsx">fP.equals(x)<a class="hash-link" href="#fpequalsx" title="Direct link to heading"></a></h3><p>Tests for equality of two FP instances</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP instance to compare</td></tr></tbody></table><a name="FP+pow"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fppowe">fP.pow(e)<a class="hash-link" href="#fppowe" title="Direct link to heading"></a></h3><p>Raises an FP to the power of a BIG</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>e</td><td>BIG instance exponent</td></tr></tbody></table><a name="FP+jacobi"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpjacobi">fP.jacobi()<a class="hash-link" href="#fpjacobi" title="Direct link to heading"></a></h3><p>return jacobi symbol (this/Modulus)</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP+sqrt"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpsqrt">fP.sqrt()<a class="hash-link" href="#fpsqrt" title="Direct link to heading"></a></h3><p>Fast Modular square root of a an FP, mod Modulus</p><p><strong>Kind</strong>: instance method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code> </p><a name="FP.mod"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fpmod">FP.mod()<a class="hash-link" href="#fpmod" title="Direct link to heading"></a></h3><p>reduce a ctx.DBIG to a ctx.BIG using a "special" modulus</p><p><strong>Kind</strong>: static method of <a href="#FP"><code>FP</code></a><br> |
| <strong>this</strong>: <code>{"{"}FP{"}"}</code></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/cryptojs/ff"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">FF</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cryptojs/fp2"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">FP2</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#fp" class="table-of-contents__link toc-highlight">FP</a><ul><li><a href="#new-fpx" class="table-of-contents__link toc-highlight">new FP(x)</a></li><li><a href="#fpzero" class="table-of-contents__link toc-highlight">fP.zero()</a></li><li><a href="#fprcopyx" class="table-of-contents__link toc-highlight">fP.rcopy(x)</a></li><li><a href="#fpbcopyx" class="table-of-contents__link toc-highlight">fP.bcopy(x)</a></li><li><a href="#fpcopyx" class="table-of-contents__link toc-highlight">fP.copy(x)</a></li><li><a href="#fpcswap" class="table-of-contents__link toc-highlight">fP.cswap()</a></li><li><a href="#fpcmoveg-d" class="table-of-contents__link toc-highlight">fP.cmove(g, d)</a></li><li><a href="#fpnres" class="table-of-contents__link toc-highlight">fP.nres()</a></li><li><a href="#fpredc" class="table-of-contents__link toc-highlight">fP.redc()</a></li><li><a href="#fptostring" class="table-of-contents__link toc-highlight">fP.toString()</a></li><li><a href="#fpiszilch" class="table-of-contents__link toc-highlight">fP.iszilch()</a></li><li><a href="#fpreduce" class="table-of-contents__link toc-highlight">fP.reduce()</a></li><li><a href="#fpone" class="table-of-contents__link toc-highlight">fP.one()</a></li><li><a href="#fpnorm" class="table-of-contents__link toc-highlight">fP.norm()</a></li><li><a href="#fpmulb" class="table-of-contents__link toc-highlight">fP.mul(b)</a></li><li><a href="#fpimuls" class="table-of-contents__link toc-highlight">fP.imul(s)</a></li><li><a href="#fpsqr" class="table-of-contents__link toc-highlight">fP.sqr()</a></li><li><a href="#fpnegx" class="table-of-contents__link toc-highlight">fP.neg(x)</a></li><li><a href="#fpsubx" class="table-of-contents__link toc-highlight">fP.sub(x)</a></li><li><a href="#fpdiv2" class="table-of-contents__link toc-highlight">fP.div2()</a></li><li><a href="#fpfpow" class="table-of-contents__link toc-highlight">fP.fpow()</a></li><li><a href="#fpinverse" class="table-of-contents__link toc-highlight">fP.inverse()</a></li><li><a href="#fpequalsx" class="table-of-contents__link toc-highlight">fP.equals(x)</a></li><li><a href="#fppowe" class="table-of-contents__link toc-highlight">fP.pow(e)</a></li><li><a href="#fpjacobi" class="table-of-contents__link toc-highlight">fP.jacobi()</a></li><li><a href="#fpsqrt" class="table-of-contents__link toc-highlight">fP.sqrt()</a></li><li><a href="#fpmod" class="table-of-contents__link toc-highlight">FP.mod()</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/milagro.svg" class="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/milagro.svg" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></div><div class="footer__copyright">Copyright © 2022 The Apache Software Foundation. Apache Milagro, Milagro, Apache, the Apache feather, and the Apache Milagro project logo are either registered trademarks or trademarks of the Apache Software Foundation.</div></div></div></footer></div> |
| <script src="/assets/js/runtime~main.2c187651.js"></script> |
| <script src="/assets/js/main.98efe6b5.js"></script> |
| </body> |
| </html> |
