Remove 'level' argument of normal().
[ginac.git] / ginac / numeric.h
index b8abb189d04d853f622952ac8b1c017084162416..bb7d258b44b38e37925d584ee8ca1d712cd79129 100644 (file)
@@ -1,8 +1,9 @@
 /** @file numeric.h
  *
- *  Makes the interface to the underlying bignum package available.
- *
- *  GiNaC Copyright (C) 1999 Johannes Gutenberg University Mainz, Germany
+ *  Makes the interface to the underlying bignum package available. */
+
+/*
+ *  GiNaC Copyright (C) 1999-2016 Johannes Gutenberg University Mainz, Germany
  *
  *  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
  *
  *  You should have received a copy of the GNU General Public License
  *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
 
-#ifndef __GINAC_NUMERIC_H__
-#define __GINAC_NUMERIC_H__
+#ifndef GINAC_NUMERIC_H
+#define GINAC_NUMERIC_H
 
-#include <strstream>
-#include <ginac/basic.h>
+#include "basic.h"
+#include "ex.h"
+#include "archive.h"
 
-#define HASHVALUE_NUMERIC 0x80000001U
+#include <cln/complex.h>
+#include <stdexcept>
+#include <vector>
 
-class cl_N;     // We want to include cln.h only in numeric.cpp in order to 
-                // avoid namespace pollution and keep compile-time low.
+namespace GiNaC {
 
-/** This class is used to instantiate a global object Digits which
- *  behaves just like Maple's Digits.  We need an object rather than a
- *  dumber basic type since as a side-effect we let it change
+/** Function pointer to implement callbacks in the case 'Digits' gets changed.
+ *  Main purpose of such callbacks is to adjust look-up tables of certain
+ *  functions to the new precision. Parameter contains the signed difference
+ *  between new Digits and old Digits. */
+typedef void (* digits_changed_callback)(long);
+
+/** This class is used to instantiate a global singleton object Digits
+ *  which behaves just like Maple's Digits.  We need an object rather 
+ *  than a dumber basic type since as a side-effect we let it change
  *  cl_default_float_format when it gets changed.  The only other
  *  meaningful thing to do with it is converting it to an unsigned,
- *  for temprary storing its value e.g.  The user must not create an
+ *  for temporarily storing its value e.g.  The user must not create an
  *  own working object of this class!  Since C++ forces us to make the
  *  class definition visible in order to use an object we put in a
  *  flag which prevents other objects of that class to be created. */
@@ -43,281 +52,279 @@ class _numeric_digits
 {
 // member functions
 public:
-    _numeric_digits();
-    _numeric_digits& operator=(long prec);
-    operator long();
-    void print(ostream & os) const;
+       _numeric_digits();
+       _numeric_digits& operator=(long prec);
+       operator long();
+       void print(std::ostream& os) const;
+       void add_callback(digits_changed_callback callback);
 // member variables
 private:
-    long digits;
-    static bool too_late;
+       long digits;                        ///< Number of decimal digits
+       static bool too_late;               ///< Already one object present
+       // Holds a list of functions that get called when digits is changed.
+       std::vector<digits_changed_callback> callbacklist;
+};
+
+
+/** Exception class thrown when a singularity is encountered. */
+class pole_error : public std::domain_error {
+public:
+       explicit pole_error(const std::string& what_arg, int degree);
+       int degree() const;
+private:
+       int deg;
 };
 
+
 /** This class is a wrapper around CLN-numbers within the GiNaC class
  *  hierarchy. Objects of this type may directly be created by the user.*/
 class numeric : public basic
 {
-// friends
-    friend numeric exp(numeric const & x);
-    friend numeric log(numeric const & x);
-    friend numeric sin(numeric const & x);
-    friend numeric cos(numeric const & x);
-    friend numeric tan(numeric const & x);
-    friend numeric asin(numeric const & x);
-    friend numeric acos(numeric const & x);
-    friend numeric atan(numeric const & x);
-    friend numeric atan(numeric const & y, numeric const & x);
-    friend numeric sinh(numeric const & x);
-    friend numeric cosh(numeric const & x);
-    friend numeric tanh(numeric const & x);
-    friend numeric asinh(numeric const & x);
-    friend numeric acosh(numeric const & x);
-    friend numeric atanh(numeric const & x);
-    friend numeric abs(numeric const & x);
-    friend numeric mod(numeric const & a, numeric const & b);
-    friend numeric smod(numeric const & a, numeric const & b);
-    friend numeric irem(numeric const & a, numeric const & b);
-    friend numeric irem(numeric const & a, numeric const & b, numeric & q);
-    friend numeric iquo(numeric const & a, numeric const & b);
-    friend numeric iquo(numeric const & a, numeric const & b, numeric & r);
-    friend numeric sqrt(numeric const & x);
-    friend numeric isqrt(numeric const & x);
-    friend numeric gcd(numeric const & a, numeric const & b);
-    friend numeric lcm(numeric const & a, numeric const & b);
-    friend numeric const & numZERO(void);
-    friend numeric const & numONE(void);
-    friend numeric const & numTWO(void);
-    friend numeric const & numTHREE(void);
-    friend numeric const & numMINUSONE(void);
-    friend numeric const & numHALF(void);
-
+       GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
+       
 // member functions
-
-    // default constructor, destructor, copy constructor assignment
-    // operator and helpers
-public:
-    numeric();
-    ~numeric();
-    numeric(numeric const & other);
-    numeric const & operator=(numeric const & other);
-protected:
-    void copy(numeric const & other);
-    void destroy(bool call_parent);
-
-    // other constructors
+       
+       // other constructors
 public:
-    explicit numeric(int i);
-    explicit numeric(unsigned int i);
-    explicit numeric(long i);
-    explicit numeric(unsigned long i);
-    explicit numeric(long numer, long denom);
-    explicit numeric(double d);
-    explicit numeric(char const *);
-    numeric(cl_N const & z);
-
-    // functions overriding virtual functions from bases classes
+       numeric(int i);
+       numeric(unsigned int i);
+       numeric(long i);
+       numeric(unsigned long i);
+       numeric(long numer, long denom);
+       numeric(double d);
+       numeric(const char *);
+       
+       // functions overriding virtual functions from base classes
 public:
-    basic * duplicate() const;
-    void printraw(ostream & os) const;
-    void printtree(ostream & os, unsigned indent) const;
-    void print(ostream & os, unsigned precedence=0) const;
-    void printcsrc(ostream & os, unsigned type, unsigned precedence=0) const;
-    bool info(unsigned inf) const;
-    ex evalf(int level=0) const;
-    ex diff(symbol const & s) const;
-    ex normal(lst &sym_lst, lst &repl_lst, int level=0) const;
-    numeric integer_content(void) const;
-    ex smod(numeric const &xi) const;
-    numeric max_coefficient(void) const;
+       unsigned precedence() const override {return 30;}
+       bool info(unsigned inf) const override;
+       bool is_polynomial(const ex & var) const override;
+       int degree(const ex & s) const override;
+       int ldegree(const ex & s) const override;
+       ex coeff(const ex & s, int n = 1) const override;
+       bool has(const ex &other, unsigned options = 0) const override;
+       ex eval() const override;
+       ex evalf() const override;
+       ex subs(const exmap & m, unsigned options = 0) const override { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
+       ex normal(exmap & repl, exmap & rev_lookup) const override;
+       ex to_rational(exmap & repl) const override;
+       ex to_polynomial(exmap & repl) const override;
+       numeric integer_content() const override;
+       ex smod(const numeric &xi) const override;
+       numeric max_coefficient() const override;
+       ex conjugate() const override;
+       ex real_part() const override;
+       ex imag_part() const override;
+       /** Save (a.k.a. serialize) object into archive. */
+       void archive(archive_node& n) const override;
+       /** Read (a.k.a. deserialize) object from archive. */
+       void read_archive(const archive_node& n, lst& syms) override;
 protected:
-    int compare_same_type(basic const & other) const;
-    bool is_equal_same_type(basic const & other) const;
-    unsigned calchash(void) const {
-        hashvalue=HASHVALUE_NUMERIC;
-        return HASHVALUE_NUMERIC;
-    }
-
-    // new virtual functions which can be overridden by derived classes
-    // (none)
-
-    // non-virtual functions in this class
+       /** Implementation of ex::diff for a numeric always returns 0.
+        *  @see ex::diff */
+       ex derivative(const symbol &s) const override { return 0; }
+       bool is_equal_same_type(const basic &other) const override;
+       unsigned calchash() const override;
+       
+       // new virtual functions which can be overridden by derived classes
+       // (none)
+       
+       // non-virtual functions in this class
 public:
-    numeric add(numeric const & other) const;
-    numeric sub(numeric const & other) const;
-    numeric mul(numeric const & other) const;
-    numeric div(numeric const & other) const;
-    numeric power(numeric const & other) const;
-    numeric const & add_dyn(numeric const & other) const;
-    numeric const & sub_dyn(numeric const & other) const;
-    numeric const & mul_dyn(numeric const & other) const;
-    numeric const & div_dyn(numeric const & other) const;
-    numeric const & power_dyn(numeric const & other) const;
-    numeric const & operator=(int i);
-    numeric const & operator=(unsigned int i);
-    numeric const & operator=(long i);
-    numeric const & operator=(unsigned long i);
-    numeric const & operator=(double d);
-    numeric const & operator=(char const * s);
-    /*
-    numeric add_dyn(numeric const & other) const   { return add(other);   }
-    numeric sub_dyn(numeric const & other) const   { return sub(other);   }
-    numeric mul_dyn(numeric const & other) const   { return mul(other);   }
-    numeric div_dyn(numeric const & other) const   { return div(other);   }
-    numeric power_dyn(numeric const & other) const { return power(other); }
-    */
-    numeric inverse(void) const;
-    int compare(numeric const & other) const;
-    bool is_equal(numeric const & other) const;
-    bool is_zero(void) const;
-    bool is_positive(void) const;
-    bool is_negative(void) const;
-    bool is_integer(void) const;
-    bool is_pos_integer(void) const;
-    bool is_nonneg_integer(void) const;
-    bool is_even(void) const;
-    bool is_odd(void) const;
-    bool is_prime(void) const;
-    bool is_rational(void) const;
-    bool is_real(void) const;
-    bool operator==(numeric const & other) const;
-    bool operator!=(numeric const & other) const;
-    bool operator<(numeric const & other) const;
-    bool operator<=(numeric const & other) const;
-    bool operator>(numeric const & other) const;
-    bool operator>=(numeric const & other) const;
-    int to_int(void) const;
-    double to_double(void) const;
-    numeric real(void) const;
-    numeric imag(void) const;
-    numeric numer(void) const;
-    numeric denom(void) const;
-    int int_length(void) const;
+       const numeric add(const numeric &other) const;
+       const numeric sub(const numeric &other) const;
+       const numeric mul(const numeric &other) const;
+       const numeric div(const numeric &other) const;
+       const numeric power(const numeric &other) const;
+       const numeric & add_dyn(const numeric &other) const;
+       const numeric & sub_dyn(const numeric &other) const;
+       const numeric & mul_dyn(const numeric &other) const;
+       const numeric & div_dyn(const numeric &other) const;
+       const numeric & power_dyn(const numeric &other) const;
+       const numeric & operator=(int i);
+       const numeric & operator=(unsigned int i);
+       const numeric & operator=(long i);
+       const numeric & operator=(unsigned long i);
+       const numeric & operator=(double d);
+       const numeric & operator=(const char *s);
+       const numeric inverse() const;
+       numeric step() const;
+       int csgn() const;
+       int compare(const numeric &other) const;
+       bool is_equal(const numeric &other) const;
+       bool is_zero() const;
+       bool is_positive() const;
+       bool is_negative() const;
+       bool is_integer() const;
+       bool is_pos_integer() const;
+       bool is_nonneg_integer() const;
+       bool is_even() const;
+       bool is_odd() const;
+       bool is_prime() const;
+       bool is_rational() const;
+       bool is_real() const;
+       bool is_cinteger() const;
+       bool is_crational() const;
+       bool operator==(const numeric &other) const;
+       bool operator!=(const numeric &other) const;
+       bool operator<(const numeric &other) const;
+       bool operator<=(const numeric &other) const;
+       bool operator>(const numeric &other) const;
+       bool operator>=(const numeric &other) const;
+       int to_int() const;
+       long to_long() const;
+       double to_double() const;
+       cln::cl_N to_cl_N() const;
+       const numeric real() const;
+       const numeric imag() const;
+       const numeric numer() const;
+       const numeric denom() const;
+       int int_length() const;
+       // converting routines for interfacing with CLN:
+       explicit numeric(const cln::cl_N &z);
+
+protected:
+       void print_numeric(const print_context & c, const char *par_open, const char *par_close, const char *imag_sym, const char *mul_sym, unsigned level) const;
+       void do_print(const print_context & c, unsigned level) const;
+       void do_print_latex(const print_latex & c, unsigned level) const;
+       void do_print_csrc(const print_csrc & c, unsigned level) const;
+       void do_print_csrc_cl_N(const print_csrc_cl_N & c, unsigned level) const;
+       void do_print_tree(const print_tree & c, unsigned level) const;
+       void do_print_python_repr(const print_python_repr & c, unsigned level) const;
 
 // member variables
 
 protected:
-    static unsigned precedence;
-    cl_N *value;
+       cln::cl_N value;
 };
+GINAC_DECLARE_UNARCHIVER(numeric); 
+
 
 // global constants
 
-extern const numeric some_numeric;
 extern const numeric I;
-extern type_info const & typeid_numeric;
 extern _numeric_digits Digits;
 
-#define is_a_numeric_hash(x) ((x)==HASHVALUE_NUMERIC)
-// may have to be changed to ((x)>=0x80000000U)
-
 // global functions
 
-numeric const & numZERO(void);
-numeric const & numONE(void);
-numeric const & numTWO(void);
-numeric const & numMINUSONE(void);
-numeric const & numHALF(void);
-
-numeric exp(numeric const & x);
-numeric log(numeric const & x);
-numeric sin(numeric const & x);
-numeric cos(numeric const & x);
-numeric tan(numeric const & x);
-numeric asin(numeric const & x);
-numeric acos(numeric const & x);
-numeric atan(numeric const & x);
-numeric atan(numeric const & y, numeric const & x);
-numeric sinh(numeric const & x);
-numeric cosh(numeric const & x);
-numeric tanh(numeric const & x);
-numeric asinh(numeric const & x);
-numeric acosh(numeric const & x);
-numeric atanh(numeric const & x);
-numeric gamma(numeric const & x);
-numeric factorial(numeric const & n);
-numeric doublefactorial(numeric const & n);
-numeric binomial(numeric const & n, numeric const & k);
-
-numeric abs(numeric const & x);
-numeric mod(numeric const & a, numeric const & b);
-numeric smod(numeric const & a, numeric const & b);
-numeric irem(numeric const & a, numeric const & b);
-numeric irem(numeric const & a, numeric const & b, numeric & q);
-numeric iquo(numeric const & a, numeric const & b);
-numeric iquo(numeric const & a, numeric const & b, numeric & r);
-numeric sqrt(numeric const & x);
-numeric isqrt(numeric const & x);
-
-numeric gcd(numeric const & a, numeric const & b);
-numeric lcm(numeric const & a, numeric const & b);
-
-/** Exception thrown by numeric members to signal failure */
-struct numeric_fail
-{
-    int failval;
-    numeric_fail(int n) { failval = n; }
-};
+const numeric exp(const numeric &x);
+const numeric log(const numeric &x);
+const numeric sin(const numeric &x);
+const numeric cos(const numeric &x);
+const numeric tan(const numeric &x);
+const numeric asin(const numeric &x);
+const numeric acos(const numeric &x);
+const numeric atan(const numeric &x);
+const numeric atan(const numeric &y, const numeric &x);
+const numeric sinh(const numeric &x);
+const numeric cosh(const numeric &x);
+const numeric tanh(const numeric &x);
+const numeric asinh(const numeric &x);
+const numeric acosh(const numeric &x);
+const numeric atanh(const numeric &x);
+const numeric Li2(const numeric &x);
+const numeric zeta(const numeric &x);
+const numeric lgamma(const numeric &x);
+const numeric tgamma(const numeric &x);
+const numeric psi(const numeric &x);
+const numeric psi(const numeric &n, const numeric &x);
+const numeric factorial(const numeric &n);
+const numeric doublefactorial(const numeric &n);
+const numeric binomial(const numeric &n, const numeric &k);
+const numeric bernoulli(const numeric &n);
+const numeric fibonacci(const numeric &n);
+const numeric isqrt(const numeric &x);
+const numeric sqrt(const numeric &x);
+const numeric abs(const numeric &x);
+const numeric mod(const numeric &a, const numeric &b);
+const numeric smod(const numeric &a, const numeric &b);
+const numeric irem(const numeric &a, const numeric &b);
+const numeric irem(const numeric &a, const numeric &b, numeric &q);
+const numeric iquo(const numeric &a, const numeric &b);
+const numeric iquo(const numeric &a, const numeric &b, numeric &r);
+const numeric gcd(const numeric &a, const numeric &b);
+const numeric lcm(const numeric &a, const numeric &b);
 
 // wrapper functions around member functions
-inline numeric inverse(numeric const & x)
+inline const numeric pow(const numeric &x, const numeric &y)
+{ return x.power(y); }
+
+inline const numeric inverse(const numeric &x)
 { return x.inverse(); }
 
-inline bool is_zero(numeric const & x)
+inline numeric step(const numeric &x)
+{ return x.step(); }
+
+inline int csgn(const numeric &x)
+{ return x.csgn(); }
+
+inline bool is_zero(const numeric &x)
 { return x.is_zero(); }
 
-inline bool is_positive(numeric const & x)
+inline bool is_positive(const numeric &x)
 { return x.is_positive(); }
 
-inline bool is_integer(numeric const & x)
+inline bool is_negative(const numeric &x)
+{ return x.is_negative(); }
+
+inline bool is_integer(const numeric &x)
 { return x.is_integer(); }
 
-inline bool is_pos_integer(numeric const & x)
+inline bool is_pos_integer(const numeric &x)
 { return x.is_pos_integer(); }
 
-inline bool is_nonneg_integer(numeric const & x)
+inline bool is_nonneg_integer(const numeric &x)
 { return x.is_nonneg_integer(); }
 
-inline bool is_even(numeric const & x)
+inline bool is_even(const numeric &x)
 { return x.is_even(); }
 
-inline bool is_odd(numeric const & x)
+inline bool is_odd(const numeric &x)
 { return x.is_odd(); }
 
-inline bool is_prime(numeric const & x)
+inline bool is_prime(const numeric &x)
 { return x.is_prime(); }
 
-inline bool is_rational(numeric const & x)
+inline bool is_rational(const numeric &x)
 { return x.is_rational(); }
 
-inline bool is_real(numeric const & x)
+inline bool is_real(const numeric &x)
 { return x.is_real(); }
 
-inline numeric real(numeric const & x)
+inline bool is_cinteger(const numeric &x)
+{ return x.is_cinteger(); }
+
+inline bool is_crational(const numeric &x)
+{ return x.is_crational(); }
+
+inline int to_int(const numeric &x)
+{ return x.to_int(); }
+
+inline long to_long(const numeric &x)
+{ return x.to_long(); }
+
+inline double to_double(const numeric &x)
+{ return x.to_double(); }
+
+inline const numeric real(const numeric &x)
 { return x.real(); }
 
-inline numeric imag(numeric const & x)
+inline const numeric imag(const numeric &x)
 { return x.imag(); }
 
-inline numeric numer(numeric const & x)
+inline const numeric numer(const numeric &x)
 { return x.numer(); }
 
-inline numeric denom(numeric const & x)
+inline const numeric denom(const numeric &x)
 { return x.denom(); }
 
-/* do we need this any more? */
-//inline numeric factorial(int n)
-//{ return factorial(numeric(n)); }
-
-/* do we need this any more? */
-//inline numeric binomial(int n, int k)
-//{ return binomial(numeric(n), numeric(k)); }
+// numeric evaluation functions for class constant objects:
 
-ex IEvalf(void);
-ex PiEvalf(void);
-ex EulerGammaEvalf(void);
-ex CatalanEvalf(void);
+ex PiEvalf();
+ex EulerEvalf();
+ex CatalanEvalf();
 
-#define ex_to_numeric(X) static_cast<numeric const &>(*(X).bp)
 
+} // namespace GiNaC
 
-#endif // ndef __GINAC_NUMERIC_H__
+#endif // ndef GINAC_NUMERIC_H