q_number.hh

Go to the documentation of this file.

// q_number.hh: this file is part of the Vaucanson project.
//
// Vaucanson, a generic library for finite state machines.
//
// Copyright (C) 2011 The Vaucanson Group.
//
// This program 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 2
// of the License, or (at your option) any later version.
//
// The complete GNU General Public Licence Notice can be found as the
// `COPYING' file in the root directory.
//
// The Vaucanson Group consists of people listed in the `AUTHORS' file.
//
#ifndef VCSN_ALGEBRA_IMPLEMENTATION_SEMIRING_Q_NUMBER_HH
# define VCSN_ALGEBRA_IMPLEMENTATION_SEMIRING_Q_NUMBER_HH

#include <iostream>
/* @{ *//* @{ */
namespace vcsn
{
/* @{ */
  namespace algebra
  {/* @{ */

    template<typename IntType>
    class TRationalNumber
    {
    public:
      inline
      TRationalNumber ();
      inline
      TRationalNumber (const IntType num);
      inline
      TRationalNumber (const IntType num, const IntType den);
      inline
      TRationalNumber (const TRationalNumber<IntType>& nb);
      // Object destructor.
      inline
      ~TRationalNumber ();
    public:
      inline
      TRationalNumber& set (const IntType num, const IntType den = 1);
      inline
      IntType num_get () const;
      inline
      IntType den_get () const;
      inline
      std::ostream& print (std::ostream& ostr) const;

    public:
      inline
      TRationalNumber<IntType> operator+ (const TRationalNumber<IntType>& nb) const;
      inline
      TRationalNumber<IntType> operator- (const TRationalNumber<IntType>& nb) const;
      inline
      TRationalNumber<IntType> operator- () const;
      inline
      TRationalNumber<IntType> operator* (const TRationalNumber<IntType>& nb) const;
      inline
      TRationalNumber<IntType> operator/ (const TRationalNumber<IntType>& nb) const;

      inline
      TRationalNumber<IntType>& operator+= (const TRationalNumber<IntType>& nb);
      inline
      TRationalNumber<IntType>& operator-= (const TRationalNumber<IntType>& nb);
      inline
      TRationalNumber<IntType>& operator*= (const TRationalNumber<IntType>& nb);
      inline
      TRationalNumber<IntType>& operator/= (const TRationalNumber<IntType>& nb);

      inline
      bool operator== (const TRationalNumber<IntType>& nb) const;
      inline
      bool operator!= (const TRationalNumber<IntType>& nb) const;
      inline
      bool operator< (const TRationalNumber<IntType>& nb) const;
      inline
      bool operator<= (const TRationalNumber<IntType>& nb) const;
      inline
      bool operator> (const TRationalNumber<IntType>& nb) const;
      inline
      bool operator>= (const TRationalNumber<IntType>& nb) const;

      // @}

      // operator int () const;
      //operator float () const;
      inline
      operator double () const;

      inline
      IntType to_integer () const;
      inline
      float to_float () const;
      inline
      double to_double () const;
    protected:

      inline void set_rational ();
      inline void set_rational (const IntType num, const IntType den);
      inline void set_unsafe_rational (const IntType num, const IntType den);
    protected:
      IntType num_;
      IntType den_;
    }; // TRationalNumber<IntType>

    template<typename IntType>
    inline
    std::ostream& operator<< (std::ostream&, const TRationalNumber<IntType>&);

    template<typename IntType>
    inline
    std::istream& operator>> (std::istream&, TRationalNumber<IntType>&);

    typedef TRationalNumber<long long> RationalNumber;

  } // !algebra

} // !vcsn


# if !defined VCSN_USE_INTERFACE_ONLY || defined VCSN_USE_LIB
#  include <vaucanson/algebra/implementation/semiring/q_number.hxx>
# endif // VCSN_USE_INTERFACE_ONLY


#endif // ! VCSN_ALGEBRA_IMPLEMENTATION_SEMIRING_Q_NUMBER_HH