Changeset 98abec in git


Ignore:
Timestamp:
Aug 26, 2014, 11:26:56 AM (9 years ago)
Author:
Martin Lee <martinlee84@…>
Branches:
(u'spielwiese', '91e5db82acc17434e4062bcfa44e6efa7d41fd30')
Children:
8b7b108474a7f7dcc5bffc2636ab9027c6131d3d
Parents:
53e6c3ed92a09bfcbead81b6adcaa7ab3eed1a88
git-author:
Martin Lee <martinlee84@web.de>2014-08-26 11:26:56+02:00
git-committer:
Martin Lee <martinlee84@web.de>2014-08-26 12:29:12+02:00
Message:
more docu for cf_map_ext
Location:
factory
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • factory/cf_map_ext.cc

    r53e6c3 r98abec  
    160160}
    161161
    162 /// changes representation by primitive element to representation by residue
    163 /// classes modulo a Conway polynomial
    164162CanonicalForm GF2FalphaRep (const CanonicalForm& F, const Variable& alpha)
    165163{
    … …  
    170168}
    171169
    172 /// change representation by residue classes modulo a Conway polynomial
    173 /// to representation by primitive element
    174170CanonicalForm Falpha2GFRep (const CanonicalForm& F)
    175171{
    … …  
    209205}
    210206
    211 /// maps a polynomial over \f$ GF(p^{k}) \f$ to a polynomial over
    212 /// \f$ GF(p^{d}) \f$ , d needs to be a multiple of k
    213207CanonicalForm GFMapUp (const CanonicalForm & F, int k)
    214208{
    … …  
    247241}
    248242
    249 /// maps a polynomial over \f$ GF(p^{d}) \f$ to a polynomial over
    250 /// \f$ GF(p^{k})\f$ , d needs to be a multiple of k
    251243CanonicalForm GFMapDown (const CanonicalForm & F, int k)
    252244{
    … …  
    260252}
    261253
     254/// map F in \f$ F_{p} (\alpha ) \f$ which is generated by G into some
     255/// \f$ F_{p}(\beta ) \f$ which is generated by H
    262256static inline
    263257CanonicalForm mapUp (const CanonicalForm& F, const CanonicalForm& G,
    … …  
    313307
    314308#ifdef HAVE_NTL
    315 /// determine a primitive element of \f$ F_{p} (\alpha ) \f$,
    316 /// \f$ \beta \f$ is a primitive element of a field which is isomorphic to
    317 /// \f$ F_{p}(\alpha ) \f$
    318 CanonicalForm
    319 primitiveElement (const Variable& alpha, Variable& beta, bool fail)
     309CanonicalForm
     310primitiveElement (const Variable& alpha, Variable& beta, bool& fail)
    320311{
    321312  bool primitive= false;

  • factory/cf_map_ext.h

    r53e6c3 r98abec  
    2222CanonicalForm getItem (const CFList& list, const int& pos);
    2323
     24/// maps a polynomial over \f$ GF(p^{k}) \f$ to a polynomial over
     25/// \f$ GF(p^{d}) \f$ , d needs to be a multiple of k
    2426CanonicalForm GFMapUp (const CanonicalForm & F, int k);
    2527
     28/// maps a polynomial over \f$ GF(p^{d}) \f$ to a polynomial over
     29/// \f$ GF(p^{k})\f$ , d needs to be a multiple of k
    2630CanonicalForm GFMapDown (const CanonicalForm & F, int k);
    2731
     32/// map F from \f$ F_{p} (\alpha ) \f$ to \f$ F_{p}(\beta ) \f$.
     33/// We assume \f$ F_{p} (\alpha ) \subset F_{p}(\beta ) \f$.
    2834CanonicalForm
    29 mapUp (const CanonicalForm& F, const Variable& alpha, const Variable& beta,
    30         const CanonicalForm& prim_elem, const CanonicalForm& im_prim_elem,
    31         CFList& source, CFList& dest);
     35mapUp (const CanonicalForm& F,           ///<[in] poly over \f$ F_{p} (\alpha ) \f$
     36       const Variable& alpha,            ///<[in] alg. variable
     37       const Variable& beta,             ///<[in] alg. variable
     38       const CanonicalForm& prim_elem,   ///<[in] primitive element of \f$ F_{p} (\alpha ) \f$
     39       const CanonicalForm& im_prim_elem,///<[in] image of prim_elem in \f$ F_{p} (\beta ) \f$
     40       CFList& source,                   ///<[in,out] look up lists
     41       CFList& dest                      ///<[in,out] look up lists
     42      );
    3243
     44/// map F from \f$ F_{p} (\beta ) \f$ to \f$ F_{p}(\alpha ) \f$.
     45/// We assume \f$ F_{p} (\alpha ) \subset F_{p}(\beta ) \f$ and F in
     46/// \f$ F_{p}(\alpha ) \f$.
    3347CanonicalForm
    34 mapDown (const CanonicalForm& F, const CanonicalForm& prim_elem, const
    35           CanonicalForm& im_prim_elem, const Variable& alpha, CFList& source,
    36           CFList& dest);
     48mapDown (const CanonicalForm& F,           ///<[in] poly over \f$ F_{p} (\beta ) \f$
     49         const CanonicalForm& prim_elem,   ///<[in] primitive element of \f$ F_{p} (\alpha ) \f$
     50         const CanonicalForm& im_prim_elem,///<[in] image of prim_elem in \f$ F_{p} (\beta ) \f$
     51         const Variable& alpha,            ///<[in] alg. variable
     52         CFList& source,                   ///<[in,out] look up lists
     53         CFList& dest                      ///<[in,out] look up lists
     54        );
    3755
     56/// determine a primitive element of \f$ F_{p} (\alpha ) \f$,
     57/// \f$ \beta \f$ is a primitive element of a field which is isomorphic to
     58/// \f$ F_{p}(\alpha ) \f$
    3859CanonicalForm
    39 primitiveElement (const Variable& alpha, Variable& beta, bool fail);
     60primitiveElement (const Variable& alpha, ///< [in] some algebraic variable
     61                  Variable& beta,        ///< [in,out] s.a.
     62                  bool& fail             ///< [in,out] failure due to integer
     63                                         ///< factorization failure?
     64                 );
    4065
     66/// compute the image of a primitive element of \f$ F_{p} (\alpha ) \f$
     67/// in \f$ F_{p}(\beta ) \f$.
     68/// We assume \f$ F_{p} (\alpha ) \subset F_{p}(\beta ) \f$.
    4169CanonicalForm
    42 mapPrimElem (const CanonicalForm& prim_elem, const Variable& alpha,
    43              const Variable& beta);
     70mapPrimElem (const CanonicalForm& prim_elem, ///< [in] primitive element
     71             const Variable& alpha,          ///< [in] algebraic variable
     72             const Variable& beta            ///< [in] algebraic variable
     73            );
    4474
    45 CanonicalForm GF2FalphaRep (const CanonicalForm& F, const Variable& alpha);
     75/// changes representation by primitive element to representation by residue
     76/// classes modulo a Conway polynomial
     77CanonicalForm GF2FalphaRep (const CanonicalForm& F, ///< [in] some poly over GF
     78                            const Variable& alpha   ///< [in] root of a Conway
     79                                                    ///< poly
     80                           );
    4681
    47 CanonicalForm Falpha2GFRep (const CanonicalForm& F);
     82/// change representation by residue classes modulo a Conway polynomial
     83/// to representation by primitive element
     84CanonicalForm Falpha2GFRep (const CanonicalForm& F ///<[in] some poly over
     85                                                   ///< F_p(alpha) where alpha
     86                                                   ///< is a root of a Conway
     87                                                   ///< poly
     88                           );
    4889
    49 /// map from \f$ F_p(\alpha) \f$ to \f$ F_p(\beta) \f$ such that 
     90/// map from \f$ F_p(\alpha) \f$ to \f$ F_p(\beta) \f$ such that
    5091/// \f$ F\in F_p(\alpha) \f$ is mapped onto \f$ \beta \f$
    5192///
    52 /// @return @a map returns the image of @a primElem such that the above 
     93/// @return @a map returns the image of @a primElem such that the above
    5394/// described properties hold
    5495CanonicalForm
    55 map (const CanonicalForm& primElem,///< [in] primitive element of 
     96map (const CanonicalForm& primElem,///< [in] primitive element of
    5697                                   ///< \f$ F_p (\alpha) \f$
    5798     const Variable& alpha,        ///< [in] algebraic variable
    … …  
    68109/// @return @a findMinPoly computes the minimal polynomial of F
    69110CanonicalForm
    70 findMinPoly (const CanonicalForm& F, ///< [in] an element of 
     111findMinPoly (const CanonicalForm& F, ///< [in] an element of
    71112                                     ///< \f$ F_p(\alpha)\backslash F_p \f$
    72113             const Variable& alpha   ///< [in] algebraic variable
Note: See TracChangeset for help on using the changeset viewer.