K4os.Hash.xxHash.xml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>K4os.Hash.xxHash</name>
  5. </assembly>
  6. <members>
  7. <member name="T:K4os.Hash.xxHash.HashAlgorithmAdapter">
  8. <summary>
  9. Adapter implementing <see cref="T:System.Security.Cryptography.HashAlgorithm"/>
  10. </summary>
  11. </member>
  12. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.#ctor(System.Int32,System.Action,System.Action{System.Byte[],System.Int32,System.Int32},System.Func{System.Byte[]})">
  13. <summary>
  14. Creates new <see cref="T:K4os.Hash.xxHash.HashAlgorithmAdapter"/>.
  15. </summary>
  16. <param name="hashSize">Hash size (in bytes)</param>
  17. <param name="reset">Reset function.</param>
  18. <param name="update">Update function.</param>
  19. <param name="digest">Digest function.</param>
  20. </member>
  21. <member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.HashSize">
  22. <inheritdoc />
  23. </member>
  24. <member name="P:K4os.Hash.xxHash.HashAlgorithmAdapter.Hash">
  25. <inheritdoc />
  26. </member>
  27. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashCore(System.Byte[],System.Int32,System.Int32)">
  28. <inheritdoc />
  29. </member>
  30. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.HashFinal">
  31. <inheritdoc />
  32. </member>
  33. <member name="M:K4os.Hash.xxHash.HashAlgorithmAdapter.Initialize">
  34. <inheritdoc />
  35. </member>
  36. <member name="T:K4os.Hash.xxHash.XXH">
  37. <summary>
  38. Base class for both <see cref="T:K4os.Hash.xxHash.XXH32"/> and <see cref="T:K4os.Hash.xxHash.XXH64"/>. Do not use directly.
  39. </summary>
  40. </member>
  41. <member name="M:K4os.Hash.xxHash.XXH.#ctor">
  42. <summary>Protected constructor to prevent instantiation.</summary>
  43. </member>
  44. <member name="T:K4os.Hash.xxHash.XXH32">
  45. <summary>
  46. xxHash 32-bit.
  47. </summary>
  48. </member>
  49. <member name="T:K4os.Hash.xxHash.XXH32.State">
  50. <summary>Internal state of the algorithm.</summary>
  51. </member>
  52. <member name="F:K4os.Hash.xxHash.XXH32.EmptyHash">
  53. <summary>Hash of empty buffer.</summary>
  54. </member>
  55. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32)">
  56. <summary>Hash of provided buffer.</summary>
  57. <param name="bytes">Buffer.</param>
  58. <param name="length">Length of buffer.</param>
  59. <returns>Digest.</returns>
  60. </member>
  61. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Void*,System.Int32,System.UInt32)">
  62. <summary>Hash of provided buffer.</summary>
  63. <param name="bytes">Buffer.</param>
  64. <param name="length">Length of buffer.</param>
  65. <param name="seed">Seed.</param>
  66. <returns>Digest.</returns>
  67. </member>
  68. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.ReadOnlySpan{System.Byte})">
  69. <summary>Hash of provided buffer.</summary>
  70. <param name="bytes">Buffer.</param>
  71. <returns>Digest.</returns>
  72. </member>
  73. <member name="M:K4os.Hash.xxHash.XXH32.DigestOf(System.Byte[],System.Int32,System.Int32)">
  74. <summary>Hash of provided buffer.</summary>
  75. <param name="bytes">Buffer.</param>
  76. <param name="offset">Starting offset.</param>
  77. <param name="length">Length of buffer.</param>
  78. <returns>Digest.</returns>
  79. </member>
  80. <member name="M:K4os.Hash.xxHash.XXH32.#ctor">
  81. <summary>Creates xxHash instance.</summary>
  82. </member>
  83. <member name="M:K4os.Hash.xxHash.XXH32.#ctor(System.UInt32)">
  84. <summary>Creates xxHash instance.</summary>
  85. </member>
  86. <member name="M:K4os.Hash.xxHash.XXH32.Reset">
  87. <summary>Resets hash calculation.</summary>
  88. </member>
  89. <member name="M:K4os.Hash.xxHash.XXH32.Reset(System.UInt32)">
  90. <summary>Resets hash calculation.</summary>
  91. </member>
  92. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.Void*,System.Int32)">
  93. <summary>Updates the hash using given buffer.</summary>
  94. <param name="bytes">Buffer.</param>
  95. <param name="length">Length of buffer.</param>
  96. </member>
  97. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte*,System.Int32)">
  98. <summary>Updates the hash using given buffer.</summary>
  99. <param name="bytes">Buffer.</param>
  100. <param name="length">Length of buffer.</param>
  101. </member>
  102. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.ReadOnlySpan{System.Byte})">
  103. <summary>Updates the has using given buffer.</summary>
  104. <param name="bytes">Buffer.</param>
  105. </member>
  106. <member name="M:K4os.Hash.xxHash.XXH32.Update(System.Byte[],System.Int32,System.Int32)">
  107. <summary>Updates the has using given buffer.</summary>
  108. <param name="bytes">Buffer.</param>
  109. <param name="offset">Starting offset.</param>
  110. <param name="length">Length of buffer.</param>
  111. </member>
  112. <member name="M:K4os.Hash.xxHash.XXH32.Digest">
  113. <summary>Hash so far.</summary>
  114. <returns>Hash so far.</returns>
  115. </member>
  116. <member name="M:K4os.Hash.xxHash.XXH32.DigestBytes">
  117. <summary>Hash so far, as byte array.</summary>
  118. <returns>Hash so far.</returns>
  119. </member>
  120. <member name="M:K4os.Hash.xxHash.XXH32.AsHashAlgorithm">
  121. <summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
  122. <returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
  123. </member>
  124. <member name="M:K4os.Hash.xxHash.XXH32.Reset(K4os.Hash.xxHash.XXH32.State@,System.UInt32)">
  125. <summary>Resets hash calculation.</summary>
  126. <param name="state">Hash state.</param>
  127. <param name="seed">Hash seed.</param>
  128. </member>
  129. <member name="M:K4os.Hash.xxHash.XXH32.Update(K4os.Hash.xxHash.XXH32.State@,System.Void*,System.Int32)">
  130. <summary>Updates the has using given buffer.</summary>
  131. <param name="state">Hash state.</param>
  132. <param name="bytes">Buffer.</param>
  133. <param name="length">Length of buffer.</param>
  134. </member>
  135. <member name="M:K4os.Hash.xxHash.XXH32.Update(K4os.Hash.xxHash.XXH32.State@,System.ReadOnlySpan{System.Byte})">
  136. <summary>Updates the has using given buffer.</summary>
  137. <param name="state">Hash state.</param>
  138. <param name="bytes">Buffer.</param>
  139. </member>
  140. <member name="M:K4os.Hash.xxHash.XXH32.Digest(K4os.Hash.xxHash.XXH32.State@)">
  141. <summary>Hash so far.</summary>
  142. <returns>Hash so far.</returns>
  143. </member>
  144. <member name="T:K4os.Hash.xxHash.XXH64">
  145. <summary>
  146. xxHash 64-bit.
  147. </summary>
  148. </member>
  149. <member name="T:K4os.Hash.xxHash.XXH64.State">
  150. <summary>Internal state of the algorithm.</summary>
  151. </member>
  152. <member name="F:K4os.Hash.xxHash.XXH64.EmptyHash">
  153. <summary>Hash of empty buffer.</summary>
  154. </member>
  155. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32)">
  156. <summary>Hash of provided buffer.</summary>
  157. <param name="bytes">Buffer.</param>
  158. <param name="length">Length of buffer.</param>
  159. <returns>Digest.</returns>
  160. </member>
  161. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Void*,System.Int32,System.UInt64)">
  162. <summary>Hash of provided buffer.</summary>
  163. <param name="bytes">Buffer.</param>
  164. <param name="length">Length of buffer.</param>
  165. <param name="seed">Seed.</param>
  166. <returns>Digest.</returns>
  167. </member>
  168. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.ReadOnlySpan{System.Byte})">
  169. <summary>Hash of provided buffer.</summary>
  170. <param name="bytes">Buffer.</param>
  171. <returns>Digest.</returns>
  172. </member>
  173. <member name="M:K4os.Hash.xxHash.XXH64.DigestOf(System.Byte[],System.Int32,System.Int32)">
  174. <summary>Hash of provided buffer.</summary>
  175. <param name="bytes">Buffer.</param>
  176. <param name="offset">Starting offset.</param>
  177. <param name="length">Length of buffer.</param>
  178. <returns>Digest.</returns>
  179. </member>
  180. <member name="M:K4os.Hash.xxHash.XXH64.#ctor">
  181. <summary>Creates xxHash instance.</summary>
  182. </member>
  183. <member name="M:K4os.Hash.xxHash.XXH64.#ctor(System.UInt64)">
  184. <summary>Creates xxHash instance.</summary>
  185. </member>
  186. <member name="M:K4os.Hash.xxHash.XXH64.Reset">
  187. <summary>Resets hash calculation.</summary>
  188. </member>
  189. <member name="M:K4os.Hash.xxHash.XXH64.Reset(System.UInt64)">
  190. <summary>Resets hash calculation.</summary>
  191. </member>
  192. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.Void*,System.Int32)">
  193. <summary>Updates the hash using given buffer.</summary>
  194. <param name="bytes">Buffer.</param>
  195. <param name="length">Length of buffer.</param>
  196. </member>
  197. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte*,System.Int32)">
  198. <summary>Updates the hash using given buffer.</summary>
  199. <param name="bytes">Buffer.</param>
  200. <param name="length">Length of buffer.</param>
  201. </member>
  202. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.ReadOnlySpan{System.Byte})">
  203. <summary>Updates the has using given buffer.</summary>
  204. <param name="bytes">Buffer.</param>
  205. </member>
  206. <member name="M:K4os.Hash.xxHash.XXH64.Update(System.Byte[],System.Int32,System.Int32)">
  207. <summary>Updates the has using given buffer.</summary>
  208. <param name="bytes">Buffer.</param>
  209. <param name="offset">Starting offset.</param>
  210. <param name="length">Length of buffer.</param>
  211. </member>
  212. <member name="M:K4os.Hash.xxHash.XXH64.Digest">
  213. <summary>Hash so far.</summary>
  214. <returns>Hash so far.</returns>
  215. </member>
  216. <member name="M:K4os.Hash.xxHash.XXH64.DigestBytes">
  217. <summary>Hash so far, as byte array.</summary>
  218. <returns>Hash so far.</returns>
  219. </member>
  220. <member name="M:K4os.Hash.xxHash.XXH64.AsHashAlgorithm">
  221. <summary>Converts this class to <see cref="T:System.Security.Cryptography.HashAlgorithm"/></summary>
  222. <returns><see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
  223. </member>
  224. <member name="M:K4os.Hash.xxHash.XXH64.Reset(K4os.Hash.xxHash.XXH64.State@,System.UInt64)">
  225. <summary>Resets hash calculation.</summary>
  226. <param name="state">Hash state.</param>
  227. <param name="seed">Hash seed.</param>
  228. </member>
  229. <member name="M:K4os.Hash.xxHash.XXH64.Update(K4os.Hash.xxHash.XXH64.State@,System.Void*,System.Int32)">
  230. <summary>Updates the has using given buffer.</summary>
  231. <param name="state">Hash state.</param>
  232. <param name="bytes">Buffer.</param>
  233. <param name="length">Length of buffer.</param>
  234. </member>
  235. <member name="M:K4os.Hash.xxHash.XXH64.Update(K4os.Hash.xxHash.XXH64.State@,System.ReadOnlySpan{System.Byte})">
  236. <summary>Updates the has using given buffer.</summary>
  237. <param name="state">Hash state.</param>
  238. <param name="bytes">Buffer.</param>
  239. </member>
  240. <member name="M:K4os.Hash.xxHash.XXH64.Digest(K4os.Hash.xxHash.XXH64.State@)">
  241. <summary>Hash so far.</summary>
  242. <returns>Hash so far.</returns>
  243. </member>
  244. </members>
  245. </doc>