pqc/external/flint-2.4.3/interfaces/doc/interfaces.txt
2014-05-24 23:16:06 +02:00

118 lines
4.2 KiB
Plaintext

/*=============================================================================
This file is part of FLINT.
FLINT is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
FLINT is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with FLINT; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
=============================================================================*/
/******************************************************************************
Copyright (C) 2009 William Hart
Copyright (C) 2011 Sebastian Pancratz
Copyright (C) 2013 Mike Hansen
******************************************************************************/
*******************************************************************************
NTL Interface
The NTL interface allows conversion between NTL objects and FLINT objects
and vice versa. The interface is built using C$++$ and is not built as a
part of the FLINT library library by default. To build the NTL interface
one must specify the location of NTL with the \code{--with-ntl=path} option
to configure. NTL version 5.5.2 or later is required.
*******************************************************************************
void fmpz_set_ZZ(fmpz_t rop, const ZZ& op)
Converts an NTL \code{ZZ} to an \code{fmpz_t}.
Assumes the \code{fmpz_t} has already been allocated to have
sufficient space.
void fmpz_get_ZZ(ZZ& rop, const fmpz_t op)
Converts an \code{fmpz_t} to an NTL \code{ZZ}. Allocation is
automatically handled.
void fmpz_set_ZZ_p(fmpz_t rop, const ZZ_p& op)
Converts an NTL \code{ZZ_p} to an \code{fmpz_t}.
Assumes the \code{fmpz_t} has already been allocated to have
sufficient space.
void fmpz_get_ZZ_p(ZZ_p& rop, const fmpz_t op)
Converts an \code{fmpz_t} to an NTL \code{ZZ_p}. Allocation is
automatically handled. Requires that \code{ZZ_p::init()} has
already been called.
void fmpz_poly_get_ZZX(ZZX& rop, const fmpz_poly_t op)
Converts an \code{fmpz_poly_t} to an NTL \code{ZZX}.
void fmpz_poly_set_ZZX(fmpz_poly_t rop, const ZZX& op)
Converts an NTL \code{ZZX} to an \code{fmpz_poly_t}.
void fmpz_mod_poly_get_ZZ_pX(ZZ_pX& rop, const fmpz_mod_poly_t op)
Converts an \code{fmpz_mod_poly_t} to an NTL
\code{ZZ_pX}. Requires that \code{ZZ_p::init()} has already been
called.
void fmpz_mod_poly_set_ZZ_pX(fmpz_mod_poly_t rop, const ZZ_pX& op)
Converts an NTL \code{ZZ_pX} to an \code{fmpz_mod_poly_t}.
void fq_get_ZZ_pE(ZZ_pE& rop, const fq_t op, const fq_ctx_t ctx)
Converts an \code{fq_t} to an NTL \code{ZZ_pE}. Requires that
\code{ZZ_pE::init()} has already been called.
void fq_set_ZZ_pE(fq_t rop, const ZZ_pE& op, const fq_ctx_t ctx)
Converts and NTL \code{ZZ_pE} to an \code{fq_t}.
void fq_poly_get_ZZ_pEX(ZZ_pEX& rop, const fq_poly_t op, const fq_ctx_t ctx)
Converts an \code{fq_poly_t} to an NTL \code{ZZ_pEX}. Requires
that \code{ZZ_pE::init()} has already been called.
void fq_poly_set_ZZ_pE(fq_poly_t rop, const ZZ_pE& op, const fq_ctx_t ctx)
Converts and NTL \code{ZZ_pEX} to an \code{fq_poly_t}.
void fq_get_zz_pE(zz_pE& rop, const fq_t op, const fq_ctx_t ctx)
Converts an \code{fq_t} to an NTL \code{zz_pE}. Requires that
\code{zz_pE::init()} has already been called.
void fq_set_zz_pE(fq_t rop, const zz_pE& op, const fq_ctx_t ctx)
Converts and NTL \code{zz_pE} to an \code{fq_t}.
void fq_poly_get_zz_pEX(zz_pEX& rop, const fq_poly_t op, const fq_ctx_t ctx)
Converts an \code{fq_poly_t} to an NTL \code{zz_pEX}. Requires
that \code{zz_pE::init()} has already been called.
void fq_poly_set_zz_pE(fq_poly_t rop, const zz_pE& op, const fq_ctx_t ctx)
Converts and NTL \code{zz_pEX} to an \code{fq_poly_t}.