source: git/factory/cf_cyclo.h

spielwiese
Last change on this file was b5f2548, checked in by Martin Lee <martinlee84@…>, 10 years ago
moved docu from .cc to .h
  • Property mode set to 100644
File size: 1.3 KB
Line 
1// -*- c++ -*-
2//*****************************************************************************
3/** @file cf_cyclo.h
4 *
5 * Compute cyclotomic polynomials and factorize integers by brute force
6 *
7 * @par Copyright:
8 *   (c) by The SINGULAR Team, see LICENSE file
9 *
10 * @author Martin Lee
11**/
12//*****************************************************************************
13
14#ifndef CF_CYCLO_H
15#define CF_CYCLO_H
16
17// #include "config.h"
18
19/// integer factorization using table look-ups,
20/// function may fail if integer contains primes which exceed the largest prime
21/// in our table
22int* integerFactorizer (const long integer, ///< [in] some integer
23                        int& length,        ///< [in,out] number of factors
24                        bool& fail          ///< [in,out] failure?
25                       );
26
27/// compute the n-th cyclotomic polynomial,
28/// function may fail if integer_factorizer fails to factorize n
29CanonicalForm
30cyclotomicPoly (int n,     ///< [in] some integer
31                bool& fail ///< [in,out] failure?
32               );
33
34/// checks if alpha is a primitive element, alpha is assumed to be an algebraic
35/// variable over some finite prime field
36bool isPrimitive (const Variable& alpha, ///< [in] some algebraic variable
37                  bool& fail             ///< [in,out] failure?
38                 );
39
40#endif
41
Note: See TracBrowser for help on using the repository browser.