shadps4-emu/ext-cryptopp
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-cryptopp.git synced 2024-11-26 19:30:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Jeffrey Walton 2022-05-29 14:13:20 -04:00
parent c88e4bde0a
commit 9ea66ce4d9
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pubkey.h
View File

@ -78,16 +78,16 @@ public:
/// \return the maximum size of a message before the trapdoor function is applied
/// \details Derived classes must implement PreimageBound().
virtual Integer PreimageBound() const =0;
/// \brief Returns the maximum size of a message after the trapdoor function is applied
/// \return the maximum size of a message after the trapdoor function is applied
/// \brief Returns the maximum size of a representation after the trapdoor function is applied
/// \return the maximum size of a representation after the trapdoor function is applied
/// \details Derived classes must implement ImageBound().
virtual Integer ImageBound() const =0;
/// \brief Returns the maximum size of a message before the trapdoor function is applied bound to a public key
/// \return the maximum size of a message before the trapdoor function is applied bound to a public key
/// \details The default implementation returns <tt>PreimageBound() - 1</tt>.
virtual Integer MaxPreimage() const {return --PreimageBound();}
/// \brief Returns the maximum size of a message after the trapdoor function is applied bound to a public key
/// \return the maximum size of a message after the trapdoor function is applied bound to a public key
/// \brief Returns the maximum size of a representation after the trapdoor function is applied bound to a public key
/// \return the maximum size of a representation after the trapdoor function is applied bound to a public key
/// \details The default implementation returns <tt>ImageBound() - 1</tt>.
virtual Integer MaxImage() const {return --ImageBound();}
};
@ -132,7 +132,7 @@ public:
/// \param x the message on which the encryption function is applied
/// \details ApplyRandomizedFunction is a generalization of encryption under a public key
/// cryptosystem. The RandomNumberGenerator may (or may not) be required.
/// \details Internally, ApplyRandomizedFunction() calls ApplyFunction() \a
/// \details Internally, ApplyRandomizedFunction() calls ApplyFunction()
/// without the RandomNumberGenerator.
Integer ApplyRandomizedFunction(RandomNumberGenerator &rng, const Integer &x) const
{CRYPTOPP_UNUSED(rng); return ApplyFunction(x);}
@ -185,7 +185,7 @@ public:
/// \param x the message on which the decryption function is applied
/// \return the message x decrypted under the private key
/// \details CalculateRandomizedInverse is a generalization of decryption using the private key
/// \details Internally, CalculateRandomizedInverse() calls CalculateInverse() \a
/// \details Internally, CalculateRandomizedInverse() calls CalculateInverse()
/// without the RandomNumberGenerator.
Integer CalculateRandomizedInverse(RandomNumberGenerator &rng, const Integer &x) const
{return CalculateInverse(rng, x);}