* Makes the interface to the underlying bignum package available. */
/*
- * GiNaC Copyright (C) 1999-2000 Johannes Gutenberg University Mainz, Germany
+ * GiNaC Copyright (C) 1999-2008 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__
-#include <strstream>
-#include <ginac/basic.h>
-#include <ginac/ex.h>
+#include "basic.h"
+#include "ex.h"
+#include "archive.h"
-class cl_N; // We want to include cln.h only in numeric.cpp in order to
- // avoid namespace pollution and keep compile-time low.
+#include <stdexcept>
+#include <vector>
+
+#include <cln/complex.h>
+
+#if defined(G__CINTVERSION) && !defined(__MAKECINT__)
+// Cint @$#$! doesn't like forward declaring classes used for casting operators
+// so we have to include the definition of cln::cl_N here, but it is enough to
+// do so for the compiler, hence the !defined(__MAKECINT__).
+ #include <cln/complex_class.h>
+#endif
-#ifndef NO_GINAC_NAMESPACE
namespace GiNaC {
-#endif // ndef NO_GINAC_NAMESPACE
-#define HASHVALUE_NUMERIC 0x80000001U
+/** 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 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
+/** 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
{
// 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
{
- GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
-
-// friends
- friend numeric exp(const numeric & x);
- friend numeric log(const numeric & x);
- friend numeric sin(const numeric & x);
- friend numeric cos(const numeric & x);
- friend numeric tan(const numeric & x);
- friend numeric asin(const numeric & x);
- friend numeric acos(const numeric & x);
- friend numeric atan(const numeric & x);
- friend numeric atan(const numeric & y, const numeric & x);
- friend numeric sinh(const numeric & x);
- friend numeric cosh(const numeric & x);
- friend numeric tanh(const numeric & x);
- friend numeric asinh(const numeric & x);
- friend numeric acosh(const numeric & x);
- friend numeric atanh(const numeric & x);
- friend numeric zeta(const numeric & x);
- friend numeric bernoulli(const numeric & n);
- friend numeric abs(const numeric & x);
- friend numeric mod(const numeric & a, const numeric & b);
- friend numeric smod(const numeric & a, const numeric & b);
- friend numeric irem(const numeric & a, const numeric & b);
- friend numeric irem(const numeric & a, const numeric & b, numeric & q);
- friend numeric iquo(const numeric & a, const numeric & b);
- friend numeric iquo(const numeric & a, const numeric & b, numeric & r);
- friend numeric sqrt(const numeric & x);
- friend numeric isqrt(const numeric & x);
- friend numeric gcd(const numeric & a, const numeric & b);
- friend numeric lcm(const numeric & a, const numeric & b);
-
+ GINAC_DECLARE_REGISTERED_CLASS(numeric, basic)
+
// member functions
-
- // default constructor, destructor, copy constructor assignment
- // operator and helpers
+
+ // other constructors
public:
- numeric();
- ~numeric();
- numeric(const numeric & other);
- const numeric & operator=(const numeric & other);
-protected:
- void copy(const numeric & other);
- void destroy(bool call_parent);
-
- // 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 print(ostream & os, unsigned precedence=0) const;
- void printraw(ostream & os) const;
- void printtree(ostream & os, unsigned indent) 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(const numeric &xi) const;
- numeric max_coefficient(void) const;
+ unsigned precedence() const {return 30;}
+ bool info(unsigned inf) const;
+ bool is_polynomial(const ex & var) const;
+ int degree(const ex & s) const;
+ int ldegree(const ex & s) const;
+ ex coeff(const ex & s, int n = 1) const;
+ bool has(const ex &other, unsigned options = 0) const;
+ ex eval(int level = 0) const;
+ ex evalf(int level = 0) const;
+ ex subs(const exmap & m, unsigned options = 0) const { return subs_one_level(m, options); } // overwrites basic::subs() for performance reasons
+ ex normal(exmap & repl, exmap & rev_lookup, int level = 0) const;
+ ex to_rational(exmap & repl) const;
+ ex to_polynomial(exmap & repl) const;
+ numeric integer_content() const;
+ ex smod(const numeric &xi) const;
+ numeric max_coefficient() const;
+ ex conjugate() const;
+ ex real_part() const;
+ ex imag_part() const;
+ /** Save (a.k.a. serialize) object into archive. */
+ void archive(archive_node& n) const;
+ /** Read (a.k.a. deserialize) object from archive. */
+ void read_archive(const archive_node& n, lst& syms);
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 { return 0; }
+ bool is_equal_same_type(const basic &other) const;
+ unsigned calchash() const;
+
+ // new virtual functions which can be overridden by derived classes
+ // (none)
+
+ // non-virtual functions in this class
public:
- numeric add(const numeric & other) const;
- numeric sub(const numeric & other) const;
- numeric mul(const numeric & other) const;
- numeric div(const numeric & other) 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=(char const * s);
- numeric inverse(void) const;
- int csgn(void) const;
- int compare(const numeric & other) const;
- bool is_equal(const numeric & 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 is_cinteger(void) const;
- bool is_crational(void) 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(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 exp(const numeric & x);
-numeric log(const numeric & x);
-numeric sin(const numeric & x);
-numeric cos(const numeric & x);
-numeric tan(const numeric & x);
-numeric asin(const numeric & x);
-numeric acos(const numeric & x);
-numeric atan(const numeric & x);
-numeric atan(const numeric & y, const numeric & x);
-numeric sinh(const numeric & x);
-numeric cosh(const numeric & x);
-numeric tanh(const numeric & x);
-numeric asinh(const numeric & x);
-numeric acosh(const numeric & x);
-numeric atanh(const numeric & x);
-numeric zeta(const numeric & x);
-numeric gamma(const numeric & x);
-numeric psi(const numeric & x);
-numeric psi(const numeric & n, const numeric & x);
-numeric factorial(const numeric & n);
-numeric doublefactorial(const numeric & n);
-numeric binomial(const numeric & n, const numeric & k);
-numeric bernoulli(const numeric & n);
-
-numeric abs(const numeric & x);
-numeric mod(const numeric & a, const numeric & b);
-numeric smod(const numeric & a, const numeric & b);
-numeric irem(const numeric & a, const numeric & b);
-numeric irem(const numeric & a, const numeric & b, numeric & q);
-numeric iquo(const numeric & a, const numeric & b);
-numeric iquo(const numeric & a, const numeric & b, numeric & r);
-numeric sqrt(const numeric & x);
-numeric isqrt(const numeric & x);
-
-numeric gcd(const numeric & a, const numeric & b);
-numeric lcm(const numeric & a, const numeric & 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 pow(const numeric & x, const numeric & y)
+inline const numeric pow(const numeric &x, const numeric &y)
{ return x.power(y); }
-inline numeric inverse(const numeric & x)
+inline const numeric inverse(const numeric &x)
{ return x.inverse(); }
-inline bool csgn(const numeric & 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)
+inline bool is_zero(const numeric &x)
{ return x.is_zero(); }
-inline bool is_positive(const numeric & x)
+inline bool is_positive(const numeric &x)
{ return x.is_positive(); }
-inline bool is_integer(const numeric & 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(const numeric & x)
+inline bool is_pos_integer(const numeric &x)
{ return x.is_pos_integer(); }
-inline bool is_nonneg_integer(const numeric & x)
+inline bool is_nonneg_integer(const numeric &x)
{ return x.is_nonneg_integer(); }
-inline bool is_even(const numeric & x)
+inline bool is_even(const numeric &x)
{ return x.is_even(); }
-inline bool is_odd(const numeric & x)
+inline bool is_odd(const numeric &x)
{ return x.is_odd(); }
-inline bool is_prime(const numeric & x)
+inline bool is_prime(const numeric &x)
{ return x.is_prime(); }
-inline bool is_rational(const numeric & x)
+inline bool is_rational(const numeric &x)
{ return x.is_rational(); }
-inline bool is_real(const numeric & x)
+inline bool is_real(const numeric &x)
{ return x.is_real(); }
-inline bool is_cinteger(const numeric & x)
+inline bool is_cinteger(const numeric &x)
{ return x.is_cinteger(); }
-inline bool is_crational(const numeric & x)
+inline bool is_crational(const numeric &x)
{ return x.is_crational(); }
-inline numeric real(const numeric & x)
+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(const numeric & x)
+inline const numeric imag(const numeric &x)
{ return x.imag(); }
-inline numeric numer(const numeric & x)
+inline const numeric numer(const numeric &x)
{ return x.numer(); }
-inline numeric denom(const numeric & x)
+inline const numeric denom(const numeric &x)
{ return x.denom(); }
// numeric evaluation functions for class constant objects:
-ex PiEvalf(void);
-ex EulerGammaEvalf(void);
-ex CatalanEvalf(void);
+ex PiEvalf();
+ex EulerEvalf();
+ex CatalanEvalf();
-// utility functions
-inline const numeric &ex_to_numeric(const ex &e)
-{
- return static_cast<const numeric &>(*e.bp);
-}
-#ifndef NO_GINAC_NAMESPACE
} // namespace GiNaC
-#endif // ndef NO_GINAC_NAMESPACE
+
+#ifdef __MAKECINT__
+#pragma link off defined_in cln/number.h;
+#pragma link off defined_in cln/complex_class.h;
+#endif
#endif // ndef __GINAC_NUMERIC_H__
git://www.ginac.de / ginac.git / blobdiff