Subject: [Boost-commit] svn:boost r74280 - sandbox/SOC/2011/checks/libs/checks/doc
From: pbristow_at_[hidden]
Date: 2011-09-06 13:08:43
Author: pbristow
Date: 2011-09-06 13:08:42 EDT (Tue, 06 Sep 2011)
New Revision: 74280
URL: http://svn.boost.org/trac/boost/changeset/74280
Log:
Corrections
Text files modified:
sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk | 30 +++++++++++++++++++++++-------
sandbox/SOC/2011/checks/libs/checks/doc/errors.qbk | 3 ++-
sandbox/SOC/2011/checks/libs/checks/doc/modulus.qbk | 7 +++++++
sandbox/SOC/2011/checks/libs/checks/doc/tutorial.qbk | 7 ++++---
4 files changed, 36 insertions(+), 11 deletions(-)
Modified: sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk (original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk 2011-09-06 13:08:42 EDT (Tue, 06 Sep 2011)
@@ -7,7 +7,6 @@
[@http://www.boost.org/LICENSE_1_0.txt])
]
[authors [Talbot, Pierre]]
- [/last-revision $Date: 2011-02-08 12:58:15 +0000 (Tue, 02 Feb 2011) $]
]
[/ Some links to external sources.]
@@ -94,14 +93,14 @@
the code is quite functional, but interfaces, library structure, and names
may still be changed without notice. The current version is available at
-[*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/libs/checks/doc/pdf/checks.pdf PDF documentation.]
+[*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/libs/checks/doc/checks.pdf PDF documentation.]
[*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/libs/checks/doc/html/index.html HTML documentation.]
[*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/boost/checks/boost/ Boost Sandbox checks source code.]
] [/important]
-[note Comments and suggestions (even bugs!) to Pierre Talbot pierre.talbot.6114 (at) herslibramont (dot) be]
+[note Comments and suggestions (even bugs!) to Pierre Talbot. ]
[endsect] [/section:status Status]
@@ -113,8 +112,11 @@
[section:acks Acknowledgements]
-* Thanks to Paul A. Bristow who is the mentor of this Google Summer of Code project for his infinite patience and his wise advice.
-* Thanks for Google for funding this Google Summer of Code 2011 project.
+The author thanks
+
+* Paul A. Bristow who was the mentor of this Google Summer of Code project for his infinite patience and his wise advice.
+* Google for funding this Google Summer of Code 2011 project.
+* Joseph A Gallian for his assistance with tables of values for the Verhoeff algorithm.
[endsect] [/section:acks Acknowledgements]
@@ -124,13 +126,27 @@
# __VIN
# __CODE39
+# Verhoeff, J, Error Detecting Codes, Mathmatical Centre Tract 29, The Mathematical Centre, Amsterdam 1969.
+# [@http://en.wikipedia.org/wiki/Verhoeff_algorithm Verhoeff_algorithm]
+# H. Peter Gumm, New class of check-digit methods for arbitrary number systems,
+IEEE Trans. on Information Theory, 31(1985) 102-105.
+# Paul Putter, & Neal R Wagner, Communication of ther ACM, Jan 1989, Vol 32, pages 106 - 110.
+Jonathan Mohr [@http://www.augustana.ab.ca/~mohrj/]
+# Numerical Recipes in C++, p 904 - 905W H Press, S A Teukolsky, W T Vettering, B P Flannery, ISBN 0 521 75033 4.
+# SNOMED Clinical Terms (First Release Technical Reference Manual)
+# First Release (January 2002), Annex B. Check-digit computation, p 30 to 34
+# [@http://www.snomed.org/Spanish%20Documents/SNOMEDCT_Core_Technical%20Reference%20Manual_US.pdf]
+uses Jonathan Mohr Javascript checkdigit.htm (copy in checkdigit.txt)
+based on code at [@http://www.augustana.ab.ca/~mohrj/algorithms/checkdigit.html ]
+#J A Gallian, Table 3 p 514, Error detection methods, ACM Surveys, 28(3) 504-517 ISSN 0360-0300 (1996)
+#J A Gallian & S Winters, American Math Monthly, 95, (1988) Modular Arithmetic in the Marketplace, p 548 - 551.
+
[endsect] [/section:refs References]
[section:rationale Rationale]
This section records the rationale and compromises for some design decisions.
-
[h4 Scope of the project]
*Scott McMurray has identifed four fairly distinct types of check:
# ISBN/ISSN/UPC/EAN/VISA/etc, for catching human-entry errors.
@@ -169,7 +185,7 @@
# Project started by Pierre Talbot June 2011 as a Google Summer of Code Project.
-# First release in Boost Sandbox for public comment Aug 2011.
+# First Boost Sandbox release for public comment Sep 2011.
[endsect] [/section:history History]
Modified: sandbox/SOC/2011/checks/libs/checks/doc/errors.qbk
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/errors.qbk (original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/errors.qbk 2011-09-06 13:08:42 EDT (Tue, 06 Sep 2011)
@@ -6,6 +6,7 @@
(See accompanying file LICENSE_1_0.txt
or copy at http://www.boost.org/LICENSE_1_0.txt)
]
+
[section:errors Type of errors]
This section will describe some common errors that an user or a device can make.
@@ -53,4 +54,4 @@
[endsect] [/section:phonetic Phonetic]
-[endsect] [/section:errors Type of errors]
\ No newline at end of file
+[endsect] [/section:errors Type of errors]
Modified: sandbox/SOC/2011/checks/libs/checks/doc/modulus.qbk
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/modulus.qbk (original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/modulus.qbk 2011-09-06 13:08:42 EDT (Tue, 06 Sep 2011)
@@ -65,6 +65,13 @@
[endsect] [/section:mod11 Modulus 11 algorithm]
+[section:verhoeff Verhoeff Algorithm]
+
+Verhoeff's check equation catches all single errors, all adjacent transpositions,
+over 95% of twin errors, over 94% of jump transpositions and jump twin errors,
+and most phonetic errors.
+
+[endsect] [/section:verhoeff Verhoeff Algorithm]
[section:summary Summary of Algorithms]
Modified: sandbox/SOC/2011/checks/libs/checks/doc/tutorial.qbk
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/tutorial.qbk (original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/tutorial.qbk 2011-09-06 13:08:42 EDT (Tue, 06 Sep 2011)
@@ -106,8 +106,9 @@
[section:extending_the_library Extending the library]
The re-usability of this library is an important feature.
-In fact, we can't code every existing check systems, this is why we will learn how
-to extend this library to cater for existing check systems not yet provided,
+In fact, we can't code every existing check systems - there are dozens of checksums in use worldwide.
+This section gives examples of how to extend this library
+to cater for existing check systems not yet provided,
and even to create your own check system.
[h5 Example with the Routing transit number]
@@ -232,7 +233,7 @@
[note This algorithm doesn't support full integer array that are not pre-computed (Example: (A) 10 -> 1 ; (M) 13 -> 4).
It can be an exercise for the reader.]
-Some basic examples are coded in the file __CHECKS__TUTO__FILE__:
+Some basic examples are coded in the file __CHECKS__TUTO__FILE__ .
[vin_example]