Changeset d3d3168 in git

Timestamp:

Feb 17, 2012, 11:05:30 AM (11 years ago)

Author:

Martin Lee <martinlee84@…>

Branches:

(u'jengelh-datetime', 'ceac47cbc86fe4a15902392bdbb9bd2ae0ea02c6')(u'spielwiese', 'a800fe4b3e9d37a38c5a10cc0ae9dfa0c15a4ee6')

Children:

c2aeb9aa4f5b5bc845c3d83ce3c7ab67db049358

Parents:

f9bd3df575b00ad6b5b1f49bf42ebe194e4bb7b2

git-author:

Martin Lee <martinlee84@web.de>2012-02-17 11:05:30+01:00

git-committer:

Martin Lee <martinlee84@web.de>2012-04-04 14:42:26+02:00

Message:

chg: added docu for conversion to FLINT and back

Location:

factory

Files:

• FLINTconvert.cc (modified) (1 diff)
• FLINTconvert.h (modified) (2 diffs)

factory/FLINTconvert.cc

@@ +1 @@
+/*****************************************************************************\
+ * Computer Algebra System SINGULAR
+\*****************************************************************************/
+/** @file FLINTconvert.cc
+ *
+ * This file implements functions for conversion to FLINT (www.flintlib.org)
+ * and back.
+ *
+ * @author Martin Lee
+ *
+ **/
+/*****************************************************************************/
+
 
 #include <config.h>

factory/FLINTconvert.h

@@ +1 @@
+/*****************************************************************************\
+ * Computer Algebra System SINGULAR
+\*****************************************************************************/
+/** @file FLINTconvert.h
+ *
+ * This file defines functions for conversion to FLINT (www.flintlib.org)
+ * and back.
+ *
+ * @author Martin Lee
+ *
+ **/
+/*****************************************************************************/
+
 #ifndef FLINT_CONVERT_H
 #define FLINT_CONVERT_H
@@ -19 +32 @@
 #endif
 
-void convertCF2Fmpz (fmpz_t result, const CanonicalForm& f);
-void convertFacCF2Fmpz_poly_t (fmpz_poly_t result, const CanonicalForm& f);
-CanonicalForm convertFmpz2CF (fmpz_t coefficient);
-CanonicalForm convertFmpz_poly_t2FacCF (fmpz_poly_t poly, const Variable& x);
-void convertFacCF2nmod_poly_t (nmod_poly_t result, const CanonicalForm& f);
-CanonicalForm convertnmod_poly_t2FacCF (nmod_poly_t poly, const Variable& x);
-void convertCF2Fmpq (fmpq_t result, const CanonicalForm& f);
-CanonicalForm convertFmpq_poly_t2FacCF (fmpq_poly_t p, const Variable& x);
-void convertFacCF2Fmpq_poly_t (fmpq_poly_t result, const CanonicalForm& f);
-CFFList convertFLINTnmod_poly_factor2FacCFFList (nmod_poly_factor_t fac,
-                                                  mp_limb_t leadingCoeff,
-                                                  const Variable& x
-                                                 );
+/// conversion of a factory integer to fmpz_t
+void
+convertCF2Fmpz (fmpz_t result,         ///< [in,out] an fmpz_t
+                const CanonicalForm& f ///< [in] a CanonicalForm wrapping an
+                                       ///< integer
+               );
+
+/// conversion of a factory univariate polynomial over Z to a fmpz_poly_t
+void
+convertFacCF2Fmpz_poly_t (fmpz_poly_t result,    ///< [in,out] an fmpz_poly_t
+                          const CanonicalForm& f ///< [in] univariate poly over
+                                                 ///< Z
+                         );
+
+/// conversion of a FLINT integer to CanonicalForm
+CanonicalForm
+convertFmpz2CF (fmpz_t coefficient ///< [in] a FLINT integer
+               );
+
+/// conversion of a FLINT poly over Z to CanonicalForm
+CanonicalForm
+convertFmpz_poly_t2FacCF (fmpz_poly_t poly, ///< [in] an fmpz_poly_t
+                          const Variable& x ///< [in] variable the result should
+                                            ///< have
+                         );
+
+/// conversion of a factory univariate polynomials over Z/p (for word size p)
+/// to nmod_poly_t
+void
+convertFacCF2nmod_poly_t (nmod_poly_t result,    ///< [in, out] a nmod_poly_t
+                          const CanonicalForm& f ///< [in] univariate poly over
+                                                 ///< Z/p
+                         );
+
+/// conversion of a FLINT poly over Z/p to CanonicalForm
+CanonicalForm
+convertnmod_poly_t2FacCF (nmod_poly_t poly, ///< [in] a nmod_poly_t
+                          const Variable& x ///< [in] variable the result should
+                                            ///< have
+                         );
+
+/// conversion of a factory rationals to fmpq_t
+void
+convertCF2Fmpq (fmpq_t result,         ///< [in,out] an fmpq_t
+                const CanonicalForm& f ///< [in] a CanonicalForm wrapping a
+                                       ///< rational
+               );
+
+/// conversion of a factory univariate polynomials over Q to fmpq_poly_t
+void
+convertFacCF2Fmpq_poly_t (fmpq_poly_t result,    ///< [in,out] an fmpq_poly_t
+                          const CanonicalForm& f ///< [in] univariate poly over
+                                                 ///< Q
+                         );
+
+/// conversion of a FLINT poly over Q to CanonicalForm
+CanonicalForm
+convertFmpq_poly_t2FacCF (fmpq_poly_t p,    ///< [in] an fmpq_poly_t
+                          const Variable& x ///< [in] variable the result should
+                                            ///< have
+                         );
+
+/// conversion of a FLINT factorization over Z/p (for word size p) to a
+/// CFFList
+CFFList
+convertFLINTnmod_poly_factor2FacCFFList (
+                   nmod_poly_factor_t fac, ///< [in] a nmod_poly_factor_t
+                   mp_limb_t leadingCoeff, ///< [in] leading coefficient
+                   const Variable& x       ///< [in] variable the result should
+                                           ///< have
+                                        );
 
 #endif