basis/checksums/fnv1/fnv1-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: checksums.fnv1
   3
   4 HELP: fnv1-32
   5 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 32-bit." } ;
   6
   7 HELP: fnv1a-32
   8 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 32-bit." } ;
   9
  10
  11 HELP: fnv1-64
  12 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 64-bit." } ;
  13
  14 HELP: fnv1a-64
  15 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 64-bit." } ;
  16
  17
  18 HELP: fnv1-128
  19 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 128-bit." } ;
  20
  21 HELP: fnv1a-128
  22 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 128-bit." } ;
  23
  24
  25 HELP: fnv1-256
  26 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 256-bit." } ;
  27
  28 HELP: fnv1a-256
  29 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 256-bit." } ;
  30
  31
  32 HELP: fnv1-512
  33 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 512-bit." } ;
  34
  35 HELP: fnv1a-512
  36 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 512-bit." } ;
  37
  38
  39 HELP: fnv1-1024
  40 { $class-description "Fowler-Noll-Vo checksum algorithm, v1, 1024-bit." } ;
  41
  42 HELP: fnv1a-1024
  43 { $class-description "Fowler-Noll-Vo checksum algorithm, v1a, 1024-bit." } ;
  44
  45 ARTICLE: "checksums.fnv1" "Fowler-Noll-Vo checksum"
  46   "The Fowler-Noll-Vo checksum algorithm is another simple and fast checksum. It comes in 32, 64, 128, 256, 512 and 1024-bit versions, each in 1 and 1a variants. The 1a variants tend to produce a slightly better result. See http://en.wikipedia.org/wiki/Fowler_Noll_Vo_hash for more details."
  47 { $subsections
  48     fnv1-32
  49     fnv1a-32
  50 }
  51 { $subsections
  52     fnv1-64
  53     fnv1a-64
  54 }
  55 { $subsections
  56     fnv1-128
  57     fnv1a-128
  58 }
  59 { $subsections
  60     fnv1-256
  61     fnv1a-256
  62 }
  63 { $subsections
  64     fnv1-512
  65     fnv1a-512
  66 }
  67 { $subsections
  68     fnv1-1024
  69     fnv1a-1024
  70 } ;
  71
  72 ABOUT: "checksums.fnv1"