UnivariateRepresentation.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_UNIVARIATEREPRESENTATION_H
#define GINACRA_UNIVARIATEREPRESENTATION_H

#include <ginac/flags.h>
#include <ginac/registrar.h>
#include <ginac/ginac.h>
#include <stdexcept>

#include "RationalUnivariatePolynomial.h"
#include "operators.h"

namespace GiNaC
{
    class UnivariateRepresentation:
        public basic
    {
        // Call GiNaC macro (registrar.h) for initiating the implementation into the basic type.
        GINAC_DECLARE_REGISTERED_CLASS(UnivariateRepresentation, basic)

        public:

            // Con- and destructors //

            UnivariateRepresentation( const RationalUnivariatePolynomial& rootSource,
                                      const RationalUnivariatePolynomial& denominator,
                                      const list<RationalUnivariatePolynomial>& numerators,
                                      const vector<symbol>& variables )
                    throw ( invalid_argument );

            ~UnivariateRepresentation();

            // Selectors //

            const RationalUnivariatePolynomial RootSource() const;

            const RationalUnivariatePolynomial Denominator() const;

            const list<RationalUnivariatePolynomial> Numerators() const;

            // Operators //

            // // binary arithmetic operators
            // const UnivariateRepresentation operator+(UnivariateRepresentation);
            // const UnivariateRepresentation operator-(UnivariateRepresentation);
            // const UnivariateRepresentation operator*(UnivariateRepresentation);
            // const UnivariateRepresentation operator/(UnivariateRepresentation);

            // // unary arithmetic operators
            // const UnivariateRepresentation operator-();

            // relational operators
            // const bool operator==(const UnivariateRepresentation&);
            // const bool operator!=(const UnivariateRepresentation&);
            // const bool operator<(const UnivariateRepresentation&);
            // const bool operator>(const UnivariateRepresentation&);
            // const bool operator<=(const UnivariateRepresentation&);
            // const bool operator>=(const UnivariateRepresentation&);

            // assignment operators

            // const UnivariateRepresentation& operator=(const UnivariateRepresentation&);

            // Operations //

            // Arithmetic Operations //

            const UnivariateRepresentation add( UnivariateRepresentation o ) throw ( invalid_argument );

            const UnivariateRepresentation minus() const;

            const UnivariateRepresentation mul( UnivariateRepresentation o ) throw ( invalid_argument );

            const UnivariateRepresentation inverse() const throw ( invalid_argument );

            // Static Methods //

        protected:

            // Methods from basic //

            bool is_equal_same_type( const basic& other );
            void do_print( const print_context& c, unsigned level = 0 ) const;
            ex eval( int level = 0 ) const;
            // unsigned calchash() const;

        private:

            // Attributes //

            RationalUnivariatePolynomial       mRootSource;
            RationalUnivariatePolynomial       mDenominator;    // mDenominator and mRootSource are coprime, i.e., they have a nonzero gcd
            list<RationalUnivariatePolynomial> mNumerators;
            vector<symbol>                     mVariables;

            // Con- and destructors //

            // Operations //

            // Relational Operations //

    };

}    // namespace GiNaC

#endif