You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

318 lines
8.8 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>crc64 - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package crc64</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "hash/crc64"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package crc64 implements the 64-bit cyclic redundancy check, or CRC-64,
  68. checksum. See <a href="http://en.wikipedia.org/wiki/Cyclic_redundancy_check">http://en.wikipedia.org/wiki/Cyclic_redundancy_check</a> for
  69. information.
  70. </p>
  71. </div>
  72. </div>
  73. <div id="pkg-index" class="toggleVisible">
  74. <div class="collapsed">
  75. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  76. </div>
  77. <div class="expanded">
  78. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  79. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  80. <div id="manual-nav">
  81. <dl>
  82. <dd><a href="index.html#pkg-constants">Constants</a></dd>
  83. <dd><a href="index.html#Checksum">func Checksum(data []byte, tab *Table) uint64</a></dd>
  84. <dd><a href="index.html#New">func New(tab *Table) hash.Hash64</a></dd>
  85. <dd><a href="index.html#Update">func Update(crc uint64, tab *Table, p []byte) uint64</a></dd>
  86. <dd><a href="index.html#Table">type Table</a></dd>
  87. <dd>&nbsp; &nbsp; <a href="index.html#MakeTable">func MakeTable(poly uint64) *Table</a></dd>
  88. </dl>
  89. </div><!-- #manual-nav -->
  90. <h4>Package files</h4>
  91. <p>
  92. <span style="font-size:90%">
  93. <a href="http://localhost:6060/src/hash/crc64/crc64.go">crc64.go</a>
  94. </span>
  95. </p>
  96. </div><!-- .expanded -->
  97. </div><!-- #pkg-index -->
  98. <div id="pkg-callgraph" class="toggle" style="display: none">
  99. <div class="collapsed">
  100. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  101. </div> <!-- .expanded -->
  102. <div class="expanded">
  103. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  104. <p>
  105. In the call graph viewer below, each node
  106. is a function belonging to this package
  107. and its children are the functions it
  108. calls&mdash;perhaps dynamically.
  109. </p>
  110. <p>
  111. The root nodes are the entry points of the
  112. package: functions that may be called from
  113. outside the package.
  114. There may be non-exported or anonymous
  115. functions among them if they are called
  116. dynamically from another package.
  117. </p>
  118. <p>
  119. Click a node to visit that function's source code.
  120. From there you can visit its callers by
  121. clicking its declaring <code>func</code>
  122. token.
  123. </p>
  124. <p>
  125. Functions may be omitted if they were
  126. determined to be unreachable in the
  127. particular programs or tests that were
  128. analyzed.
  129. </p>
  130. <!-- Zero means show all package entry points. -->
  131. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  132. </div>
  133. </div> <!-- #pkg-callgraph -->
  134. <h2 id="pkg-constants">Constants</h2>
  135. <pre>const (
  136. <span class="comment">// The ISO polynomial, defined in ISO 3309 and used in HDLC.</span>
  137. <span id="ISO">ISO</span> = 0xD800000000000000
  138. <span class="comment">// The ECMA polynomial, defined in ECMA 182.</span>
  139. <span id="ECMA">ECMA</span> = 0xC96C5795D7870F42
  140. )</pre>
  141. <p>
  142. Predefined polynomials.
  143. </p>
  144. <pre>const <span id="Size">Size</span> = 8</pre>
  145. <p>
  146. The size of a CRC-64 checksum in bytes.
  147. </p>
  148. <h2 id="Checksum">func <a href="http://localhost:6060/src/hash/crc64/crc64.go?s=2299:2344#L79">Checksum</a></h2>
  149. <pre>func Checksum(data []<a href="../../builtin/index.html#byte">byte</a>, tab *<a href="index.html#Table">Table</a>) <a href="../../builtin/index.html#uint64">uint64</a></pre>
  150. <p>
  151. Checksum returns the CRC-64 checksum of data
  152. using the polynomial represented by the Table.
  153. </p>
  154. <h2 id="New">func <a href="http://localhost:6060/src/hash/crc64/crc64.go?s=1371:1403#L44">New</a></h2>
  155. <pre>func New(tab *<a href="index.html#Table">Table</a>) <a href="../index.html">hash</a>.<a href="../index.html#Hash64">Hash64</a></pre>
  156. <p>
  157. New creates a new hash.Hash64 computing the CRC-64 checksum
  158. using the polynomial represented by the Table.
  159. Its Sum method will lay the value out in big-endian byte order.
  160. </p>
  161. <h2 id="Update">func <a href="http://localhost:6060/src/hash/crc64/crc64.go?s=1777:1829#L61">Update</a></h2>
  162. <pre>func Update(crc <a href="../../builtin/index.html#uint64">uint64</a>, tab *<a href="index.html#Table">Table</a>, p []<a href="../../builtin/index.html#byte">byte</a>) <a href="../../builtin/index.html#uint64">uint64</a></pre>
  163. <p>
  164. Update returns the result of adding the bytes in p to the crc.
  165. </p>
  166. <h2 id="Table">type <a href="http://localhost:6060/src/hash/crc64/crc64.go?s=697:719#L15">Table</a></h2>
  167. <pre>type Table [256]<a href="../../builtin/index.html#uint64">uint64</a></pre>
  168. <p>
  169. Table is a 256-word table representing the polynomial for efficient processing.
  170. </p>
  171. <h3 id="MakeTable">func <a href="http://localhost:6060/src/hash/crc64/crc64.go?s=845:879#L19">MakeTable</a></h3>
  172. <pre>func MakeTable(poly <a href="../../builtin/index.html#uint64">uint64</a>) *<a href="index.html#Table">Table</a></pre>
  173. <p>
  174. MakeTable returns a Table constructed from the specified polynomial.
  175. The contents of this Table must not be modified.
  176. </p>
  177. <div id="footer">
  178. Build version go1.6.<br>
  179. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  180. the content of this page is licensed under the
  181. Creative Commons Attribution 3.0 License,
  182. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  183. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  184. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  185. </div>
  186. </div><!-- .container -->
  187. </div><!-- #page -->
  188. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  189. <script type="text/javascript" src="../../../lib/godoc/jquery.js"></script>
  190. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.js"></script>
  191. <script type="text/javascript" src="../../../lib/godoc/jquery.treeview.edit.js"></script>
  192. <script type="text/javascript" src="../../../lib/godoc/godocs.js"></script>
  193. </body>
  194. </html>