big_integer_gmp.h

Go to the documentation of this file.

/*
SeComLib
Copyright 2012-2013 TU Delft, Information Security & Privacy Lab (http://isplab.tudelft.nl/)

Contributors:
Inald Lagendijk (R.L.Lagendijk@TUDelft.nl)
Mihai Todor (todormihai@gmail.com)
Thijs Veugen (P.J.M.Veugen@tudelft.nl)
Zekeriya Erkin (z.erkin@tudelft.nl)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#ifndef BIG_INTEGER_GMP_HEADER_GUARD
#define BIG_INTEGER_GMP_HEADER_GUARD

#include "big_integer_base.h"

//include C++ headers
#include <iostream>
#include <string>
#include <stdexcept>

//include 3rd party library headers
#if defined(LIB_GMP)
    #if defined(_WIN32)
        #pragma warning(push)
        #pragma warning(disable: 4127)//disable "warning C4127: conditional expression is constant"
        #pragma warning(disable: 4146)//disable "warning C4146: unary minus operator applied to unsigned type, result still unsigned"
        #include "gmp/gmp.h"
        #pragma warning(pop)//restore warnings
    #else
        #include "gmp.h"
    #endif
#elif defined(LIB_MPIR)
    #if defined(_WIN32)
        #pragma warning(push)
        #pragma warning(disable: 4127)//disable "warning C4127: conditional expression is constant"
        #include "mpir/mpir.h"
        #pragma warning(pop)//restore warnings
    #else
        #include "mpir.h"
    #endif
#endif

namespace SeComLib {
namespace Core {
    #define MILLER_RABIN_PRIMALITY_TEST_COUNT 10

    //forward-declare the GMP random provider wrapper
    class RandomProviderGmp;

    class BigIntegerGmp {
    public:
        typedef mpz_t BigIntegerType;

        typedef RandomProviderGmp RandomGeneratorImpl;

        static void Initialize (BigIntegerBase<BigIntegerGmp> &input);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &value);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const long value);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const unsigned long value);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const double value, const BigIntegerBase<BigIntegerGmp> &scaling, const bool truncate = false);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const double value, const unsigned int numberOfDigits, const bool truncate = false);
        static void Initialize (BigIntegerBase<BigIntegerGmp> &input, const std::string &value, const int base = 0);

        static void Destroy (BigIntegerBase<BigIntegerGmp> &input);

        static void Set (BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &value);
        static void Set (BigIntegerBase<BigIntegerGmp> &input, const long value);
        static void Set (BigIntegerBase<BigIntegerGmp> &input, const unsigned long value);

        static void InvertSign (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input);

        static void Add (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void Add (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const long rhs);
        static void Add (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const unsigned long rhs);

        static void Subtract (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void Subtract (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const long rhs);
        static void Subtract (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const unsigned long rhs);

        static void Multiply (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void Multiply (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const long rhs);
        static void Multiply (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const unsigned long rhs);

        static void Divide (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void Divide (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const long rhs);
        static void Divide (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const unsigned long rhs);

        static void Modulo (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &n);
        static void Modulo (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const long n);
        static void Modulo (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const unsigned long n);

        static int Compare (const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static int Compare (const BigIntegerBase<BigIntegerGmp> &lhs, const long rhs);
        static int Compare (const BigIntegerBase<BigIntegerGmp> &lhs, const unsigned long rhs);

        static void RightShift (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const unsigned long numberOfBits);
        static void LeftShift (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const unsigned long numberOfBits);

        static void InvertBits (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input);

        static void BitwiseAnd (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void BitwiseOr (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void BitwiseXor (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);

        static void GetNextPrime (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input);
        static bool IsPrime (const BigIntegerBase<BigIntegerGmp> &input);

        static void SetBit (BigIntegerBase<BigIntegerGmp> &input, const size_t index);
        static int GetBit (const BigIntegerBase<BigIntegerGmp> &input, const size_t index);

        static size_t GetSize (const BigIntegerBase<BigIntegerGmp> &input, const unsigned int base = 2);

        static void Abs (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input);

        static void Pow (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &power);
        static void Pow (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const long power);
        static void Pow (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const unsigned long power);

        static void PowModN (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &power, const BigIntegerBase<BigIntegerGmp> &n);
        static void PowModN (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const long power, const BigIntegerBase<BigIntegerGmp> &n);
        static void PowModN (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const unsigned long power, const BigIntegerBase<BigIntegerGmp> &n);

        static void InvertModN (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &input, const BigIntegerBase<BigIntegerGmp> &n);

        static void Swap (BigIntegerBase<BigIntegerGmp> &lhs, BigIntegerBase<BigIntegerGmp> &rhs);

        static void Gcd (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);
        static void Lcm (BigIntegerBase<BigIntegerGmp> &output, const BigIntegerBase<BigIntegerGmp> &lhs, const BigIntegerBase<BigIntegerGmp> &rhs);

        static std::string ToString (const BigIntegerBase<BigIntegerGmp> &input, const unsigned int base = 2);
        static unsigned long ToUnsignedLong (const BigIntegerBase<BigIntegerGmp> &input);
    };


}//namespace Core
}//namespace SeComLib

#endif//BIG_INTEGER_GMP_HEADER_GUARD