'factory' documentation: work needed

[jakobkroeker]

@mmklee
For some (old/new) parts of factory there exists doxygen-style documentation
That are good news.

But there is still some work needed; see the documentations statistics below (collected by hand):

./cfNewtonPolygon.h                          documented
./cfNewtonPolygon.cc                         NOT DOCUMENTED
./cfNTLzzpEXGCD.h                            documented
./cfNTLzzpEXGCD.cc                           INCOMPLETE DOC
  missing:
        -tryPlainDivRem
        -tryPlainRem
        -InvModStatus

./cfGcdUtil.h                                NOT DOCUMENTED
./cfGcdUtil.cc                               INCOMPLETE DOC
./cfSubResGcd.h                              documented
./cfSubResGcd.cc                             documented (see header)
./cf_factory.h                               NOT DOCUMENTED
./cf_factory.cc                              NOT DOCUMENTED
./cf_irred.h                                 INCOMPLETE DOC
./cf_irred.cc                                INCOMPLETE DOC
   missing:  -is_irreducible

./singext.h                                  NOT DOCUMENTED
./singext.cc                                 NOT DOCUMENTED
./fac_util.h                                 INCOMPLETE DOC
./fac_util.cc                                NOT DOCUMENTED
./cf_random.h                                INCOMPLETE DOC
./cf_random.cc                               NOT DOCUMENTED
./cf_globals.h                               see .cc file
./cf_globals.cc                              documented
./cf_map_ext.h                               INCOMPLETE DOC
./cf_map_ext.cc                              INCOMPLETE DOC
./facFqBivarUtil.h                           documented
./facFqBivarUtil.cc                          INCOMPLETE DOC
  missing documentation:
    -GFInExtensionHelper
    -FqInExtensionHelper
    -substituteCheck(const CanonicalForm &F, const CanonicalForm &G)
    -recSubstituteCheck 

./facFqBivar.h                               documented
./facFqBivar.cc                              INCOMPLETE DOC (for some parts see header)

  missing documentation:
        extHenselLiftAndLatticeRecombi
        init4ext
        henselLiftAndLatticeRecombi
        extSieveSmallFactors
        sieveSmallFactors
        extEarlyReconstructionAndLifting
        earlyReconstructionAndLifting (2 x)
        refineAndRestartLift (2 x)
        furtherLiftingAndIncreasePrecisionFq2Fp(2 x)
        extFurtherLiftingAndIncreasePrecision
        furtherLiftingAndIncreasePrecision (3x)
        increasePrecisionFq2Fp(2 x)
        extIncreasePrecision(3 x)
        increasePrecision(5x)
        increasePrecisionFq2Fp
        increasePrecision2
        liftAndComputeLatticeFq2Fp
        liftAndComputeLattice (3x)                
        extLiftAndComputeLattice(2x)
        extReconstructionTry(2x)
        reconstruction(3x)
        extReconstruction
        monicReconstruction
        reconstructionTry 3x
        extractZeroOneVecs 3x
        isReduced 2x
        deleteFactors
        getCombinations
        earlyFactorDetection (1x there, 1x missing) 


./cf_hnf.h                                   documented
./cf_hnf.cc                                  documentation in header. DUPLICATE documentation
./parseutil.h                                NOT DOCUMENTED
./parseutil.cc                               NOT DOCUMENTED
./facBivar.h                                 documented
./facBivar.cc                                NOT DOCUMENTED (except one function in header)
./cf_primetab.h                              - 
./cf_primetab.cc                             -
./int_rat.h                                  NOT DOCUMENTED
./int_rat.cc                                 only OCCATIONAL DOC  and parameters not described
./int_poly.h                                 NOT DOCUMENTED
./int_poly.cc                                OCCACIONAL DOC (very few routines documented 
./FLINTconvert.h                             documented
./FLINTconvert.cc                            INCOMPLETE DOC
  undocumented:
   - convertFacCF2Fmpz_array
   - convertFmpq_t2CF

./facAlgFuncUtil.h                           NOT DOCUMENTED
./facAlgFuncUtil.cc                          NOT DOCUMENTED
./facIrredTest.h                             documented
./facIrredTest.cc                            INCOMPLETE DOC
  missing documentation for
  - inverseERF

./cf_algorithm.h                             NOT DOCUMENTED
./cf_algorithm.cc                            INCOMPLETE DOC  (usually parameters not described)
./variable.h                                 NOT DOCUMENTED
./variable.cc                                NOT DOCUMENTED
./gfops.h                                    NOT DOCUMENTED
./gfops.cc                                   NOT DOCUMENTED
./facAlgExt.h                                documented
./facAlgExt.cc                               INCOMPLETE DOC
   missing doc for:
   -uniSqrfPart
   -Norm
   -sqrfNorm

./int_int.h                                  INCOMPLETE DOC
./int_int.cc                                 INCOMPLETE DOC
./cfModGcd.h                                 INCOMPLETE DOC    and not in doxygen-style; parameters not always described
./cfModGcd.cc                                INCOMPLETE DOC    and not in doxygen-style; parameters not always described
./cf_defs.h                                  documented
./cfCharSets.h                               INCOMPLETE DOC    and mostly not in doxygen-style
./cfCharSets.cc                              INCOMPLETE DOC 

./timing.h                                   NOT DOCUMENTED
./cf_cyclo.h                                 NOT DOCUMENTED
./cf_cyclo.cc                                INCOMPLETE DOC  (parameters not documented)
./imm.h                                      NOT DOCUMENTED
./cfModResultant.h                           documented
./cfModResultant.cc                          INCOMPLETE DOC
 missing:
        -symmetricRemainder
        -balanceUni
        -newtonInterp
        -evalPoint
        -uniResultant
        -oneNorm
        -myCompress

./cf_switches.h                              documented
./cf_switches.cc                             documented
./facAbsFact.h                               documented
./facAbsFact.cc                              INCOMPLETE DOC
  missing documentation:
  -evalPoints4AbsFa

./cf_generator.h                             NOT DOCUMENTED
./cf_generator.cc                            NOT DOCUMENTED
./facFqSquarefree.h                          documented
./facFqSquarefree.cc                         INCOMPLETE DOC
  missing documentation :
    -sqrfPosDer
    -pthRoot (3x)

./facMul.h                                   documented
./facMul.cc                                  INCOMPLETE DOC ( some functions documented  header)
missing doc for:
        divrem32()
        divrem21()
        divrem32()
        split()
        reverse()
        mulMod2NTLFq()
        mulMod2FLINTFp()
        mulMod2NTLFqReci()
        mulMod2NTLFpReci()
        mulMod2NTLFp()
        reverseSubstFp()
        reverseSubstFq()
        reverseSubstReciproFp()
        reverseSubstReciproFq()
        kronSubReciproFp()
        kronSubReciproFq()
        kronSubFq (const CanonicalForm& A, int d, const Variable& alpha)
        kronSubFq (fq_nmod_poly_t result, const CanonicalForm& A, int d,
                   const fq_nmod_ctx_t fq_con)
        kronSubFp (nmod_poly_t result, const CanonicalForm& A, int d)
        kronSubFp (const CanonicalForm& A, int d)
        mulMod2FLINTQa()
        mulMod2FLINTQ()
        mulMod2FLINTQReci()
        mulMod2FLINTFq()
        mulMod2FLINTFqReci()
        mulMod2FLINTFp()
        mulMod2FLINTFpReci()
        reverseSubstFp()
        reverseSubstFq()
        reverseSubstReciproQ()
        reverseSubstReciproFq()
        reverseSubstReciproFp()
        reverseSubstQa(const fmpz_poly_t F, int d1, int d2, const Variable& alpha, const fmpq_poly_t mipo)
        reverseSubstQa(const fmpz_poly_t F, int d, const Variable& x, const Variable& alpha, const CanonicalForm& den)
        reverseSubstQ()
        kronSubReciproQ()
        kronSubReciproFq()
        kronSubReciproFp()
        kronSubQa()
        newtonDiv (const CanonicalForm& F, const CanonicalForm& G, CanonicalForm& Q)
        newtonInverse (const CanonicalForm& F, const int n, const Variable& x)
        newtonInverse (const CanonicalForm& F, const int n, const CanonicalForm& M)
        uniReverse()
        mulFLINTQTrunc()
        mulFLINTQaTrunc()
        modFLINTQ()
        divFLINTQ()
        mulFLINTQ()
        mulFLINTQa()
        kronSub()

./cfUnivarGcd.h                              NOT DOCUMENTED
./cfUnivarGcd.cc                             NOT DOCUMENTED
./gmpext.h                                   INCOMPLETE DOC
./facHensel.h                                documented
./facHensel.cc                               INCOMPLETE DOC

  not documented:
          -CFList
          -nonMonicHenselLift (const CFList& F, const CFList& factors, const CFList& LCs,
                              CFList& diophant, CFArray& Pi, CFMatrix& M, int lOld,
                              int& lNew, const CFList& MOD, bool& noOneToOne
                             )

          -nonMonicHenselLift23

          -nonMonicHenselLift2 (const CFList& F, const CFList& factors, const CFList& MOD,
                            CFList& diophant, CFArray& Pi, CFMatrix& M, int lOld,
                            int& lNew, const CFList& LCs1, const CFList& LCs2, bool& bad
                           )
          -nonMonicHenselStep12
          -henselStep
          -multiRecDiophantine
          -biDiophantine
          -henselStep12
          -diophantine (const CanonicalForm& F, const CFList& factors)
          -diophantine (const CanonicalForm& F, const CanonicalForm& G,
                       const CFList& factors, modpk& b)
          -diophantineQa
          -diophantineHenselQa
          -diophantineHensel
          -modularDiophant
          -replacevar
          -Farey
          -chineseRemainder
          -mod
          -mapinto
          -tryDiophantine
          -productsFLINT
          -productsNTL

./NTLconvert.h                               NOT DOCUMENTED
./NTLconvert.cc                              INCOMPLETE DOC
./facAlgFunc.h                               documented
./facAlgFunc.cc                              INCOMPLETE DOC
./gf_tabutil.h                               NOT DOCUMENTED
./gf_tabutil.cc                              NOT DOCUMENTED
./cfEzgcd.h                                  INCOMPLETE DOC
./cfEzgcd.cc                                 INCOMPLETE DOC
./cf_iter.h                                  INCOMPLETE DOC
./cf_iter.cc
./facFactorize.h                             documented
./facFactorize.cc                            INCOMPLETE DOC (evalPoints)
./facFqFactorize.h                           documented
./facFqFactorize.cc                          algorithms not described /referenced
./cf_eval.h                                  NOT DOCUMENTED
./cf_eval.cc                                 NOT DOCUMENTED
./cfGcdAlgExt.h                             OCCACIONAL DOC (occationaly some  rotines have documentation)
./cfGcdAlgExt.cc                             OCCACIONAL DOC (occationaly some rotines have documentation)
./ExtensionInfo.h                            documented
./ExtensionInfo.cc                           see header
./facAbsBiFact.h                             documented
./facAbsBiFact.cc                            INCOMPLETE DOC
    missing doc for : choosePoint
./cf_reval.h                                 NOT DOCUMENTED
./cf_reval.cc                                NOT DOCUMENTED
./fac_sqrfree.h                              INCOMPLETE DOC
./fac_sqrfree.cc                             NOT DOCUMENTED
./cf_assert.h                                NOT DOCUMENTED
./cf_map.h                                   INCOMPLETE DOC  ( no class member documentations)
./cf_map.cc                                  INCOMPLETE DOC (some parameters not described) 
./cfCharSetsUtil.h                           NOT DOCUMENTED
./cfCharSetsUtil.cc                          INCOMLETE and not in doxygen-style
./debug.h                                    NOT DOCUMENTED
./debug.cc                                   NOT DOCUMENTED
./cf_primes.h                                NOT DOCUMENTED
./cf_primes.cc                               NOT DOCUMENTED
./facFqFactorizeUtil.h                       documented
./facFqFactorizeUtil.cc                      INCOMPLETE DOC
  missing:
  -compareByNumberOfVars

./int_cf.h                                   NOT DOCUMENTED
./int_cf.cc                                  INCOMPLETE DOC  (not all methods documented, not in doxygen-style, somtimes parameters not documented)
./templates/ftmpl_functions.h                documented
./ffops.h                                    NOT DOCUMENTED
./ffops.cc                                   NOT DOCUMENTED
./facSparseHensel.h                          INCOMPLETE DOC
./facSparseHensel.cc                         documentation in header.
./canonicalform.h                            NOT DOCUMENTED
./canonicalform.cc                           INCOMPLETE DOC and not in doxygen-style
./DegreePattern.h                            documented
./DegreePattern.cc                           see header 
./old/fac_cantzass.h                         NOT DOCUMENTED
./old/fac_univar.h                           NOT DOCUMENTED
./old/fac_iterfor.h                          NOT DOCUMENTED
./old/cf_binom.h                             NOT DOCUMENTED
./old/fac_distrib.h                          NOT DOCUMENTED
./old/int_pp.h                               NOT DOCUMENTED
./old/fac_berlekamp.h                        NOT DOCUMENTED
./old/fac_multivar.h                         NOT DOCUMENTED
./old/var_intglobal.h                        NOT DOCUMENTED
./cf_util.h                                  NOT DOCUMENTED
./cf_util.cc                                 INCOMPLETE DOC

./cf_gcd.cc                                  documented
./cf_chinese.cc                              documented
./cf_resultant.cc                            documented
./cf_iter_inline.cc                          documented
./int_intdiv.cc                              INCOMPLETE DOC (parameters not described)
./imm.cc                                     - 
./cf_linsys.cc                               NOT DOCUMENTED
./cf_factor.cc                               INCOMPLETE DOC (parameters not described and not all functions have doc) 
./ftmpl_inst.cc                              NOT DOCUMENTED
./gengftables-conway.cc                      INCOMPLETE DOC (some parameters not described) 
./cf_inline.cc                               documented, but not in doxygen-style!
./cf_ops.cc                                  documented, but not in doxygen-style!
./cf_char.cc                                 NOT DOCUMENTED
./include/factory/templates/ftmpl_factor.h   NOT DOCUMENTED
./templates/ftmpl_factor.cc                  NOT DOCUMENTED
./include/factory/templates/ftmpl_matrix.h   NOT DOCUMENTED
./templates/ftmpl_matrix.cc                  NOT DOCUMENTED
./include/factory/templates/ftmpl_list.h     NOT DOCUMENTED
./templates/ftmpl_list.cc                    NOT DOCUMENTED 
./include/factory/templates/ftmpl_afactor.h  NOT DOCUMENTED
./templates/ftmpl_afactor.cc                 (NOT DOCUMENTED)
./include/factory/templates/ftmpl_array.h    NOT DOCUMENTED
./templates/ftmpl_array.cc                   NOT DOCUMENTED 
./old/fac_multihensel.cc                     NOT DOCUMENTED 
./old/fac_cantzass.cc                        NOT DOCUMENTED 
./old/fac_multivar.cc                        NOT DOCUMENTED 
./old/var_intglobal.cc                       (NOT DOCUMENTED)
./old/fac_univar.cc                          NOT DOCUMENTED 
./old/fac_berlekamp.cc                       NOT DOCUMENTED 
./old/fac_distrib.cc                         NOT DOCUMENTED 
./old/fac_iterfor.cc                         NOT DOCUMENTED 
./old/int_pp.cc                              NOT DOCUMENTED 
./old/cf_binom.cc                            NOT DOCUMENTED 
./old/gengftables.cc                         NOT DOCUMENTED 
./test.cc                                    -
./test_install.cc                            -
./cplusplus.cc                               -
./examples/gcd.cc                            -
./examples/factorize.cc                      -
./examples/application.cc                    -
./include/factory/cf_gmp.h                   -