blob: 352c9385675f49d1c00719998971363f95ebfa1f [file] [log] [blame]
<!-- HTML header for doxygen 1.8.10-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<title>Intel&reg; Enhanced Privacy ID SDK: epid/member/tiny/math/fq.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="epidstyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a
onclick="storeLink('index.html')"
id="projectlink"
class="index.html"
href="index.html">Intel&reg; Enhanced Privacy ID SDK</a>
&#160;<span id="projectnumber">6.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('fq_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fq.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Definition of Fq math.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stddef.h&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &quot;<a class="el" href="bitsupplier_8h.html">epid/common/bitsupplier.h</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aceb37a8f5538fe9ca682058ff0e36091"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#aceb37a8f5538fe9ca682058ff0e36091">FqInField</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:aceb37a8f5538fe9ca682058ff0e36091"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if an element is in Fq. <a href="#aceb37a8f5538fe9ca682058ff0e36091">More...</a><br /></td></tr>
<tr class="separator:aceb37a8f5538fe9ca682058ff0e36091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab52f69c761454d976c3fc56a26549419"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ab52f69c761454d976c3fc56a26549419">FqAdd</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *left, <a class="el" href="struct_fq_elem.html">FqElem</a> const *right)</td></tr>
<tr class="memdesc:ab52f69c761454d976c3fc56a26549419"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add two elements of Fq. <a href="#ab52f69c761454d976c3fc56a26549419">More...</a><br /></td></tr>
<tr class="separator:ab52f69c761454d976c3fc56a26549419"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5148f610202ae759aafb197cb52137f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a5148f610202ae759aafb197cb52137f1">FqSub</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *left, <a class="el" href="struct_fq_elem.html">FqElem</a> const *right)</td></tr>
<tr class="memdesc:a5148f610202ae759aafb197cb52137f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subtract two elements of Fq. <a href="#a5148f610202ae759aafb197cb52137f1">More...</a><br /></td></tr>
<tr class="separator:a5148f610202ae759aafb197cb52137f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0bf77a97fb3a12292886bef3abcf9bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ab0bf77a97fb3a12292886bef3abcf9bd">FqMul</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *left, <a class="el" href="struct_fq_elem.html">FqElem</a> const *right)</td></tr>
<tr class="memdesc:ab0bf77a97fb3a12292886bef3abcf9bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiply two elements of Fq. <a href="#ab0bf77a97fb3a12292886bef3abcf9bd">More...</a><br /></td></tr>
<tr class="separator:ab0bf77a97fb3a12292886bef3abcf9bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a276d3747aefdac5503982f2aa5eccbf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a276d3747aefdac5503982f2aa5eccbf8">FqExp</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *base, <a class="el" href="struct_very_large_int.html">VeryLargeInt</a> const *exp)</td></tr>
<tr class="memdesc:a276d3747aefdac5503982f2aa5eccbf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exponentiate an element of Fq by a large integer. <a href="#a276d3747aefdac5503982f2aa5eccbf8">More...</a><br /></td></tr>
<tr class="separator:a276d3747aefdac5503982f2aa5eccbf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17133e5b777baa8c745b7dfcf1c8ad8d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a17133e5b777baa8c745b7dfcf1c8ad8d">FqCp</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:a17133e5b777baa8c745b7dfcf1c8ad8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy an element's value. <a href="#a17133e5b777baa8c745b7dfcf1c8ad8d">More...</a><br /></td></tr>
<tr class="separator:a17133e5b777baa8c745b7dfcf1c8ad8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac08ca8c781cd18cbadabbeeb85722e49"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ac08ca8c781cd18cbadabbeeb85722e49">FqIsZero</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> const *value)</td></tr>
<tr class="memdesc:ac08ca8c781cd18cbadabbeeb85722e49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if an element is zero. <a href="#ac08ca8c781cd18cbadabbeeb85722e49">More...</a><br /></td></tr>
<tr class="separator:ac08ca8c781cd18cbadabbeeb85722e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b60a8996973d474d2fb7a31838c6d8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a7b60a8996973d474d2fb7a31838c6d8c">FqInv</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:a7b60a8996973d474d2fb7a31838c6d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert an element of Fq. <a href="#a7b60a8996973d474d2fb7a31838c6d8c">More...</a><br /></td></tr>
<tr class="separator:a7b60a8996973d474d2fb7a31838c6d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8379530cca959e7e36446b2979d8af4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ae8379530cca959e7e36446b2979d8af4">FqNeg</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:ae8379530cca959e7e36446b2979d8af4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Negate an element of Fq. <a href="#ae8379530cca959e7e36446b2979d8af4">More...</a><br /></td></tr>
<tr class="separator:ae8379530cca959e7e36446b2979d8af4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62c8f43f78a0c4f830c9ed65048b8f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ab62c8f43f78a0c4f830c9ed65048b8f9">FqSquare</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:ab62c8f43f78a0c4f830c9ed65048b8f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Square an element of Fq. <a href="#ab62c8f43f78a0c4f830c9ed65048b8f9">More...</a><br /></td></tr>
<tr class="separator:ab62c8f43f78a0c4f830c9ed65048b8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac85eb642d3b3973477749769e04d45af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ac85eb642d3b3973477749769e04d45af">FqClear</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result)</td></tr>
<tr class="memdesc:ac85eb642d3b3973477749769e04d45af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear an element's value. <a href="#ac85eb642d3b3973477749769e04d45af">More...</a><br /></td></tr>
<tr class="separator:ac85eb642d3b3973477749769e04d45af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab28f9df688a669a64dc04fa33f4cbb64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#ab28f9df688a669a64dc04fa33f4cbb64">FqSet</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, uint32_t in)</td></tr>
<tr class="memdesc:ab28f9df688a669a64dc04fa33f4cbb64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set an element's value. <a href="#ab28f9df688a669a64dc04fa33f4cbb64">More...</a><br /></td></tr>
<tr class="separator:ab28f9df688a669a64dc04fa33f4cbb64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd40d255e0094f7156092db44a3b90fa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#abd40d255e0094f7156092db44a3b90fa">FqEq</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> const *left, <a class="el" href="struct_fq_elem.html">FqElem</a> const *right)</td></tr>
<tr class="memdesc:abd40d255e0094f7156092db44a3b90fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if two elements in Fq are equal. <a href="#abd40d255e0094f7156092db44a3b90fa">More...</a><br /></td></tr>
<tr class="separator:abd40d255e0094f7156092db44a3b90fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbb0976ef343b14c66305db0a48647ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#afbb0976ef343b14c66305db0a48647ca">FqCondSet</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *true_val, <a class="el" href="struct_fq_elem.html">FqElem</a> const *false_val, int truth_val)</td></tr>
<tr class="memdesc:afbb0976ef343b14c66305db0a48647ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conditionally Set an element's value to one of two values. <a href="#afbb0976ef343b14c66305db0a48647ca">More...</a><br /></td></tr>
<tr class="separator:afbb0976ef343b14c66305db0a48647ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cbded46e28a1e6f641c5c0ae37fd744"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a0cbded46e28a1e6f641c5c0ae37fd744">FqSqrt</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="struct_fq_elem.html">FqElem</a> const *in)</td></tr>
<tr class="memdesc:a0cbded46e28a1e6f641c5c0ae37fd744"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the Square root of an element of Fq. <a href="#a0cbded46e28a1e6f641c5c0ae37fd744">More...</a><br /></td></tr>
<tr class="separator:a0cbded46e28a1e6f641c5c0ae37fd744"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5cc7d7d7640cd0bbcb635e95be3ed8a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a5cc7d7d7640cd0bbcb635e95be3ed8a3">FqRand</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, <a class="el" href="group___epid_common.html#ga6119a2c0323a3fca9e502b24bc378c2c">BitSupplier</a> rnd_func, void *rnd_param)</td></tr>
<tr class="memdesc:a5cc7d7d7640cd0bbcb635e95be3ed8a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random element of Fq. <a href="#a5cc7d7d7640cd0bbcb635e95be3ed8a3">More...</a><br /></td></tr>
<tr class="separator:a5cc7d7d7640cd0bbcb635e95be3ed8a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7794f72bcc506f8d8a60dbfae1a70ed0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fq_8h.html#a7794f72bcc506f8d8a60dbfae1a70ed0">FqFromHash</a> (<a class="el" href="struct_fq_elem.html">FqElem</a> *result, unsigned char const *hash, size_t len)</td></tr>
<tr class="memdesc:a7794f72bcc506f8d8a60dbfae1a70ed0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reinterpret a buffer as an element of Fq. <a href="#a7794f72bcc506f8d8a60dbfae1a70ed0">More...</a><br /></td></tr>
<tr class="separator:a7794f72bcc506f8d8a60dbfae1a70ed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Definition of Fq math. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ab52f69c761454d976c3fc56a26549419"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab52f69c761454d976c3fc56a26549419">&#9670;&nbsp;</a></span>FqAdd()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqAdd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add two elements of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of adding left and right. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be added. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be added. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac85eb642d3b3973477749769e04d45af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac85eb642d3b3973477749769e04d45af">&#9670;&nbsp;</a></span>FqClear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqClear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear an element's value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>element to clear. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afbb0976ef343b14c66305db0a48647ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbb0976ef343b14c66305db0a48647ca">&#9670;&nbsp;</a></span>FqCondSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqCondSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>true_val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>false_val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>truth_val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Conditionally Set an element's value to one of two values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">true_val</td><td>value to set if condition is true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">false_val</td><td>value to set if condition is false. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">truth_val</td><td>value of condition. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17133e5b777baa8c745b7dfcf1c8ad8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17133e5b777baa8c745b7dfcf1c8ad8d">&#9670;&nbsp;</a></span>FqCp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqCp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy an element's value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>copy target. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>copy source. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abd40d255e0094f7156092db44a3b90fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd40d255e0094f7156092db44a3b90fa">&#9670;&nbsp;</a></span>FqEq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FqEq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if two elements in Fq are equal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be tested. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be tested. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value different from zero (i.e., true) if indeed the values are equal. Zero (i.e., false) otherwise. </dd></dl>
</div>
</div>
<a id="a276d3747aefdac5503982f2aa5eccbf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a276d3747aefdac5503982f2aa5eccbf8">&#9670;&nbsp;</a></span>FqExp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqExp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_very_large_int.html">VeryLargeInt</a> const *&#160;</td>
<td class="paramname"><em>exp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Exponentiate an element of Fq by a large integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">base</td><td>the base. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">exp</td><td>the exponent. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7794f72bcc506f8d8a60dbfae1a70ed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7794f72bcc506f8d8a60dbfae1a70ed0">&#9670;&nbsp;</a></span>FqFromHash()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqFromHash </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char const *&#160;</td>
<td class="paramname"><em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reinterpret a buffer as an element of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hash</td><td>buffer to reinterpret. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of hash in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aceb37a8f5538fe9ca682058ff0e36091"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceb37a8f5538fe9ca682058ff0e36091">&#9670;&nbsp;</a></span>FqInField()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FqInField </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if an element is in Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value different from zero (i.e., true) indeed the value is in the field. Zero (i.e., false) otherwise. </dd></dl>
</div>
</div>
<a id="a7b60a8996973d474d2fb7a31838c6d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b60a8996973d474d2fb7a31838c6d8c">&#9670;&nbsp;</a></span>FqInv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqInv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invert an element of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the inverse of the element. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to invert. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac08ca8c781cd18cbadabbeeb85722e49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac08ca8c781cd18cbadabbeeb85722e49">&#9670;&nbsp;</a></span>FqIsZero()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FqIsZero </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if an element is zero. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>the element to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value different from zero (i.e., true) if indeed the value is zero. Zero (i.e., false) otherwise. </dd></dl>
</div>
</div>
<a id="ab0bf77a97fb3a12292886bef3abcf9bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0bf77a97fb3a12292886bef3abcf9bd">&#9670;&nbsp;</a></span>FqMul()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqMul </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Multiply two elements of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of multiplying left and right. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be multiplied. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be multiplied. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8379530cca959e7e36446b2979d8af4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8379530cca959e7e36446b2979d8af4">&#9670;&nbsp;</a></span>FqNeg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqNeg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Negate an element of Fq. </p>
<p>This function was formerly called as FqConst.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the negative of the element. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to negate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5cc7d7d7640cd0bbcb635e95be3ed8a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5cc7d7d7640cd0bbcb635e95be3ed8a3">&#9670;&nbsp;</a></span>FqRand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FqRand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___epid_common.html#ga6119a2c0323a3fca9e502b24bc378c2c">BitSupplier</a>&#160;</td>
<td class="paramname"><em>rnd_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>rnd_param</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate a random element of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>the random value. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rnd_func</td><td>Random number generator. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rnd_param</td><td>Pass through context data for rnd_func. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value different from zero (i.e., true) if on success. Zero (i.e., false) otherwise. </dd></dl>
</div>
</div>
<a id="ab28f9df688a669a64dc04fa33f4cbb64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab28f9df688a669a64dc04fa33f4cbb64">&#9670;&nbsp;</a></span>FqSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set an element's value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>value to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0cbded46e28a1e6f641c5c0ae37fd744"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cbded46e28a1e6f641c5c0ae37fd744">&#9670;&nbsp;</a></span>FqSqrt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int FqSqrt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the Square root of an element of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the square root of the element. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to find the square root of. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A value different from zero (i.e., true) if the square root exists. Zero (i.e., false) otherwise. </dd></dl>
</div>
</div>
<a id="ab62c8f43f78a0c4f830c9ed65048b8f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab62c8f43f78a0c4f830c9ed65048b8f9">&#9670;&nbsp;</a></span>FqSquare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqSquare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Square an element of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the square of the element. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to square. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5148f610202ae759aafb197cb52137f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5148f610202ae759aafb197cb52137f1">&#9670;&nbsp;</a></span>FqSub()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FqSub </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>left</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
<td class="paramname"><em>right</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subtract two elements of Fq. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of subtracting left from right. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The operand to be subtracted from. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The operand to subtract. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.10-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_12b90d9c027aaf878a834df729679a56.html">epid</a></li><li class="navelem"><a class="el" href="dir_512d3e62841a8535b716ec4cf8b9e950.html">member</a></li><li class="navelem"><a class="el" href="dir_ea12d375fc1eb79df248c0adf953af4f.html">tiny</a></li><li class="navelem"><a class="el" href="dir_5f2fc2cf41db41de2b55e03ffa7a1d16.html">math</a></li><li class="navelem"><a class="el" href="fq_8h.html">fq.h</a></li>
<li class="footer">
&copy; 2016-2017 Intel Corporation
</li>
</ul>
</div>
</body>
</html>