6a66fd66d16010991cb22e5c9532566081225672
[ginac.git] / ginac / polynomial / divide_in_z_p.h
1 /** @file divide_in_z_p.h
2  *
3  *  Interface to polynomial division in Z/Zp. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_CHINREM_GCD_DIVIDE_IN_Z_P_H
24 #define GINAC_CHINREM_GCD_DIVIDE_IN_Z_P_H
25
26 #include "ex.h"
27
28 namespace GiNaC {
29
30 /** 
31  * Exact polynomial division of a, b \in Z_p[x_0, \ldots, x_n]
32  * It doesn't check whether the inputs are proper polynomials, so be careful
33  * of what you pass in.
34  *  
35  * @param a  first multivariate polynomial (dividend)
36  * @param b  second multivariate polynomial (divisor)
37  * @param q  quotient (returned)
38  * @param var variables X iterator to first element of vector of symbols
39  *
40  * @return "true" when exact division succeeds (the quotient is returned in
41  *          q), "false" otherwise.
42  */
43 extern bool
44 divide_in_z_p(const ex &a, const ex &b, ex &q, const exvector& vars, const long p);
45
46 } // namespace GiNaC
47
48 #endif // ndef GINAC_CHINREM_GCD_DIVIDE_IN_Z_P_H