MultivariateTermMR.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_MULTIVARIATETERMMR_H
#define GINACRA_MULTIVARIATETERMMR_H

// #define GINACRA_MULTIVARIATEPOLYNOMIAL_DEBUG

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

#include "MultivariateMonomialMR.h"
#include "MultivariateCoefficientMR.h"
#include "utilities.h"

namespace GiNaCRA
{
    class MultivariateTermMR:
        public MultivariateMonomialMR
    {
        public:

            MultivariateTermMR():
                mCoeff()
            {}

            MultivariateTermMR( unsigned size ):
                MultivariateMonomialMR( size ),
                mCoeff( 1 )
            {}

            MultivariateTermMR( GiNaC::ex coeff ):
                MultivariateMonomialMR(),
                mCoeff( coeff )
            {}

            MultivariateTermMR( const MultivariateMonomialMR& m1, const GiNaC::ex& coeff ):
                MultivariateMonomialMR( m1 ),
                mCoeff( coeff )
            {}

            MultivariateTermMR( const MultivariateMonomialMR& m1, const MultivariateCoefficientMR& coeff ):
                MultivariateMonomialMR( m1 ),
                mCoeff( coeff )
            {}

            MultivariateTermMR( const MultivariateMonomialMR& m1 ):
                MultivariateMonomialMR( m1 ),
                mCoeff( 1 )
            {}

            friend bool operator ==( const MultivariateTermMR& t1, const MultivariateTermMR& t2 );
            friend const MultivariateTermMR operator *( const MultivariateTermMR& t1, const MultivariateTermMR& t2 );
            friend const MultivariateTermMR operator *( const MultivariateTermMR& t1, const MultivariateMonomialMR& m1 );
            friend const MultivariateTermMR operator *( const MultivariateMonomialMR& m1, const MultivariateTermMR& t1 );

            inline bool hasEqualExponents( const MultivariateTermMR& m2 ) const
            {
                if( mTotDeg != m2.mTotDeg || mExponents.size() != m2.mExponents.size() )
                    return false;
                return std::equal( mExponents.begin(), mExponents.end(), m2.mExponents.begin() );
            }

            inline GiNaC::ex toEx() const
            {
                return getCoeffExpr() * super::toEx();
            }

            inline GiNaC::ex getCoeffExpr() const
            {
                return mCoeff.getExpression();
            }

            inline MultivariateCoefficientMR getCoeff() const
            {
                return mCoeff;
            }

            inline MultivariateTermMR negate() const
            {
                return MultivariateTermMR( *this, -mCoeff );
            }

            /*
             * Part of the SPolynomial calculation.
             * @param m1
             * @return lcm(mon(this),m1) divided by t1
             */
            const MultivariateTermMR lcmdivt( const MultivariateMonomialMR& m1 ) const;

            bool dividable( const MultivariateTermMR& denom ) const;

            std::pair<MultivariateTermMR, bool> divby( const MultivariateTermMR& denom ) const;

            MultivariateTermMR divide( const ex& c ) const
            {
                return MultivariateTermMR( *this, mCoeff.getExpression() / c );
            }

            friend std::ostream& operator <<( std::ostream& os, const MultivariateTermMR& rhs );

        protected:
            MultivariateCoefficientMR mCoeff;

        private:
            typedef MultivariateMonomialMR super;
    };

}

/*
namespace std {

        template<typename t1, typename t2>
        pair<const GiNaCRA::MultivariateTermMR, bool>& pair<const GiNaCRA::MultivariateTermMR, bool>::operator=(const pair<const GiNaCRA::MultivariateTermMR, bool>& input);

}*/

#endif