utilities.h

Go to the documentation of this file.

/*
 * GiNaCRA - GiNaC Real Algebra package
 * Copyright (C) 2010-2012  Ulrich Loup, Joachim Redies, Sebastian Junges
 *
 * This file is part of GiNaCRA.
 *
 * GiNaCRA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GiNaCRA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GiNaCRA.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


#ifndef GINACRA_UTILITIES_H
#define GINACRA_UTILITIES_H

#include <ginac/ginac.h>
#include <cln/cln.h>
#include <stdexcept>

#include "constants.h"

using std::invalid_argument;
using std::map;
using std::vector;

namespace GiNaC
{
    const ex prod( const lst& l ) throw ( invalid_argument );

    const ex lcm( const lst& l ) throw ( invalid_argument );

    long lcm( long a, long b );

    long gcd( long a, long b );

    long numerator( long a, long b );

    long denominator( long a, long b );

    bool is_constant( const ex& polynomial, const vector<symbol>& symbolLst );

    bool is_rational_polynomial( const ex& p, const symbol& x );

    bool is_realalgebraic_polynomial( const ex& p, const symbol& x );

    bool is_realalgebraic_term( const ex& p );

    sign sgn( const numeric& n );

    const ex monpart( const ex& polynomial, const vector<symbol>& symbolLst );

    const ex coeffpart( const ex& polynomial, const vector<symbol>& symbolLst );

    void isolateByVariables( const ex& polynomial, const vector<symbol>& symbolLst, ex& coefficient, ex& monomial );

    const GiNaC::ex rationalize( const GiNaC::ex& p, const vector<GiNaC::symbol>& symbolLst );

    inline const GiNaC::ex rationalize( const GiNaC::ex& p, const GiNaC::symbol& s );

    inline const GiNaC::numeric rationalize( const GiNaC::numeric& n );

    const vector<symbol> sortVariables( const vector<symbol>& l );

    bool symbol_is_lesseq_lex( const symbol& a, const symbol& b );

    bool symbol_is_less_lex( const symbol& a, const symbol& b );

    // TODO make a good exception handling

    const map<int, ex> signedSubresultants( const ex& A, const ex& B, const symbol& sym );

    const vector<ex> signedSubresultantsCoefficients( const ex& A, const ex& B, const symbol& sym ) throw ( invalid_argument );

}    // namespace GiNaC

namespace GiNaCRA
{
    struct plus_second:
        std:: binary_function<unsigned, std::pair<unsigned, unsigned>, unsigned>
    {
        unsigned operator ()( unsigned x, const std::pair<unsigned, unsigned>& y ) const
        {
            return x + y.second;
        }
    };

}

#endif // GINACRA_UTILITIES_H