/** @file factor.h
*
- * Polynomial factorization routines. Implementation.
- * Only univariate at the moment and completely non-optimized!
- */
+ * Polynomial factorization. */
/*
- * GiNaC Copyright (C) 1999-2008 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2019 Johannes Gutenberg University Mainz, Germany
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
-#ifndef __GINAC_FACTOR_H__
-#define __GINAC_FACTOR_H__
+#ifndef GINAC_FACTOR_H
+#define GINAC_FACTOR_H
namespace GiNaC {
class ex;
-extern ex factor(const ex& poly);
+/** Factorizes univariate and multivariate polynomials.
+ *
+ * The default option is factor_options::polynomial, which means that factor()
+ * will only factorize an expression if it is a proper polynomial (i.e. the
+ * flag info_flags::polynomial is set). Given the option factor_options::all,
+ * factor() will factorize all subexpressions, e.g. polynomials containing
+ * functions or polynomials inside function arguments.
+ *
+ * @param[in] poly expression to factorize
+ * @param[in] option options to influence the factorization
+ * @return factorized expression
+ */
+extern ex factor(const ex& poly, unsigned options = 0);
} // namespace GiNaC
-#endif // ndef __GINAC_FACTOR_H__
+#endif // ndef GINAC_FACTOR_H