pqc/ntru__poly__ascii_8h_source.html
travis-ci b333b7d765 Lastest doxygen docs updated
travis build: 29
	commit: 03f3b4b230
	auto-pushed to gh-pages
2014-06-08 23:33:25 +00:00

172 lines
18 KiB
HTML

<!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.7"/>
<title>post quantum cryptography: /home/travis/build/hasufell/pqc/src/ntru_poly_ascii.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.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 style="padding-left: 0.5em;">
<div id="projectname">post quantum cryptography
</div>
<div id="projectbrief">Highly optimized implementation of the NTRUEncrypt algorithm</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ntru_poly_ascii.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ntru__poly__ascii_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2014 FH Bielefeld</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This file is part of a FH Bielefeld project.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * MA 02110-1301 USA</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#ifndef NTRU_POLY_ASCII_H_</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define NTRU_POLY_ASCII_H_</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ntru__common_8h.html">ntru_common.h</a>&quot;</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ntru__params_8h.html">ntru_params.h</a>&quot;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ntru__string_8h.html">ntru_string.h</a>&quot;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#include &lt;fmpz_poly.h&gt;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &lt;fmpz.h&gt;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#a0d86ab2dede39b332d4149e16b2046b8">bin_poly_to_ascii</a>(<span class="keyword">const</span> fmpz_poly_t poly,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#ab9464c96c3ebec6ee716c604fdc4ad21">bin_poly_arr_to_ascii</a>(<span class="keyword">const</span> fmpz_poly_t **bin_poly_arr,</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">const</span> uint32_t poly_c,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#aa4d233591b7e51d6cf787edd3bfa91e2">poly_to_ascii</a>(<span class="keyword">const</span> fmpz_poly_t poly,</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#afa141976b665b94c0db9912bc50de4a1">poly_arr_to_ascii</a>(<span class="keyword">const</span> fmpz_poly_t **poly_array,</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; <span class="keyword">const</span> uint32_t poly_c,</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#a4ba0179e3ae0d5e721ff8429a8265e80">poly_to_base64</a>(<span class="keyword">const</span> fmpz_poly_t poly,</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="keywordtype">string</span> *</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<a class="code" href="ntru__poly__ascii_8h.html#a16163cc57631a0965577cb0f89365ca0">poly_arr_to_base64</a>(<span class="keyword">const</span> fmpz_poly_t **poly_arr,</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <span class="keyword">const</span> uint32_t poly_c,</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; <span class="keyword">const</span> <a class="code" href="structntru__params.html">ntru_params</a> *params);</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* NTRU_POLY_ASCII_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_a4ba0179e3ae0d5e721ff8429a8265e80"><div class="ttname"><a href="ntru__poly__ascii_8h.html#a4ba0179e3ae0d5e721ff8429a8265e80">poly_to_base64</a></div><div class="ttdeci">string * poly_to_base64(const fmpz_poly_t poly, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00237">ntru_poly_ascii.c:237</a></div></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_afa141976b665b94c0db9912bc50de4a1"><div class="ttname"><a href="ntru__poly__ascii_8h.html#afa141976b665b94c0db9912bc50de4a1">poly_arr_to_ascii</a></div><div class="ttdeci">string * poly_arr_to_ascii(const fmpz_poly_t **poly_array, const uint32_t poly_c, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00203">ntru_poly_ascii.c:203</a></div></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_a0d86ab2dede39b332d4149e16b2046b8"><div class="ttname"><a href="ntru__poly__ascii_8h.html#a0d86ab2dede39b332d4149e16b2046b8">bin_poly_to_ascii</a></div><div class="ttdeci">string * bin_poly_to_ascii(const fmpz_poly_t poly, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00114">ntru_poly_ascii.c:114</a></div></div>
<div class="ttc" id="structntru__params_html"><div class="ttname"><a href="structntru__params.html">ntru_params</a></div><div class="ttdef"><b>Definition:</b> <a href="ntru__params_8h_source.html#l00043">ntru_params.h:43</a></div></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_ab9464c96c3ebec6ee716c604fdc4ad21"><div class="ttname"><a href="ntru__poly__ascii_8h.html#ab9464c96c3ebec6ee716c604fdc4ad21">bin_poly_arr_to_ascii</a></div><div class="ttdeci">string * bin_poly_arr_to_ascii(const fmpz_poly_t **bin_poly_arr, const uint32_t poly_c, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00143">ntru_poly_ascii.c:143</a></div></div>
<div class="ttc" id="ntru__params_8h_html"><div class="ttname"><a href="ntru__params_8h.html">ntru_params.h</a></div><div class="ttdoc">NTRU parameters. </div></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_a16163cc57631a0965577cb0f89365ca0"><div class="ttname"><a href="ntru__poly__ascii_8h.html#a16163cc57631a0965577cb0f89365ca0">poly_arr_to_base64</a></div><div class="ttdeci">string * poly_arr_to_base64(const fmpz_poly_t **poly_arr, const uint32_t poly_c, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00264">ntru_poly_ascii.c:264</a></div></div>
<div class="ttc" id="ntru__common_8h_html"><div class="ttname"><a href="ntru__common_8h.html">ntru_common.h</a></div><div class="ttdoc">common macros/functions </div></div>
<div class="ttc" id="ntru__string_8h_html"><div class="ttname"><a href="ntru__string_8h.html">ntru_string.h</a></div><div class="ttdoc">header for ntru_string.c </div></div>
<div class="ttc" id="ntru__poly__ascii_8h_html_aa4d233591b7e51d6cf787edd3bfa91e2"><div class="ttname"><a href="ntru__poly__ascii_8h.html#aa4d233591b7e51d6cf787edd3bfa91e2">poly_to_ascii</a></div><div class="ttdeci">string * poly_to_ascii(const fmpz_poly_t poly, const ntru_params *params)</div><div class="ttdef"><b>Definition:</b> <a href="ntru__poly__ascii_8c_source.html#l00180">ntru_poly_ascii.c:180</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jun 8 2014 23:33:23 for post quantum cryptography by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>