blob: 622546f167009fd47b8984a5a6440799cefc591f [file] [log] [blame]
<!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/fp16">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.2.0">
<title data-rh="true">FP16 | 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/fp16"><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="FP16 | Apache Milagro"><meta data-rh="true" name="description" content="FP16"><meta data-rh="true" property="og:description" content="FP16"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://milagro.apache.org/docs/cryptojs/fp16"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/fp16" hreflang="en"><link data-rh="true" rel="alternate" href="https://milagro.apache.org/docs/cryptojs/fp16" 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.27cb1668.css">
<link rel="preload" href="/assets/js/runtime~main.b2dc6e47.js" as="script">
<link rel="preload" href="/assets/js/main.8eab308a.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" 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 menu__link--active" aria-current="page" 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">FP16</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>FP16</h1></header><a name="FP16"></a><h2 class="anchor anchorWithStickyNavbar_LWe7" id="fp16">FP16<a class="hash-link" href="#fp16" title="Direct link to heading"></a></h2><p><strong>Kind</strong>: global class<br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><ul><li><a href="#FP16">FP16</a><ul><li><a href="#new_FP16_new">new FP16()</a></li><li><a href="#FP16+reduce">.reduce()</a></li><li><a href="#FP16+norm">.norm()</a></li><li><a href="#FP16+iszilch">.iszilch()</a></li><li><a href="#FP16+isunity">.isunity()</a></li><li><a href="#FP16+cmove">.cmove(g, d)</a></li><li><a href="#FP16+isreal">.isreal()</a></li><li><a href="#FP16+real">.real()</a></li><li><a href="#FP16+geta">.geta()</a></li><li><a href="#FP16+getb">.getb()</a></li><li><a href="#FP16+equals">.equals(x)</a></li><li><a href="#FP16+copy">.copy(x)</a></li><li><a href="#FP16+zero">.zero()</a></li><li><a href="#FP16+one">.one(x)</a></li><li><a href="#FP16+set">.set(c, d)</a></li><li><a href="#FP16+seta">.seta(c)</a></li><li><a href="#FP16+neg">.neg()</a></li><li><a href="#FP16+conj">.conj()</a></li><li><a href="#FP16+nconj">.nconj()</a></li><li><a href="#FP16+add">.add(x)</a></li><li><a href="#FP16+sub">.sub(x)</a></li><li><a href="#FP16+pmul">.pmul(s)</a></li><li><a href="#FP16+qmul">.qmul(s)</a></li><li><a href="#FP16+imul">.imul(s)</a></li><li><a href="#FP16+sqr">.sqr()</a></li><li><a href="#FP16+mul">.mul(y)</a></li><li><a href="#FP16+toString">.toString()</a></li><li><a href="#FP16+inverse">.inverse()</a></li><li><a href="#FP16+times_i">.times_i()</a></li><li><a href="#FP16+times_i2">.times_i2()</a></li><li><a href="#FP16+times_i4">.times_i4()</a></li><li><a href="#FP16+frob">.frob(f)</a></li><li><a href="#FP16+pow">.pow(e)</a></li><li><a href="#FP16+xtr_A">.xtr_A(w, y, z)</a></li><li><a href="#FP16+xtr_D">.xtr_D()</a></li><li><a href="#FP16+xtr_pow">.xtr_pow(n)</a></li><li><a href="#FP16+xtr_pow2">.xtr_pow2()</a></li></ul></li></ul><a name="new_FP16_new"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="new-fp16">new FP16()<a class="hash-link" href="#new-fp16" title="Direct link to heading"></a></h3><p>Creates an instance of FP16.</p><a name="FP16+reduce"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16reduce">fP16.reduce()<a class="hash-link" href="#fp16reduce" title="Direct link to heading"></a></h3><p>Reduces all components of possibly unreduced FP16 mod Modulus</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+norm"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16norm">fP16.norm()<a class="hash-link" href="#fp16norm" title="Direct link to heading"></a></h3><p>Normalises the components of an FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+iszilch"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16iszilch">fP16.iszilch()<a class="hash-link" href="#fp16iszilch" title="Direct link to heading"></a></h3><p>Tests for FP16 equal to zero</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+isunity"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16isunity">fP16.isunity()<a class="hash-link" href="#fp16isunity" title="Direct link to heading"></a></h3><p>Tests for FP16 equal to unity</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+cmove"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16cmoveg-d">fP16.cmove(g, d)<a class="hash-link" href="#fp16cmoveg-d" title="Direct link to heading"></a></h3><p>Conditional copy of FP16 number</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>g</td><td>FP16 instance</td></tr><tr><td>d</td><td>copy depends on this value</td></tr></tbody></table><a name="FP16+isreal"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16isreal">fP16.isreal()<a class="hash-link" href="#fp16isreal" title="Direct link to heading"></a></h3><p>test is w real? That is in a+ib test b is zero</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+real"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16real">fP16.real()<a class="hash-link" href="#fp16real" title="Direct link to heading"></a></h3><p>extract real part a</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+geta"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16geta">fP16.geta()<a class="hash-link" href="#fp16geta" title="Direct link to heading"></a></h3><p>extract a from this</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+getb"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16getb">fP16.getb()<a class="hash-link" href="#fp16getb" title="Direct link to heading"></a></h3><p>extract b from this</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+equals"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16equalsx">fP16.equals(x)<a class="hash-link" href="#fp16equalsx" title="Direct link to heading"></a></h3><p>Tests for equality of two FP16s</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP16 instance to compare</td></tr></tbody></table><a name="FP16+copy"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16copyx">fP16.copy(x)<a class="hash-link" href="#fp16copyx" title="Direct link to heading"></a></h3><p>Copy FP16 to another FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP16 instance to be copied</td></tr></tbody></table><a name="FP16+zero"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16zero">fP16.zero()<a class="hash-link" href="#fp16zero" title="Direct link to heading"></a></h3><p>Set FP16 to zero</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+one"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16onex">fP16.one(x)<a class="hash-link" href="#fp16onex" title="Direct link to heading"></a></h3><p>Set FP16 to unity</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP16 instance to be set to one</td></tr></tbody></table><a name="FP16+set"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16setc-d">fP16.set(c, d)<a class="hash-link" href="#fp16setc-d" title="Direct link to heading"></a></h3><p>Set FP16 from two FP8 values</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>c</td><td>FP8 instance</td></tr><tr><td>d</td><td>FP8 instance</td></tr></tbody></table><a name="FP16+seta"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16setac">fP16.seta(c)<a class="hash-link" href="#fp16setac" title="Direct link to heading"></a></h3><p>Set FP16 from one FP8 value</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>c</td><td>FP8 instance</td></tr></tbody></table><a name="FP16+neg"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16neg">fP16.neg()<a class="hash-link" href="#fp16neg" title="Direct link to heading"></a></h3><p>this=-this</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+conj"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16conj">fP16.conj()<a class="hash-link" href="#fp16conj" title="Direct link to heading"></a></h3><p>Conjugation of FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+nconj"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16nconj">fP16.nconj()<a class="hash-link" href="#fp16nconj" title="Direct link to heading"></a></h3><p>Negative conjugation of FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+add"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16addx">fP16.add(x)<a class="hash-link" href="#fp16addx" title="Direct link to heading"></a></h3><p>addition of two FP16s</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP16 instance</td></tr></tbody></table><a name="FP16+sub"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16subx">fP16.sub(x)<a class="hash-link" href="#fp16subx" title="Direct link to heading"></a></h3><p>subtraction of two FP16s</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>x</td><td>FP16 instance</td></tr></tbody></table><a name="FP16+pmul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16pmuls">fP16.pmul(s)<a class="hash-link" href="#fp16pmuls" title="Direct link to heading"></a></h3><p>Multiplication of an FP16 by an FP8</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>s</td><td>FP8 instance</td></tr></tbody></table><a name="FP16+qmul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16qmuls">fP16.qmul(s)<a class="hash-link" href="#fp16qmuls" title="Direct link to heading"></a></h3><p>Multiplication of an FP16 by an FP2</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>s</td><td>FP2 instance</td></tr></tbody></table><a name="FP16+imul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16imuls">fP16.imul(s)<a class="hash-link" href="#fp16imuls" title="Direct link to heading"></a></h3><p>Multiplication of an FP16 by a small integer</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</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="FP16+sqr"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16sqr">fP16.sqr()<a class="hash-link" href="#fp16sqr" title="Direct link to heading"></a></h3><p>Fast Squaring of an FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+mul"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16muly">fP16.mul(y)<a class="hash-link" href="#fp16muly" title="Direct link to heading"></a></h3><p>Full unconditional Multiplication of two FP16s</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>y</td><td>FP16 instance, the multiplier</td></tr></tbody></table><a name="FP16+toString"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16tostring">fP16.toString()<a class="hash-link" href="#fp16tostring" title="Direct link to heading"></a></h3><p>convert this to hex string</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+inverse"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16inverse">fP16.inverse()<a class="hash-link" href="#fp16inverse" title="Direct link to heading"></a></h3><p>Inverting an FP16</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+times_i"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16times_i">fP16.times_i()<a class="hash-link" href="#fp16times_i" title="Direct link to heading"></a></h3><p>multiplies an FP16 instance by irreducible polynomial sqrt(1+sqrt(-1))</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+times_i2"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16times_i2">fP16.times_i2()<a class="hash-link" href="#fp16times_i2" title="Direct link to heading"></a></h3><p>multiplies an FP16 instance by irreducible polynomial (1+sqrt(-1))</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+times_i4"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16times_i4">fP16.times_i4()<a class="hash-link" href="#fp16times_i4" title="Direct link to heading"></a></h3><p>multiplies an FP16 instance by irreducible polynomial (1+sqrt(-1))</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+frob"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16frobf">fP16.frob(f)<a class="hash-link" href="#fp16frobf" title="Direct link to heading"></a></h3><p>Raises an FP16 to the power of the internal modulus p, using the Frobenius</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>f</td><td>Modulus</td></tr></tbody></table><a name="FP16+pow"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16powe">fP16.pow(e)<a class="hash-link" href="#fp16powe" title="Direct link to heading"></a></h3><p>Raises an FP16 to the power of a BIG</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</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="FP16+xtr_A"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16xtr_aw-y-z">fP16.xtr_A(w, y, z)<a class="hash-link" href="#fp16xtr_aw-y-z" title="Direct link to heading"></a></h3><p>Calculates the XTR addition function r=w_x-conj(x)_y+z</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>w</td><td>FP16 instance</td></tr><tr><td>y</td><td>FP16 instance</td></tr><tr><td>z</td><td>FP16 instance</td></tr></tbody></table><a name="FP16+xtr_D"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16xtr_d">fP16.xtr_D()<a class="hash-link" href="#fp16xtr_d" title="Direct link to heading"></a></h3><p>Calculates the XTR doubling function r=x^2-2<!-- -->*<!-- -->conj(x)</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><a name="FP16+xtr_pow"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16xtr_pown">fP16.xtr_pow(n)<a class="hash-link" href="#fp16xtr_pown" title="Direct link to heading"></a></h3><p>Calculates FP16 trace of an FP16 raised to the power of a BIG number</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</code> </p><table><thead><tr><th>Param</th><th>Description</th></tr></thead><tbody><tr><td>n</td><td>Big number</td></tr></tbody></table><a name="FP16+xtr_pow2"></a><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fp16xtr_pow2">fP16.xtr_pow2()<a class="hash-link" href="#fp16xtr_pow2" title="Direct link to heading"></a></h3><p>Calculates FP16 trace of c^a.d^b, where c and d are derived from FP16 traces of FP16s</p><p><strong>Kind</strong>: instance method of <a href="#FP16"><code>FP16</code></a><br>
<strong>this</strong>: <code>{&quot;{&quot;}FP16{&quot;}&quot;}</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/fp12"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">FP12</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/cryptojs/fp24"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">FP24</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="#fp16" class="table-of-contents__link toc-highlight">FP16</a><ul><li><a href="#new-fp16" class="table-of-contents__link toc-highlight">new FP16()</a></li><li><a href="#fp16reduce" class="table-of-contents__link toc-highlight">fP16.reduce()</a></li><li><a href="#fp16norm" class="table-of-contents__link toc-highlight">fP16.norm()</a></li><li><a href="#fp16iszilch" class="table-of-contents__link toc-highlight">fP16.iszilch()</a></li><li><a href="#fp16isunity" class="table-of-contents__link toc-highlight">fP16.isunity()</a></li><li><a href="#fp16cmoveg-d" class="table-of-contents__link toc-highlight">fP16.cmove(g, d)</a></li><li><a href="#fp16isreal" class="table-of-contents__link toc-highlight">fP16.isreal()</a></li><li><a href="#fp16real" class="table-of-contents__link toc-highlight">fP16.real()</a></li><li><a href="#fp16geta" class="table-of-contents__link toc-highlight">fP16.geta()</a></li><li><a href="#fp16getb" class="table-of-contents__link toc-highlight">fP16.getb()</a></li><li><a href="#fp16equalsx" class="table-of-contents__link toc-highlight">fP16.equals(x)</a></li><li><a href="#fp16copyx" class="table-of-contents__link toc-highlight">fP16.copy(x)</a></li><li><a href="#fp16zero" class="table-of-contents__link toc-highlight">fP16.zero()</a></li><li><a href="#fp16onex" class="table-of-contents__link toc-highlight">fP16.one(x)</a></li><li><a href="#fp16setc-d" class="table-of-contents__link toc-highlight">fP16.set(c, d)</a></li><li><a href="#fp16setac" class="table-of-contents__link toc-highlight">fP16.seta(c)</a></li><li><a href="#fp16neg" class="table-of-contents__link toc-highlight">fP16.neg()</a></li><li><a href="#fp16conj" class="table-of-contents__link toc-highlight">fP16.conj()</a></li><li><a href="#fp16nconj" class="table-of-contents__link toc-highlight">fP16.nconj()</a></li><li><a href="#fp16addx" class="table-of-contents__link toc-highlight">fP16.add(x)</a></li><li><a href="#fp16subx" class="table-of-contents__link toc-highlight">fP16.sub(x)</a></li><li><a href="#fp16pmuls" class="table-of-contents__link toc-highlight">fP16.pmul(s)</a></li><li><a href="#fp16qmuls" class="table-of-contents__link toc-highlight">fP16.qmul(s)</a></li><li><a href="#fp16imuls" class="table-of-contents__link toc-highlight">fP16.imul(s)</a></li><li><a href="#fp16sqr" class="table-of-contents__link toc-highlight">fP16.sqr()</a></li><li><a href="#fp16muly" class="table-of-contents__link toc-highlight">fP16.mul(y)</a></li><li><a href="#fp16tostring" class="table-of-contents__link toc-highlight">fP16.toString()</a></li><li><a href="#fp16inverse" class="table-of-contents__link toc-highlight">fP16.inverse()</a></li><li><a href="#fp16times_i" class="table-of-contents__link toc-highlight">fP16.times_i()</a></li><li><a href="#fp16times_i2" class="table-of-contents__link toc-highlight">fP16.times_i2()</a></li><li><a href="#fp16times_i4" class="table-of-contents__link toc-highlight">fP16.times_i4()</a></li><li><a href="#fp16frobf" class="table-of-contents__link toc-highlight">fP16.frob(f)</a></li><li><a href="#fp16powe" class="table-of-contents__link toc-highlight">fP16.pow(e)</a></li><li><a href="#fp16xtr_aw-y-z" class="table-of-contents__link toc-highlight">fP16.xtr_A(w, y, z)</a></li><li><a href="#fp16xtr_d" class="table-of-contents__link toc-highlight">fP16.xtr_D()</a></li><li><a href="#fp16xtr_pown" class="table-of-contents__link toc-highlight">fP16.xtr_pow(n)</a></li><li><a href="#fp16xtr_pow2" class="table-of-contents__link toc-highlight">fP16.xtr_pow2()</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.b2dc6e47.js"></script>
<script src="/assets/js/main.8eab308a.js"></script>
</body>
</html>