ginac/numeric.h

   1 /** @file numeric.h
   2  *
   3  *  Makes the interface to the underlying bignum package available. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_NUMERIC_H__
  24 #define __GINAC_NUMERIC_H__
  25
  26 #include <strstream>
  27 #include "basic.h"
  28 #include "ex.h"
  29
  30 class cl_N;     // We want to include cln.h only in numeric.cpp in order to
  31                 // avoid namespace pollution and keep compile-time low.
  32
  33 #ifndef NO_NAMESPACE_GINAC
  34 namespace GiNaC {
  35 #endif // ndef NO_NAMESPACE_GINAC
  36
  37 #define HASHVALUE_NUMERIC 0x80000001U
  38
  39 /** This class is used to instantiate a global object Digits which
  40  *  behaves just like Maple's Digits.  We need an object rather than a
  41  *  dumber basic type since as a side-effect we let it change
  42  *  cl_default_float_format when it gets changed.  The only other
  43  *  meaningful thing to do with it is converting it to an unsigned,
  44  *  for temprary storing its value e.g.  The user must not create an
  45  *  own working object of this class!  Since C++ forces us to make the
  46  *  class definition visible in order to use an object we put in a
  47  *  flag which prevents other objects of that class to be created. */
  48 class _numeric_digits
  49 {
  50 // member functions
  51 public:
  52     _numeric_digits();
  53     _numeric_digits& operator=(long prec);
  54     operator long();
  55     void print(ostream & os) const;
  56 // member variables
  57 private:
  58     long digits;
  59     static bool too_late;
  60 };
  61
  62 /** This class is a wrapper around CLN-numbers within the GiNaC class
  63  *  hierarchy. Objects of this type may directly be created by the user.*/
  64 class numeric : public basic
  65 {
  66     GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
  67
  68 // friends
  69     friend const numeric exp(const numeric & x);
  70     friend const numeric log(const numeric & x);
  71     friend const numeric sin(const numeric & x);
  72     friend const numeric cos(const numeric & x);
  73     friend const numeric tan(const numeric & x);
  74     friend const numeric asin(const numeric & x);
  75     friend const numeric acos(const numeric & x);
  76     friend const numeric atan(const numeric & x);
  77     friend const numeric atan(const numeric & y, const numeric & x);
  78     friend const numeric sinh(const numeric & x);
  79     friend const numeric cosh(const numeric & x);
  80     friend const numeric tanh(const numeric & x);
  81     friend const numeric asinh(const numeric & x);
  82     friend const numeric acosh(const numeric & x);
  83     friend const numeric atanh(const numeric & x);
  84     friend const numeric zeta(const numeric & x);
  85     friend const numeric bernoulli(const numeric & n);
  86     friend const numeric fibonacci(const numeric & n);
  87     friend numeric abs(const numeric & x);
  88     friend numeric mod(const numeric & a, const numeric & b);
  89     friend numeric smod(const numeric & a, const numeric & b);
  90     friend numeric irem(const numeric & a, const numeric & b);
  91     friend numeric irem(const numeric & a, const numeric & b, numeric & q);
  92     friend numeric iquo(const numeric & a, const numeric & b);
  93     friend numeric iquo(const numeric & a, const numeric & b, numeric & r);
  94     friend numeric sqrt(const numeric & x);
  95     friend numeric isqrt(const numeric & x);
  96     friend numeric gcd(const numeric & a, const numeric & b);
  97     friend numeric lcm(const numeric & a, const numeric & b);
  98
  99 // member functions
 100
 101     // default constructor, destructor, copy constructor assignment
 102     // operator and helpers
 103 public:
 104     numeric();
 105     ~numeric();
 106     numeric(const numeric & other);
 107     const numeric & operator=(const numeric & other);
 108 protected:
 109     void copy(const numeric & other);
 110     void destroy(bool call_parent);
 111
 112     // other constructors
 113 public:
 114     explicit numeric(int i);
 115     explicit numeric(unsigned int i);
 116     explicit numeric(long i);
 117     explicit numeric(unsigned long i);
 118     explicit numeric(long numer, long denom);
 119     explicit numeric(double d);
 120     explicit numeric(const char *);
 121     numeric(const cl_N & z);
 122
 123     // functions overriding virtual functions from bases classes
 124 public:
 125     basic * duplicate() const;
 126     void print(ostream & os, unsigned precedence=0) const;
 127     void printraw(ostream & os) const;
 128     void printtree(ostream & os, unsigned indent) const;
 129     void printcsrc(ostream & os, unsigned type, unsigned precedence=0) const;
 130     bool info(unsigned inf) const;
 131     bool has(const ex & other) const;
 132     ex eval(int level=0) const;
 133     ex evalf(int level=0) const;
 134     ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
 135     ex to_rational(lst &repl_lst) const;
 136     numeric integer_content(void) const;
 137     ex smod(const numeric &xi) const;
 138     numeric max_coefficient(void) const;
 139 protected:
 140     ex derivative(const symbol & s) const;
 141     int compare_same_type(const basic & other) const;
 142     bool is_equal_same_type(const basic & other) const;
 143     unsigned calchash(void) const;
 144
 145     // new virtual functions which can be overridden by derived classes
 146     // (none)
 147
 148     // non-virtual functions in this class
 149 public:
 150     numeric add(const numeric & other) const;
 151     numeric sub(const numeric & other) const;
 152     numeric mul(const numeric & other) const;
 153     numeric div(const numeric & other) const;
 154     numeric power(const numeric & other) const;
 155     const numeric & add_dyn(const numeric & other) const;
 156     const numeric & sub_dyn(const numeric & other) const;
 157     const numeric & mul_dyn(const numeric & other) const;
 158     const numeric & div_dyn(const numeric & other) const;
 159     const numeric & power_dyn(const numeric & other) const;
 160     const numeric & operator=(int i);
 161     const numeric & operator=(unsigned int i);
 162     const numeric & operator=(long i);
 163     const numeric & operator=(unsigned long i);
 164     const numeric & operator=(double d);
 165     const numeric & operator=(const char * s);
 166     numeric inverse(void) const;
 167     int csgn(void) const;
 168     int compare(const numeric & other) const;
 169     bool is_equal(const numeric & other) const;
 170     bool is_zero(void) const;
 171     bool is_positive(void) const;
 172     bool is_negative(void) const;
 173     bool is_integer(void) const;
 174     bool is_pos_integer(void) const;
 175     bool is_nonneg_integer(void) const;
 176     bool is_even(void) const;
 177     bool is_odd(void) const;
 178     bool is_prime(void) const;
 179     bool is_rational(void) const;
 180     bool is_real(void) const;
 181     bool is_cinteger(void) const;
 182     bool is_crational(void) const;
 183     bool operator==(const numeric & other) const;
 184     bool operator!=(const numeric & other) const;
 185     bool operator<(const numeric & other) const;
 186     bool operator<=(const numeric & other) const;
 187     bool operator>(const numeric & other) const;
 188     bool operator>=(const numeric & other) const;
 189     int to_int(void) const;
 190     long to_long(void) const;
 191     double to_double(void) const;
 192     const numeric real(void) const;
 193     const numeric imag(void) const;
 194     const numeric numer(void) const;
 195     const numeric denom(void) const;
 196     int int_length(void) const;
 197
 198 // member variables
 199
 200 protected:
 201     static unsigned precedence;
 202     ::cl_N *value;
 203 };
 204
 205 // global constants
 206
 207 extern const numeric some_numeric;
 208 extern const numeric I;
 209 extern const type_info & typeid_numeric;
 210 extern _numeric_digits Digits;
 211
 212 //#define is_a_numeric_hash(x) ((x)==HASHVALUE_NUMERIC)
 213 // may have to be changed to ((x)>=0x80000000U)
 214
 215 // has been changed
 216 //#define is_a_numeric_hash(x) ((x)&0x80000000U)
 217
 218 // global functions
 219
 220 const numeric exp(const numeric & x);
 221 const numeric log(const numeric & x);
 222 const numeric sin(const numeric & x);
 223 const numeric cos(const numeric & x);
 224 const numeric tan(const numeric & x);
 225 const numeric asin(const numeric & x);
 226 const numeric acos(const numeric & x);
 227 const numeric atan(const numeric & x);
 228 const numeric atan(const numeric & y, const numeric & x);
 229 const numeric sinh(const numeric & x);
 230 const numeric cosh(const numeric & x);
 231 const numeric tanh(const numeric & x);
 232 const numeric asinh(const numeric & x);
 233 const numeric acosh(const numeric & x);
 234 const numeric atanh(const numeric & x);
 235 const numeric zeta(const numeric & x);
 236 const numeric lgamma(const numeric & x);
 237 const numeric tgamma(const numeric & x);
 238 const numeric psi(const numeric & x);
 239 const numeric psi(const numeric & n, const numeric & x);
 240 const numeric factorial(const numeric & n);
 241 const numeric doublefactorial(const numeric & n);
 242 const numeric binomial(const numeric & n, const numeric & k);
 243 const numeric bernoulli(const numeric & n);
 244 const numeric fibonacci(const numeric & n);
 245
 246 numeric abs(const numeric & x);
 247 numeric mod(const numeric & a, const numeric & b);
 248 numeric smod(const numeric & a, const numeric & b);
 249 numeric irem(const numeric & a, const numeric & b);
 250 numeric irem(const numeric & a, const numeric & b, numeric & q);
 251 numeric iquo(const numeric & a, const numeric & b);
 252 numeric iquo(const numeric & a, const numeric & b, numeric & r);
 253 numeric sqrt(const numeric & x);
 254 numeric isqrt(const numeric & x);
 255
 256 numeric gcd(const numeric & a, const numeric & b);
 257 numeric lcm(const numeric & a, const numeric & b);
 258
 259 // wrapper functions around member functions
 260 inline numeric pow(const numeric & x, const numeric & y)
 261 { return x.power(y); }
 262
 263 inline numeric inverse(const numeric & x)
 264 { return x.inverse(); }
 265
 266 inline int csgn(const numeric & x)
 267 { return x.csgn(); }
 268
 269 inline bool is_zero(const numeric & x)
 270 { return x.is_zero(); }
 271
 272 inline bool is_positive(const numeric & x)
 273 { return x.is_positive(); }
 274
 275 inline bool is_integer(const numeric & x)
 276 { return x.is_integer(); }
 277
 278 inline bool is_pos_integer(const numeric & x)
 279 { return x.is_pos_integer(); }
 280
 281 inline bool is_nonneg_integer(const numeric & x)
 282 { return x.is_nonneg_integer(); }
 283
 284 inline bool is_even(const numeric & x)
 285 { return x.is_even(); }
 286
 287 inline bool is_odd(const numeric & x)
 288 { return x.is_odd(); }
 289
 290 inline bool is_prime(const numeric & x)
 291 { return x.is_prime(); }
 292
 293 inline bool is_rational(const numeric & x)
 294 { return x.is_rational(); }
 295
 296 inline bool is_real(const numeric & x)
 297 { return x.is_real(); }
 298
 299 inline bool is_cinteger(const numeric & x)
 300 { return x.is_cinteger(); }
 301
 302 inline bool is_crational(const numeric & x)
 303 { return x.is_crational(); }
 304
 305 inline const numeric real(const numeric & x)
 306 { return x.real(); }
 307
 308 inline const numeric imag(const numeric & x)
 309 { return x.imag(); }
 310
 311 inline const numeric numer(const numeric & x)
 312 { return x.numer(); }
 313
 314 inline const numeric denom(const numeric & x)
 315 { return x.denom(); }
 316
 317 // numeric evaluation functions for class constant objects:
 318
 319 ex PiEvalf(void);
 320 ex EulerEvalf(void);
 321 ex CatalanEvalf(void);
 322
 323
 324 // utility functions
 325 inline const numeric &ex_to_numeric(const ex &e)
 326 {
 327     return static_cast<const numeric &>(*e.bp);
 328 }
 329
 330
 331 #ifndef NO_NAMESPACE_GINAC
 332 } // namespace GiNaC
 333 #endif // ndef NO_NAMESPACE_GINAC
 334
 335 #endif // ndef __GINAC_NUMERIC_H__