RealAlgebraicNumber.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_REALALGEBRAICNUMBER_H
#define GINACRA_REALALGEBRAICNUMBER_H

#include <ginac/ginac.h>
#include <tr1/memory>

#include "RationalUnivariatePolynomial.h"
#include "constants.h"

namespace GiNaCRA
{
    class RealAlgebraicNumber
    {
        public:

            // Con- and destructors //

            RealAlgebraicNumber( bool isRoot, bool isNumeric = false, const numeric& value = 0 );

            ~RealAlgebraicNumber();

            virtual std::tr1::shared_ptr<RealAlgebraicNumber> clone() const
            {
                return std::tr1::shared_ptr<RealAlgebraicNumber>( new RealAlgebraicNumber( *this ));
            }

            // Selectors //

            const bool isRoot() const
            {
                return mIsRoot;
            }

            void setIsRoot( bool isRoot )
            {
                mIsRoot = isRoot;
            }

            bool isNumeric() const
            {
                return mIsNumeric;
            }

            const numeric value() const
            {
                return mValue;
            }

            // Operators //

            // assignment operators

            virtual const RealAlgebraicNumber& operator = ( const RealAlgebraicNumber& o )
            {
                mIsRoot = o.mIsRoot;
                return *this;
            }

            // Operations //

            virtual GiNaC::sign sgn() const;

            virtual GiNaC::sign sgn( const RationalUnivariatePolynomial& p ) const;

            virtual const numeric approximateValue() const;

        protected:

            // Attributes //

            bool mIsRoot;
            bool mIsNumeric;
            numeric mValue;
    };

    // TYPES //

    typedef std::tr1::shared_ptr<RealAlgebraicNumber> RealAlgebraicNumberPtr;

    struct RealAlgebraicNumberPtrHasher
    {
        size_t operator ()( RealAlgebraicNumberPtr p ) const
        {
            return (size_t)p.get();
        }
    };

}

#endif