[PATCH] Update docs Thanks to Bing Shi

Gbp-Pq: Name update_gf2n_docs.patch

diff --git a/gf2n.cpp b/gf2n.cpp
index 452e698254daccadd4c576198029dd03b52e2f00..8993baaed96987f4cdca0d8683a5be5eeb211c2b 100644 (file)
--- a/gf2n.cpp
+++ b/gf2n.cpp
@@ -135,6 +135,9 @@ PolynomialMod2 PolynomialMod2::Monomial(size_t i)
 \r
 PolynomialMod2 PolynomialMod2::Trinomial(size_t t0, size_t t1, size_t t2)\r
 {\r
+       CRYPTOPP_ASSERT(t0 > t1);\r
+       CRYPTOPP_ASSERT(t1 > t2);\r
+\r
        PolynomialMod2 r((word)0, t0+1);\r
        r.SetBit(t0);\r
        r.SetBit(t1);\r
@@ -144,6 +147,11 @@ PolynomialMod2 PolynomialMod2::Trinomial(size_t t0, size_t t1, size_t t2)
 \r
 PolynomialMod2 PolynomialMod2::Pentanomial(size_t t0, size_t t1, size_t t2, size_t t3, size_t t4)\r
 {\r
+       CRYPTOPP_ASSERT(t0 > t1);\r
+       CRYPTOPP_ASSERT(t1 > t2);\r
+       CRYPTOPP_ASSERT(t2 > t3);\r
+       CRYPTOPP_ASSERT(t3 > t4);\r
+\r
        PolynomialMod2 r((word)0, t0+1);\r
        r.SetBit(t0);\r
        r.SetBit(t1);\r

diff --git a/gf2n.h b/gf2n.h
index 4aef31ee49cb6e297eafbf8715de4a708d326972..38e2a910ff743ee672cfaae11e5eb813e1b1f93f 100644 (file)
--- a/gf2n.h
+++ b/gf2n.h
@@ -69,9 +69,11 @@ public:
                static PolynomialMod2 CRYPTOPP_API Monomial(size_t i);\r
                /// \brief Provides x^t0 + x^t1 + x^t2\r
                /// \return x^t0 + x^t1 + x^t2\r
+               /// \pre The coefficients should be provided in descending order. That is, <pre>t0 > t1 > t2<pre>.\r
                static PolynomialMod2 CRYPTOPP_API Trinomial(size_t t0, size_t t1, size_t t2);\r
                /// \brief Provides x^t0 + x^t1 + x^t2 + x^t3 + x^t4\r
                /// \return x^t0 + x^t1 + x^t2 + x^t3 + x^t4\r
+               /// \pre The coefficients should be provided in descending order. That is, <pre>t0 > t1 > t2 > t3 > t4<pre>.\r
                static PolynomialMod2 CRYPTOPP_API Pentanomial(size_t t0, size_t t1, size_t t2, size_t t3, size_t t4);\r
                /// \brief Provides x^(n-1) + ... + x + 1\r
                /// \return x^(n-1) + ... + x + 1\r