diff options
author | Jack Lloyd <[email protected]> | 2017-11-14 20:58:18 -0500 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2017-11-14 20:58:18 -0500 |
commit | 122ceb41f0366a48e84eac3e69e940db2a00eb28 (patch) | |
tree | 4a75edb73356b723a192e75b0daca20ceb75893b /doc/manual/bigint.rst | |
parent | f66fd9c12ff7d64c925e73be12a27135790994c3 (diff) |
Update manual to avoid use of old integer typedefs.
Diffstat (limited to 'doc/manual/bigint.rst')
-rw-r--r-- | doc/manual/bigint.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/manual/bigint.rst b/doc/manual/bigint.rst index 04af0c6db..421ed27c5 100644 --- a/doc/manual/bigint.rst +++ b/doc/manual/bigint.rst @@ -13,13 +13,13 @@ Encoding Functions These transform the normal representation of a ``BigInt`` into some other form, such as a decimal string: -.. cpp:function:: secure_vector<byte> BigInt::encode(const BigInt& n, Encoding enc = Binary) +.. cpp:function:: secure_vector<uint8_t> BigInt::encode(const BigInt& n, Encoding enc = Binary) This function encodes the BigInt n into a memory vector. ``Encoding`` is an enum that has values ``Binary``, ``Decimal``, and ``Hexadecimal``. -.. cpp:function:: BigInt BigInt::decode(const std::vector<byte>& vec, Encoding enc) +.. cpp:function:: BigInt BigInt::decode(const std::vector<uint8_t>& vec, Encoding enc) Decode the integer from ``vec`` using the encoding specified. @@ -27,7 +27,7 @@ These functions are static member functions, so they would be called like this:: BigInt n1 = ...; // some number - secure_vector<byte> n1_encoded = BigInt::encode(n1); + secure_vector<uint8_t> n1_encoded = BigInt::encode(n1); BigInt n2 = BigInt::decode(n1_encoded); assert(n1 == n2); |