e5c6076090bba9f15513eed03efce3bb17d0b9c3
[ginac.git] / ginac / polynomial / optimal_vars_finder.h
1 /** @file optimal_vars_finder.h
2  *
3  *  Interface to a function that optimizes the choice of variable for GCD
4  *  computations. */
5
6 /*
7  *  GiNaC Copyright (C) 1999-2011 Johannes Gutenberg University Mainz, Germany
8  *
9  *  This program is free software; you can redistribute it and/or modify
10  *  it under the terms of the GNU General Public License as published by
11  *  the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software
21  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  */
23
24 #ifndef GINAC_CHINREM_GCD_OPTIMAL_SYMBOL_FINDER_H
25 #define GINAC_CHINREM_GCD_OPTIMAL_SYMBOL_FINDER_H
26
27 #include "ex.h"
28
29 #include <vector>
30
31 namespace GiNaC {
32
33 /**
34  * @brief Find the order of variables which is optimal for GCD computation.
35  *
36  * Collects statistical information about the highest and lowest degrees
37  * of all variables that appear in two polynomials. Sorts the variables
38  * by minimum degree (lowest to highest). The information gathered by
39  * this function is used by GCD routines to find out the main variable
40  * for GCD computation.
41  */
42 extern exvector gcd_optimal_variables_order(const ex& A, const ex& B);
43
44 } // namespace GiNaC
45
46 #endif // GINAC_CHINREM_GCD_OPTIMAL_SYMBOL_FINDER_H