ginac/factor.h

   1 /** @file factor.h
   2  *
   3  *  Polynomial factorization. */
   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_FACTOR_H
  24 #define GINAC_FACTOR_H
  25
  26 namespace GiNaC {
  27
  28 class ex;
  29
  30 /** Factorizes univariate and multivariate polynomials.
  31  *
  32  *  The default option is factor_options::polynomial, which means that factor()
  33  *  will only factorize an expression if it is a proper polynomial (i.e. the
  34  *  flag info_flags::polynomial is set). Given the option factor_options::all,
  35  *  factor() will factorize all subexpressions, e.g. polynomials containing
  36  *  functions or polynomials inside function arguments.
  37  *
  38  *  @param[in] poly    expression to factorize
  39  *  @param[in] option  options to influence the factorization
  40  *  @return            factorized expression
  41  */
  42 extern ex factor(const ex& poly, unsigned options = 0);
  43
  44 } // namespace GiNaC
  45
  46 #endif // ndef GINAC_FACTOR_H