1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BitMagic-C++: Sparse vector serialization</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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BitMagic-C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Sparse vector serialization<div class="ingroups"><a class="el" href="group__bmagic.html">BitMagic Library</a> » <a class="el" href="group__svector.html">Sparse and compressed vectors</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Sparse vector serialization.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Sparse vector serialization:</div>
<div class="dyncontent">
<div class="center"><img src="group__svserial.png" border="0" usemap="#group____svserial" alt=""/></div>
<map name="group____svserial" id="group____svserial">
<area shape="rect" href="group__svector.html" title="Sparse vector for integer types using bit transposition transform." alt="" coords="5,5,168,45"/>
<area shape="rect" title="Sparse vector serialization." alt="" coords="381,13,556,38"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbm_1_1sparse__vector__serial__layout.html">bm::sparse_vector_serial_layout< SV ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">layout class for serialization buffer structure <a href="structbm_1_1sparse__vector__serial__layout.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classbm_1_1sparse__vector__serializer.html">bm::sparse_vector_serializer< SV ></a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga358d9cdc693676c83730f9fdb0cf922e"><td class="memTemplParams" colspan="2">template<class SV > </td></tr>
<tr class="memitem:ga358d9cdc693676c83730f9fdb0cf922e"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__svserial.html#ga358d9cdc693676c83730f9fdb0cf922e">bm::sparse_vector_serialize</a> (const SV &sv, <a class="el" href="structbm_1_1sparse__vector__serial__layout.html">sparse_vector_serial_layout</a>< SV > &sv_layout, <a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *temp_block=0)</td></tr>
<tr class="memdesc:ga358d9cdc693676c83730f9fdb0cf922e"><td class="mdescLeft"> </td><td class="mdescRight">Serialize sparse vector into a memory buffer(s) structure. <a href="group__svserial.html#ga358d9cdc693676c83730f9fdb0cf922e">More...</a><br /></td></tr>
<tr class="separator:ga358d9cdc693676c83730f9fdb0cf922e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a06b8c24ce8cd1ec82f598b80149178"><td class="memTemplParams" colspan="2">template<class SV > </td></tr>
<tr class="memitem:ga9a06b8c24ce8cd1ec82f598b80149178"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__svserial.html#ga9a06b8c24ce8cd1ec82f598b80149178">bm::sparse_vector_deserialize</a> (SV &sv, const unsigned char *buf, <a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> *temp_block=0)</td></tr>
<tr class="memdesc:ga9a06b8c24ce8cd1ec82f598b80149178"><td class="mdescLeft"> </td><td class="mdescRight">Deserialize sparse vector. <a href="group__svserial.html#ga9a06b8c24ce8cd1ec82f598b80149178">More...</a><br /></td></tr>
<tr class="separator:ga9a06b8c24ce8cd1ec82f598b80149178"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Sparse vector serialization. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9a06b8c24ce8cd1ec82f598b80149178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a06b8c24ce8cd1ec82f598b80149178">◆ </a></span>sparse_vector_deserialize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class SV > </div>
<table class="memname">
<tr>
<td class="memname">int bm::sparse_vector_deserialize </td>
<td>(</td>
<td class="paramtype">SV & </td>
<td class="paramname"><em>sv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> * </td>
<td class="paramname"><em>temp_block</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserialize sparse vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sv</td><td>- target sparse vector </td></tr>
<tr><td class="paramname">buf</td><td>- source memory buffer </td></tr>
<tr><td class="paramname">temp_block</td><td>- temporary block buffer to avoid re-allocations</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 (error processing via std::logic_error)</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classbm_1_1sparse__vector__deserializer.html" title="sparse vector de-serializer">sparse_vector_deserializer</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="rscsample01_8cpp-example.html#a15">rscsample01.cpp</a>, and <a class="el" href="svsample02_8cpp-example.html#a11">svsample02.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bmsparsevec__serial_8h_source.html#l00380">380</a> of file <a class="el" href="bmsparsevec__serial_8h_source.html">bmsparsevec_serial.h</a>.</p>
<p class="reference">References <a class="el" href="bmsparsevec__serial_8h_source.html#l00243">bm::sparse_vector_deserializer< SV >::deserialize()</a>.</p>
<p class="reference">Referenced by <a class="el" href="rscsample01_8cpp_source.html#l00080">main()</a>.</p>
</div>
</div>
<a id="ga358d9cdc693676c83730f9fdb0cf922e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga358d9cdc693676c83730f9fdb0cf922e">◆ </a></span>sparse_vector_serialize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class SV > </div>
<table class="memname">
<tr>
<td class="memname">void bm::sparse_vector_serialize </td>
<td>(</td>
<td class="paramtype">const SV & </td>
<td class="paramname"><em>sv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbm_1_1sparse__vector__serial__layout.html">sparse_vector_serial_layout</a>< SV > & </td>
<td class="paramname"><em>sv_layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacebm.html#a17fd5ba52db3ddda05e6f8dd5000a1a4">bm::word_t</a> * </td>
<td class="paramname"><em>temp_block</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialize sparse vector into a memory buffer(s) structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sv</td><td>- sparse vector to serialize </td></tr>
<tr><td class="paramname">sv_layout</td><td>- buffer structure to keep the result </td></tr>
<tr><td class="paramname">temp_block</td><td>- temporary buffer (allocate with <a class="el" href="bm_8h.html#ad9736d9521d713fa5d48859aa720bfdd">BM_DECLARE_TEMP_BLOCK(x)</a> for speed)</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__bvserial.html#ga537dfe6318f1f1fe18d86dac312be978" title="Bit mask flags for serialization algorithm.">serialization_flags</a> </dd>
<dd>
<a class="el" href="classbm_1_1sparse__vector__deserializer.html" title="sparse vector de-serializer">sparse_vector_deserializer</a> </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="rscsample01_8cpp-example.html#a12">rscsample01.cpp</a>, <a class="el" href="strsvsample03_8cpp-example.html#a16">strsvsample03.cpp</a>, and <a class="el" href="svsample02_8cpp-example.html#a8">svsample02.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="bmsparsevec__serial_8h_source.html#l00356">356</a> of file <a class="el" href="bmsparsevec__serial_8h_source.html">bmsparsevec_serial.h</a>.</p>
<p class="reference">References <a class="el" href="bmsparsevec__serial_8h_source.html#l00628">bm::sparse_vector_serializer< SV >::serialize()</a>.</p>
<p class="reference">Referenced by <a class="el" href="rscsample01_8cpp_source.html#l00080">main()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
|