Changes between Version 2 and Version 3 of WikiStart

Timestamp:

08/26/14 11:26:37 (10 years ago)

Author:

hfinkel

Comment:

--

WikiStart

@@ -9 +9 @@
 This implementation uses the ECMA-182 polynomial with -1 initialization, and computes the bit-reversed CRC.
 
+== Interface ==
+
+This library provides the following functions for general-purpose use. For most applications, only crc64_omp (and possibly crc64_invert) will be of use:
+
+
+Calculate the CRC64 of the provided buffer (in serial).
+{{{
+  uint64_t crc64(const void *input, size_t nbytes);
+}}}
+
+Calculate the CRC64 of the provided buffer, in parallel if possible (using OpenMP).
+{{{
+  uint64_t crc64_omp(const void *input, size_t nbytes);
+}}}
+
+Calculate the 'check bytes' for the provided CRC64. If these bytes are appended to the original buffer, then the new total CRC64 should be -1. The CRC64 of the buffer is provided as is a pointer to the end of the buffer (where the inverted CRC will be written). The end-of-buffer pointer need not be aligned.
+{{{
+   void crc64_invert(uint64_t cs, void *buffer);
+}}}
+
+Given the CRC64 of the first part of a buffer, and the CRC64 and length of the second part of a buffer, calculate the CRC64 of the complete buffer.
+{{{
+  uint64_t crc64_combine(uint64_t cs1, uint64_t cs2, size_t nbytes2);
+}}}
+
 == References ==