ginac/polynomial/pgcd.h

   1 /** @file pgcd.h
   2  *
   3  *  Interface to GCD functions for polynomials over prime fields. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2022 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_PGCD_H
  24 #define GINAC_CHINREM_GCD_PGCD_H
  25
  26 #include "ex.h"
  27
  28 namespace GiNaC {
  29
  30 /// Exception to be thrown when modular GCD algorithm fails
  31 struct pgcd_failed
  32 {
  33         virtual ~pgcd_failed() { }
  34 };
  35
  36 /**
  37  * @brief Compute the GCD of two polynomials over a prime field Z_p
  38  *
  39  * @param vars variables
  40  * @param p designates the coefficient field Z_p
  41  * @param A polynomial \in Z_p[vars]
  42  * @param B second polynomial \in Z_p[vars]
  43  */
  44 extern ex
  45 pgcd(const ex& A, const ex& B, const exvector& vars, const long p);
  46
  47 } // namespace GiNaC
  48
  49 #endif // ndef GINAC_CHINREM_GCD_PGCD_H