ginac/normal.h

   1 /** @file normal.h
   2  *
   3  *  This file defines several functions that work on univariate and
   4  *  multivariate polynomials and rational functions.
   5  *  These functions include polynomial quotient and remainder, GCD and LCM
   6  *  computation, square-free factorization and rational function normalization. */
   7
   8 /*
   9  *  GiNaC Copyright (C) 1999-2021 Johannes Gutenberg University Mainz, Germany
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  24  */
  25
  26 #ifndef GINAC_NORMAL_H
  27 #define GINAC_NORMAL_H
  28
  29 #include "lst.h"
  30
  31 namespace GiNaC {
  32
  33 /**
  34  * Flags to control the behavior of gcd() and friends
  35  */
  36 struct gcd_options
  37 {
  38         enum {
  39                 /**
  40                  * Usually GiNaC tries heuristic GCD first, because typically
  41                  * it's much faster than anything else. Even if heuristic
  42                  * algorithm fails, the overhead is negligible w.r.t. cost
  43                  * of computing the GCD by some other method. However, some
  44                  * people dislike it, so here's a flag which tells GiNaC
  45                  * to NOT use the heuristic algorithm.
  46                  */
  47                 no_heur_gcd = 2,
  48                 /**
  49                  * GiNaC tries to avoid expanding expressions when computing
  50                  * GCDs. This is a good idea, but some people dislike it.
  51                  * Hence the flag to disable special handling of partially
  52                  * factored polynomials. DON'T SET THIS unless you *really*
  53                  * know what are you doing!
  54                  */
  55                 no_part_factored = 4,
  56                 /**
  57                  * By default GiNaC uses modular GCD algorithm. Typically
  58                  * it's much faster than PRS (pseudo remainder sequence)
  59                  * algorithm. This flag forces GiNaC to use PRS algorithm
  60                  */
  61                 use_sr_gcd = 8
  62
  63         };
  64 };
  65
  66 class ex;
  67 class symbol;
  68
  69 // Quotient q(x) of polynomials a(x) and b(x) in Q[x], so that a(x)=b(x)*q(x)+r(x)
  70 extern ex quo(const ex &a, const ex &b, const ex &x, bool check_args = true);
  71
  72 // Remainder r(x) of polynomials a(x) and b(x) in Q[x], so that a(x)=b(x)*q(x)+r(x)
  73 extern ex rem(const ex &a, const ex &b, const ex &x, bool check_args = true);
  74
  75 // Decompose rational function a(x)=N(x)/D(x) into Q(x)+R(x)/D(x) with degree(R, x) < degree(D, x)
  76 extern ex decomp_rational(const ex &a, const ex &x);
  77
  78 // Pseudo-remainder of polynomials a(x) and b(x) in Q[x]
  79 extern ex prem(const ex &a, const ex &b, const ex &x, bool check_args = true);
  80
  81 // Pseudo-remainder of polynomials a(x) and b(x) in Q[x]
  82 extern ex sprem(const ex &a, const ex &b, const ex &x, bool check_args = true);
  83
  84 // Exact polynomial division of a(X) by b(X) in Q[X] (quotient returned in q), returns false when exact division fails
  85 extern bool divide(const ex &a, const ex &b, ex &q, bool check_args = true);
  86
  87 // Polynomial GCD in Z[X], cofactors are returned in ca and cb, if desired
  88 extern ex gcd(const ex &a, const ex &b, ex *ca = nullptr, ex *cb = nullptr,
  89               bool check_args = true, unsigned options = 0);
  90
  91 // Polynomial LCM in Z[X]
  92 extern ex lcm(const ex &a, const ex &b, bool check_args = true);
  93
  94 // Square-free factorization of a polynomial a(x)
  95 extern ex sqrfree(const ex &a, const lst &l = lst());
  96
  97 // Square-free partial fraction decomposition of a rational function a(x)
  98 extern ex sqrfree_parfrac(const ex & a, const symbol & x);
  99
 100 // Collect common factors in sums.
 101 extern ex collect_common_factors(const ex & e);
 102
 103 // Resultant of two polynomials e1,e2 with respect to symbol s.
 104 extern ex resultant(const ex & e1, const ex & e2, const ex & s);
 105
 106 } // namespace GiNaC
 107
 108 #endif // ndef GINAC_NORMAL_H