• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!-- HTML header for doxygen 1.8.10-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.14"/>
8<title>Intel&reg; Enhanced Privacy ID SDK: epid/member/tiny/math/fq.h File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
18  $(document).ready(initResizable);
19/* @license-end */</script>
20<link href="doxygen.css" rel="stylesheet" type="text/css" />
21<link href="epidstyle.css" rel="stylesheet" type="text/css"/>
22</head>
23<body>
24<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
25<div id="titlearea">
26<table cellspacing="0" cellpadding="0">
27 <tbody>
28 <tr style="height: 56px;">
29  <td id="projectalign" style="padding-left: 0.5em;">
30   <div id="projectname"><a
31                            onclick="storeLink('index.html')"
32                            id="projectlink"
33                            class="index.html"
34                            href="index.html">Intel&reg; Enhanced Privacy ID SDK</a>
35&#160;<span id="projectnumber">6.0.1</span>
36</div>
37  </td>
38 </tr>
39 </tbody>
40</table>
41</div>
42<!-- end header part -->
43<!-- Generated by Doxygen 1.8.14 -->
44</div><!-- top -->
45<div id="side-nav" class="ui-resizable side-nav-resizable">
46  <div id="nav-tree">
47    <div id="nav-tree-contents">
48      <div id="nav-sync" class="sync"></div>
49    </div>
50  </div>
51  <div id="splitbar" style="-moz-user-select:none;"
52       class="ui-resizable-handle">
53  </div>
54</div>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(document).ready(function(){initNavTree('fq_8h.html','');});
58/* @license-end */
59</script>
60<div id="doc-content">
61<div class="header">
62  <div class="summary">
63<a href="#func-members">Functions</a>  </div>
64  <div class="headertitle">
65<div class="title">fq.h File Reference</div>  </div>
66</div><!--header-->
67<div class="contents">
68
69<p>Definition of Fq math.
70<a href="#details">More...</a></p>
71<div class="textblock"><code>#include &lt;stddef.h&gt;</code><br />
72<code>#include &lt;stdint.h&gt;</code><br />
73<code>#include &quot;<a class="el" href="bitsupplier_8h.html">epid/common/bitsupplier.h</a>&quot;</code><br />
74</div><table class="memberdecls">
75<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
76Functions</h2></td></tr>
77<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>
78<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>
79<tr class="separator:aceb37a8f5538fe9ca682058ff0e36091"><td class="memSeparator" colspan="2">&#160;</td></tr>
80<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>
81<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>
82<tr class="separator:ab52f69c761454d976c3fc56a26549419"><td class="memSeparator" colspan="2">&#160;</td></tr>
83<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>
84<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>
85<tr class="separator:a5148f610202ae759aafb197cb52137f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
86<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>
87<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>
88<tr class="separator:ab0bf77a97fb3a12292886bef3abcf9bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
89<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>
90<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>
91<tr class="separator:a276d3747aefdac5503982f2aa5eccbf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
92<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>
93<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>
94<tr class="separator:a17133e5b777baa8c745b7dfcf1c8ad8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
95<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>
96<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>
97<tr class="separator:ac08ca8c781cd18cbadabbeeb85722e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
98<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>
99<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>
100<tr class="separator:a7b60a8996973d474d2fb7a31838c6d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<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>
102<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>
103<tr class="separator:ae8379530cca959e7e36446b2979d8af4"><td class="memSeparator" colspan="2">&#160;</td></tr>
104<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>
105<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>
106<tr class="separator:ab62c8f43f78a0c4f830c9ed65048b8f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
107<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>
108<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>
109<tr class="separator:ac85eb642d3b3973477749769e04d45af"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<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>
111<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>
112<tr class="separator:ab28f9df688a669a64dc04fa33f4cbb64"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<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>
114<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>
115<tr class="separator:abd40d255e0094f7156092db44a3b90fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
116<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>
117<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>
118<tr class="separator:afbb0976ef343b14c66305db0a48647ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<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>
120<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>
121<tr class="separator:a0cbded46e28a1e6f641c5c0ae37fd744"><td class="memSeparator" colspan="2">&#160;</td></tr>
122<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>
123<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>
124<tr class="separator:a5cc7d7d7640cd0bbcb635e95be3ed8a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<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>
126<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>
127<tr class="separator:a7794f72bcc506f8d8a60dbfae1a70ed0"><td class="memSeparator" colspan="2">&#160;</td></tr>
128</table>
129<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130<div class="textblock"><p>Definition of Fq math. </p>
131</div><h2 class="groupheader">Function Documentation</h2>
132<a id="ab52f69c761454d976c3fc56a26549419"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#ab52f69c761454d976c3fc56a26549419">&#9670;&nbsp;</a></span>FqAdd()</h2>
134
135<div class="memitem">
136<div class="memproto">
137      <table class="memname">
138        <tr>
139          <td class="memname">void FqAdd </td>
140          <td>(</td>
141          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
142          <td class="paramname"><em>result</em>, </td>
143        </tr>
144        <tr>
145          <td class="paramkey"></td>
146          <td></td>
147          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
148          <td class="paramname"><em>left</em>, </td>
149        </tr>
150        <tr>
151          <td class="paramkey"></td>
152          <td></td>
153          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
154          <td class="paramname"><em>right</em>&#160;</td>
155        </tr>
156        <tr>
157          <td></td>
158          <td>)</td>
159          <td></td><td></td>
160        </tr>
161      </table>
162</div><div class="memdoc">
163
164<p>Add two elements of Fq. </p>
165<dl class="params"><dt>Parameters</dt><dd>
166  <table class="params">
167    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of adding left and right. </td></tr>
168    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be added. </td></tr>
169    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be added. </td></tr>
170  </table>
171  </dd>
172</dl>
173
174</div>
175</div>
176<a id="ac85eb642d3b3973477749769e04d45af"></a>
177<h2 class="memtitle"><span class="permalink"><a href="#ac85eb642d3b3973477749769e04d45af">&#9670;&nbsp;</a></span>FqClear()</h2>
178
179<div class="memitem">
180<div class="memproto">
181      <table class="memname">
182        <tr>
183          <td class="memname">void FqClear </td>
184          <td>(</td>
185          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
186          <td class="paramname"><em>result</em></td><td>)</td>
187          <td></td>
188        </tr>
189      </table>
190</div><div class="memdoc">
191
192<p>Clear an element's value. </p>
193<dl class="params"><dt>Parameters</dt><dd>
194  <table class="params">
195    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>element to clear. </td></tr>
196  </table>
197  </dd>
198</dl>
199
200</div>
201</div>
202<a id="afbb0976ef343b14c66305db0a48647ca"></a>
203<h2 class="memtitle"><span class="permalink"><a href="#afbb0976ef343b14c66305db0a48647ca">&#9670;&nbsp;</a></span>FqCondSet()</h2>
204
205<div class="memitem">
206<div class="memproto">
207      <table class="memname">
208        <tr>
209          <td class="memname">void FqCondSet </td>
210          <td>(</td>
211          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
212          <td class="paramname"><em>result</em>, </td>
213        </tr>
214        <tr>
215          <td class="paramkey"></td>
216          <td></td>
217          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
218          <td class="paramname"><em>true_val</em>, </td>
219        </tr>
220        <tr>
221          <td class="paramkey"></td>
222          <td></td>
223          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
224          <td class="paramname"><em>false_val</em>, </td>
225        </tr>
226        <tr>
227          <td class="paramkey"></td>
228          <td></td>
229          <td class="paramtype">int&#160;</td>
230          <td class="paramname"><em>truth_val</em>&#160;</td>
231        </tr>
232        <tr>
233          <td></td>
234          <td>)</td>
235          <td></td><td></td>
236        </tr>
237      </table>
238</div><div class="memdoc">
239
240<p>Conditionally Set an element's value to one of two values. </p>
241<dl class="params"><dt>Parameters</dt><dd>
242  <table class="params">
243    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
244    <tr><td class="paramdir">[in]</td><td class="paramname">true_val</td><td>value to set if condition is true. </td></tr>
245    <tr><td class="paramdir">[in]</td><td class="paramname">false_val</td><td>value to set if condition is false. </td></tr>
246    <tr><td class="paramdir">[in]</td><td class="paramname">truth_val</td><td>value of condition. </td></tr>
247  </table>
248  </dd>
249</dl>
250
251</div>
252</div>
253<a id="a17133e5b777baa8c745b7dfcf1c8ad8d"></a>
254<h2 class="memtitle"><span class="permalink"><a href="#a17133e5b777baa8c745b7dfcf1c8ad8d">&#9670;&nbsp;</a></span>FqCp()</h2>
255
256<div class="memitem">
257<div class="memproto">
258      <table class="memname">
259        <tr>
260          <td class="memname">void FqCp </td>
261          <td>(</td>
262          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
263          <td class="paramname"><em>result</em>, </td>
264        </tr>
265        <tr>
266          <td class="paramkey"></td>
267          <td></td>
268          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
269          <td class="paramname"><em>in</em>&#160;</td>
270        </tr>
271        <tr>
272          <td></td>
273          <td>)</td>
274          <td></td><td></td>
275        </tr>
276      </table>
277</div><div class="memdoc">
278
279<p>Copy an element's value. </p>
280<dl class="params"><dt>Parameters</dt><dd>
281  <table class="params">
282    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>copy target. </td></tr>
283    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>copy source. </td></tr>
284  </table>
285  </dd>
286</dl>
287
288</div>
289</div>
290<a id="abd40d255e0094f7156092db44a3b90fa"></a>
291<h2 class="memtitle"><span class="permalink"><a href="#abd40d255e0094f7156092db44a3b90fa">&#9670;&nbsp;</a></span>FqEq()</h2>
292
293<div class="memitem">
294<div class="memproto">
295      <table class="memname">
296        <tr>
297          <td class="memname">int FqEq </td>
298          <td>(</td>
299          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
300          <td class="paramname"><em>left</em>, </td>
301        </tr>
302        <tr>
303          <td class="paramkey"></td>
304          <td></td>
305          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
306          <td class="paramname"><em>right</em>&#160;</td>
307        </tr>
308        <tr>
309          <td></td>
310          <td>)</td>
311          <td></td><td></td>
312        </tr>
313      </table>
314</div><div class="memdoc">
315
316<p>Test if two elements in Fq are equal. </p>
317<dl class="params"><dt>Parameters</dt><dd>
318  <table class="params">
319    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be tested. </td></tr>
320    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be tested. </td></tr>
321  </table>
322  </dd>
323</dl>
324<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>
325
326</div>
327</div>
328<a id="a276d3747aefdac5503982f2aa5eccbf8"></a>
329<h2 class="memtitle"><span class="permalink"><a href="#a276d3747aefdac5503982f2aa5eccbf8">&#9670;&nbsp;</a></span>FqExp()</h2>
330
331<div class="memitem">
332<div class="memproto">
333      <table class="memname">
334        <tr>
335          <td class="memname">void FqExp </td>
336          <td>(</td>
337          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
338          <td class="paramname"><em>result</em>, </td>
339        </tr>
340        <tr>
341          <td class="paramkey"></td>
342          <td></td>
343          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
344          <td class="paramname"><em>base</em>, </td>
345        </tr>
346        <tr>
347          <td class="paramkey"></td>
348          <td></td>
349          <td class="paramtype"><a class="el" href="struct_very_large_int.html">VeryLargeInt</a> const *&#160;</td>
350          <td class="paramname"><em>exp</em>&#160;</td>
351        </tr>
352        <tr>
353          <td></td>
354          <td>)</td>
355          <td></td><td></td>
356        </tr>
357      </table>
358</div><div class="memdoc">
359
360<p>Exponentiate an element of Fq by a large integer. </p>
361<dl class="params"><dt>Parameters</dt><dd>
362  <table class="params">
363    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
364    <tr><td class="paramdir">[in]</td><td class="paramname">base</td><td>the base. </td></tr>
365    <tr><td class="paramdir">[in]</td><td class="paramname">exp</td><td>the exponent. </td></tr>
366  </table>
367  </dd>
368</dl>
369
370</div>
371</div>
372<a id="a7794f72bcc506f8d8a60dbfae1a70ed0"></a>
373<h2 class="memtitle"><span class="permalink"><a href="#a7794f72bcc506f8d8a60dbfae1a70ed0">&#9670;&nbsp;</a></span>FqFromHash()</h2>
374
375<div class="memitem">
376<div class="memproto">
377      <table class="memname">
378        <tr>
379          <td class="memname">void FqFromHash </td>
380          <td>(</td>
381          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
382          <td class="paramname"><em>result</em>, </td>
383        </tr>
384        <tr>
385          <td class="paramkey"></td>
386          <td></td>
387          <td class="paramtype">unsigned char const *&#160;</td>
388          <td class="paramname"><em>hash</em>, </td>
389        </tr>
390        <tr>
391          <td class="paramkey"></td>
392          <td></td>
393          <td class="paramtype">size_t&#160;</td>
394          <td class="paramname"><em>len</em>&#160;</td>
395        </tr>
396        <tr>
397          <td></td>
398          <td>)</td>
399          <td></td><td></td>
400        </tr>
401      </table>
402</div><div class="memdoc">
403
404<p>Reinterpret a buffer as an element of Fq. </p>
405<dl class="params"><dt>Parameters</dt><dd>
406  <table class="params">
407    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
408    <tr><td class="paramdir">[in]</td><td class="paramname">hash</td><td>buffer to reinterpret. </td></tr>
409    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>length of hash in bytes. </td></tr>
410  </table>
411  </dd>
412</dl>
413
414</div>
415</div>
416<a id="aceb37a8f5538fe9ca682058ff0e36091"></a>
417<h2 class="memtitle"><span class="permalink"><a href="#aceb37a8f5538fe9ca682058ff0e36091">&#9670;&nbsp;</a></span>FqInField()</h2>
418
419<div class="memitem">
420<div class="memproto">
421      <table class="memname">
422        <tr>
423          <td class="memname">int FqInField </td>
424          <td>(</td>
425          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
426          <td class="paramname"><em>in</em></td><td>)</td>
427          <td></td>
428        </tr>
429      </table>
430</div><div class="memdoc">
431
432<p>Test if an element is in Fq. </p>
433<dl class="params"><dt>Parameters</dt><dd>
434  <table class="params">
435    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to test. </td></tr>
436  </table>
437  </dd>
438</dl>
439<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>
440
441</div>
442</div>
443<a id="a7b60a8996973d474d2fb7a31838c6d8c"></a>
444<h2 class="memtitle"><span class="permalink"><a href="#a7b60a8996973d474d2fb7a31838c6d8c">&#9670;&nbsp;</a></span>FqInv()</h2>
445
446<div class="memitem">
447<div class="memproto">
448      <table class="memname">
449        <tr>
450          <td class="memname">void FqInv </td>
451          <td>(</td>
452          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
453          <td class="paramname"><em>result</em>, </td>
454        </tr>
455        <tr>
456          <td class="paramkey"></td>
457          <td></td>
458          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
459          <td class="paramname"><em>in</em>&#160;</td>
460        </tr>
461        <tr>
462          <td></td>
463          <td>)</td>
464          <td></td><td></td>
465        </tr>
466      </table>
467</div><div class="memdoc">
468
469<p>Invert an element of Fq. </p>
470<dl class="params"><dt>Parameters</dt><dd>
471  <table class="params">
472    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the inverse of the element. </td></tr>
473    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to invert. </td></tr>
474  </table>
475  </dd>
476</dl>
477
478</div>
479</div>
480<a id="ac08ca8c781cd18cbadabbeeb85722e49"></a>
481<h2 class="memtitle"><span class="permalink"><a href="#ac08ca8c781cd18cbadabbeeb85722e49">&#9670;&nbsp;</a></span>FqIsZero()</h2>
482
483<div class="memitem">
484<div class="memproto">
485      <table class="memname">
486        <tr>
487          <td class="memname">int FqIsZero </td>
488          <td>(</td>
489          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
490          <td class="paramname"><em>value</em></td><td>)</td>
491          <td></td>
492        </tr>
493      </table>
494</div><div class="memdoc">
495
496<p>Test if an element is zero. </p>
497<dl class="params"><dt>Parameters</dt><dd>
498  <table class="params">
499    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>the element to test. </td></tr>
500  </table>
501  </dd>
502</dl>
503<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>
504
505</div>
506</div>
507<a id="ab0bf77a97fb3a12292886bef3abcf9bd"></a>
508<h2 class="memtitle"><span class="permalink"><a href="#ab0bf77a97fb3a12292886bef3abcf9bd">&#9670;&nbsp;</a></span>FqMul()</h2>
509
510<div class="memitem">
511<div class="memproto">
512      <table class="memname">
513        <tr>
514          <td class="memname">void FqMul </td>
515          <td>(</td>
516          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
517          <td class="paramname"><em>result</em>, </td>
518        </tr>
519        <tr>
520          <td class="paramkey"></td>
521          <td></td>
522          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
523          <td class="paramname"><em>left</em>, </td>
524        </tr>
525        <tr>
526          <td class="paramkey"></td>
527          <td></td>
528          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
529          <td class="paramname"><em>right</em>&#160;</td>
530        </tr>
531        <tr>
532          <td></td>
533          <td>)</td>
534          <td></td><td></td>
535        </tr>
536      </table>
537</div><div class="memdoc">
538
539<p>Multiply two elements of Fq. </p>
540<dl class="params"><dt>Parameters</dt><dd>
541  <table class="params">
542    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of multiplying left and right. </td></tr>
543    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The first operand to be multiplied. </td></tr>
544    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The second operand to be multiplied. </td></tr>
545  </table>
546  </dd>
547</dl>
548
549</div>
550</div>
551<a id="ae8379530cca959e7e36446b2979d8af4"></a>
552<h2 class="memtitle"><span class="permalink"><a href="#ae8379530cca959e7e36446b2979d8af4">&#9670;&nbsp;</a></span>FqNeg()</h2>
553
554<div class="memitem">
555<div class="memproto">
556      <table class="memname">
557        <tr>
558          <td class="memname">void FqNeg </td>
559          <td>(</td>
560          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
561          <td class="paramname"><em>result</em>, </td>
562        </tr>
563        <tr>
564          <td class="paramkey"></td>
565          <td></td>
566          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
567          <td class="paramname"><em>in</em>&#160;</td>
568        </tr>
569        <tr>
570          <td></td>
571          <td>)</td>
572          <td></td><td></td>
573        </tr>
574      </table>
575</div><div class="memdoc">
576
577<p>Negate an element of Fq. </p>
578<p>This function was formerly called as FqConst.</p>
579<dl class="params"><dt>Parameters</dt><dd>
580  <table class="params">
581    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the negative of the element. </td></tr>
582    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to negate. </td></tr>
583  </table>
584  </dd>
585</dl>
586
587</div>
588</div>
589<a id="a5cc7d7d7640cd0bbcb635e95be3ed8a3"></a>
590<h2 class="memtitle"><span class="permalink"><a href="#a5cc7d7d7640cd0bbcb635e95be3ed8a3">&#9670;&nbsp;</a></span>FqRand()</h2>
591
592<div class="memitem">
593<div class="memproto">
594      <table class="memname">
595        <tr>
596          <td class="memname">int FqRand </td>
597          <td>(</td>
598          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
599          <td class="paramname"><em>result</em>, </td>
600        </tr>
601        <tr>
602          <td class="paramkey"></td>
603          <td></td>
604          <td class="paramtype"><a class="el" href="group___epid_common.html#ga6119a2c0323a3fca9e502b24bc378c2c">BitSupplier</a>&#160;</td>
605          <td class="paramname"><em>rnd_func</em>, </td>
606        </tr>
607        <tr>
608          <td class="paramkey"></td>
609          <td></td>
610          <td class="paramtype">void *&#160;</td>
611          <td class="paramname"><em>rnd_param</em>&#160;</td>
612        </tr>
613        <tr>
614          <td></td>
615          <td>)</td>
616          <td></td><td></td>
617        </tr>
618      </table>
619</div><div class="memdoc">
620
621<p>Generate a random element of Fq. </p>
622<dl class="params"><dt>Parameters</dt><dd>
623  <table class="params">
624    <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>the random value. </td></tr>
625    <tr><td class="paramdir">[in]</td><td class="paramname">rnd_func</td><td>Random number generator. </td></tr>
626    <tr><td class="paramdir">[in]</td><td class="paramname">rnd_param</td><td>Pass through context data for rnd_func. </td></tr>
627  </table>
628  </dd>
629</dl>
630<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>
631
632</div>
633</div>
634<a id="ab28f9df688a669a64dc04fa33f4cbb64"></a>
635<h2 class="memtitle"><span class="permalink"><a href="#ab28f9df688a669a64dc04fa33f4cbb64">&#9670;&nbsp;</a></span>FqSet()</h2>
636
637<div class="memitem">
638<div class="memproto">
639      <table class="memname">
640        <tr>
641          <td class="memname">void FqSet </td>
642          <td>(</td>
643          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
644          <td class="paramname"><em>result</em>, </td>
645        </tr>
646        <tr>
647          <td class="paramkey"></td>
648          <td></td>
649          <td class="paramtype">uint32_t&#160;</td>
650          <td class="paramname"><em>in</em>&#160;</td>
651        </tr>
652        <tr>
653          <td></td>
654          <td>)</td>
655          <td></td><td></td>
656        </tr>
657      </table>
658</div><div class="memdoc">
659
660<p>Set an element's value. </p>
661<dl class="params"><dt>Parameters</dt><dd>
662  <table class="params">
663    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>target. </td></tr>
664    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>value to set. </td></tr>
665  </table>
666  </dd>
667</dl>
668
669</div>
670</div>
671<a id="a0cbded46e28a1e6f641c5c0ae37fd744"></a>
672<h2 class="memtitle"><span class="permalink"><a href="#a0cbded46e28a1e6f641c5c0ae37fd744">&#9670;&nbsp;</a></span>FqSqrt()</h2>
673
674<div class="memitem">
675<div class="memproto">
676      <table class="memname">
677        <tr>
678          <td class="memname">int FqSqrt </td>
679          <td>(</td>
680          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
681          <td class="paramname"><em>result</em>, </td>
682        </tr>
683        <tr>
684          <td class="paramkey"></td>
685          <td></td>
686          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
687          <td class="paramname"><em>in</em>&#160;</td>
688        </tr>
689        <tr>
690          <td></td>
691          <td>)</td>
692          <td></td><td></td>
693        </tr>
694      </table>
695</div><div class="memdoc">
696
697<p>Compute the Square root of an element of Fq. </p>
698<dl class="params"><dt>Parameters</dt><dd>
699  <table class="params">
700    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the square root of the element. </td></tr>
701    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to find the square root of. </td></tr>
702  </table>
703  </dd>
704</dl>
705<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>
706
707</div>
708</div>
709<a id="ab62c8f43f78a0c4f830c9ed65048b8f9"></a>
710<h2 class="memtitle"><span class="permalink"><a href="#ab62c8f43f78a0c4f830c9ed65048b8f9">&#9670;&nbsp;</a></span>FqSquare()</h2>
711
712<div class="memitem">
713<div class="memproto">
714      <table class="memname">
715        <tr>
716          <td class="memname">void FqSquare </td>
717          <td>(</td>
718          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
719          <td class="paramname"><em>result</em>, </td>
720        </tr>
721        <tr>
722          <td class="paramkey"></td>
723          <td></td>
724          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
725          <td class="paramname"><em>in</em>&#160;</td>
726        </tr>
727        <tr>
728          <td></td>
729          <td>)</td>
730          <td></td><td></td>
731        </tr>
732      </table>
733</div><div class="memdoc">
734
735<p>Square an element of Fq. </p>
736<dl class="params"><dt>Parameters</dt><dd>
737  <table class="params">
738    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>the square of the element. </td></tr>
739    <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>the element to square. </td></tr>
740  </table>
741  </dd>
742</dl>
743
744</div>
745</div>
746<a id="a5148f610202ae759aafb197cb52137f1"></a>
747<h2 class="memtitle"><span class="permalink"><a href="#a5148f610202ae759aafb197cb52137f1">&#9670;&nbsp;</a></span>FqSub()</h2>
748
749<div class="memitem">
750<div class="memproto">
751      <table class="memname">
752        <tr>
753          <td class="memname">void FqSub </td>
754          <td>(</td>
755          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> *&#160;</td>
756          <td class="paramname"><em>result</em>, </td>
757        </tr>
758        <tr>
759          <td class="paramkey"></td>
760          <td></td>
761          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
762          <td class="paramname"><em>left</em>, </td>
763        </tr>
764        <tr>
765          <td class="paramkey"></td>
766          <td></td>
767          <td class="paramtype"><a class="el" href="struct_fq_elem.html">FqElem</a> const *&#160;</td>
768          <td class="paramname"><em>right</em>&#160;</td>
769        </tr>
770        <tr>
771          <td></td>
772          <td>)</td>
773          <td></td><td></td>
774        </tr>
775      </table>
776</div><div class="memdoc">
777
778<p>Subtract two elements of Fq. </p>
779<dl class="params"><dt>Parameters</dt><dd>
780  <table class="params">
781    <tr><td class="paramdir">[out]</td><td class="paramname">result</td><td>of subtracting left from right. </td></tr>
782    <tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The operand to be subtracted from. </td></tr>
783    <tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The operand to subtract. </td></tr>
784  </table>
785  </dd>
786</dl>
787
788</div>
789</div>
790</div><!-- contents -->
791</div><!-- doc-content -->
792<!-- HTML footer for doxygen 1.8.10-->
793<!-- start footer part -->
794<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
795  <ul>
796    <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>
797    <li class="footer">
798      &copy; 2016-2017 Intel Corporation
799    </li>
800  </ul>
801</div>
802</body>
803</html>
804