group___big_num_primitives.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  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.11"/>
  8. <title>Intel&reg; Enhanced Privacy ID SDK: bignum</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. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </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">2.0.0</span>
  36. </div>
  37. </td>
  38. </tr>
  39. </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.11 -->
  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. $(document).ready(function(){initNavTree('group___big_num_primitives.html','');});
  57. </script>
  58. <div id="doc-content">
  59. <div class="header">
  60. <div class="summary">
  61. <a href="#typedef-members">Typedefs</a> &#124;
  62. <a href="#func-members">Functions</a> </div>
  63. <div class="headertitle">
  64. <div class="title">bignum<div class="ingroups"><a class="el" href="group___epid_module.html">epid</a> &raquo; <a class="el" href="group___epid_common.html">common</a> &raquo; <a class="el" href="group___epid_math.html">math</a></div></div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <p>Big number operations.
  68. <a href="#details">More...</a></p>
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  71. Typedefs</h2></td></tr>
  72. <tr class="memitem:ga2bf153e27be2683f0fb26f0f7ff1f718"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2bf153e27be2683f0fb26f0f7ff1f718"></a>
  73. typedef struct <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a></td></tr>
  74. <tr class="memdesc:ga2bf153e27be2683f0fb26f0f7ff1f718"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal representation of large numbers. <br /></td></tr>
  75. <tr class="separator:ga2bf153e27be2683f0fb26f0f7ff1f718"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:gad5f6f262bfd780fed3678bcee16f0aed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#gad5f6f262bfd780fed3678bcee16f0aed">NewBigNum</a> (size_t data_size_bytes, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> **bignum)</td></tr>
  80. <tr class="memdesc:gad5f6f262bfd780fed3678bcee16f0aed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new BigNum. <a href="#gad5f6f262bfd780fed3678bcee16f0aed">More...</a><br /></td></tr>
  81. <tr class="separator:gad5f6f262bfd780fed3678bcee16f0aed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga2d17600068b1d94000635c6644258a03"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga2d17600068b1d94000635c6644258a03">DeleteBigNum</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> **bignum)</td></tr>
  83. <tr class="memdesc:ga2d17600068b1d94000635c6644258a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes a previously allocated BigNum. <a href="#ga2d17600068b1d94000635c6644258a03">More...</a><br /></td></tr>
  84. <tr class="separator:ga2d17600068b1d94000635c6644258a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ga808cf477b70ed06358b11756bfe36024"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga808cf477b70ed06358b11756bfe36024">ReadBigNum</a> (void const *bn_str, size_t strlen, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *bn)</td></tr>
  86. <tr class="memdesc:ga808cf477b70ed06358b11756bfe36024"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes a BigNum from a string. <a href="#ga808cf477b70ed06358b11756bfe36024">More...</a><br /></td></tr>
  87. <tr class="separator:ga808cf477b70ed06358b11756bfe36024"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga47f356d816bcb5742ba6d78000861328"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga47f356d816bcb5742ba6d78000861328">WriteBigNum</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *bn, size_t strlen, void const *bn_str)</td></tr>
  89. <tr class="memdesc:ga47f356d816bcb5742ba6d78000861328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a BigNum to a string. <a href="#ga47f356d816bcb5742ba6d78000861328">More...</a><br /></td></tr>
  90. <tr class="separator:ga47f356d816bcb5742ba6d78000861328"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gae70fd9b3026f0ab3c7e9601d0a3186b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#gae70fd9b3026f0ab3c7e9601d0a3186b8">BigNumAdd</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *a, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *b, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *r)</td></tr>
  92. <tr class="memdesc:gae70fd9b3026f0ab3c7e9601d0a3186b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds two BigNum values. <a href="#gae70fd9b3026f0ab3c7e9601d0a3186b8">More...</a><br /></td></tr>
  93. <tr class="separator:gae70fd9b3026f0ab3c7e9601d0a3186b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:gacbec9669ab0fe768e2be74dcaca397ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#gacbec9669ab0fe768e2be74dcaca397ea">BigNumSub</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *a, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *b, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *r)</td></tr>
  95. <tr class="memdesc:gacbec9669ab0fe768e2be74dcaca397ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subtracts two BigNum values. <a href="#gacbec9669ab0fe768e2be74dcaca397ea">More...</a><br /></td></tr>
  96. <tr class="separator:gacbec9669ab0fe768e2be74dcaca397ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ga03c89b8b8dd87de2c0f4b5822145d317"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga03c89b8b8dd87de2c0f4b5822145d317">BigNumMul</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *a, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *b, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *r)</td></tr>
  98. <tr class="memdesc:ga03c89b8b8dd87de2c0f4b5822145d317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Multiplies two BigNum values. <a href="#ga03c89b8b8dd87de2c0f4b5822145d317">More...</a><br /></td></tr>
  99. <tr class="separator:ga03c89b8b8dd87de2c0f4b5822145d317"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga7dd6038987210d10bf843602fef0c929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___big_num_primitives.html#ga7dd6038987210d10bf843602fef0c929">BigNumMod</a> (<a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *a, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *b, <a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *r)</td></tr>
  101. <tr class="memdesc:ga7dd6038987210d10bf843602fef0c929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes modular reduction for BigNum value by specified modulus. <a href="#ga7dd6038987210d10bf843602fef0c929">More...</a><br /></td></tr>
  102. <tr class="separator:ga7dd6038987210d10bf843602fef0c929"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table>
  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  105. <p>Big number operations. </p>
  106. <p>This module provides an API for working with large numbers. BigNums represent non-negative integers.</p>
  107. <p>Each BigNum variable represents a number of a byte-size set when the variable was created. BigNum variables cannot be re-sized after they are created. </p>
  108. <h2 class="groupheader">Function Documentation</h2>
  109. <a class="anchor" id="gae70fd9b3026f0ab3c7e9601d0a3186b8"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> BigNumAdd </td>
  115. <td>(</td>
  116. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  117. <td class="paramname"><em>a</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  123. <td class="paramname"><em>b</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *&#160;</td>
  129. <td class="paramname"><em>r</em>&#160;</td>
  130. </tr>
  131. <tr>
  132. <td></td>
  133. <td>)</td>
  134. <td></td><td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Adds two BigNum values. </p>
  139. <dl class="params"><dt>Parameters</dt><dd>
  140. <table class="params">
  141. <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The left hand parameter. </td></tr>
  142. <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The right hand parameter. </td></tr>
  143. <tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>The result of adding a and b.</td></tr>
  144. </table>
  145. </dd>
  146. </dl>
  147. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  148. </div>
  149. </div>
  150. <a class="anchor" id="ga7dd6038987210d10bf843602fef0c929"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> BigNumMod </td>
  156. <td>(</td>
  157. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  158. <td class="paramname"><em>a</em>, </td>
  159. </tr>
  160. <tr>
  161. <td class="paramkey"></td>
  162. <td></td>
  163. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  164. <td class="paramname"><em>b</em>, </td>
  165. </tr>
  166. <tr>
  167. <td class="paramkey"></td>
  168. <td></td>
  169. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *&#160;</td>
  170. <td class="paramname"><em>r</em>&#160;</td>
  171. </tr>
  172. <tr>
  173. <td></td>
  174. <td>)</td>
  175. <td></td><td></td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Computes modular reduction for BigNum value by specified modulus. </p>
  180. <dl class="params"><dt>Parameters</dt><dd>
  181. <table class="params">
  182. <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The BigNum value. </td></tr>
  183. <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The modulus. </td></tr>
  184. <tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>Modular reduction result.</td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  189. </div>
  190. </div>
  191. <a class="anchor" id="ga03c89b8b8dd87de2c0f4b5822145d317"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> BigNumMul </td>
  197. <td>(</td>
  198. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  199. <td class="paramname"><em>a</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  205. <td class="paramname"><em>b</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *&#160;</td>
  211. <td class="paramname"><em>r</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Multiplies two BigNum values. </p>
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The left hand parameter. </td></tr>
  224. <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The right hand parameter. </td></tr>
  225. <tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>The result of multiplying a and b.</td></tr>
  226. </table>
  227. </dd>
  228. </dl>
  229. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a class="anchor" id="gacbec9669ab0fe768e2be74dcaca397ea"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> BigNumSub </td>
  238. <td>(</td>
  239. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  240. <td class="paramname"><em>a</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  246. <td class="paramname"><em>b</em>, </td>
  247. </tr>
  248. <tr>
  249. <td class="paramkey"></td>
  250. <td></td>
  251. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *&#160;</td>
  252. <td class="paramname"><em>r</em>&#160;</td>
  253. </tr>
  254. <tr>
  255. <td></td>
  256. <td>)</td>
  257. <td></td><td></td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>Subtracts two BigNum values. </p>
  262. <dl class="params"><dt>Parameters</dt><dd>
  263. <table class="params">
  264. <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>The left hand parameter. </td></tr>
  265. <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>The right hand parameter. </td></tr>
  266. <tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>The result of subtracting a and b.</td></tr>
  267. </table>
  268. </dd>
  269. </dl>
  270. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  271. </div>
  272. </div>
  273. <a class="anchor" id="ga2d17600068b1d94000635c6644258a03"></a>
  274. <div class="memitem">
  275. <div class="memproto">
  276. <table class="memname">
  277. <tr>
  278. <td class="memname">void DeleteBigNum </td>
  279. <td>(</td>
  280. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> **&#160;</td>
  281. <td class="paramname"><em>bignum</em></td><td>)</td>
  282. <td></td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Deletes a previously allocated BigNum. </p>
  287. <p>Frees memory pointed to by bignum. Nulls the pointer.</p>
  288. <dl class="params"><dt>Parameters</dt><dd>
  289. <table class="params">
  290. <tr><td class="paramdir">[in]</td><td class="paramname">bignum</td><td>The BigNum. Can be NULL.</td></tr>
  291. </table>
  292. </dd>
  293. </dl>
  294. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group___big_num_primitives.html#gad5f6f262bfd780fed3678bcee16f0aed" title="Constructs a new BigNum. ">NewBigNum</a> </dd></dl>
  295. </div>
  296. </div>
  297. <a class="anchor" id="gad5f6f262bfd780fed3678bcee16f0aed"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> NewBigNum </td>
  303. <td>(</td>
  304. <td class="paramtype">size_t&#160;</td>
  305. <td class="paramname"><em>data_size_bytes</em>, </td>
  306. </tr>
  307. <tr>
  308. <td class="paramkey"></td>
  309. <td></td>
  310. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> **&#160;</td>
  311. <td class="paramname"><em>bignum</em>&#160;</td>
  312. </tr>
  313. <tr>
  314. <td></td>
  315. <td>)</td>
  316. <td></td><td></td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Constructs a new BigNum. </p>
  321. <p>Allocates memory and creates a new BigNum.</p>
  322. <p>Use <a class="el" href="group___big_num_primitives.html#ga2d17600068b1d94000635c6644258a03" title="Deletes a previously allocated BigNum. ">DeleteBigNum()</a> to free memory.</p>
  323. <dl class="params"><dt>Parameters</dt><dd>
  324. <table class="params">
  325. <tr><td class="paramdir">[in]</td><td class="paramname">data_size_bytes</td><td>The size in bytes of the new number. </td></tr>
  326. <tr><td class="paramdir">[out]</td><td class="paramname">bignum</td><td>The BigNum.</td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a></dd></dl>
  331. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group___big_num_primitives.html#ga2d17600068b1d94000635c6644258a03" title="Deletes a previously allocated BigNum. ">DeleteBigNum</a> </dd></dl>
  332. </div>
  333. </div>
  334. <a class="anchor" id="ga808cf477b70ed06358b11756bfe36024"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> ReadBigNum </td>
  340. <td>(</td>
  341. <td class="paramtype">void const *&#160;</td>
  342. <td class="paramname"><em>bn_str</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">size_t&#160;</td>
  348. <td class="paramname"><em>strlen</em>, </td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey"></td>
  352. <td></td>
  353. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> *&#160;</td>
  354. <td class="paramname"><em>bn</em>&#160;</td>
  355. </tr>
  356. <tr>
  357. <td></td>
  358. <td>)</td>
  359. <td></td><td></td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Deserializes a BigNum from a string. </p>
  364. <dl class="params"><dt>Parameters</dt><dd>
  365. <table class="params">
  366. <tr><td class="paramdir">[in]</td><td class="paramname">bn_str</td><td>The serialized value. </td></tr>
  367. <tr><td class="paramdir">[in]</td><td class="paramname">strlen</td><td>The size of bn_str in bytes. </td></tr>
  368. <tr><td class="paramdir">[out]</td><td class="paramname">bn</td><td>The target BigNum.</td></tr>
  369. </table>
  370. </dd>
  371. </dl>
  372. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  373. </div>
  374. </div>
  375. <a class="anchor" id="ga47f356d816bcb5742ba6d78000861328"></a>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname"><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360">EpidStatus</a> WriteBigNum </td>
  381. <td>(</td>
  382. <td class="paramtype"><a class="el" href="group___big_num_primitives.html#ga2bf153e27be2683f0fb26f0f7ff1f718">BigNum</a> const *&#160;</td>
  383. <td class="paramname"><em>bn</em>, </td>
  384. </tr>
  385. <tr>
  386. <td class="paramkey"></td>
  387. <td></td>
  388. <td class="paramtype">size_t&#160;</td>
  389. <td class="paramname"><em>strlen</em>, </td>
  390. </tr>
  391. <tr>
  392. <td class="paramkey"></td>
  393. <td></td>
  394. <td class="paramtype">void const *&#160;</td>
  395. <td class="paramname"><em>bn_str</em>&#160;</td>
  396. </tr>
  397. <tr>
  398. <td></td>
  399. <td>)</td>
  400. <td></td><td></td>
  401. </tr>
  402. </table>
  403. </div><div class="memdoc">
  404. <p>Serializes a BigNum to a string. </p>
  405. <dl class="params"><dt>Parameters</dt><dd>
  406. <table class="params">
  407. <tr><td class="paramdir">[in]</td><td class="paramname">bn</td><td>The BigNum to be serialized. </td></tr>
  408. <tr><td class="paramdir">[in]</td><td class="paramname">strlen</td><td>The size of bn_str in bytes. </td></tr>
  409. <tr><td class="paramdir">[out]</td><td class="paramname">bn_str</td><td>The target string.</td></tr>
  410. </table>
  411. </dd>
  412. </dl>
  413. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="group___error_codes.html#gafdb27c77c2c4b32c807e326a8a0da360" title="Return status for SDK functions. ">EpidStatus</a> </dd></dl>
  414. </div>
  415. </div>
  416. </div><!-- contents -->
  417. </div><!-- doc-content -->
  418. <!-- HTML footer for doxygen 1.8.10-->
  419. <!-- start footer part -->
  420. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  421. <ul>
  422. <li class="footer">
  423. &copy; 2016 Intel Corporation
  424. </li>
  425. </ul>
  426. </div>
  427. </body>
  428. </html>