|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r74239 - sandbox/SOC/2011/checks/boost/checks
From: pbristow_at_[hidden]
Date: 2011-09-05 13:42:21
Author: pbristow
Date: 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
New Revision: 74239
URL: http://svn.boost.org/trac/boost/changeset/74239
Log:
Major correction of typos etc.
Text files modified:
sandbox/SOC/2011/checks/boost/checks/amex.hpp | 32 ++++++++++++------------
sandbox/SOC/2011/checks/boost/checks/basic_check_algorithm.hpp | 47 ++++++++++++++++++------------------
sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp | 35 +++++++++++++--------------
sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp | 6 ++--
sandbox/SOC/2011/checks/boost/checks/ean.hpp | 40 +++++++++++++++---------------
sandbox/SOC/2011/checks/boost/checks/isbn.hpp | 36 ++++++++++++++--------------
sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp | 14 +++++-----
sandbox/SOC/2011/checks/boost/checks/limits.hpp | 33 +++++++++++++------------
sandbox/SOC/2011/checks/boost/checks/luhn.hpp | 31 ++++++++++++-----------
sandbox/SOC/2011/checks/boost/checks/mastercard.hpp | 30 +++++++++++-----------
sandbox/SOC/2011/checks/boost/checks/modulus10.hpp | 12 ++++----
sandbox/SOC/2011/checks/boost/checks/modulus11.hpp | 39 +++++++++++++++--------------
sandbox/SOC/2011/checks/boost/checks/modulus97.hpp | 51 +++++++++++++++++++++------------------
sandbox/SOC/2011/checks/boost/checks/translation_exception.hpp | 8 +++---
sandbox/SOC/2011/checks/boost/checks/upc.hpp | 21 +++++++--------
sandbox/SOC/2011/checks/boost/checks/verhoeff.hpp | 30 +++++++++++-----------
sandbox/SOC/2011/checks/boost/checks/visa.hpp | 30 +++++++++++-----------
sandbox/SOC/2011/checks/boost/checks/weight.hpp | 16 ++++++------
sandbox/SOC/2011/checks/boost/checks/weighted_sum.hpp | 18 +++++++-------
19 files changed, 267 insertions(+), 262 deletions(-)
Modified: sandbox/SOC/2011/checks/boost/checks/amex.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/amex.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/amex.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/amex.hpp header file ------------------------------------//
+// Boost checks/amex.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file amex.hpp
+/*! \file
\brief This file provides tools to compute and validate an American Express credit card number.
*/
@@ -19,11 +19,11 @@
#include <boost/checks/luhn.hpp>
/*!
- \brief This macro defines the size of a American Express number.
+ \brief This macro defines the size of a American Express card number (15).
*/
#define AMEX_SIZE 15
/*!
- \brief This macro defines the size of a American Express number without its check digit.
+ \brief This macro defines the size of a American Express card number without its check digit (14).
*/
#define AMEX_SIZE_WITHOUT_CHECKDIGIT 14
@@ -31,7 +31,7 @@
namespace checks{
/*! \class amex_algorithm
- \brief This class can be used to compute or validate checksum with the Luhn algorithm but filter following the amex pattern.
+ \brief This class can be used to compute or validate checksum with the Luhn algorithm, but filter following the Amex pattern.
\tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without check digits. No "real" value in the sequence will be skipped.
*/
@@ -39,7 +39,7 @@
struct amex_algorithm : boost::checks::luhn_algorithm < number_of_virtual_value_skipped >
{
/*!
- \brief Verify that a number matches the amex pattern.
+ \brief Verify that a number matches the Amex pattern.
\param current_valid_value is the current valid value analysed.
\param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
@@ -53,9 +53,9 @@
const unsigned int real_pos_from_left = AMEX_SIZE - current_value_position - number_of_virtual_value_skipped ;
if( real_pos_from_left == 1 && current_valid_value != 3)
- throw std::invalid_argument("The Major Industry Identifier of an American Express should be 3.") ;
- else if( real_pos_from_left == 2 && current_valid_value != 4 && current_valid_value != 7 )
- throw std::invalid_argument("The Issuer Identification Number of an American Express should be 34 or 37." ) ;
+ throw std::invalid_argument("The Major Industry Identifier of an American Express should be 3!") ;
+ else if( real_pos_from_left == 2 && current_valid_value != 4 && current_valid_value != 7 )
+ throw std::invalid_argument("The Issuer Identification Number of an American Express should be 34 or 37!" ) ;
}
};
@@ -68,7 +68,7 @@
*/
typedef amex_algorithm<1> amex_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the amex_check_algorithm type.
\pre check_seq is a valid range.
@@ -77,9 +77,9 @@
\param check_seq is the sequence of value to check.
\throws std::invalid_argument if check_seq doesn't contain exactly AMEX_SIZE digits.
- \throws std::invalid_argument if the two first digits (from the leftmost) don't match the amex pattern.
+ \throws std::invalid_argument if the two first digits (from the leftmost) don't match the Amex pattern.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_amex (const check_range& check_seq)
@@ -87,14 +87,14 @@
return boost::checks::check_sequence<amex_check_algorithm, AMEX_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the amex_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly AMEX_SIZE_WITHOUT_CHECKDIGIT digits.
\throws std::invalid_argument if the two first digits (from the leftmost) don't match the amex pattern.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -108,5 +108,5 @@
}
-}}
+}} // namespace boost namespace checks
#endif
Modified: sandbox/SOC/2011/checks/boost/checks/basic_check_algorithm.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/basic_check_algorithm.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/basic_check_algorithm.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -5,10 +5,10 @@
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file basic_check_algorithm.hpp
+/*! \file
\brief This file provides a class that should be used as an "interface" because most of the static functions should be re-implemented using inheritance.
- \remarks The class implements static functions that often common to many algorithms.
+ \remarks The class implements static functions that are common to many algorithms.
*/
#ifndef BOOST_CHECKS_BASIC_CHECK_ALGO_HPP
@@ -27,16 +27,16 @@
namespace checks{
/*! \class basic_check_algorithm
- \brief The main check algorithm class that provides every static functions that can be overloaded.\n Most of the functions must be re-implemented to have the desired behavior.
+ \brief The main check algorithm class that provides every static function that can be overloaded.\n Most of the functions must be re-implemented to have the desired behavior.
\tparam iteration_sense must meet the iteration_sense concept requirements.
- \tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped.
+ \tparam number_of_virtual_value_skipped Helper functions to provide the same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped.
*/
template <typename iteration_sense, unsigned int number_of_virtual_value_skipped = 0>
struct basic_check_algorithm
{
/*!
- \brief This is the sense of the iteration (begins with the right or the leftmost value).
+ \brief This is the sense or direction of the iteration (begins with the right or the leftmost value).
*/
typedef iteration_sense iteration_sense ;
@@ -45,14 +45,14 @@
\tparam value is the type of a value in the sequence.
\param current_value is the current value analysed in the sequence that must be translated.
- \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+ \param valid_value_counter is the number of valid value(s) already counted (the current value is not included).\n This is also the position (beyond the valid values) of the current value analysed (0 <= valid_value_counter < n).
- \throws boost::checks::translation_exception is throwed if the translation of current_value failed.\n This will automaticaly throws if the value is not a digit (0 <= i < 11).
+ \throws boost::checks::translation_exception is thrown if the translation of current_value failed.\n This will automatically throw if the value is not a digit (0 <= i < 11).
\returns the translation of the current value in the range [0..9].
*/
template <typename value>
- static int translate_to_valid_value(const value ¤t_value, const unsigned int valid_value_counter )
+ static int translate_to_valid_value(const value ¤t_value, const unsigned int /* valid_value_counter */ )
{
int valid_value = 0;
try{
@@ -70,9 +70,9 @@
\param checksum is the checksum to validate.
- \returns true.
+ \returns @c true always (unless overloaded to check a sequence).
- \remarks This function should be overload if you want to check a sequence.
+ \remarks This function should be overloaded if you want to check a sequence.
*/
static bool validate_checksum(int checksum)
{
@@ -89,13 +89,13 @@
\returns default initialized value of checkdigit.
- \remarks This function should be overload if you want to compute the check digit of a sequence.
+ \remarks This function should be overloaded if you want to compute the check digit of a sequence.
*/
template <typename checkdigit>
static typename checkdigit compute_checkdigit( int checksum )
{
return checkdigit() ;
- }
+ }
/*!
\brief Compute the check digit(s) of a sequence.
@@ -104,11 +104,11 @@
\tparam checkdigits_iter must meet the OutputIterator requirements.
\param checksum is the checksum used to extract the check digit(s).
- \param checkdigits is the iterator in which the check digit(s) will be written.
+ \param checkdigits is the iterator with which the check digit(s) will be written.
\returns checkdigits.
- \remarks This function should be overload if you want your algorithm compute more than one check digit (through it works for one check digit too).
+ \remarks This function should be overloaded if you want your algorithm to compute more than one check digit (through it works for just one check digit too).
*/
template <typename checkdigits_iter>
static typename checkdigits_iter compute_multicheckdigit( int checksum, checkdigits_iter checkdigits )
@@ -117,16 +117,16 @@
}
/*!
- \brief Compute an operation on the checksum with the current valid value
- \post Do nothing. The checksum is inchanged.
+ \brief Compute an operation on the checksum with the current valid value.
+ \post Do nothing. The checksum is unchanged.
\param current_valid_value is the current valid value analysed.
- \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+ \param valid_value_counter is the number of valid value(s) already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
\param checksum is the current checksum.
- \remarks This function should be overload if you want to calculate the checksum of a sequence.
+ \remarks This function should be overloaded if you want to calculate the checksum of a sequence.
*/
- static void operate_on_valid_value( const int current_valid_value, const unsigned int valid_value_counter, int &checksum )
+ static void operate_on_valid_value( const int /* current_valid_value */, const unsigned int /* valid_value_counter */, int &checksum )
{
}
@@ -138,9 +138,9 @@
\param current_valid_value is the current valid value analysed.
\param current_value_position is the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
- \remarks This function should be overload if you want to filter the values with their positions.
+ \remarks This function should be overloaded if you want to filter the values with their positions.
*/
- static void filter_valid_value_with_pos(const unsigned int current_valid_value, const unsigned int current_value_position )
+ static void filter_valid_value_with_pos(const unsigned int /* current_valid_value */, const unsigned int /* current_value_position */ )
{
}
@@ -149,7 +149,7 @@
\tparam check_range The type of the sequence to check.
- \remarks This function should be overload if you want to change the type of the check digit.
+ \remarks This function should be overloaded if you want to change the type of the check digit.
*/
template <typename check_range>
struct checkdigit
@@ -159,5 +159,6 @@
};
-}}
+}} // namespace boost namespace checks
+
#endif //BOOST_CHECKS_BASIC_CHECK_ALGO_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/basic_checks.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/basic_checks.hpp header file ------------------------------------//
+// Boost checks/basic_checks.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file basic_checks.hpp
+/*! \file
\brief This file provides a set of basic functions used to compute and validate check digit(s) and checksum.
*/
@@ -23,7 +23,7 @@
namespace boost {
namespace checks{
-/*!
+/*!
\brief Run through a sequence and calculate the checksum with the algorithm policy class.
\pre seq_begin and seq_end are valid iterators.
@@ -58,12 +58,12 @@
return checksum ;
}
-/*!
+/*!
\brief Create iterators according to the algorithm::iterator policy. And call the iterator overload version of compute_checksum.
-
+
\pre check_seq is a valid range.
- \tparam algorithm is a set of static method use to translate, filter and calculate or verify the checkdigit.
+ \tparam algorithm is a set of static methods used to translate, filter and calculate or verify the checkdigit.
\tparam size_contract is a contract concerning the size of the sequence.
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
@@ -82,7 +82,7 @@
return compute_checksum<algorithm, size_contract>( begin, end );
}
-/*!
+/*!
\brief Validate a sequence according to algorithm.
\pre check_seq is a valid range.
@@ -93,7 +93,7 @@
\throws std::invalid_argument if check_seq contains no valid value.
- \returns True if the checkdigit is correct, false otherwise.
+ \returns @c true if the checkdigit is correct, @c false otherwise.
*/
template <typename algorithm, typename check_range>
bool check_sequence (const check_range& check_seq)
@@ -102,7 +102,7 @@
return algorithm::validate_checksum( checksum ) ;
}
-/*!
+/*!
\brief Validate a sequence according to algorithm.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
@@ -114,7 +114,7 @@
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
- \returns True if the checkdigit is correct, false otherwise.
+ \returns @c true if the checkdigit is correct, @c false otherwise.
*/
template <typename algorithm, size_t size_expected, typename check_range>
bool check_sequence (const check_range& check_seq)
@@ -123,7 +123,7 @@
return algorithm::validate_checksum( checksum ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to algorithm.
\pre check_seq is a valid range.
@@ -143,12 +143,12 @@
return algorithm::compute_checkdigit<typename algorithm::checkdigit<check_range>::type>( checksum ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to algorithm.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
- \tparam algorithm is a set of static method use to translate, filter and calculate or verify the checkdigit.
+ \tparam algorithm is a set of static methods used to translate, filter and calculate or verify the checkdigit.
\tparam size_expected is the number of valid value expected in the sequence.
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
@@ -168,9 +168,9 @@
\brief Calculate the checkdigits of a sequence according to algorithm.
- \pre check_seq is a valid range.\n checkdigits is a valid initialized iterator and have enough reserved place to store the check digits.
+ \pre check_seq is a valid range.\n checkdigits is a valid initialized iterator and have enough reserved place to store the check digits.
- \tparam algorithm is a set of static method use to translate, filter and calculate or verify the checkdigits.
+ \tparam algorithm is a set of static methods used to translate, filter and calculate or verify the checkdigits.
\tparam check_range is a valid range type.
\tparam checkdigit_iterator must meet the OutputIterator requirements.
\param check_seq is the sequence of value to check.
@@ -187,7 +187,7 @@
return algorithm::compute_multicheckdigit( checksum, checkdigits ) ;
}
-/*!
+/*!
\brief Calculate the checkdigits of a sequence according to algorithm.
\pre check_seq is a valid range.\n checkdigits is a valid initialized iterator and have enough reserved place to store the check digits.\n size_expected > 0 (enforced by static assert).
@@ -210,6 +210,5 @@
return algorithm::compute_multicheckdigit( checksum, checkdigits ) ;
}
-}}
+}} // namespace boost namespace checks
#endif // BOOST_CHECK_BASIC_HPP
-
Modified: sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/checks_fwd.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,4 +1,4 @@
-// Boost checks/checks_fwd.hpp header file //
+// Boost checks/checks_fwd.hpp header file
// (C) Copyright Pierre Talbot 2011
@@ -140,7 +140,7 @@
bool check_ean8 (const check_range& check_seq) ;
template <typename check_range>
-typename boost::checks::ean_compute_algorithm::checkdigit<check_range>::type compute_ean8 (const check_range& check_seq);
+typename boost::checks::ean_compute_algorithm::checkdigit<check_range>::type compute_ean8 (const check_range& check_seq);
// IBSN-10 and ISBN-13
@@ -190,5 +190,5 @@
typename boost::checks::mastercard_compute_algorithm::checkdigit<check_range>::type compute_mastercard (const check_range& check_seq) ;
-}}
+}} // namespace boost namespace checks
#endif \\ BOOST_CHECK_CHECKS_FWD_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/ean.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/ean.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/ean.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,12 +1,12 @@
-// Boost checks/ean.hpp header file ------------------------------------//
+// Boost checks/ean.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file ean.hpp
- \brief This file provides tools to compute and validate an European Article Numbering of size 8 or 13.
+/*! \file
+ \brief This file provides tools to compute and validate an European Article Numbering (EAN) of size 8 or 13.
*/
#ifndef BOOST_CHECKS_EAN_HPP
@@ -22,19 +22,19 @@
#include <boost/checks/modulus10.hpp>
/*!
- \brief This macro defines the size of an EAN-13.
+ \brief This macro defines the size of an EAN-13 (13).
*/
#define EAN13_SIZE 13
/*!
- \brief This macro defines the size of an EAN-13 without its check digit.
+ \brief This macro defines the size of an EAN-13 without its check digit (12).
*/
#define EAN13_SIZE_WITHOUT_CHECKDIGIT 12
/*!
- \brief This macro defines the size of an EAN-8.
+ \brief This macro defines the size of an EAN-8 (8).
*/
-#define EAN8_SIZE 8
+#define EAN8_SIZE 8
/*!
- \brief This macro defines the size of a EAN-8 without its check digit.
+ \brief This macro defines the size of a EAN-8 without its check digit (7).
*/
#define EAN8_SIZE_WITHOUT_CHECKDIGIT 7
@@ -46,7 +46,7 @@
*/
typedef boost::checks::weight<1,3> ean_weight ;
/*!
- \brief This is the running sense to check an EAN.
+ \brief This is the running sense or direction to check an EAN.
*/
typedef boost::checks::rightmost ean_sense ;
@@ -59,7 +59,7 @@
*/
typedef boost::checks::modulus10_algorithm< ean_weight, ean_sense, 1> ean_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the ean_check_algorithm type.
\pre check_seq is a valid range.
@@ -69,7 +69,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly EAN13_SIZE digits.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_ean13 (const check_range& check_seq)
@@ -77,14 +77,14 @@
return boost::checks::check_sequence<ean_check_algorithm, EAN13_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the ean_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly EAN13_SIZE_WITHOUT_CHECKDIGIT digits.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -96,7 +96,7 @@
return boost::checks::compute_checkdigit<ean_compute_algorithm, EAN13_SIZE_WITHOUT_CHECKDIGIT> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the ean_check_algorithm type.
\pre check_seq is a valid range.
@@ -106,7 +106,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly EAN8_SIZE digits.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_ean8 (const check_range& check_seq)
@@ -114,14 +114,14 @@
return boost::checks::check_sequence<ean_check_algorithm, EAN8_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the ean_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly EAN8_SIZE_WITHOUT_CHECKDIGIT digits.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -134,5 +134,5 @@
}
-}}
+}} // namespace boost namespace checks
#endif // BOOST_CHECKS_EAN_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/isbn.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/isbn.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/isbn.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,12 +1,12 @@
-// Boost checks/isbn.hpp header file ------------------------------------//
+// Boost checks/isbn.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file isbn.hpp
- \brief This file provides tools to compute and validate an International Standard Book Number of size 10 or 13.
+/*! \file
+ \brief This file provides tools to compute and validate an International Standard Book Number (ISBN) of size 10 or 13.
\remarks The ISBN-13 is derived from the EAN number, so EAN macro or type are used.
*/
@@ -56,12 +56,12 @@
const unsigned int real_pos_from_left = EAN13_SIZE - current_value_position - number_of_virtual_value_skipped ;
if( real_pos_from_left == 1 && current_valid_value != 9)
- throw std::invalid_argument("The first digit should be 9.") ;
+ throw std::invalid_argument("The first digit should be 9!") ;
else if( real_pos_from_left == 2 && current_valid_value != 7)
- throw std::invalid_argument("The second digit should be 7.") ;
+ throw std::invalid_argument("The second digit should be 7!") ;
else if( real_pos_from_left == 3 && current_valid_value != 8 && current_valid_value != 9)
- throw std::invalid_argument("The third digit should be 8 or 9.") ;
- }
+ throw std::invalid_argument("The third digit should be 8 or 9!") ;
+ }
};
/*!
@@ -73,7 +73,7 @@
*/
typedef boost::checks::isbn13_algorithm<1> isbn13_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the isbn13_check_algorithm type.
\pre check_seq is a valid range.
@@ -83,7 +83,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly EAN13_SIZE digits.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_isbn13 (const check_range& check_seq)
@@ -91,14 +91,14 @@
return boost::checks::check_sequence<isbn13_check_algorithm, EAN13_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the isbn13_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly EAN13_SIZE_WITHOUT_CHECKDIGIT digits.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -110,7 +110,7 @@
return boost::checks::compute_checkdigit<isbn13_compute_algorithm, EAN13_SIZE_WITHOUT_CHECKDIGIT> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the mod11_check_algorithm type.
\pre check_seq is a valid range.
@@ -120,7 +120,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly ISBN10_SIZE digits.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_isbn10 (const check_range& check_seq)
@@ -128,14 +128,14 @@
return boost::checks::check_modulus11< ISBN10_SIZE >( check_seq );
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the mod11_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly ISBN10_SIZE_WITHOUT_CHECKDIGIT digits.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -148,5 +148,5 @@
}
-}}
+}} // namespace boost namespace checks
#endif // BOOST_CHECKS_ISBN_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/iteration_sense.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,12 +1,12 @@
-// Boost checks/iteration_sense.hpp header file ------------------------------------//
+// Boost checks/iteration_sense.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file iteration_sense.hpp
- \brief Provides two sense of iteration to run through the sequence from right to left or left to right.
+/*! \file
+ \brief Provides two sense or direction of iteration to run through the sequence, either from right to left or left to right.
*/
@@ -50,7 +50,7 @@
\brief Get the beginning of the sequence.
\tparam seq_range The type of the sequence to check.
- \returns A reverse iterator represents the beginning of the sequence.
+ \returns A reverse iterator representing the beginning of the sequence.
*/
template <typename seq_range>
static typename iterator<seq_range>::type begin(seq_range &sequence) { return boost::rbegin(sequence) ; }
@@ -59,7 +59,7 @@
\brief Get the ending of the sequence.
\tparam seq_range The type of the sequence to check.
- \returns A reverse iterator represents one pass the end of the sequence.
+ \returns A reverse iterator represents one past the end of the sequence.
*/
template <typename seq_range>
static typename iterator<seq_range>::type end(seq_range &sequence) { return boost::rend(sequence) ; }
@@ -89,12 +89,12 @@
*/
template <typename seq_range>
static typename iterator<seq_range>::type begin(seq_range &sequence) { return boost::begin(sequence) ; }
-
+
/*! \fn static typename iterator<seq_range>::type end(seq_range &sequence)
\brief Get the ending of the sequence.
\tparam seq_range The type of the sequence to check.
- \returns An iterator represents one pass the end of the sequence.
+ \returns An iterator represents one past the end of the sequence.
*/
template <typename seq_range>
static typename iterator<seq_range>::type end(seq_range &sequence) { return boost::end(sequence) ; }
Modified: sandbox/SOC/2011/checks/boost/checks/limits.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/limits.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/limits.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -5,7 +5,7 @@
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file limits.hpp
+/*! \file
\brief Provides two types of size contract to manage the expected size of the check sequence.
*/
@@ -22,10 +22,10 @@
namespace checks{
/*! \class strict_size_contract
- \brief This is a contract class used to verify that a sequence have the expected size.
+ \brief This is a contract class used to verify that a sequence has the expected size.
- \tparam expected_size The expected size of the sequence. (expected_size > 0, enforced with static assert).
- \tparam exception_size_failure If the size is not respected a exception_size_failure exception will be throwed. Default exception class is std::invalid_argument.
+ \tparam expected_size The expected size of the sequence. (Expected_size > 0, enforced with static assert).
+ \tparam exception_size_failure If the size is not respected an exception_size_failure exception will be thrown. Default exception class is std::invalid_argument.
*/
template <size_t expected_size, class exception_size_failure = std::invalid_argument>
struct strict_size_contract
@@ -38,28 +38,28 @@
*/
static void respect_size_contract(const size_t valid_value_counter)
{
- BOOST_STATIC_ASSERT_MSG( expected_size > 0 , "The expected size must be greater than 0" );
+ BOOST_STATIC_ASSERT_MSG( expected_size > 0 , "The expected size must be greater than 0!" );
if( valid_value_counter != expected_size )
- throw exception_size_failure("Too few or too much valid values in the sequence.") ;
+ throw exception_size_failure("Too few or too many valid values in the sequence!") ;
}
/*! \fn static bool reach_one_past_the_end(const size_t valid_value_counter)
\brief Tells if the expected interval of value [0..n) is outstripped.
\param valid_value_counter Number of valid values in the sequence already counted.
- \returns True if valid_value_counter is one past the end of the expected size, false otherwise.
+ \returns true if valid_value_counter is one past the end of the expected size, else false.
*/
static bool reach_one_past_the_end(const size_t valid_value_counter)
{
- BOOST_STATIC_ASSERT_MSG( expected_size > 0 , "The expected size must be greater than 0" );
+ BOOST_STATIC_ASSERT_MSG( expected_size > 0 , "The expected size must be greater than 0!" );
return valid_value_counter > expected_size ;
}
};
/*! \class no_null_size_contract
- \brief This is a contract class used to verify that a sequence have not a size of zero.
+ \brief This is a contract class used to verify that a sequence does not have a size of zero.
- \tparam exception_size_failure If the size is null a exception_size_failure exception will be throwed. Default exception class is std::invalid_argument.
+ \tparam exception_size_failure If the size is null, a exception_size_failure exception will be thrown. Default exception class is std::invalid_argument.
*/
template <class exception_size_failure = std::invalid_argument>
struct no_null_size_contract
@@ -68,26 +68,27 @@
\brief Enforce the size contract.
\param valid_value_counter Number of valid values in the sequence.
- \throws exception_size_failure If the terms of the contract are not respected. (valid_value_counter == 0).
+ \throws exception_size_failure if the terms of the contract are not respected. (valid_value_counter == 0).
*/
static void respect_size_contract(const size_t valid_value_counter)
{
if( valid_value_counter == 0 )
- throw exception_size_failure("No valid value in this sequence.") ;
+ throw exception_size_failure("No valid value in this sequence!") ;
}
/*! \fn static bool reach_one_past_the_end(const size_t valid_value_counter)
- \brief Tells if the expected interval of value [0..n) is outstripped.
+ \brief Warns if the expected interval of value [0..n) is exceeded.
\param valid_value_counter Number of valid values in the sequence already counted.
- \returns False.
+ \returns false.
*/
- static bool reach_one_past_the_end(const size_t valid_value_counter)
+ static bool reach_one_past_the_end(const size_t /* valid_value_counter */)
{
return false ;
}
};
-}}
+}} // namespace boost namespace checks
+
#endif // BOOST_CHECKS_LIMITS_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/luhn.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/luhn.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/luhn.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -5,7 +5,7 @@
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file luhn.hpp
+/*! \file
\brief This file provides tools to compute and validate sequence with the Luhn algorithm.
*/
@@ -38,17 +38,17 @@
*/
template <unsigned int number_of_virtual_value_skipped = 0>
struct luhn_algorithm : boost::checks::modulus10_algorithm < luhn_weight, luhn_sense, number_of_virtual_value_skipped>
-{
+{
/*!
\brief Compute the Luhn algorithm operation on the checksum.
-
+
\post checksum is equal to the new computed checksum.
\param current_valid_value is the current valid value analysed.
\param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
\param checksum is the current checksum.
- \remarks This function become obsolete if you don't use luhn_weight. It's using operator "<<" to make internal multiplication.
+ \remarks This function become obsolete if you don't use luhn_weight. It is using operator "<<" to make internal multiplication.
*/
static void operate_on_valid_value( const int current_valid_value, const unsigned int valid_value_counter, int &checksum )
{
@@ -67,7 +67,7 @@
*/
typedef luhn_algorithm<1> luhn_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the luhn_check_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
@@ -78,7 +78,7 @@
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, false otherwise.
*/
template <size_t size_expected, typename check_range>
bool check_luhn (const check_range& check_seq)
@@ -86,7 +86,7 @@
return boost::checks::check_sequence<luhn_check_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the luhn_check_algorithm type.
\pre check_seq is a valid range.
@@ -96,7 +96,7 @@
\throws std::invalid_argument if check_seq contains no valid value.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_luhn (const check_range& check_seq)
@@ -104,15 +104,15 @@
return boost::checks::check_sequence<luhn_check_algorithm> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the luhn_compute_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
-
+
\tparam size_expected is the number of valid value expected in the sequence. (So the check digit is not included.)
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -124,14 +124,14 @@
return boost::checks::compute_checkdigit<luhn_compute_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the luhn_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq contains no valid value.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -144,5 +144,6 @@
}
-}}
+}} // namespace boost namespace checks
+
#endif // BOOST_CHECKS_LUHN_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/mastercard.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/mastercard.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/mastercard.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/mastercard.hpp header file ------------------------------------//
+// Boost checks/mastercard.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file mastercard.hpp
+/*! \file
\brief This file provides tools to compute and validate a Mastercard credit card number.
*/
@@ -31,18 +31,18 @@
namespace checks{
/*! \class mastercard_algorithm
- \brief This class can be used to compute or validate checksum with the Luhn algorithm but filter following the Mastercard pattern.
+ \brief This class can be used to compute or validate checksum with the Luhn algorithm, but filter following the Mastercard pattern.
\tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without check digits. No "real" value in the sequence will be skipped.
*/
template <unsigned int number_of_virtual_value_skipped = 0>
struct mastercard_algorithm : boost::checks::luhn_algorithm < number_of_virtual_value_skipped >
-{
+{
/*!
\brief Verify that a number matches the Mastercard pattern.
\param current_valid_value is the current valid value analysed.
- \param current_value_position is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+ \param current_value_position is the number of valid values already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
\throws std::invalid_argument if the first character is not equal to 5 or the second is not between 1 and 5. The exception contains a descriptive message of what was expected.
@@ -53,9 +53,9 @@
const unsigned int real_pos_from_left = MASTERCARD_SIZE - current_value_position - number_of_virtual_value_skipped ;
if( real_pos_from_left == 1 && current_valid_value != 5)
- throw std::invalid_argument("The Major Industry Identifier of a Mastercard should be 5.") ;
- else if( real_pos_from_left == 2 && (current_valid_value == 0 || current_valid_value > 5) )
- throw std::invalid_argument("The Issuer Identification Number of an Mastercard should be between 51 and 55." ) ;
+ throw std::invalid_argument("The Major Industry Identifier of a Mastercard should be 5!") ;
+ else if( real_pos_from_left == 2 && (current_valid_value == 0 || current_valid_value > 5) )
+ throw std::invalid_argument("The Issuer Identification Number of an Mastercard should be between 51 and 55!" ) ;
}
};
@@ -68,7 +68,7 @@
*/
typedef mastercard_algorithm<1> mastercard_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the mastercard_check_algorithm type.
\pre check_seq is a valid range.
@@ -77,7 +77,7 @@
\param check_seq is the sequence of value to check.
\throws std::invalid_argument if check_seq doesn't contain exactly MASTERCARD_SIZE digits.
- \throws std::invalid_argument if the two first digits (from the leftmost) don't match the mastercard pattern.
+ \throws std::invalid_argument if the two first digits (from the leftmost) don't match the Mastercard pattern.
\returns True if the check digit is correct, false otherwise.
*/
@@ -87,16 +87,16 @@
return boost::checks::check_sequence<mastercard_check_algorithm, MASTERCARD_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the mastercard_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly MASTERCARD_SIZE_WITHOUT_CHECKDIGIT digits.
- \throws std::invalid_argument if the two first digits (from the leftmost) don't match the mastercard pattern.
+ \throws std::invalid_argument if the two first digits (from the leftmost) do not match the Mastercard pattern.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
\returns The check digit. The check digit is in the range [0..9].
@@ -108,6 +108,6 @@
}
-}}
+}} // namespace boost namespace checks
#endif // BOOST_CHECKS_MASTERCARD_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/modulus10.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/modulus10.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/modulus10.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/modulus10.hpp header file ------------------------------------//
+// Boost checks/modulus10.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file modulus10.hpp
+/*! \file
\brief This file provides tools to compute and validate classic modulus 10 checksum.
*/
@@ -40,7 +40,7 @@
\param checksum is the checksum to validate.
- \returns true if the checksum is correct, false otherwise.
+ \returns @c true if the checksum is correct, @c false otherwise.
*/
static bool validate_checksum(int checksum)
{
@@ -54,7 +54,7 @@
\param checksum is the checksum used to extract the check digit.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
-
+
\returns The modulus 10 check digit of checksum.
*/
template <typename checkdigit>
@@ -68,6 +68,6 @@
}
};
-}}
+}} // namespace boost namespace checks
-#endif //BOOST_CHECKS_MOD10_HPP
\ No newline at end of file
+#endif //BOOST_CHECKS_MOD10_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/modulus11.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/modulus11.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/modulus11.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -5,7 +5,7 @@
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file modulus11.hpp
+/*! \file
\brief This file provides tools to compute and validate classic modulus 11 checksum.
*/
@@ -33,7 +33,7 @@
\tparam iteration_sense must meet the iteration_sense concept requirements.
\tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without check digits. No "real" value in the sequence will be skipped.
- \remarks The range of the check digit is [0..10], the tenth element is translated as the letter 'X'.
+ \remarks The range of the check digit is [0..10], the tenth element is translated as the letter 'X'.
*/
template <typename mod11_weight, typename iteration_sense, unsigned int number_of_virtual_value_skipped = 0>
struct modulus11_algorithm : boost::checks::weighted_sum_algorithm<mod11_weight, iteration_sense, number_of_virtual_value_skipped>
@@ -46,13 +46,13 @@
\param current_value is the current value analysed in the sequence that must be translated.
\param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
- \throws boost::checks::translation_exception is throwed if the translation of current_value failed.\n The translation will fail if the current value is not a digit (0 <= i < 10). If it's the rightmost digit the value 10 or the 'x' or 'X' character is allowed.
+ \throws boost::checks::translation_exception is thrown if the translation of current_value failed.\n The translation will fail if the current value is not a digit (0 <= i < 10), unless it is the rightmost digit, when the value 10 or the 'x' or 'X' character is allowed.
\returns the translation of the current value in the range [0..10].
*/
template <typename value>
static int translate_to_valid_value(const value ¤t_value, const unsigned int valid_value_counter )
- {
+ {
int valid_value = 0;
try
{
@@ -89,8 +89,8 @@
\param checksum is the checksum used to extract the check digit.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
-
- \returns The modulus 11 check digit of checksum. 'X' is returned if the check digit is equal to 10.
+
+ \returns The modulus 11 check digit of checksum. 'X' is returned if the check digit value is equal to 10.
*/
template <typename checkdigit>
static typename checkdigit compute_checkdigit( int checksum )
@@ -114,7 +114,7 @@
}
catch( boost::bad_lexical_cast )
{
- throw boost::checks::translation_exception() ;
+ throw boost::checks::translation_exception() ;
}
}
}
@@ -126,7 +126,7 @@
*/
typedef boost::checks::weight<1,2,3,4,5,6,7,8,9,10> mod11_weight ;
/*!
- \brief The most common iteration sense used with a modulus 11 algorithm.
+ \brief The most common iteration sense or direction used with a modulus 11 algorithm (right to left).
*/
typedef boost::checks::rightmost mod11_sense ;
@@ -139,7 +139,7 @@
*/
typedef modulus11_algorithm<mod11_weight, mod11_sense, 1> mod11_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the mod11_check_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
@@ -150,7 +150,7 @@
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, false otherwise.
*/
template <size_t size_expected, typename check_range>
bool check_modulus11 (const check_range& check_seq)
@@ -158,7 +158,7 @@
return boost::checks::check_sequence<mod11_check_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the mod11_check_algorithm type.
\pre check_seq is a valid range.
@@ -168,7 +168,7 @@
\throws std::invalid_argument if check_seq contains no valid value.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, false otherwise.
*/
template <typename check_range>
bool check_modulus11 (const check_range& check_seq)
@@ -176,15 +176,15 @@
return boost::checks::check_sequence<mod11_check_algorithm> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the mod11_compute_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
-
+
\tparam size_expected is the number of valid value expected in the sequence. (So the check digit is not included.)
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -196,14 +196,14 @@
return boost::checks::compute_checkdigit<mod11_compute_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the mod11_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq contains no valid value.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -215,6 +215,7 @@
return boost::checks::compute_checkdigit<mod11_compute_algorithm> ( check_seq ) ;
}
-}}
+}} // namespace boost namespace checks
+
#endif //BOOST_CHECKS_MOD10_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/modulus97.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/modulus97.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/modulus97.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,12 +1,13 @@
-// Boost checks/modulus97.hpp header file ------------------------------------//
+// Boost checks/modulus97.hpp header file
+
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file modulus97.hpp
- \brief This file provides tools to compute and validate classic modulus 97 checksum. It provides function for convenience with the mod97-10 algorithm (ISO/IEC 7064:2003).
+/*! \file
+ \brief This file provides tools to compute and validate the classic modulus 97 checksum. It provides functions for convenience with the mod97-10 algorithm (ISO/IEC 7064:2003).
*/
#ifndef BOOST_CHECKS_MOD97_HPP
@@ -27,7 +28,8 @@
namespace checks{
/*! \class modulus97_algorithm
- \brief This class can be used to compute or validate checksum with a basic modulus 97.
+ \brief This class can be used to compute or validate a checksum with a basic modulus 97.
+ \detail The mod97-10 algorithm (ISO/IEC 7064:2003 Information technology -- Security techniques -- Check character systems) uses two check digits.
\tparam mod97_weight must meet the weight concept requirements.
\tparam iteration_sense must meet the iteration_sense concept requirements.
@@ -43,7 +45,7 @@
\param checksum is the checksum to validate.
- \returns true if the checksum is correct, false otherwise.
+ \returns @c true if the checksum is correct, @c false otherwise.
*/
static bool validate_checksum(int checksum)
{
@@ -59,10 +61,10 @@
\tparam checkdigits_iter must meet the OutputIterator requirements.
\param checksum is the checksum used to extract the check digit.
\param checkdigits is the output iterator in which the two check digits will be written.
-
+
\throws boost::checks::translation_exception if the check digits cannot be translated into the check digits_iter type.
-
- \returns An iterator initialized at one pass the end of the two check digits.
+
+ \returns An iterator initialized at one pass to the end of the two check digits.
*/
template <typename checkdigits_iter>
static typename checkdigits_iter compute_multicheckdigit( int checksum, checkdigits_iter checkdigits )
@@ -70,9 +72,9 @@
unsigned int mod97_checkdigits = 98 - (checksum % 97) ;
try{
- *checkdigits = boost::lexical_cast<checkdigits_iter::value_type>(mod97_checkdigits / 10) ;
+ *checkdigits = boost::lexical_cast<checkdigits_iter::value_type>(mod97_checkdigits / 10) ;
++checkdigits;
- *checkdigits = boost::lexical_cast<checkdigits_iter::value_type>(mod97_checkdigits % 10) ;
+ *checkdigits = boost::lexical_cast<checkdigits_iter::value_type>(mod97_checkdigits % 10) ;
++checkdigits;
}
catch( boost::bad_lexical_cast ){
@@ -83,7 +85,7 @@
};
/*! \class make_mod97_weight
- \brief This class is used to pre-computed the weight of the mod97-10 algorithm (a = 1; a = a * 10 % 97 ;).
+ \brief This class is used to pre-compute the weight of the mod97-10 algorithm (a = 1; a = a * 10 % 97 ;).
\tparam weight_value is the weight value stored by make_mod97_weight.
@@ -96,7 +98,7 @@
typedef make_mod97_weight<weight_value * 10 % 97> next ;
};
/*! \class make_mod97_weight
- \brief This class is the terminal specialisation of make_mod97_weight, so the recursion can finish.
+ \brief This class is the terminal specialisation of make_mod97_weight, so the recursion can finish.
*/
template<>
struct make_mod97_weight<68>
@@ -106,7 +108,7 @@
};
/*!
- \brief This is the initial weight for the mod97-10 weights serie.
+ \brief This is the initial weight for the mod97-10 weights series.
*/
typedef make_mod97_weight<1> initial_mod97_weight ;
@@ -127,7 +129,7 @@
typedef boost::checks::weight< BOOST_PP_ENUM(96, MOD97_weight_maker, ~) > mod97_10_weight ;
/*!
- \brief The iteration sense of the sequence. From right to left.
+ \brief The iteration sense or direction of the sequence. From right to left.
*/
typedef boost::checks::rightmost mod97_10_sense ;
@@ -140,7 +142,7 @@
*/
typedef modulus97_algorithm< mod97_10_weight, mod97_10_sense, 2 > mod97_10_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the mod97_10_check_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
@@ -159,7 +161,7 @@
return boost::checks::check_sequence<mod97_10_check_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the mod97_10_check_algorithm type.
\pre check_seq is a valid range.
@@ -169,7 +171,7 @@
\throws std::invalid_argument if check_seq contains no valid value.
- \returns True if the two check digits are correct, false otherwise.
+ \returns @c true if the two check digits are correct, @c false otherwise.
*/
template <typename check_range>
bool check_mod97_10 (const check_range& check_seq)
@@ -177,17 +179,17 @@
return boost::checks::check_sequence<mod97_10_check_algorithm> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digits of a sequence according to the mod97_10_compute_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).\n mod97_checkdigits should have enough reserved place to store the two check digits.
-
+
\tparam size_expected is the number of valid value expected in the sequence. (So the check digits are not included.)
\tparam check_range is a valid range type.
\tparam checkdigits_iter must meet the OutputIterator requirements.
\param check_seq is the sequence of value to check.
\param mod97_checkdigits is the OutputIterator in which the two check digits will be stored.
-
+
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
\throws boost::checks::translation_exception if the check digits cannot be translated into the checkdigits_iter type.
@@ -199,16 +201,16 @@
return boost::checks::compute_multicheckdigit<mod97_10_compute_algorithm, size_expected> ( check_seq, mod97_checkdigits ) ;
}
-/*!
+/*!
\brief Calculate the check digits of a sequence according to the mod97_10_compute_algorithm type.
\pre check_seq is a valid range.\n mod97_checkdigits should have enough reserved place to store the two check digits.
-
+
\tparam check_range is a valid range type.
\tparam checkdigits_iter must meet the OutputIterator requirements.
\param check_seq is the sequence of value to check.
\param mod97_checkdigits is the OutputIterator in which the two check digits will be stored.
-
+
\throws std::invalid_argument if check_seq contains no valid value.
\throws boost::checks::translation_exception if the check digits cannot be translated into the checkdigits_iter type.
@@ -221,5 +223,6 @@
}
-}}
+}} // namespace boost namespace checks
+
#endif //BOOST_CHECKS_MOD97_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/translation_exception.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/translation_exception.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/translation_exception.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/translation_exception.hpp header file ------------------------------------//
+// Boost checks/translation_exception.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file translation_exception.hpp
+/*! \file
\brief This file provides an exception class used when the translation of a value failed.
*/
@@ -26,7 +26,7 @@
class translation_exception : public std::exception
{
};
-
-}}
+
+}} // namespace boost namespace checks
#endif // BOOST_CHECKS_translation_EXCEPTION_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/upc.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/upc.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/upc.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/upc.hpp header file ------------------------------------//
+// Boost checks/upc.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file upc.hpp
+/*! \file
\brief This file provides tools to compute and validate an Universal Product Code.
*/
@@ -38,7 +38,7 @@
*/
typedef boost::checks::weight<1,3> upc_weight ;
/*!
- \brief This is the running sense to check an UPC.
+ \brief This is the running sense or direction to check an UPC.
*/
typedef boost::checks::rightmost upc_sense ;
@@ -51,7 +51,7 @@
*/
typedef boost::checks::modulus10_algorithm< upc_weight, upc_sense, 1> upc_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the upc_check_algorithm type.
\pre check_seq is a valid range.
@@ -61,7 +61,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly UPCA_SIZE digits.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_upca (const check_range& check_seq)
@@ -69,14 +69,14 @@
return boost::checks::check_sequence<upc_check_algorithm, UPCA_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the upc_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly UPCA_SIZE_WITHOUT_CHECKDIGIT digits.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -88,6 +88,5 @@
return boost::checks::compute_checkdigit<upc_compute_algorithm, UPCA_SIZE_WITHOUT_CHECKDIGIT> ( check_seq ) ;
}
-
-}}
-#endif // BOOST_CHECKS_UPCA_HPP
\ No newline at end of file
+}} // namespace boost namespace checks
+#endif // BOOST_CHECKS_UPCA_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/verhoeff.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/verhoeff.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/verhoeff.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -5,7 +5,7 @@
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file verhoeff.hpp
+/*! \file
\brief This file provides tools to compute a Verhoeff checksum.
*/
@@ -38,10 +38,10 @@
*/
template <unsigned int number_of_virtual_value_skipped = 0>
struct verhoeff_algorithm : boost::checks::basic_check_algorithm<verhoeff_iteration_sense, number_of_virtual_value_skipped>
-{
+{
/*!
\brief Compute the Verhoeff scheme on the checksum with the current valid value.
-
+
\post checksum is equal to the new computed checksum.
\param current_valid_value is the current valid value analysed.
@@ -86,7 +86,7 @@
\param checksum is the checksum to validate.
- \returns true if the checksum is correct, false otherwise.
+ \returns @c true if the checksum is correct, @c false otherwise.
*/
static bool validate_checksum(int checksum)
{
@@ -100,7 +100,7 @@
\param checksum is the checksum used to extract the check digit.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
-
+
\returns The Verhoeff check digit of checksum.
*/
template <typename checkdigit>
@@ -128,7 +128,7 @@
*/
typedef verhoeff_algorithm<1> verhoeff_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the verhoeff_check_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
@@ -139,7 +139,7 @@
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <size_t size_expected, typename check_range>
bool check_verhoeff (const check_range& check_seq)
@@ -147,7 +147,7 @@
return boost::checks::check_sequence<verhoeff_check_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Validate a sequence according to the verhoeff_check_algorithm type.
\pre check_seq is a valid range.
@@ -157,7 +157,7 @@
\throws std::invalid_argument if check_seq contains no valid value.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_verhoeff (const check_range& check_seq)
@@ -165,15 +165,15 @@
return boost::checks::check_sequence<verhoeff_check_algorithm> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the verhoeff_compute_algorithm type.
\pre check_seq is a valid range.\n size_expected > 0 (enforced by static assert).
-
+
\tparam size_expected is the number of valid value expected in the sequence. (So the check digit is not included.)
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain size_expected valid values.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -185,14 +185,14 @@
return boost::checks::compute_checkdigit<verhoeff_compute_algorithm, size_expected> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the verhoeff_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq contains no valid value.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
Modified: sandbox/SOC/2011/checks/boost/checks/visa.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/visa.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/visa.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/visa.hpp header file ------------------------------------//
+// Boost checks/visa.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file visa.hpp
+/*! \file
\brief This file provides tools to compute and validate a Visa credit card number.
*/
@@ -19,11 +19,11 @@
#include <boost/checks/luhn.hpp>
/*!
- \brief This macro defines the size of a Visa number.
+ \brief This macro defines the size of a Visa number (16).
*/
#define VISA_SIZE 16
/*!
- \brief This macro defines the size of a Visa number without its check digit.
+ \brief This macro defines the size of a Visa number without its check digit (15).
*/
#define VISA_SIZE_WITHOUT_CHECKDIGIT 15
@@ -31,13 +31,13 @@
namespace checks{
/*! \class visa_algorithm
- \brief This class can be used to compute or validate checksum with the Luhn algorithm but filter following the Visa pattern.
+ \brief This class can be used to compute or validate checksum with the Luhn algorithm, but filter following the Visa pattern.
- \tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without check digits. No "real" value in the sequence will be skipped.
+ \tparam number_of_virtual_value_skipped Helper functions to provide same behavior on a sequence with and without check digits. No "real" value in the sequence will be skipped.
*/
template <unsigned int number_of_virtual_value_skipped = 0>
struct visa_algorithm : boost::checks::luhn_algorithm < number_of_virtual_value_skipped >
-{
+{
/*!
\brief Verify that a number matches the Visa pattern.
@@ -53,8 +53,8 @@
const unsigned int real_pos_from_left = VISA_SIZE - current_value_position - number_of_virtual_value_skipped ;
if( real_pos_from_left == 1 && current_valid_value != 4)
- throw std::invalid_argument("The Major Industry Identifier of a VISA credit card should be 4.") ;
- }
+ throw std::invalid_argument("The Major Industry Identifier of a VISA credit card should be 4!") ;
+ }
};
/*!
@@ -66,7 +66,7 @@
*/
typedef visa_algorithm<1> visa_compute_algorithm ;
-/*!
+/*!
\brief Validate a sequence according to the visa_check_algorithm type.
\pre check_seq is a valid range.
@@ -77,7 +77,7 @@
\throws std::invalid_argument if check_seq doesn't contain exactly VISA_SIZE digits.
\throws std::invalid_argument if the first digit (from the leftmost) doesn't match the Visa pattern.
- \returns True if the check digit is correct, false otherwise.
+ \returns @c true if the check digit is correct, @c false otherwise.
*/
template <typename check_range>
bool check_visa (const check_range& check_seq)
@@ -85,14 +85,14 @@
return boost::checks::check_sequence<visa_check_algorithm, VISA_SIZE> ( check_seq ) ;
}
-/*!
+/*!
\brief Calculate the check digit of a sequence according to the visa_compute_algorithm type.
\pre check_seq is a valid range.
-
+
\tparam check_range is a valid range type.
\param check_seq is the sequence of value to check.
-
+
\throws std::invalid_argument if check_seq doesn't contain exactly VISA_SIZE_WITHOUT_CHECKDIGIT digits.
\throws std::invalid_argument if the first digit (from the leftmost) doESn't match the Visa pattern.
\throws boost::checks::translation_exception if the check digit cannot be translated into the checkdigit type.
@@ -106,5 +106,5 @@
}
-}}
+}} // namespace boost namespace checks
#endif // BOOST_CHECKS_VISA_HPP
Modified: sandbox/SOC/2011/checks/boost/checks/weight.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/weight.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/weight.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/weight.hpp header file ------------------------------------//
+// Boost checks/weight.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file weight.hpp
+/*! \file
\brief Provides a template overriden struct to encapsulate a compile-time weight sequence.
*/
@@ -20,10 +20,10 @@
#include <boost/preprocessor/facilities/intercept.hpp>
/*! \def BOOST_CHECK_LIMIT_WEIGHTS
- \brief The BOOST_CHECK_LIMIT_WEIGHTS macro defines the maximum number of weight accepted by the library.
+ \brief The BOOST_CHECK_LIMIT_WEIGHTS macro defines the maximum number of weights accepted by the library.
- \remarks This macro expands to 100. For compile-time saving, you can decrease it if the algorithm used have a lower weight size sequence.
- A contrario, you can increase it till 236 (see Boost.preprocessor for more details about this limit.)
+ \remarks This macro expands to 100. For compile-time saving, you can decrease it if the algorithm(s) used have a lower weight size sequence.
+ A contrario, you can increase it till 236 (see Boost.Preprocessor for more details about this limit.)
*/
#define BOOST_CHECK_LIMIT_WEIGHTS 100
@@ -32,7 +32,7 @@
/*! \class weight
\brief The weight metafunction encapsulate 0 to BOOST_CHECK_LIMIT_WEIGHTS weights.
- \tparam weight_value The weights are implicitly linked to a position through a sequence. No weight means a weight of 1 for all the digits.
+ \tparam weight_value The weights are implicitly linked to a position through a sequence. No weight means an equal weight of 1 for all the digits.
\remarks There are BOOST_CHECK_LIMIT_WEIGHTS partial specialisations of this class.
*/
@@ -57,12 +57,12 @@
static const int weights[weight_size] = { BOOST_PP_ENUM_PARAMS(weight_size, weight_value) } ; \
return weights[value_pos % weight_size] ; \
} \
- } ;
+ } ;
// Develop the macro _WEIGHT_factory BOOST_CHECK_LIMIT_WEIGHTS times.
BOOST_PP_REPEAT_FROM_TO(1,BOOST_CHECK_LIMIT_WEIGHTS,_WEIGHT_factory,~)
#undef _WEIGHT_factory
-}}
+}} // namespace boost namespace checks
#endif //BOOST_CHECK_WEIGHT_HPP
\ No newline at end of file
Modified: sandbox/SOC/2011/checks/boost/checks/weighted_sum.hpp
==============================================================================
--- sandbox/SOC/2011/checks/boost/checks/weighted_sum.hpp (original)
+++ sandbox/SOC/2011/checks/boost/checks/weighted_sum.hpp 2011-09-05 13:42:18 EDT (Mon, 05 Sep 2011)
@@ -1,11 +1,11 @@
-// Boost checks/weighted_sum.hpp header file ------------------------------------//
+// Boost checks/weighted_sum.hpp header file
// (C) Copyright Pierre Talbot 2011
// Distributed under the Boost Software License, Version 1.0. (See
// accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt
// See http://www.boost.org for updates, documentation, and revision history.
-/*! \file weighted_sum.hpp
+/*! \file
\brief This file provides tools to compute weighted sum.
*/
@@ -24,22 +24,22 @@
namespace checks{
/*! \class weighted_sum_algorithm
- \brief This class permit to add to the current checksum the weight multiply by the current value.
+ \brief This class permits to add to the current checksum the weight multiplied by the current value.
\tparam weight must meet the weight concept requirements.
\tparam iteration_sense must meet the iteration_sense concept requirements.
- \tparam number_of_virtual_value_skipped Help functions to provide same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped.
+ \tparam number_of_virtual_value_skipped Helper function to provide same behavior on sequence with and without checkdigits. No "real" value in the sequence will be skipped.
*/
template <typename weight, typename iteration_sense, unsigned int number_of_virtual_value_skipped = 0>
struct weighted_sum_algorithm : boost::checks::basic_check_algorithm< iteration_sense >
-{
+{
/*!
\brief Compute an operation on the checksum with the current valid value.
- \post The current weight multiply by the current value is added to the checksum.
+ \post The current weight multiplied by the current value is added to the checksum.
\param current_valid_value is the current valid value analysed.
- \param valid_value_counter is the number of valid value already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
+ \param valid_value_counter is the number of valid values already counted (the current value is not included).\n This is also the position (above the valid values) of the current value analysed (0 <= valid_value_counter < n).
\param checksum is the current checksum.
*/
static void operate_on_valid_value( const int current_valid_value, const unsigned int valid_value_counter, int &checksum )
@@ -49,6 +49,6 @@
}
};
-}}
+}}// namespace boost namespace checks
-#endif //BOOST_CHECKS_MOD10_HPP
\ No newline at end of file
+#endif //BOOST_CHECKS_MOD10_HPP
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk