/** @file
 *****************************************************************************
 * @author     This file is part of libsnark, developed by SCIPR Lab
 *             and contributors (see AUTHORS).
 * @copyright  MIT license (see LICENSE file)
 *****************************************************************************/

#ifndef PUBLIC_PARAMS_HPP_
#define PUBLIC_PARAMS_HPP_
#include <vector>

namespace libsnark {

template<typename EC_ppT>
class EC_pp_selector {
    /*
      for every curve the user should define corresponding
      public_params and a template specialization for EC_pp_selector
      with the following typedefs:

      Fp_type
      G1_type
      G2_type
      G1_precomp_type
      G2_precomp_type
      Fq_type
      Fqe_type
      Fqk_type
      GT_type
    */
};

template<typename EC_ppT>
using Fr = typename EC_pp_selector<EC_ppT>::Fp_type;
template<typename EC_ppT>
using G1 = typename EC_pp_selector<EC_ppT>::G1_type;
template<typename EC_ppT>
using G2 = typename EC_pp_selector<EC_ppT>::G2_type;
template<typename EC_ppT>
using G1_precomp = typename EC_pp_selector<EC_ppT>::G1_precomp_type;
template<typename EC_ppT>
using G2_precomp = typename EC_pp_selector<EC_ppT>::G2_precomp_type;
template<typename EC_ppT>
using affine_ate_G1_precomp = typename EC_pp_selector<EC_ppT>::affine_ate_G1_precomp_type;
template<typename EC_ppT>
using affine_ate_G2_precomp = typename EC_pp_selector<EC_ppT>::affine_ate_G2_precomp_type;
template<typename EC_ppT>
using Fq = typename EC_pp_selector<EC_ppT>::Fq_type;
template<typename EC_ppT>
using Fqe = typename EC_pp_selector<EC_ppT>::Fqe_type;
template<typename EC_ppT>
using Fqk = typename EC_pp_selector<EC_ppT>::Fqk_type;
template<typename EC_ppT>
using GT = typename EC_pp_selector<EC_ppT>::GT_type;

template<typename EC_ppT>
using Fr_vector = std::vector<Fr<EC_ppT> >;
template<typename EC_ppT>
using G1_vector = std::vector<G1<EC_ppT> >;
template<typename EC_ppT>
using G2_vector = std::vector<G2<EC_ppT> >;

/* one should also define specializations for the following templatized functions */
template<typename EC_ppT>
void init_public_params();

template<typename EC_ppT>
GT<EC_ppT> final_exponentiation(const Fqk<EC_ppT> &elt);

template<typename EC_ppT>
G1_precomp<EC_ppT> precompute_G1(const G1<EC_ppT> &P);

template<typename EC_ppT>
G2_precomp<EC_ppT> precompute_G2(const G2<EC_ppT> &Q);

template<typename EC_ppT>
Fqk<EC_ppT> miller_loop(const G1_precomp<EC_ppT> &prec_P,
                        const G2_precomp<EC_ppT> &prec_Q);

template<typename EC_ppT>
affine_ate_G1_precomp<EC_ppT> affine_ate_precompute_G1(const G1<EC_ppT> &P);

template<typename EC_ppT>
affine_ate_G2_precomp<EC_ppT> affine_ate_precompute_G2(const G2<EC_ppT> &Q);

template<typename EC_ppT>
Fqk<EC_ppT> affine_ate_miller_loop(const affine_ate_G1_precomp<EC_ppT> &prec_P,
                                   const affine_ate_G2_precomp<EC_ppT> &prec_Q);

template<typename EC_ppT>
Fqk<EC_ppT> double_miller_loop(const G1_precomp<EC_ppT> &prec_P1,
                               const G2_precomp<EC_ppT> &prec_Q1,
                               const G1_precomp<EC_ppT> &prec_P2,
                               const G2_precomp<EC_ppT> &prec_Q2);

/* the following are used in test files */
template<typename EC_ppT>
Fqk<EC_ppT> pairing(const G1<EC_ppT> &P,
                    const G2<EC_ppT> &Q);

template<typename EC_ppT>
GT<EC_ppT> reduced_pairing(const G1<EC_ppT> &P,
                           const G2<EC_ppT> &Q);

template<typename EC_ppT>
GT<EC_ppT> affine_reduced_pairing(const G1<EC_ppT> &P,
                                  const G2<EC_ppT> &Q);

} // libsnark
#endif // PUBLIC_PARAMS_HPP_