X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=ginac%2Fnumeric.cpp;h=c69a117d3748c0da1ed9fd26385143b5529a2361;hp=880e0a7ebbde60bcbf0ec559527cc69769f7dd02;hb=b301f03a61bc9f72b27940ca7fe1f8d0b343a4e2;hpb=aa6281216091efd92dc5fcc3f96c7189114e80f1 diff --git a/ginac/numeric.cpp b/ginac/numeric.cpp index 880e0a7e..c69a117d 100644 --- a/ginac/numeric.cpp +++ b/ginac/numeric.cpp @@ -7,7 +7,7 @@ * of special functions or implement the interface to the bignum package. */ /* - * GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany + * GiNaC Copyright (C) 1999-2003 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 @@ -29,20 +29,15 @@ #include #include #include - -#if defined(HAVE_SSTREAM) #include -#elif defined(HAVE_STRSTREAM) -#include -#else -#error Need either sstream or strstream -#endif +#include #include "numeric.h" #include "ex.h" #include "print.h" +#include "operators.h" #include "archive.h" -#include "debugmsg.h" +#include "tostring.h" #include "utils.h" // CLN should pollute the global namespace as little as possible. Hence, we @@ -69,67 +64,54 @@ namespace GiNaC { GINAC_IMPLEMENT_REGISTERED_CLASS(numeric, basic) ////////// -// default ctor, dtor, copy ctor assignment -// operator and helpers +// default constructor ////////// /** default ctor. Numerically it initializes to an integer zero. */ numeric::numeric() : basic(TINFO_numeric) { - debugmsg("numeric default ctor", LOGLEVEL_CONSTRUCT); value = cln::cl_I(0); setflag(status_flags::evaluated | status_flags::expanded); } -void numeric::copy(const numeric &other) -{ - inherited::copy(other); - value = other.value; -} - -DEFAULT_DESTROY(numeric) - ////////// -// other ctors +// other constructors ////////// // public numeric::numeric(int i) : basic(TINFO_numeric) { - debugmsg("numeric ctor from int",LOGLEVEL_CONSTRUCT); // Not the whole int-range is available if we don't cast to long // first. This is due to the behaviour of the cl_I-ctor, which - // emphasizes efficiency. However, if the integer is small enough, - // i.e. satisfies cl_immediate_p(), we save space and dereferences by - // using an immediate type: - if (cln::cl_immediate_p(i)) + // emphasizes efficiency. However, if the integer is small enough + // we save space and dereferences by using an immediate type. + // (C.f. ) + if (i < (1L << (cl_value_len-1)) && i >= -(1L << (cl_value_len-1))) value = cln::cl_I(i); else - value = cln::cl_I((long) i); + value = cln::cl_I(static_cast(i)); setflag(status_flags::evaluated | status_flags::expanded); } numeric::numeric(unsigned int i) : basic(TINFO_numeric) { - debugmsg("numeric ctor from uint",LOGLEVEL_CONSTRUCT); // Not the whole uint-range is available if we don't cast to ulong // first. This is due to the behaviour of the cl_I-ctor, which - // emphasizes efficiency. However, if the integer is small enough, - // i.e. satisfies cl_immediate_p(), we save space and dereferences by - // using an immediate type: - if (cln::cl_immediate_p(i)) + // emphasizes efficiency. However, if the integer is small enough + // we save space and dereferences by using an immediate type. + // (C.f. ) + if (i < (1U << (cl_value_len-1))) value = cln::cl_I(i); else - value = cln::cl_I((unsigned long) i); + value = cln::cl_I(static_cast(i)); setflag(status_flags::evaluated | status_flags::expanded); } numeric::numeric(long i) : basic(TINFO_numeric) { - debugmsg("numeric ctor from long",LOGLEVEL_CONSTRUCT); value = cln::cl_I(i); setflag(status_flags::evaluated | status_flags::expanded); } @@ -137,17 +119,16 @@ numeric::numeric(long i) : basic(TINFO_numeric) numeric::numeric(unsigned long i) : basic(TINFO_numeric) { - debugmsg("numeric ctor from ulong",LOGLEVEL_CONSTRUCT); value = cln::cl_I(i); setflag(status_flags::evaluated | status_flags::expanded); } -/** Ctor for rational numerics a/b. + +/** Constructor for rational numerics a/b. * * @exception overflow_error (division by zero) */ numeric::numeric(long numer, long denom) : basic(TINFO_numeric) { - debugmsg("numeric ctor from long/long",LOGLEVEL_CONSTRUCT); if (!denom) throw std::overflow_error("division by zero"); value = cln::cl_I(numer) / cln::cl_I(denom); @@ -157,7 +138,6 @@ numeric::numeric(long numer, long denom) : basic(TINFO_numeric) numeric::numeric(double d) : basic(TINFO_numeric) { - debugmsg("numeric ctor from double",LOGLEVEL_CONSTRUCT); // We really want to explicitly use the type cl_LF instead of the // more general cl_F, since that would give us a cl_DF only which // will not be promoted to cl_LF if overflow occurs: @@ -170,40 +150,47 @@ numeric::numeric(double d) : basic(TINFO_numeric) * notation like "2+5*I". */ numeric::numeric(const char *s) : basic(TINFO_numeric) { - debugmsg("numeric ctor from string",LOGLEVEL_CONSTRUCT); cln::cl_N ctorval = 0; // parse complex numbers (functional but not completely safe, unfortunately // std::string does not understand regexpese): // ss should represent a simple sum like 2+5*I - std::string ss(s); - // make it safe by adding explicit sign + std::string ss = s; + std::string::size_type delim; + + // make this implementation safe by adding explicit sign if (ss.at(0) != '+' && ss.at(0) != '-' && ss.at(0) != '#') ss = '+' + ss; - std::string::size_type delim; + + // We use 'E' as exponent marker in the output, but some people insist on + // writing 'e' at input, so let's substitute them right at the beginning: + while ((delim = ss.find("e"))!=std::string::npos) + ss.replace(delim,1,"E"); + + // main parser loop: do { // chop ss into terms from left to right std::string term; bool imaginary = false; delim = ss.find_first_of(std::string("+-"),1); // Do we have an exponent marker like "31.415E-1"? If so, hop on! - if ((delim != std::string::npos) && (ss.at(delim-1) == 'E')) + if (delim!=std::string::npos && ss.at(delim-1)=='E') delim = ss.find_first_of(std::string("+-"),delim+1); term = ss.substr(0,delim); - if (delim != std::string::npos) + if (delim!=std::string::npos) ss = ss.substr(delim); // is the term imaginary? - if (term.find("I") != std::string::npos) { + if (term.find("I")!=std::string::npos) { // erase 'I': - term = term.replace(term.find("I"),1,""); + term.erase(term.find("I"),1); // erase '*': - if (term.find("*") != std::string::npos) - term = term.replace(term.find("*"),1,""); + if (term.find("*")!=std::string::npos) + term.erase(term.find("*"),1); // correct for trivial +/-I without explicit factor on I: - if (term.size() == 1) - term += "1"; + if (term.size()==1) + term += '1'; imaginary = true; } - if (term.find(".") != std::string::npos) { + if (term.find('.')!=std::string::npos || term.find('E')!=std::string::npos) { // CLN's short type cl_SF is not very useful within the GiNaC // framework where we are mainly interested in the arbitrary // precision type cl_LF. Hence we go straight to the construction @@ -214,33 +201,25 @@ numeric::numeric(const char *s) : basic(TINFO_numeric) // 31.4E-1 --> 31.4e-1_ // and s on. // No exponent marker? Let's add a trivial one. - if (term.find("E") == std::string::npos) + if (term.find("E")==std::string::npos) term += "E0"; // E to lower case term = term.replace(term.find("E"),1,"e"); // append _ to term -#if defined(HAVE_SSTREAM) - std::ostringstream buf; - buf << unsigned(Digits) << std::ends; - term += "_" + buf.str(); -#else - char buf[14]; - std::ostrstream(buf,sizeof(buf)) << unsigned(Digits) << std::ends; - term += "_" + std::string(buf); -#endif + term += "_" + ToString((unsigned)Digits); // construct float using cln::cl_F(const char *) ctor. if (imaginary) ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_F(term.c_str())); else ctorval = ctorval + cln::cl_F(term.c_str()); } else { - // not a floating point number... + // this is not a floating point number... if (imaginary) ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_R(term.c_str())); else ctorval = ctorval + cln::cl_R(term.c_str()); } - } while(delim != std::string::npos); + } while (delim != std::string::npos); value = ctorval; setflag(status_flags::evaluated | status_flags::expanded); } @@ -250,7 +229,6 @@ numeric::numeric(const char *s) : basic(TINFO_numeric) * only. */ numeric::numeric(const cln::cl_N &z) : basic(TINFO_numeric) { - debugmsg("numeric ctor from cl_N", LOGLEVEL_CONSTRUCT); value = z; setflag(status_flags::evaluated | status_flags::expanded); } @@ -259,19 +237,14 @@ numeric::numeric(const cln::cl_N &z) : basic(TINFO_numeric) // archiving ////////// -numeric::numeric(const archive_node &n, const lst &sym_lst) : inherited(n, sym_lst) +numeric::numeric(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst) { - debugmsg("numeric ctor from archive_node", LOGLEVEL_CONSTRUCT); cln::cl_N ctorval = 0; // Read number as string std::string str; if (n.find_string("number", str)) { -#ifdef HAVE_SSTREAM std::istringstream s(str); -#else - std::istrstream s(str.c_str(), str.size() + 1); -#endif cln::cl_idecoded_float re, im; char c; s.get(c); @@ -301,12 +274,7 @@ void numeric::archive(archive_node &n) const inherited::archive(n); // Write number as string -#ifdef HAVE_SSTREAM std::ostringstream s; -#else - char buf[1024]; - std::ostrstream s(buf, 1024); -#endif if (this->is_crational()) s << cln::the(value); else { @@ -324,13 +292,7 @@ void numeric::archive(archive_node &n) const s << im.sign << " " << im.mantissa << " " << im.exponent; } } -#ifdef HAVE_SSTREAM n.add_string("number", s.str()); -#else - s << ends; - std::string str(buf); - n.add_string("number", str); -#endif } DEFAULT_UNARCHIVE(numeric) @@ -346,18 +308,105 @@ DEFAULT_UNARCHIVE(numeric) * want to visibly distinguish from cl_LF. * * @see numeric::print() */ -static void print_real_number(std::ostream &os, const cln::cl_R &num) +static void print_real_number(const print_context & c, const cln::cl_R & x) { cln::cl_print_flags ourflags; - if (cln::instanceof(num, cln::cl_RA_ring)) { - // case 1: integer or rational, nothing special to do: - cln::print_real(os, ourflags, num); + if (cln::instanceof(x, cln::cl_RA_ring)) { + // case 1: integer or rational + if (cln::instanceof(x, cln::cl_I_ring) || + !is_a(c)) { + cln::print_real(c.s, ourflags, x); + } else { // rational output in LaTeX context + if (x < 0) + c.s << "-"; + c.s << "\\frac{"; + cln::print_real(c.s, ourflags, cln::abs(cln::numerator(cln::the(x)))); + c.s << "}{"; + cln::print_real(c.s, ourflags, cln::denominator(cln::the(x))); + c.s << '}'; + } } else { // case 2: float // make CLN believe this number has default_float_format, so it prints // 'E' as exponent marker instead of 'L': - ourflags.default_float_format = cln::float_format(cln::the(num)); - cln::print_real(os, ourflags, num); + ourflags.default_float_format = cln::float_format(cln::the(x)); + cln::print_real(c.s, ourflags, x); + } +} + +/** Helper function to print integer number in C++ source format. + * + * @see numeric::print() */ +static void print_integer_csrc(const print_context & c, const cln::cl_I & x) +{ + // Print small numbers in compact float format, but larger numbers in + // scientific format + const int max_cln_int = 536870911; // 2^29-1 + if (x >= cln::cl_I(-max_cln_int) && x <= cln::cl_I(max_cln_int)) + c.s << cln::cl_I_to_int(x) << ".0"; + else + c.s << cln::double_approx(x); +} + +/** Helper function to print real number in C++ source format. + * + * @see numeric::print() */ +static void print_real_csrc(const print_context & c, const cln::cl_R & x) +{ + if (cln::instanceof(x, cln::cl_I_ring)) { + + // Integer number + print_integer_csrc(c, cln::the(x)); + + } else if (cln::instanceof(x, cln::cl_RA_ring)) { + + // Rational number + const cln::cl_I numer = cln::numerator(cln::the(x)); + const cln::cl_I denom = cln::denominator(cln::the(x)); + if (cln::plusp(x) > 0) { + c.s << "("; + print_integer_csrc(c, numer); + } else { + c.s << "-("; + print_integer_csrc(c, -numer); + } + c.s << "/"; + print_integer_csrc(c, denom); + c.s << ")"; + + } else { + + // Anything else + c.s << cln::double_approx(x); + } +} + +/** Helper function to print real number in C++ source format using cl_N types. + * + * @see numeric::print() */ +static void print_real_cl_N(const print_context & c, const cln::cl_R & x) +{ + if (cln::instanceof(x, cln::cl_I_ring)) { + + // Integer number + c.s << "cln::cl_I(\""; + print_real_number(c, x); + c.s << "\")"; + + } else if (cln::instanceof(x, cln::cl_RA_ring)) { + + // Rational number + cln::cl_print_flags ourflags; + c.s << "cln::cl_RA(\""; + cln::print_rational(c.s, ourflags, cln::the(x)); + c.s << "\")"; + + } else { + + // Anything else + c.s << "cln::cl_F(\""; + print_real_number(c, cln::cl_float(1.0, cln::default_float_format) * x); + c.s << "_" << Digits << "\")"; } } @@ -367,8 +416,6 @@ static void print_real_number(std::ostream &os, const cln::cl_R &num) * @see print_real_number() */ void numeric::print(const print_context & c, unsigned level) const { - debugmsg("numeric print", LOGLEVEL_PRINT); - if (is_a(c)) { c.s << std::string(level, ' ') << cln::the(value) @@ -376,87 +423,107 @@ void numeric::print(const print_context & c, unsigned level) const << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec << std::endl; + } else if (is_a(c)) { + + // CLN output + if (this->is_real()) { + + // Real number + print_real_cl_N(c, cln::the(value)); + + } else { + + // Complex number + c.s << "cln::complex("; + print_real_cl_N(c, cln::realpart(cln::the(value))); + c.s << ","; + print_real_cl_N(c, cln::imagpart(cln::the(value))); + c.s << ")"; + } + } else if (is_a(c)) { + // C++ source output std::ios::fmtflags oldflags = c.s.flags(); c.s.setf(std::ios::scientific); - if (this->is_rational() && !this->is_integer()) { - if (compare(_num0()) > 0) { - c.s << "("; - if (is_a(c)) - c.s << "cln::cl_F(\"" << numer().evalf() << "\")"; - else - c.s << numer().to_double(); - } else { - c.s << "-("; - if (is_a(c)) - c.s << "cln::cl_F(\"" << -numer().evalf() << "\")"; - else - c.s << -numer().to_double(); - } - c.s << "/"; - if (is_a(c)) - c.s << "cln::cl_F(\"" << denom().evalf() << "\")"; - else - c.s << denom().to_double(); - c.s << ")"; + int oldprec = c.s.precision(); + + // Set precision + if (is_a(c)) + c.s.precision(std::numeric_limits::digits10 + 1); + else + c.s.precision(std::numeric_limits::digits10 + 1); + + if (this->is_real()) { + + // Real number + print_real_csrc(c, cln::the(value)); + } else { - if (is_a(c)) - c.s << "cln::cl_F(\"" << evalf() << "\")"; + + // Complex number + c.s << "std::complex<"; + if (is_a(c)) + c.s << "double>("; else - c.s << to_double(); + c.s << "float>("; + + print_real_csrc(c, cln::realpart(cln::the(value))); + c.s << ","; + print_real_csrc(c, cln::imagpart(cln::the(value))); + c.s << ")"; } + c.s.flags(oldflags); + c.s.precision(oldprec); } else { + const std::string par_open = is_a(c) ? "{(" : "("; const std::string par_close = is_a(c) ? ")}" : ")"; const std::string imag_sym = is_a(c) ? "i" : "I"; const std::string mul_sym = is_a(c) ? " " : "*"; const cln::cl_R r = cln::realpart(cln::the(value)); const cln::cl_R i = cln::imagpart(cln::the(value)); + + if (is_a(c)) + c.s << class_name() << "('"; if (cln::zerop(i)) { // case 1, real: x or -x if ((precedence() <= level) && (!this->is_nonneg_integer())) { c.s << par_open; - print_real_number(c.s, r); + print_real_number(c, r); c.s << par_close; } else { - print_real_number(c.s, r); + print_real_number(c, r); } } else { if (cln::zerop(r)) { // case 2, imaginary: y*I or -y*I - if ((precedence() <= level) && (i < 0)) { - if (i == -1) { - c.s << par_open+imag_sym+par_close; - } else { + if (i==1) + c.s << imag_sym; + else { + if (precedence()<=level) c.s << par_open; - print_real_number(c.s, i); - c.s << mul_sym+imag_sym+par_close; - } - } else { - if (i == 1) { - c.s << imag_sym; - } else { - if (i == -1) { - c.s << "-" << imag_sym; - } else { - print_real_number(c.s, i); - c.s << mul_sym+imag_sym; - } + if (i == -1) + c.s << "-" << imag_sym; + else { + print_real_number(c, i); + c.s << mul_sym+imag_sym; } + if (precedence()<=level) + c.s << par_close; } } else { // case 3, complex: x+y*I or x-y*I or -x+y*I or -x-y*I if (precedence() <= level) c.s << par_open; - print_real_number(c.s, r); + print_real_number(c, r); if (i < 0) { if (i == -1) { c.s << "-"+imag_sym; } else { - print_real_number(c.s, i); + print_real_number(c, i); c.s << mul_sym+imag_sym; } } else { @@ -464,7 +531,7 @@ void numeric::print(const print_context & c, unsigned level) const c.s << "+"+imag_sym; } else { c.s << "+"; - print_real_number(c.s, i); + print_real_number(c, i); c.s << mul_sym+imag_sym; } } @@ -472,6 +539,8 @@ void numeric::print(const print_context & c, unsigned level) const c.s << par_close; } } + if (is_a(c)) + c.s << "')"; } } @@ -520,6 +589,21 @@ bool numeric::info(unsigned inf) const return false; } +int numeric::degree(const ex & s) const +{ + return 0; +} + +int numeric::ldegree(const ex & s) const +{ + return 0; +} + +ex numeric::coeff(const ex & s, int n) const +{ + return n==0 ? *this : _ex0; +} + /** Disassemble real part and imaginary part to scan for the occurrence of a * single number. Also handles the imaginary unit. It ignores the sign on * both this and the argument, which may lead to what might appear as funny @@ -528,9 +612,9 @@ bool numeric::info(unsigned inf) const * sign as a multiplicative factor. */ bool numeric::has(const ex &other) const { - if (!is_exactly_of_type(*other.bp, numeric)) + if (!is_exactly_a(other)) return false; - const numeric &o = static_cast(*other.bp); + const numeric &o = ex_to(other); if (this->is_equal(o) || this->is_equal(-o)) return true; if (o.imag().is_zero()) // e.g. scan for 3 in -3*I @@ -574,7 +658,7 @@ ex numeric::evalf(int level) const int numeric::compare_same_type(const basic &other) const { - GINAC_ASSERT(is_exactly_of_type(other, numeric)); + GINAC_ASSERT(is_exactly_a(other)); const numeric &o = static_cast(other); return this->compare(o); @@ -583,20 +667,22 @@ int numeric::compare_same_type(const basic &other) const bool numeric::is_equal_same_type(const basic &other) const { - GINAC_ASSERT(is_exactly_of_type(other,numeric)); + GINAC_ASSERT(is_exactly_a(other)); const numeric &o = static_cast(other); return this->is_equal(o); } -unsigned numeric::calchash(void) const +unsigned numeric::calchash() const { - // Use CLN's hashcode. Warning: It depends only on the number's value, not - // its type or precision (i.e. a true equivalence relation on numbers). As - // a consequence, 3 and 3.0 share the same hashvalue. + // Base computation of hashvalue on CLN's hashcode. Note: That depends + // only on the number's value, not its type or precision (i.e. a true + // equivalence relation on numbers). As a consequence, 3 and 3.0 share + // the same hashvalue. That shouldn't really matter, though. setflag(status_flags::hash_calculated); - return (hashvalue = cln::equal_hashcode(cln::the(value)) | 0x80000000U); + hashvalue = golden_ratio_hash(cln::equal_hashcode(cln::the(value))); + return hashvalue; } @@ -616,13 +702,6 @@ unsigned numeric::calchash(void) const * a numeric object. */ const numeric numeric::add(const numeric &other) const { - // Efficiency shortcut: trap the neutral element by pointer. - static const numeric * _num0p = &_num0(); - if (this==_num0p) - return other; - else if (&other==_num0p) - return *this; - return numeric(cln::the(value)+cln::the(other.value)); } @@ -639,13 +718,6 @@ const numeric numeric::sub(const numeric &other) const * result as a numeric object. */ const numeric numeric::mul(const numeric &other) const { - // Efficiency shortcut: trap the neutral element by pointer. - static const numeric * _num1p = &_num1(); - if (this==_num1p) - return other; - else if (&other==_num1p) - return *this; - return numeric(cln::the(value)*cln::the(other.value)); } @@ -666,9 +738,9 @@ const numeric numeric::div(const numeric &other) const * returns result as a numeric object. */ const numeric numeric::power(const numeric &other) const { - // Efficiency shortcut: trap the neutral exponent by pointer. - static const numeric * _num1p = &_num1(); - if (&other==_num1p) + // Shortcut for efficiency and numeric stability (as in 1.0 exponent): + // trap the neutral exponent. + if (&other==_num1_p || cln::equal(cln::the(other.value),cln::the(_num1.value))) return *this; if (cln::zerop(cln::the(value))) { @@ -679,61 +751,93 @@ const numeric numeric::power(const numeric &other) const else if (cln::minusp(cln::realpart(cln::the(other.value)))) throw std::overflow_error("numeric::eval(): division by zero"); else - return _num0(); + return _num0; } return numeric(cln::expt(cln::the(value),cln::the(other.value))); } + +/** Numerical addition method. Adds argument to *this and returns result as + * a numeric object on the heap. Use internally only for direct wrapping into + * an ex object, where the result would end up on the heap anyways. */ const numeric &numeric::add_dyn(const numeric &other) const { - // Efficiency shortcut: trap the neutral element by pointer. - static const numeric * _num0p = &_num0(); - if (this==_num0p) + // Efficiency shortcut: trap the neutral element by pointer. This hack + // is supposed to keep the number of distinct numeric objects low. + if (this==_num0_p) return other; - else if (&other==_num0p) + else if (&other==_num0_p) return *this; return static_cast((new numeric(cln::the(value)+cln::the(other.value)))-> - setflag(status_flags::dynallocated)); + setflag(status_flags::dynallocated)); } +/** Numerical subtraction method. Subtracts argument from *this and returns + * result as a numeric object on the heap. Use internally only for direct + * wrapping into an ex object, where the result would end up on the heap + * anyways. */ const numeric &numeric::sub_dyn(const numeric &other) const { + // Efficiency shortcut: trap the neutral exponent (first by pointer). This + // hack is supposed to keep the number of distinct numeric objects low. + if (&other==_num0_p || cln::zerop(cln::the(other.value))) + return *this; + return static_cast((new numeric(cln::the(value)-cln::the(other.value)))-> - setflag(status_flags::dynallocated)); + setflag(status_flags::dynallocated)); } +/** Numerical multiplication method. Multiplies *this and argument and returns + * result as a numeric object on the heap. Use internally only for direct + * wrapping into an ex object, where the result would end up on the heap + * anyways. */ const numeric &numeric::mul_dyn(const numeric &other) const { - // Efficiency shortcut: trap the neutral element by pointer. - static const numeric * _num1p = &_num1(); - if (this==_num1p) + // Efficiency shortcut: trap the neutral element by pointer. This hack + // is supposed to keep the number of distinct numeric objects low. + if (this==_num1_p) return other; - else if (&other==_num1p) + else if (&other==_num1_p) return *this; return static_cast((new numeric(cln::the(value)*cln::the(other.value)))-> - setflag(status_flags::dynallocated)); + setflag(status_flags::dynallocated)); } +/** Numerical division method. Divides *this by argument and returns result as + * a numeric object on the heap. Use internally only for direct wrapping + * into an ex object, where the result would end up on the heap + * anyways. + * + * @exception overflow_error (division by zero) */ const numeric &numeric::div_dyn(const numeric &other) const { + // Efficiency shortcut: trap the neutral element by pointer. This hack + // is supposed to keep the number of distinct numeric objects low. + if (&other==_num1_p) + return *this; if (cln::zerop(cln::the(other.value))) throw std::overflow_error("division by zero"); return static_cast((new numeric(cln::the(value)/cln::the(other.value)))-> - setflag(status_flags::dynallocated)); + setflag(status_flags::dynallocated)); } +/** Numerical exponentiation. Raises *this to the power given as argument and + * returns result as a numeric object on the heap. Use internally only for + * direct wrapping into an ex object, where the result would end up on the + * heap anyways. */ const numeric &numeric::power_dyn(const numeric &other) const { - // Efficiency shortcut: trap the neutral exponent by pointer. - static const numeric * _num1p=&_num1(); - if (&other==_num1p) + // Efficiency shortcut: trap the neutral exponent (first try by pointer, then + // try harder, since calls to cln::expt() below may return amazing results for + // floating point exponent 1.0). + if (&other==_num1_p || cln::equal(cln::the(other.value),cln::the(_num1.value))) return *this; if (cln::zerop(cln::the(value))) { @@ -744,7 +848,7 @@ const numeric &numeric::power_dyn(const numeric &other) const else if (cln::minusp(cln::realpart(cln::the(other.value)))) throw std::overflow_error("numeric::eval(): division by zero"); else - return _num0(); + return _num0; } return static_cast((new numeric(cln::expt(cln::the(value),cln::the(other.value))))-> setflag(status_flags::dynallocated)); @@ -788,7 +892,7 @@ const numeric &numeric::operator=(const char * s) /** Inverse of a number. */ -const numeric numeric::inverse(void) const +const numeric numeric::inverse() const { if (cln::zerop(cln::the(value))) throw std::overflow_error("numeric::inverse(): division by zero"); @@ -801,7 +905,7 @@ const numeric numeric::inverse(void) const * csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0. * * @see numeric::compare(const numeric &other) */ -int numeric::csgn(void) const +int numeric::csgn() const { if (cln::zerop(cln::the(value))) return 0; @@ -826,7 +930,7 @@ int numeric::csgn(void) const * to be compatible with our method csgn. * * @return csgn(*this-other) - * @see numeric::csgn(void) */ + * @see numeric::csgn() */ int numeric::compare(const numeric &other) const { // Comparing two real numbers? @@ -852,84 +956,86 @@ bool numeric::is_equal(const numeric &other) const /** True if object is zero. */ -bool numeric::is_zero(void) const +bool numeric::is_zero() const { return cln::zerop(cln::the(value)); } /** True if object is not complex and greater than zero. */ -bool numeric::is_positive(void) const +bool numeric::is_positive() const { - if (this->is_real()) + if (cln::instanceof(value, cln::cl_R_ring)) // real? return cln::plusp(cln::the(value)); return false; } /** True if object is not complex and less than zero. */ -bool numeric::is_negative(void) const +bool numeric::is_negative() const { - if (this->is_real()) + if (cln::instanceof(value, cln::cl_R_ring)) // real? return cln::minusp(cln::the(value)); return false; } /** True if object is a non-complex integer. */ -bool numeric::is_integer(void) const +bool numeric::is_integer() const { return cln::instanceof(value, cln::cl_I_ring); } /** True if object is an exact integer greater than zero. */ -bool numeric::is_pos_integer(void) const +bool numeric::is_pos_integer() const { - return (this->is_integer() && cln::plusp(cln::the(value))); + return (cln::instanceof(value, cln::cl_I_ring) && cln::plusp(cln::the(value))); } /** True if object is an exact integer greater or equal zero. */ -bool numeric::is_nonneg_integer(void) const +bool numeric::is_nonneg_integer() const { - return (this->is_integer() && !cln::minusp(cln::the(value))); + return (cln::instanceof(value, cln::cl_I_ring) && !cln::minusp(cln::the(value))); } /** True if object is an exact even integer. */ -bool numeric::is_even(void) const +bool numeric::is_even() const { - return (this->is_integer() && cln::evenp(cln::the(value))); + return (cln::instanceof(value, cln::cl_I_ring) && cln::evenp(cln::the(value))); } /** True if object is an exact odd integer. */ -bool numeric::is_odd(void) const +bool numeric::is_odd() const { - return (this->is_integer() && cln::oddp(cln::the(value))); + return (cln::instanceof(value, cln::cl_I_ring) && cln::oddp(cln::the(value))); } /** Probabilistic primality test. * * @return true if object is exact integer and prime. */ -bool numeric::is_prime(void) const +bool numeric::is_prime() const { - return (this->is_integer() && cln::isprobprime(cln::the(value))); + return (cln::instanceof(value, cln::cl_I_ring) // integer? + && cln::plusp(cln::the(value)) // positive? + && cln::isprobprime(cln::the(value))); } /** True if object is an exact rational number, may even be complex * (denominator may be unity). */ -bool numeric::is_rational(void) const +bool numeric::is_rational() const { return cln::instanceof(value, cln::cl_RA_ring); } /** True if object is a real integer, rational or float (but not complex). */ -bool numeric::is_real(void) const +bool numeric::is_real() const { return cln::instanceof(value, cln::cl_R_ring); } @@ -949,7 +1055,7 @@ bool numeric::operator!=(const numeric &other) const /** True if object is element of the domain of integers extended by I, i.e. is * of the form a+b*I, where a and b are integers. */ -bool numeric::is_cinteger(void) const +bool numeric::is_cinteger() const { if (cln::instanceof(value, cln::cl_I_ring)) return true; @@ -964,7 +1070,7 @@ bool numeric::is_cinteger(void) const /** True if object is an exact rational number, may even be complex * (denominator may be unity). */ -bool numeric::is_crational(void) const +bool numeric::is_crational() const { if (cln::instanceof(value, cln::cl_RA_ring)) return true; @@ -1024,7 +1130,7 @@ bool numeric::operator>=(const numeric &other) const /** Converts numeric types to machine's int. You should check with * is_integer() if the number is really an integer before calling this method. * You may also consider checking the range first. */ -int numeric::to_int(void) const +int numeric::to_int() const { GINAC_ASSERT(this->is_integer()); return cln::cl_I_to_int(cln::the(value)); @@ -1034,7 +1140,7 @@ int numeric::to_int(void) const /** Converts numeric types to machine's long. You should check with * is_integer() if the number is really an integer before calling this method. * You may also consider checking the range first. */ -long numeric::to_long(void) const +long numeric::to_long() const { GINAC_ASSERT(this->is_integer()); return cln::cl_I_to_long(cln::the(value)); @@ -1043,7 +1149,7 @@ long numeric::to_long(void) const /** Converts numeric types to machine's double. You should check with is_real() * if the number is really not complex before calling this method. */ -double numeric::to_double(void) const +double numeric::to_double() const { GINAC_ASSERT(this->is_real()); return cln::double_approx(cln::realpart(cln::the(value))); @@ -1053,21 +1159,21 @@ double numeric::to_double(void) const /** Returns a new CLN object of type cl_N, representing the value of *this. * This method may be used when mixing GiNaC and CLN in one project. */ -cln::cl_N numeric::to_cl_N(void) const +cln::cl_N numeric::to_cl_N() const { return cln::cl_N(cln::the(value)); } /** Real part of a number. */ -const numeric numeric::real(void) const +const numeric numeric::real() const { return numeric(cln::realpart(cln::the(value))); } /** Imaginary part of a number. */ -const numeric numeric::imag(void) const +const numeric numeric::imag() const { return numeric(cln::imagpart(cln::the(value))); } @@ -1077,10 +1183,10 @@ const numeric numeric::imag(void) const * numerator of complex if real and imaginary part are both rational numbers * (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other * cases. */ -const numeric numeric::numer(void) const +const numeric numeric::numer() const { - if (this->is_integer()) - return numeric(*this); + if (cln::instanceof(value, cln::cl_I_ring)) + return numeric(*this); // integer case else if (cln::instanceof(value, cln::cl_RA_ring)) return numeric(cln::numerator(cln::the(value))); @@ -1108,10 +1214,10 @@ const numeric numeric::numer(void) const /** Denominator. Computes the denominator of rational numbers, common integer * denominator of complex if real and imaginary part are both rational numbers * (i.e denom(4/3+5/6*I) == 6), one in all other cases. */ -const numeric numeric::denom(void) const +const numeric numeric::denom() const { - if (this->is_integer()) - return _num1(); + if (cln::instanceof(value, cln::cl_I_ring)) + return _num1; // integer case if (cln::instanceof(value, cln::cl_RA_ring)) return numeric(cln::denominator(cln::the(value))); @@ -1120,7 +1226,7 @@ const numeric numeric::denom(void) const const cln::cl_RA r = cln::the(cln::realpart(cln::the(value))); const cln::cl_RA i = cln::the(cln::imagpart(cln::the(value))); if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring)) - return _num1(); + return _num1; if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring)) return numeric(cln::denominator(i)); if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring)) @@ -1129,7 +1235,7 @@ const numeric numeric::denom(void) const return numeric(cln::lcm(cln::denominator(r), cln::denominator(i))); } // at least one float encountered - return _num1(); + return _num1; } @@ -1139,9 +1245,9 @@ const numeric numeric::denom(void) const * * @return number of bits (excluding sign) needed to represent that number * in two's complement if it is an integer, 0 otherwise. */ -int numeric::int_length(void) const +int numeric::int_length() const { - if (this->is_integer()) + if (cln::instanceof(value, cln::cl_I_ring)) return cln::integer_length(cln::the(value)); else return 0; @@ -1233,7 +1339,7 @@ const numeric atan(const numeric &x) { if (!x.is_real() && x.real().is_zero() && - abs(x.imag()).is_equal(_num1())) + abs(x.imag()).is_equal(_num1)) throw pole_error("atan(): logarithmic pole",0); return cln::atan(x.to_cl_N()); } @@ -1384,7 +1490,7 @@ static cln::cl_N Li2_projection(const cln::cl_N &x, const numeric Li2(const numeric &x) { if (x.is_zero()) - return _num0(); + return _num0; // what is the desired float format? // first guess: default format @@ -1423,10 +1529,7 @@ const numeric zeta(const numeric &x) if (cln::zerop(x.to_cl_N()-aux)) return cln::zeta(aux); } - std::clog << "zeta(" << x - << "): Does anybody know a good way to calculate this numerically?" - << std::endl; - return numeric(0); + throw dunno(); } @@ -1434,17 +1537,11 @@ const numeric zeta(const numeric &x) * This is only a stub! */ const numeric lgamma(const numeric &x) { - std::clog << "lgamma(" << x - << "): Does anybody know a good way to calculate this numerically?" - << std::endl; - return numeric(0); + throw dunno(); } const numeric tgamma(const numeric &x) { - std::clog << "tgamma(" << x - << "): Does anybody know a good way to calculate this numerically?" - << std::endl; - return numeric(0); + throw dunno(); } @@ -1452,10 +1549,7 @@ const numeric tgamma(const numeric &x) * This is only a stub! */ const numeric psi(const numeric &x) { - std::clog << "psi(" << x - << "): Does anybody know a good way to calculate this numerically?" - << std::endl; - return numeric(0); + throw dunno(); } @@ -1463,10 +1557,7 @@ const numeric psi(const numeric &x) * This is only a stub! */ const numeric psi(const numeric &n, const numeric &x) { - std::clog << "psi(" << n << "," << x - << "): Does anybody know a good way to calculate this numerically?" - << std::endl; - return numeric(0); + throw dunno(); } @@ -1490,8 +1581,8 @@ const numeric factorial(const numeric &n) * @exception range_error (argument must be integer >= -1) */ const numeric doublefactorial(const numeric &n) { - if (n.is_equal(_num_1())) - return _num1(); + if (n.is_equal(_num_1)) + return _num1; if (!n.is_nonneg_integer()) throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1"); @@ -1508,12 +1599,12 @@ const numeric binomial(const numeric &n, const numeric &k) { if (n.is_integer() && k.is_integer()) { if (n.is_nonneg_integer()) { - if (k.compare(n)!=1 && k.compare(_num0())!=-1) + if (k.compare(n)!=1 && k.compare(_num0)!=-1) return numeric(cln::binomial(n.to_int(),k.to_int())); else - return _num0(); + return _num0; } else { - return _num_1().power(k)*binomial(k-n-_num1(),k); + return _num_1.power(k)*binomial(k-n-_num1,k); } } @@ -1531,7 +1622,7 @@ const numeric bernoulli(const numeric &nn) { if (!nn.is_integer() || nn.is_negative()) throw std::range_error("numeric::bernoulli(): argument must be integer >= 0"); - + // Method: // // The Bernoulli numbers are rational numbers that may be computed using @@ -1555,46 +1646,61 @@ const numeric bernoulli(const numeric &nn) // But if somebody works with the n'th Bernoulli number she is likely to // also need all previous Bernoulli numbers. So we need a complete remember // table and above divide and conquer algorithm is not suited to build one - // up. The code below is adapted from Pari's function bernvec(). + // up. The formula below accomplishes this. It is a modification of the + // defining formula above but the computation of the binomial coefficients + // is carried along in an inline fashion. It also honors the fact that + // B_n is zero when n is odd and greater than 1. // // (There is an interesting relation with the tangent polynomials described - // in `Concrete Mathematics', which leads to a program twice as fast as our - // implementation below, but it requires storing one such polynomial in + // in `Concrete Mathematics', which leads to a program a little faster as + // our implementation below, but it requires storing one such polynomial in // addition to the remember table. This doubles the memory footprint so // we don't use it.) - + + const unsigned n = nn.to_int(); + // the special cases not covered by the algorithm below - if (nn.is_equal(_num1())) - return _num_1_2(); - if (nn.is_odd()) - return _num0(); - + if (n & 1) + return (n==1) ? _num_1_2 : _num0; + if (!n) + return _num1; + // store nonvanishing Bernoulli numbers here static std::vector< cln::cl_RA > results; - static int highest_result = 0; - // algorithm not applicable to B(0), so just store it - if (results.empty()) - results.push_back(cln::cl_RA(1)); - - int n = nn.to_long(); - for (int i=highest_result; i0; --j) { - B = cln::cl_I(n*m) * (B+results[j]) / (d1*d2); - n += 4; - m += 2; - d1 -= 1; - d2 -= 2; - } - B = (1 - ((B+1)/(2*i+3))) / (cln::cl_I(1)<<(2*i+2)); - results.push_back(B); - ++highest_result; + static unsigned next_r = 0; + + // algorithm not applicable to B(2), so just store it + if (!next_r) { + results.push_back(cln::recip(cln::cl_RA(6))); + next_r = 4; } - return results[n/2]; + if (n) + if (p < (1UL<(a.to_cl_N()), cln::the(b.to_cl_N())); else - return _num0(); + return _num0; } @@ -1692,7 +1798,7 @@ const numeric smod(const numeric &a, const numeric &b) return cln::mod(cln::the(a.to_cl_N()) + b2, cln::the(b.to_cl_N())) - b2; } else - return _num0(); + return _num0; } @@ -1701,34 +1807,40 @@ const numeric smod(const numeric &a, const numeric &b) * In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the * sign of a or is zero. * - * @return remainder of a/b if both are integer, 0 otherwise. */ + * @return remainder of a/b if both are integer, 0 otherwise. + * @exception overflow_error (division by zero) if b is zero. */ const numeric irem(const numeric &a, const numeric &b) { + if (b.is_zero()) + throw std::overflow_error("numeric::irem(): division by zero"); if (a.is_integer() && b.is_integer()) return cln::rem(cln::the(a.to_cl_N()), cln::the(b.to_cl_N())); else - return _num0(); + return _num0; } /** Numeric integer remainder. * Equivalent to Maple's irem(a,b,'q') it obeyes the relation * irem(a,b,q) == a - q*b. In general, mod(a,b) has the sign of b or is zero, - * and irem(a,b) has the sign of a or is zero. + * and irem(a,b) has the sign of a or is zero. * * @return remainder of a/b and quotient stored in q if both are integer, - * 0 otherwise. */ + * 0 otherwise. + * @exception overflow_error (division by zero) if b is zero. */ const numeric irem(const numeric &a, const numeric &b, numeric &q) { + if (b.is_zero()) + throw std::overflow_error("numeric::irem(): division by zero"); if (a.is_integer() && b.is_integer()) { const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the(a.to_cl_N()), cln::the(b.to_cl_N())); q = rem_quo.quotient; return rem_quo.remainder; } else { - q = _num0(); - return _num0(); + q = _num0; + return _num0; } } @@ -1736,14 +1848,17 @@ const numeric irem(const numeric &a, const numeric &b, numeric &q) /** Numeric integer quotient. * Equivalent to Maple's iquo as far as sign conventions are concerned. * - * @return truncated quotient of a/b if both are integer, 0 otherwise. */ + * @return truncated quotient of a/b if both are integer, 0 otherwise. + * @exception overflow_error (division by zero) if b is zero. */ const numeric iquo(const numeric &a, const numeric &b) { + if (b.is_zero()) + throw std::overflow_error("numeric::iquo(): division by zero"); if (a.is_integer() && b.is_integer()) return cln::truncate1(cln::the(a.to_cl_N()), cln::the(b.to_cl_N())); else - return _num0(); + return _num0; } @@ -1752,17 +1867,20 @@ const numeric iquo(const numeric &a, const numeric &b) * r == a - iquo(a,b,r)*b. * * @return truncated quotient of a/b and remainder stored in r if both are - * integer, 0 otherwise. */ + * integer, 0 otherwise. + * @exception overflow_error (division by zero) if b is zero. */ const numeric iquo(const numeric &a, const numeric &b, numeric &r) { + if (b.is_zero()) + throw std::overflow_error("numeric::iquo(): division by zero"); if (a.is_integer() && b.is_integer()) { const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the(a.to_cl_N()), cln::the(b.to_cl_N())); r = rem_quo.remainder; return rem_quo.quotient; } else { - r = _num0(); - return _num0(); + r = _num0; + return _num0; } } @@ -1777,7 +1895,7 @@ const numeric gcd(const numeric &a, const numeric &b) return cln::gcd(cln::the(a.to_cl_N()), cln::the(b.to_cl_N())); else - return _num1(); + return _num1; } @@ -1817,26 +1935,26 @@ const numeric isqrt(const numeric &x) cln::isqrt(cln::the(x.to_cl_N()), &root); return root; } else - return _num0(); + return _num0; } /** Floating point evaluation of Archimedes' constant Pi. */ -ex PiEvalf(void) +ex PiEvalf() { return numeric(cln::pi(cln::default_float_format)); } /** Floating point evaluation of Euler's constant gamma. */ -ex EulerEvalf(void) +ex EulerEvalf() { return numeric(cln::eulerconst(cln::default_float_format)); } /** Floating point evaluation of Catalan's constant. */ -ex CatalanEvalf(void) +ex CatalanEvalf() { return numeric(cln::catalanconst(cln::default_float_format)); } @@ -1876,7 +1994,6 @@ _numeric_digits::operator long() /** Append global Digits object to ostream. */ void _numeric_digits::print(std::ostream &os) const { - debugmsg("_numeric_digits print", LOGLEVEL_PRINT); os << digits; }