languages/go
languages/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-10-04 15:09:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

hash/crc32: clarify documentation

Browse source 
Explicitly specify that we represent polynomial in reversed notation

Fixes #8229

Change-Id: Idf094c01fd82f133cd0c1b50fa967d12c577bdb5
Reviewed-on: https://go-review.googlesource.com/9237
Reviewed-by: David Chase <drchase@google.com>
This commit is contained in:
Aamir Khan 2015-04-22 19:24:48 +09:00 committed by David Chase
parent 7579867fec
commit 80f575b78f
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
src/hash/crc32/crc32.go
View file

@ -5,6 +5,18 @@
// Package crc32 implements the 32-bit cyclic redundancy check, or CRC-32,
// checksum. See http://en.wikipedia.org/wiki/Cyclic_redundancy_check for
// information.
//
// Polynomials are represented in LSB-first form also known as reversed representation.
//
// LSB-first representation is a hexadecimal number with n bits, the most
// significant bit represents the coefficient of x^0 and the least significant
// bit represents the coefficient of x^(n-1).
//
// For example, x^5 + x^2 + x^0 is (binary:10100, hexadecimal:0x14) in 5-bit LSB-first form,
// as opposed to (binary:00101, hexadecimal:0x05) in MSB-first (normal) form.
//
// See http://en.wikipedia.org/wiki/Mathematics_of_cyclic_redundancy_checks#Reversed_representations_and_reciprocal_polynomials
// for information.
package crc32
import (