3 * This file contains the interface to the underlying bignum package.
4 * Its most important design principle is to completely hide the inner
5 * working of that other package from the user of GiNaC. It must either
6 * provide implementation of arithmetic operators and numerical evaluation
7 * of special functions or implement the interface to the bignum package. */
10 * GiNaC Copyright (C) 1999-2006 Johannes Gutenberg University Mainz, Germany
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
37 #include "operators.h"
42 // CLN should pollute the global namespace as little as possible. Hence, we
43 // include most of it here and include only the part needed for properly
44 // declaring cln::cl_number in numeric.h. This can only be safely done in
45 // namespaced versions of CLN, i.e. version > 1.1.0. Also, we only need a
46 // subset of CLN, so we don't include the complete <cln/cln.h> but only the
48 #include <cln/output.h>
49 #include <cln/integer_io.h>
50 #include <cln/integer_ring.h>
51 #include <cln/rational_io.h>
52 #include <cln/rational_ring.h>
53 #include <cln/lfloat_class.h>
54 #include <cln/lfloat_io.h>
55 #include <cln/real_io.h>
56 #include <cln/real_ring.h>
57 #include <cln/complex_io.h>
58 #include <cln/complex_ring.h>
59 #include <cln/numtheory.h>
63 GINAC_IMPLEMENT_REGISTERED_CLASS_OPT(numeric, basic,
64 print_func<print_context>(&numeric::do_print).
65 print_func<print_latex>(&numeric::do_print_latex).
66 print_func<print_csrc>(&numeric::do_print_csrc).
67 print_func<print_csrc_cl_N>(&numeric::do_print_csrc_cl_N).
68 print_func<print_tree>(&numeric::do_print_tree).
69 print_func<print_python_repr>(&numeric::do_print_python_repr))
72 // default constructor
75 /** default ctor. Numerically it initializes to an integer zero. */
76 numeric::numeric() : basic(&numeric::tinfo_static)
79 setflag(status_flags::evaluated | status_flags::expanded);
88 numeric::numeric(int i) : basic(&numeric::tinfo_static)
90 // Not the whole int-range is available if we don't cast to long
91 // first. This is due to the behaviour of the cl_I-ctor, which
92 // emphasizes efficiency. However, if the integer is small enough
93 // we save space and dereferences by using an immediate type.
94 // (C.f. <cln/object.h>)
95 if (i < (1L << (cl_value_len-1)) && i >= -(1L << (cl_value_len-1)))
98 value = cln::cl_I(static_cast<long>(i));
99 setflag(status_flags::evaluated | status_flags::expanded);
103 numeric::numeric(unsigned int i) : basic(&numeric::tinfo_static)
105 // Not the whole uint-range is available if we don't cast to ulong
106 // first. This is due to the behaviour of the cl_I-ctor, which
107 // emphasizes efficiency. However, if the integer is small enough
108 // we save space and dereferences by using an immediate type.
109 // (C.f. <cln/object.h>)
110 if (i < (1UL << (cl_value_len-1)))
111 value = cln::cl_I(i);
113 value = cln::cl_I(static_cast<unsigned long>(i));
114 setflag(status_flags::evaluated | status_flags::expanded);
118 numeric::numeric(long i) : basic(&numeric::tinfo_static)
120 value = cln::cl_I(i);
121 setflag(status_flags::evaluated | status_flags::expanded);
125 numeric::numeric(unsigned long i) : basic(&numeric::tinfo_static)
127 value = cln::cl_I(i);
128 setflag(status_flags::evaluated | status_flags::expanded);
132 /** Constructor for rational numerics a/b.
134 * @exception overflow_error (division by zero) */
135 numeric::numeric(long numer, long denom) : basic(&numeric::tinfo_static)
138 throw std::overflow_error("division by zero");
139 value = cln::cl_I(numer) / cln::cl_I(denom);
140 setflag(status_flags::evaluated | status_flags::expanded);
144 numeric::numeric(double d) : basic(&numeric::tinfo_static)
146 // We really want to explicitly use the type cl_LF instead of the
147 // more general cl_F, since that would give us a cl_DF only which
148 // will not be promoted to cl_LF if overflow occurs:
149 value = cln::cl_float(d, cln::default_float_format);
150 setflag(status_flags::evaluated | status_flags::expanded);
154 /** ctor from C-style string. It also accepts complex numbers in GiNaC
155 * notation like "2+5*I". */
156 numeric::numeric(const char *s) : basic(&numeric::tinfo_static)
158 cln::cl_N ctorval = 0;
159 // parse complex numbers (functional but not completely safe, unfortunately
160 // std::string does not understand regexpese):
161 // ss should represent a simple sum like 2+5*I
163 std::string::size_type delim;
165 // make this implementation safe by adding explicit sign
166 if (ss.at(0) != '+' && ss.at(0) != '-' && ss.at(0) != '#')
169 // We use 'E' as exponent marker in the output, but some people insist on
170 // writing 'e' at input, so let's substitute them right at the beginning:
171 while ((delim = ss.find("e"))!=std::string::npos)
172 ss.replace(delim,1,"E");
176 // chop ss into terms from left to right
178 bool imaginary = false;
179 delim = ss.find_first_of(std::string("+-"),1);
180 // Do we have an exponent marker like "31.415E-1"? If so, hop on!
181 if (delim!=std::string::npos && ss.at(delim-1)=='E')
182 delim = ss.find_first_of(std::string("+-"),delim+1);
183 term = ss.substr(0,delim);
184 if (delim!=std::string::npos)
185 ss = ss.substr(delim);
186 // is the term imaginary?
187 if (term.find("I")!=std::string::npos) {
189 term.erase(term.find("I"),1);
191 if (term.find("*")!=std::string::npos)
192 term.erase(term.find("*"),1);
193 // correct for trivial +/-I without explicit factor on I:
198 if (term.find('.')!=std::string::npos || term.find('E')!=std::string::npos) {
199 // CLN's short type cl_SF is not very useful within the GiNaC
200 // framework where we are mainly interested in the arbitrary
201 // precision type cl_LF. Hence we go straight to the construction
202 // of generic floats. In order to create them we have to convert
203 // our own floating point notation used for output and construction
204 // from char * to CLN's generic notation:
205 // 3.14 --> 3.14e0_<Digits>
206 // 31.4E-1 --> 31.4e-1_<Digits>
208 // No exponent marker? Let's add a trivial one.
209 if (term.find("E")==std::string::npos)
212 term = term.replace(term.find("E"),1,"e");
213 // append _<Digits> to term
214 term += "_" + ToString((unsigned)Digits);
215 // construct float using cln::cl_F(const char *) ctor.
217 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_F(term.c_str()));
219 ctorval = ctorval + cln::cl_F(term.c_str());
221 // this is not a floating point number...
223 ctorval = ctorval + cln::complex(cln::cl_I(0),cln::cl_R(term.c_str()));
225 ctorval = ctorval + cln::cl_R(term.c_str());
227 } while (delim != std::string::npos);
229 setflag(status_flags::evaluated | status_flags::expanded);
233 /** Ctor from CLN types. This is for the initiated user or internal use
235 numeric::numeric(const cln::cl_N &z) : basic(&numeric::tinfo_static)
238 setflag(status_flags::evaluated | status_flags::expanded);
246 numeric::numeric(const archive_node &n, lst &sym_lst) : inherited(n, sym_lst)
248 cln::cl_N ctorval = 0;
250 // Read number as string
252 if (n.find_string("number", str)) {
253 std::istringstream s(str);
254 cln::cl_idecoded_float re, im;
258 case 'R': // Integer-decoded real number
259 s >> re.sign >> re.mantissa >> re.exponent;
260 ctorval = re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent);
262 case 'C': // Integer-decoded complex number
263 s >> re.sign >> re.mantissa >> re.exponent;
264 s >> im.sign >> im.mantissa >> im.exponent;
265 ctorval = cln::complex(re.sign * re.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), re.exponent),
266 im.sign * im.mantissa * cln::expt(cln::cl_float(2.0, cln::default_float_format), im.exponent));
268 default: // Ordinary number
275 setflag(status_flags::evaluated | status_flags::expanded);
278 void numeric::archive(archive_node &n) const
280 inherited::archive(n);
282 // Write number as string
283 std::ostringstream s;
284 if (this->is_crational())
287 // Non-rational numbers are written in an integer-decoded format
288 // to preserve the precision
289 if (this->is_real()) {
290 cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(value));
292 s << re.sign << " " << re.mantissa << " " << re.exponent;
294 cln::cl_idecoded_float re = cln::integer_decode_float(cln::the<cln::cl_F>(cln::realpart(cln::the<cln::cl_N>(value))));
295 cln::cl_idecoded_float im = cln::integer_decode_float(cln::the<cln::cl_F>(cln::imagpart(cln::the<cln::cl_N>(value))));
297 s << re.sign << " " << re.mantissa << " " << re.exponent << " ";
298 s << im.sign << " " << im.mantissa << " " << im.exponent;
301 n.add_string("number", s.str());
304 DEFAULT_UNARCHIVE(numeric)
307 // functions overriding virtual functions from base classes
310 /** Helper function to print a real number in a nicer way than is CLN's
311 * default. Instead of printing 42.0L0 this just prints 42.0 to ostream os
312 * and instead of 3.99168L7 it prints 3.99168E7. This is fine in GiNaC as
313 * long as it only uses cl_LF and no other floating point types that we might
314 * want to visibly distinguish from cl_LF.
316 * @see numeric::print() */
317 static void print_real_number(const print_context & c, const cln::cl_R & x)
319 cln::cl_print_flags ourflags;
320 if (cln::instanceof(x, cln::cl_RA_ring)) {
321 // case 1: integer or rational
322 if (cln::instanceof(x, cln::cl_I_ring) ||
323 !is_a<print_latex>(c)) {
324 cln::print_real(c.s, ourflags, x);
325 } else { // rational output in LaTeX context
329 cln::print_real(c.s, ourflags, cln::abs(cln::numerator(cln::the<cln::cl_RA>(x))));
331 cln::print_real(c.s, ourflags, cln::denominator(cln::the<cln::cl_RA>(x)));
336 // make CLN believe this number has default_float_format, so it prints
337 // 'E' as exponent marker instead of 'L':
338 ourflags.default_float_format = cln::float_format(cln::the<cln::cl_F>(x));
339 cln::print_real(c.s, ourflags, x);
343 /** Helper function to print integer number in C++ source format.
345 * @see numeric::print() */
346 static void print_integer_csrc(const print_context & c, const cln::cl_I & x)
348 // Print small numbers in compact float format, but larger numbers in
350 const int max_cln_int = 536870911; // 2^29-1
351 if (x >= cln::cl_I(-max_cln_int) && x <= cln::cl_I(max_cln_int))
352 c.s << cln::cl_I_to_int(x) << ".0";
354 c.s << cln::double_approx(x);
357 /** Helper function to print real number in C++ source format.
359 * @see numeric::print() */
360 static void print_real_csrc(const print_context & c, const cln::cl_R & x)
362 if (cln::instanceof(x, cln::cl_I_ring)) {
365 print_integer_csrc(c, cln::the<cln::cl_I>(x));
367 } else if (cln::instanceof(x, cln::cl_RA_ring)) {
370 const cln::cl_I numer = cln::numerator(cln::the<cln::cl_RA>(x));
371 const cln::cl_I denom = cln::denominator(cln::the<cln::cl_RA>(x));
372 if (cln::plusp(x) > 0) {
374 print_integer_csrc(c, numer);
377 print_integer_csrc(c, -numer);
380 print_integer_csrc(c, denom);
386 c.s << cln::double_approx(x);
390 /** Helper function to print real number in C++ source format using cl_N types.
392 * @see numeric::print() */
393 static void print_real_cl_N(const print_context & c, const cln::cl_R & x)
395 if (cln::instanceof(x, cln::cl_I_ring)) {
398 c.s << "cln::cl_I(\"";
399 print_real_number(c, x);
402 } else if (cln::instanceof(x, cln::cl_RA_ring)) {
405 cln::cl_print_flags ourflags;
406 c.s << "cln::cl_RA(\"";
407 cln::print_rational(c.s, ourflags, cln::the<cln::cl_RA>(x));
413 c.s << "cln::cl_F(\"";
414 print_real_number(c, cln::cl_float(1.0, cln::default_float_format) * x);
415 c.s << "_" << Digits << "\")";
419 void numeric::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
421 const cln::cl_R r = cln::realpart(value);
422 const cln::cl_R i = cln::imagpart(value);
426 // case 1, real: x or -x
427 if ((precedence() <= level) && (!this->is_nonneg_integer())) {
429 print_real_number(c, r);
432 print_real_number(c, r);
438 // case 2, imaginary: y*I or -y*I
442 if (precedence()<=level)
445 c.s << "-" << imag_sym;
447 print_real_number(c, i);
448 c.s << mul_sym << imag_sym;
450 if (precedence()<=level)
456 // case 3, complex: x+y*I or x-y*I or -x+y*I or -x-y*I
457 if (precedence() <= level)
459 print_real_number(c, r);
462 c.s << "-" << imag_sym;
464 print_real_number(c, i);
465 c.s << mul_sym << imag_sym;
469 c.s << "+" << imag_sym;
472 print_real_number(c, i);
473 c.s << mul_sym << imag_sym;
476 if (precedence() <= level)
482 void numeric::do_print(const print_context & c, unsigned level) const
484 print_numeric(c, "(", ")", "I", "*", level);
487 void numeric::do_print_latex(const print_latex & c, unsigned level) const
489 print_numeric(c, "{(", ")}", "i", " ", level);
492 void numeric::do_print_csrc(const print_csrc & c, unsigned level) const
494 std::ios::fmtflags oldflags = c.s.flags();
495 c.s.setf(std::ios::scientific);
496 int oldprec = c.s.precision();
499 if (is_a<print_csrc_double>(c))
500 c.s.precision(std::numeric_limits<double>::digits10 + 1);
502 c.s.precision(std::numeric_limits<float>::digits10 + 1);
504 if (this->is_real()) {
507 print_real_csrc(c, cln::the<cln::cl_R>(value));
512 c.s << "std::complex<";
513 if (is_a<print_csrc_double>(c))
518 print_real_csrc(c, cln::realpart(value));
520 print_real_csrc(c, cln::imagpart(value));
525 c.s.precision(oldprec);
528 void numeric::do_print_csrc_cl_N(const print_csrc_cl_N & c, unsigned level) const
530 if (this->is_real()) {
533 print_real_cl_N(c, cln::the<cln::cl_R>(value));
538 c.s << "cln::complex(";
539 print_real_cl_N(c, cln::realpart(value));
541 print_real_cl_N(c, cln::imagpart(value));
546 void numeric::do_print_tree(const print_tree & c, unsigned level) const
548 c.s << std::string(level, ' ') << value
549 << " (" << class_name() << ")" << " @" << this
550 << std::hex << ", hash=0x" << hashvalue << ", flags=0x" << flags << std::dec
554 void numeric::do_print_python_repr(const print_python_repr & c, unsigned level) const
556 c.s << class_name() << "('";
557 print_numeric(c, "(", ")", "I", "*", level);
561 bool numeric::info(unsigned inf) const
564 case info_flags::numeric:
565 case info_flags::polynomial:
566 case info_flags::rational_function:
568 case info_flags::real:
570 case info_flags::rational:
571 case info_flags::rational_polynomial:
572 return is_rational();
573 case info_flags::crational:
574 case info_flags::crational_polynomial:
575 return is_crational();
576 case info_flags::integer:
577 case info_flags::integer_polynomial:
579 case info_flags::cinteger:
580 case info_flags::cinteger_polynomial:
581 return is_cinteger();
582 case info_flags::positive:
583 return is_positive();
584 case info_flags::negative:
585 return is_negative();
586 case info_flags::nonnegative:
587 return !is_negative();
588 case info_flags::posint:
589 return is_pos_integer();
590 case info_flags::negint:
591 return is_integer() && is_negative();
592 case info_flags::nonnegint:
593 return is_nonneg_integer();
594 case info_flags::even:
596 case info_flags::odd:
598 case info_flags::prime:
600 case info_flags::algebraic:
606 int numeric::degree(const ex & s) const
611 int numeric::ldegree(const ex & s) const
616 ex numeric::coeff(const ex & s, int n) const
618 return n==0 ? *this : _ex0;
621 /** Disassemble real part and imaginary part to scan for the occurrence of a
622 * single number. Also handles the imaginary unit. It ignores the sign on
623 * both this and the argument, which may lead to what might appear as funny
624 * results: (2+I).has(-2) -> true. But this is consistent, since we also
625 * would like to have (-2+I).has(2) -> true and we want to think about the
626 * sign as a multiplicative factor. */
627 bool numeric::has(const ex &other, unsigned options) const
629 if (!is_exactly_a<numeric>(other))
631 const numeric &o = ex_to<numeric>(other);
632 if (this->is_equal(o) || this->is_equal(-o))
634 if (o.imag().is_zero()) { // e.g. scan for 3 in -3*I
635 if (!this->real().is_equal(*_num0_p))
636 if (this->real().is_equal(o) || this->real().is_equal(-o))
638 if (!this->imag().is_equal(*_num0_p))
639 if (this->imag().is_equal(o) || this->imag().is_equal(-o))
644 if (o.is_equal(I)) // e.g scan for I in 42*I
645 return !this->is_real();
646 if (o.real().is_zero()) // e.g. scan for 2*I in 2*I+1
647 if (!this->imag().is_equal(*_num0_p))
648 if (this->imag().is_equal(o*I) || this->imag().is_equal(-o*I))
655 /** Evaluation of numbers doesn't do anything at all. */
656 ex numeric::eval(int level) const
658 // Warning: if this is ever gonna do something, the ex ctors from all kinds
659 // of numbers should be checking for status_flags::evaluated.
664 /** Cast numeric into a floating-point object. For example exact numeric(1) is
665 * returned as a 1.0000000000000000000000 and so on according to how Digits is
666 * currently set. In case the object already was a floating point number the
667 * precision is trimmed to match the currently set default.
669 * @param level ignored, only needed for overriding basic::evalf.
670 * @return an ex-handle to a numeric. */
671 ex numeric::evalf(int level) const
673 // level can safely be discarded for numeric objects.
674 return numeric(cln::cl_float(1.0, cln::default_float_format) * value);
677 ex numeric::conjugate() const
682 return numeric(cln::conjugate(this->value));
687 int numeric::compare_same_type(const basic &other) const
689 GINAC_ASSERT(is_exactly_a<numeric>(other));
690 const numeric &o = static_cast<const numeric &>(other);
692 return this->compare(o);
696 bool numeric::is_equal_same_type(const basic &other) const
698 GINAC_ASSERT(is_exactly_a<numeric>(other));
699 const numeric &o = static_cast<const numeric &>(other);
701 return this->is_equal(o);
705 unsigned numeric::calchash() const
707 // Base computation of hashvalue on CLN's hashcode. Note: That depends
708 // only on the number's value, not its type or precision (i.e. a true
709 // equivalence relation on numbers). As a consequence, 3 and 3.0 share
710 // the same hashvalue. That shouldn't really matter, though.
711 setflag(status_flags::hash_calculated);
712 hashvalue = golden_ratio_hash(cln::equal_hashcode(value));
718 // new virtual functions which can be overridden by derived classes
724 // non-virtual functions in this class
729 /** Numerical addition method. Adds argument to *this and returns result as
730 * a numeric object. */
731 const numeric numeric::add(const numeric &other) const
733 return numeric(value + other.value);
737 /** Numerical subtraction method. Subtracts argument from *this and returns
738 * result as a numeric object. */
739 const numeric numeric::sub(const numeric &other) const
741 return numeric(value - other.value);
745 /** Numerical multiplication method. Multiplies *this and argument and returns
746 * result as a numeric object. */
747 const numeric numeric::mul(const numeric &other) const
749 return numeric(value * other.value);
753 /** Numerical division method. Divides *this by argument and returns result as
756 * @exception overflow_error (division by zero) */
757 const numeric numeric::div(const numeric &other) const
759 if (cln::zerop(other.value))
760 throw std::overflow_error("numeric::div(): division by zero");
761 return numeric(value / other.value);
765 /** Numerical exponentiation. Raises *this to the power given as argument and
766 * returns result as a numeric object. */
767 const numeric numeric::power(const numeric &other) const
769 // Shortcut for efficiency and numeric stability (as in 1.0 exponent):
770 // trap the neutral exponent.
771 if (&other==_num1_p || cln::equal(other.value,_num1_p->value))
774 if (cln::zerop(value)) {
775 if (cln::zerop(other.value))
776 throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
777 else if (cln::zerop(cln::realpart(other.value)))
778 throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
779 else if (cln::minusp(cln::realpart(other.value)))
780 throw std::overflow_error("numeric::eval(): division by zero");
784 return numeric(cln::expt(value, other.value));
789 /** Numerical addition method. Adds argument to *this and returns result as
790 * a numeric object on the heap. Use internally only for direct wrapping into
791 * an ex object, where the result would end up on the heap anyways. */
792 const numeric &numeric::add_dyn(const numeric &other) const
794 // Efficiency shortcut: trap the neutral element by pointer. This hack
795 // is supposed to keep the number of distinct numeric objects low.
798 else if (&other==_num0_p)
801 return static_cast<const numeric &>((new numeric(value + other.value))->
802 setflag(status_flags::dynallocated));
806 /** Numerical subtraction method. Subtracts argument from *this and returns
807 * result as a numeric object on the heap. Use internally only for direct
808 * wrapping into an ex object, where the result would end up on the heap
810 const numeric &numeric::sub_dyn(const numeric &other) const
812 // Efficiency shortcut: trap the neutral exponent (first by pointer). This
813 // hack is supposed to keep the number of distinct numeric objects low.
814 if (&other==_num0_p || cln::zerop(other.value))
817 return static_cast<const numeric &>((new numeric(value - other.value))->
818 setflag(status_flags::dynallocated));
822 /** Numerical multiplication method. Multiplies *this and argument and returns
823 * result as a numeric object on the heap. Use internally only for direct
824 * wrapping into an ex object, where the result would end up on the heap
826 const numeric &numeric::mul_dyn(const numeric &other) const
828 // Efficiency shortcut: trap the neutral element by pointer. This hack
829 // is supposed to keep the number of distinct numeric objects low.
832 else if (&other==_num1_p)
835 return static_cast<const numeric &>((new numeric(value * other.value))->
836 setflag(status_flags::dynallocated));
840 /** Numerical division method. Divides *this by argument and returns result as
841 * a numeric object on the heap. Use internally only for direct wrapping
842 * into an ex object, where the result would end up on the heap
845 * @exception overflow_error (division by zero) */
846 const numeric &numeric::div_dyn(const numeric &other) const
848 // Efficiency shortcut: trap the neutral element by pointer. This hack
849 // is supposed to keep the number of distinct numeric objects low.
852 if (cln::zerop(cln::the<cln::cl_N>(other.value)))
853 throw std::overflow_error("division by zero");
854 return static_cast<const numeric &>((new numeric(value / other.value))->
855 setflag(status_flags::dynallocated));
859 /** Numerical exponentiation. Raises *this to the power given as argument and
860 * returns result as a numeric object on the heap. Use internally only for
861 * direct wrapping into an ex object, where the result would end up on the
863 const numeric &numeric::power_dyn(const numeric &other) const
865 // Efficiency shortcut: trap the neutral exponent (first try by pointer, then
866 // try harder, since calls to cln::expt() below may return amazing results for
867 // floating point exponent 1.0).
868 if (&other==_num1_p || cln::equal(other.value, _num1_p->value))
871 if (cln::zerop(value)) {
872 if (cln::zerop(other.value))
873 throw std::domain_error("numeric::eval(): pow(0,0) is undefined");
874 else if (cln::zerop(cln::realpart(other.value)))
875 throw std::domain_error("numeric::eval(): pow(0,I) is undefined");
876 else if (cln::minusp(cln::realpart(other.value)))
877 throw std::overflow_error("numeric::eval(): division by zero");
881 return static_cast<const numeric &>((new numeric(cln::expt(value, other.value)))->
882 setflag(status_flags::dynallocated));
886 const numeric &numeric::operator=(int i)
888 return operator=(numeric(i));
892 const numeric &numeric::operator=(unsigned int i)
894 return operator=(numeric(i));
898 const numeric &numeric::operator=(long i)
900 return operator=(numeric(i));
904 const numeric &numeric::operator=(unsigned long i)
906 return operator=(numeric(i));
910 const numeric &numeric::operator=(double d)
912 return operator=(numeric(d));
916 const numeric &numeric::operator=(const char * s)
918 return operator=(numeric(s));
922 /** Inverse of a number. */
923 const numeric numeric::inverse() const
925 if (cln::zerop(value))
926 throw std::overflow_error("numeric::inverse(): division by zero");
927 return numeric(cln::recip(value));
930 /** Return the step function of a numeric. The imaginary part of it is
931 * ignored because the step function is generally considered real but
932 * a numeric may develop a small imaginary part due to rounding errors.
934 int numeric::step() const
935 { cln::cl_R r = cln::realpart(value);
943 /** Return the complex half-plane (left or right) in which the number lies.
944 * csgn(x)==0 for x==0, csgn(x)==1 for Re(x)>0 or Re(x)=0 and Im(x)>0,
945 * csgn(x)==-1 for Re(x)<0 or Re(x)=0 and Im(x)<0.
947 * @see numeric::compare(const numeric &other) */
948 int numeric::csgn() const
950 if (cln::zerop(value))
952 cln::cl_R r = cln::realpart(value);
953 if (!cln::zerop(r)) {
959 if (cln::plusp(cln::imagpart(value)))
967 /** This method establishes a canonical order on all numbers. For complex
968 * numbers this is not possible in a mathematically consistent way but we need
969 * to establish some order and it ought to be fast. So we simply define it
970 * to be compatible with our method csgn.
972 * @return csgn(*this-other)
973 * @see numeric::csgn() */
974 int numeric::compare(const numeric &other) const
976 // Comparing two real numbers?
977 if (cln::instanceof(value, cln::cl_R_ring) &&
978 cln::instanceof(other.value, cln::cl_R_ring))
979 // Yes, so just cln::compare them
980 return cln::compare(cln::the<cln::cl_R>(value), cln::the<cln::cl_R>(other.value));
982 // No, first cln::compare real parts...
983 cl_signean real_cmp = cln::compare(cln::realpart(value), cln::realpart(other.value));
986 // ...and then the imaginary parts.
987 return cln::compare(cln::imagpart(value), cln::imagpart(other.value));
992 bool numeric::is_equal(const numeric &other) const
994 return cln::equal(value, other.value);
998 /** True if object is zero. */
999 bool numeric::is_zero() const
1001 return cln::zerop(value);
1005 /** True if object is not complex and greater than zero. */
1006 bool numeric::is_positive() const
1008 if (cln::instanceof(value, cln::cl_R_ring)) // real?
1009 return cln::plusp(cln::the<cln::cl_R>(value));
1014 /** True if object is not complex and less than zero. */
1015 bool numeric::is_negative() const
1017 if (cln::instanceof(value, cln::cl_R_ring)) // real?
1018 return cln::minusp(cln::the<cln::cl_R>(value));
1023 /** True if object is a non-complex integer. */
1024 bool numeric::is_integer() const
1026 return cln::instanceof(value, cln::cl_I_ring);
1030 /** True if object is an exact integer greater than zero. */
1031 bool numeric::is_pos_integer() const
1033 return (cln::instanceof(value, cln::cl_I_ring) && cln::plusp(cln::the<cln::cl_I>(value)));
1037 /** True if object is an exact integer greater or equal zero. */
1038 bool numeric::is_nonneg_integer() const
1040 return (cln::instanceof(value, cln::cl_I_ring) && !cln::minusp(cln::the<cln::cl_I>(value)));
1044 /** True if object is an exact even integer. */
1045 bool numeric::is_even() const
1047 return (cln::instanceof(value, cln::cl_I_ring) && cln::evenp(cln::the<cln::cl_I>(value)));
1051 /** True if object is an exact odd integer. */
1052 bool numeric::is_odd() const
1054 return (cln::instanceof(value, cln::cl_I_ring) && cln::oddp(cln::the<cln::cl_I>(value)));
1058 /** Probabilistic primality test.
1060 * @return true if object is exact integer and prime. */
1061 bool numeric::is_prime() const
1063 return (cln::instanceof(value, cln::cl_I_ring) // integer?
1064 && cln::plusp(cln::the<cln::cl_I>(value)) // positive?
1065 && cln::isprobprime(cln::the<cln::cl_I>(value)));
1069 /** True if object is an exact rational number, may even be complex
1070 * (denominator may be unity). */
1071 bool numeric::is_rational() const
1073 return cln::instanceof(value, cln::cl_RA_ring);
1077 /** True if object is a real integer, rational or float (but not complex). */
1078 bool numeric::is_real() const
1080 return cln::instanceof(value, cln::cl_R_ring);
1084 bool numeric::operator==(const numeric &other) const
1086 return cln::equal(value, other.value);
1090 bool numeric::operator!=(const numeric &other) const
1092 return !cln::equal(value, other.value);
1096 /** True if object is element of the domain of integers extended by I, i.e. is
1097 * of the form a+b*I, where a and b are integers. */
1098 bool numeric::is_cinteger() const
1100 if (cln::instanceof(value, cln::cl_I_ring))
1102 else if (!this->is_real()) { // complex case, handle n+m*I
1103 if (cln::instanceof(cln::realpart(value), cln::cl_I_ring) &&
1104 cln::instanceof(cln::imagpart(value), cln::cl_I_ring))
1111 /** True if object is an exact rational number, may even be complex
1112 * (denominator may be unity). */
1113 bool numeric::is_crational() const
1115 if (cln::instanceof(value, cln::cl_RA_ring))
1117 else if (!this->is_real()) { // complex case, handle Q(i):
1118 if (cln::instanceof(cln::realpart(value), cln::cl_RA_ring) &&
1119 cln::instanceof(cln::imagpart(value), cln::cl_RA_ring))
1126 /** Numerical comparison: less.
1128 * @exception invalid_argument (complex inequality) */
1129 bool numeric::operator<(const numeric &other) const
1131 if (this->is_real() && other.is_real())
1132 return (cln::the<cln::cl_R>(value) < cln::the<cln::cl_R>(other.value));
1133 throw std::invalid_argument("numeric::operator<(): complex inequality");
1137 /** Numerical comparison: less or equal.
1139 * @exception invalid_argument (complex inequality) */
1140 bool numeric::operator<=(const numeric &other) const
1142 if (this->is_real() && other.is_real())
1143 return (cln::the<cln::cl_R>(value) <= cln::the<cln::cl_R>(other.value));
1144 throw std::invalid_argument("numeric::operator<=(): complex inequality");
1148 /** Numerical comparison: greater.
1150 * @exception invalid_argument (complex inequality) */
1151 bool numeric::operator>(const numeric &other) const
1153 if (this->is_real() && other.is_real())
1154 return (cln::the<cln::cl_R>(value) > cln::the<cln::cl_R>(other.value));
1155 throw std::invalid_argument("numeric::operator>(): complex inequality");
1159 /** Numerical comparison: greater or equal.
1161 * @exception invalid_argument (complex inequality) */
1162 bool numeric::operator>=(const numeric &other) const
1164 if (this->is_real() && other.is_real())
1165 return (cln::the<cln::cl_R>(value) >= cln::the<cln::cl_R>(other.value));
1166 throw std::invalid_argument("numeric::operator>=(): complex inequality");
1170 /** Converts numeric types to machine's int. You should check with
1171 * is_integer() if the number is really an integer before calling this method.
1172 * You may also consider checking the range first. */
1173 int numeric::to_int() const
1175 GINAC_ASSERT(this->is_integer());
1176 return cln::cl_I_to_int(cln::the<cln::cl_I>(value));
1180 /** Converts numeric types to machine's long. You should check with
1181 * is_integer() if the number is really an integer before calling this method.
1182 * You may also consider checking the range first. */
1183 long numeric::to_long() const
1185 GINAC_ASSERT(this->is_integer());
1186 return cln::cl_I_to_long(cln::the<cln::cl_I>(value));
1190 /** Converts numeric types to machine's double. You should check with is_real()
1191 * if the number is really not complex before calling this method. */
1192 double numeric::to_double() const
1194 GINAC_ASSERT(this->is_real());
1195 return cln::double_approx(cln::realpart(value));
1199 /** Returns a new CLN object of type cl_N, representing the value of *this.
1200 * This method may be used when mixing GiNaC and CLN in one project.
1202 cln::cl_N numeric::to_cl_N() const
1208 /** Real part of a number. */
1209 const numeric numeric::real() const
1211 return numeric(cln::realpart(value));
1215 /** Imaginary part of a number. */
1216 const numeric numeric::imag() const
1218 return numeric(cln::imagpart(value));
1222 /** Numerator. Computes the numerator of rational numbers, rationalized
1223 * numerator of complex if real and imaginary part are both rational numbers
1224 * (i.e numer(4/3+5/6*I) == 8+5*I), the number carrying the sign in all other
1226 const numeric numeric::numer() const
1228 if (cln::instanceof(value, cln::cl_I_ring))
1229 return numeric(*this); // integer case
1231 else if (cln::instanceof(value, cln::cl_RA_ring))
1232 return numeric(cln::numerator(cln::the<cln::cl_RA>(value)));
1234 else if (!this->is_real()) { // complex case, handle Q(i):
1235 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(value));
1236 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(value));
1237 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1238 return numeric(*this);
1239 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1240 return numeric(cln::complex(r*cln::denominator(i), cln::numerator(i)));
1241 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1242 return numeric(cln::complex(cln::numerator(r), i*cln::denominator(r)));
1243 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring)) {
1244 const cln::cl_I s = cln::lcm(cln::denominator(r), cln::denominator(i));
1245 return numeric(cln::complex(cln::numerator(r)*(cln::exquo(s,cln::denominator(r))),
1246 cln::numerator(i)*(cln::exquo(s,cln::denominator(i)))));
1249 // at least one float encountered
1250 return numeric(*this);
1254 /** Denominator. Computes the denominator of rational numbers, common integer
1255 * denominator of complex if real and imaginary part are both rational numbers
1256 * (i.e denom(4/3+5/6*I) == 6), one in all other cases. */
1257 const numeric numeric::denom() const
1259 if (cln::instanceof(value, cln::cl_I_ring))
1260 return *_num1_p; // integer case
1262 if (cln::instanceof(value, cln::cl_RA_ring))
1263 return numeric(cln::denominator(cln::the<cln::cl_RA>(value)));
1265 if (!this->is_real()) { // complex case, handle Q(i):
1266 const cln::cl_RA r = cln::the<cln::cl_RA>(cln::realpart(value));
1267 const cln::cl_RA i = cln::the<cln::cl_RA>(cln::imagpart(value));
1268 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_I_ring))
1270 if (cln::instanceof(r, cln::cl_I_ring) && cln::instanceof(i, cln::cl_RA_ring))
1271 return numeric(cln::denominator(i));
1272 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_I_ring))
1273 return numeric(cln::denominator(r));
1274 if (cln::instanceof(r, cln::cl_RA_ring) && cln::instanceof(i, cln::cl_RA_ring))
1275 return numeric(cln::lcm(cln::denominator(r), cln::denominator(i)));
1277 // at least one float encountered
1282 /** Size in binary notation. For integers, this is the smallest n >= 0 such
1283 * that -2^n <= x < 2^n. If x > 0, this is the unique n > 0 such that
1284 * 2^(n-1) <= x < 2^n.
1286 * @return number of bits (excluding sign) needed to represent that number
1287 * in two's complement if it is an integer, 0 otherwise. */
1288 int numeric::int_length() const
1290 if (cln::instanceof(value, cln::cl_I_ring))
1291 return cln::integer_length(cln::the<cln::cl_I>(value));
1300 /** Imaginary unit. This is not a constant but a numeric since we are
1301 * natively handing complex numbers anyways, so in each expression containing
1302 * an I it is automatically eval'ed away anyhow. */
1303 const numeric I = numeric(cln::complex(cln::cl_I(0),cln::cl_I(1)));
1306 /** Exponential function.
1308 * @return arbitrary precision numerical exp(x). */
1309 const numeric exp(const numeric &x)
1311 return cln::exp(x.to_cl_N());
1315 /** Natural logarithm.
1317 * @param x complex number
1318 * @return arbitrary precision numerical log(x).
1319 * @exception pole_error("log(): logarithmic pole",0) */
1320 const numeric log(const numeric &x)
1323 throw pole_error("log(): logarithmic pole",0);
1324 return cln::log(x.to_cl_N());
1328 /** Numeric sine (trigonometric function).
1330 * @return arbitrary precision numerical sin(x). */
1331 const numeric sin(const numeric &x)
1333 return cln::sin(x.to_cl_N());
1337 /** Numeric cosine (trigonometric function).
1339 * @return arbitrary precision numerical cos(x). */
1340 const numeric cos(const numeric &x)
1342 return cln::cos(x.to_cl_N());
1346 /** Numeric tangent (trigonometric function).
1348 * @return arbitrary precision numerical tan(x). */
1349 const numeric tan(const numeric &x)
1351 return cln::tan(x.to_cl_N());
1355 /** Numeric inverse sine (trigonometric function).
1357 * @return arbitrary precision numerical asin(x). */
1358 const numeric asin(const numeric &x)
1360 return cln::asin(x.to_cl_N());
1364 /** Numeric inverse cosine (trigonometric function).
1366 * @return arbitrary precision numerical acos(x). */
1367 const numeric acos(const numeric &x)
1369 return cln::acos(x.to_cl_N());
1375 * @param x complex number
1377 * @exception pole_error("atan(): logarithmic pole",0) */
1378 const numeric atan(const numeric &x)
1381 x.real().is_zero() &&
1382 abs(x.imag()).is_equal(*_num1_p))
1383 throw pole_error("atan(): logarithmic pole",0);
1384 return cln::atan(x.to_cl_N());
1390 * @param x real number
1391 * @param y real number
1392 * @return atan(y/x) */
1393 const numeric atan(const numeric &y, const numeric &x)
1395 if (x.is_real() && y.is_real())
1396 return cln::atan(cln::the<cln::cl_R>(x.to_cl_N()),
1397 cln::the<cln::cl_R>(y.to_cl_N()));
1399 throw std::invalid_argument("atan(): complex argument");
1403 /** Numeric hyperbolic sine (trigonometric function).
1405 * @return arbitrary precision numerical sinh(x). */
1406 const numeric sinh(const numeric &x)
1408 return cln::sinh(x.to_cl_N());
1412 /** Numeric hyperbolic cosine (trigonometric function).
1414 * @return arbitrary precision numerical cosh(x). */
1415 const numeric cosh(const numeric &x)
1417 return cln::cosh(x.to_cl_N());
1421 /** Numeric hyperbolic tangent (trigonometric function).
1423 * @return arbitrary precision numerical tanh(x). */
1424 const numeric tanh(const numeric &x)
1426 return cln::tanh(x.to_cl_N());
1430 /** Numeric inverse hyperbolic sine (trigonometric function).
1432 * @return arbitrary precision numerical asinh(x). */
1433 const numeric asinh(const numeric &x)
1435 return cln::asinh(x.to_cl_N());
1439 /** Numeric inverse hyperbolic cosine (trigonometric function).
1441 * @return arbitrary precision numerical acosh(x). */
1442 const numeric acosh(const numeric &x)
1444 return cln::acosh(x.to_cl_N());
1448 /** Numeric inverse hyperbolic tangent (trigonometric function).
1450 * @return arbitrary precision numerical atanh(x). */
1451 const numeric atanh(const numeric &x)
1453 return cln::atanh(x.to_cl_N());
1457 /*static cln::cl_N Li2_series(const ::cl_N &x,
1458 const ::float_format_t &prec)
1460 // Note: argument must be in the unit circle
1461 // This is very inefficient unless we have fast floating point Bernoulli
1462 // numbers implemented!
1463 cln::cl_N c1 = -cln::log(1-x);
1465 // hard-wire the first two Bernoulli numbers
1466 cln::cl_N acc = c1 - cln::square(c1)/4;
1468 cln::cl_F pisq = cln::square(cln::cl_pi(prec)); // pi^2
1469 cln::cl_F piac = cln::cl_float(1, prec); // accumulator: pi^(2*i)
1471 c1 = cln::square(c1);
1475 aug = c2 * (*(bernoulli(numeric(2*i)).clnptr())) / cln::factorial(2*i+1);
1476 // aug = c2 * cln::cl_I(i%2 ? 1 : -1) / cln::cl_I(2*i+1) * cln::cl_zeta(2*i, prec) / piac / (cln::cl_I(1)<<(2*i-1));
1479 } while (acc != acc+aug);
1483 /** Numeric evaluation of Dilogarithm within circle of convergence (unit
1484 * circle) using a power series. */
1485 static cln::cl_N Li2_series(const cln::cl_N &x,
1486 const cln::float_format_t &prec)
1488 // Note: argument must be in the unit circle
1490 cln::cl_N num = cln::complex(cln::cl_float(1, prec), 0);
1495 den = den + i; // 1, 4, 9, 16, ...
1499 } while (acc != acc+aug);
1503 /** Folds Li2's argument inside a small rectangle to enhance convergence. */
1504 static cln::cl_N Li2_projection(const cln::cl_N &x,
1505 const cln::float_format_t &prec)
1507 const cln::cl_R re = cln::realpart(x);
1508 const cln::cl_R im = cln::imagpart(x);
1509 if (re > cln::cl_F(".5"))
1510 // zeta(2) - Li2(1-x) - log(x)*log(1-x)
1512 - Li2_series(1-x, prec)
1513 - cln::log(x)*cln::log(1-x));
1514 if ((re <= 0 && cln::abs(im) > cln::cl_F(".75")) || (re < cln::cl_F("-.5")))
1515 // -log(1-x)^2 / 2 - Li2(x/(x-1))
1516 return(- cln::square(cln::log(1-x))/2
1517 - Li2_series(x/(x-1), prec));
1518 if (re > 0 && cln::abs(im) > cln::cl_LF(".75"))
1519 // Li2(x^2)/2 - Li2(-x)
1520 return(Li2_projection(cln::square(x), prec)/2
1521 - Li2_projection(-x, prec));
1522 return Li2_series(x, prec);
1525 /** Numeric evaluation of Dilogarithm. The domain is the entire complex plane,
1526 * the branch cut lies along the positive real axis, starting at 1 and
1527 * continuous with quadrant IV.
1529 * @return arbitrary precision numerical Li2(x). */
1530 const numeric Li2(const numeric &x)
1535 // what is the desired float format?
1536 // first guess: default format
1537 cln::float_format_t prec = cln::default_float_format;
1538 const cln::cl_N value = x.to_cl_N();
1539 // second guess: the argument's format
1540 if (!x.real().is_rational())
1541 prec = cln::float_format(cln::the<cln::cl_F>(cln::realpart(value)));
1542 else if (!x.imag().is_rational())
1543 prec = cln::float_format(cln::the<cln::cl_F>(cln::imagpart(value)));
1545 if (value==1) // may cause trouble with log(1-x)
1546 return cln::zeta(2, prec);
1548 if (cln::abs(value) > 1)
1549 // -log(-x)^2 / 2 - zeta(2) - Li2(1/x)
1550 return(- cln::square(cln::log(-value))/2
1551 - cln::zeta(2, prec)
1552 - Li2_projection(cln::recip(value), prec));
1554 return Li2_projection(x.to_cl_N(), prec);
1558 /** Numeric evaluation of Riemann's Zeta function. Currently works only for
1559 * integer arguments. */
1560 const numeric zeta(const numeric &x)
1562 // A dirty hack to allow for things like zeta(3.0), since CLN currently
1563 // only knows about integer arguments and zeta(3).evalf() automatically
1564 // cascades down to zeta(3.0).evalf(). The trick is to rely on 3.0-3
1565 // being an exact zero for CLN, which can be tested and then we can just
1566 // pass the number casted to an int:
1568 const int aux = (int)(cln::double_approx(cln::the<cln::cl_R>(x.to_cl_N())));
1569 if (cln::zerop(x.to_cl_N()-aux))
1570 return cln::zeta(aux);
1576 /** The Gamma function.
1577 * This is only a stub! */
1578 const numeric lgamma(const numeric &x)
1582 const numeric tgamma(const numeric &x)
1588 /** The psi function (aka polygamma function).
1589 * This is only a stub! */
1590 const numeric psi(const numeric &x)
1596 /** The psi functions (aka polygamma functions).
1597 * This is only a stub! */
1598 const numeric psi(const numeric &n, const numeric &x)
1604 /** Factorial combinatorial function.
1606 * @param n integer argument >= 0
1607 * @exception range_error (argument must be integer >= 0) */
1608 const numeric factorial(const numeric &n)
1610 if (!n.is_nonneg_integer())
1611 throw std::range_error("numeric::factorial(): argument must be integer >= 0");
1612 return numeric(cln::factorial(n.to_int()));
1616 /** The double factorial combinatorial function. (Scarcely used, but still
1617 * useful in cases, like for exact results of tgamma(n+1/2) for instance.)
1619 * @param n integer argument >= -1
1620 * @return n!! == n * (n-2) * (n-4) * ... * ({1|2}) with 0!! == (-1)!! == 1
1621 * @exception range_error (argument must be integer >= -1) */
1622 const numeric doublefactorial(const numeric &n)
1624 if (n.is_equal(*_num_1_p))
1627 if (!n.is_nonneg_integer())
1628 throw std::range_error("numeric::doublefactorial(): argument must be integer >= -1");
1630 return numeric(cln::doublefactorial(n.to_int()));
1634 /** The Binomial coefficients. It computes the binomial coefficients. For
1635 * integer n and k and positive n this is the number of ways of choosing k
1636 * objects from n distinct objects. If n is negative, the formula
1637 * binomial(n,k) == (-1)^k*binomial(k-n-1,k) is used to compute the result. */
1638 const numeric binomial(const numeric &n, const numeric &k)
1640 if (n.is_integer() && k.is_integer()) {
1641 if (n.is_nonneg_integer()) {
1642 if (k.compare(n)!=1 && k.compare(*_num0_p)!=-1)
1643 return numeric(cln::binomial(n.to_int(),k.to_int()));
1647 return _num_1_p->power(k)*binomial(k-n-(*_num1_p),k);
1651 // should really be gamma(n+1)/gamma(k+1)/gamma(n-k+1) or a suitable limit
1652 throw std::range_error("numeric::binomial(): don't know how to evaluate that.");
1656 /** Bernoulli number. The nth Bernoulli number is the coefficient of x^n/n!
1657 * in the expansion of the function x/(e^x-1).
1659 * @return the nth Bernoulli number (a rational number).
1660 * @exception range_error (argument must be integer >= 0) */
1661 const numeric bernoulli(const numeric &nn)
1663 if (!nn.is_integer() || nn.is_negative())
1664 throw std::range_error("numeric::bernoulli(): argument must be integer >= 0");
1668 // The Bernoulli numbers are rational numbers that may be computed using
1671 // B_n = - 1/(n+1) * sum_{k=0}^{n-1}(binomial(n+1,k)*B_k)
1673 // with B(0) = 1. Since the n'th Bernoulli number depends on all the
1674 // previous ones, the computation is necessarily very expensive. There are
1675 // several other ways of computing them, a particularly good one being
1679 // for (unsigned i=0; i<n; i++) {
1680 // c = exquo(c*(i-n),(i+2));
1681 // Bern = Bern + c*s/(i+2);
1682 // s = s + expt_pos(cl_I(i+2),n);
1686 // But if somebody works with the n'th Bernoulli number she is likely to
1687 // also need all previous Bernoulli numbers. So we need a complete remember
1688 // table and above divide and conquer algorithm is not suited to build one
1689 // up. The formula below accomplishes this. It is a modification of the
1690 // defining formula above but the computation of the binomial coefficients
1691 // is carried along in an inline fashion. It also honors the fact that
1692 // B_n is zero when n is odd and greater than 1.
1694 // (There is an interesting relation with the tangent polynomials described
1695 // in `Concrete Mathematics', which leads to a program a little faster as
1696 // our implementation below, but it requires storing one such polynomial in
1697 // addition to the remember table. This doubles the memory footprint so
1698 // we don't use it.)
1700 const unsigned n = nn.to_int();
1702 // the special cases not covered by the algorithm below
1704 return (n==1) ? (*_num_1_2_p) : (*_num0_p);
1708 // store nonvanishing Bernoulli numbers here
1709 static std::vector< cln::cl_RA > results;
1710 static unsigned next_r = 0;
1712 // algorithm not applicable to B(2), so just store it
1714 results.push_back(cln::recip(cln::cl_RA(6)));
1718 return results[n/2-1];
1720 results.reserve(n/2);
1721 for (unsigned p=next_r; p<=n; p+=2) {
1722 cln::cl_I c = 1; // seed for binonmial coefficients
1723 cln::cl_RA b = cln::cl_RA(p-1)/-2;
1724 // The CLN manual says: "The conversion from `unsigned int' works only
1725 // if the argument is < 2^29" (This is for 32 Bit machines. More
1726 // generally, cl_value_len is the limiting exponent of 2. We must make
1727 // sure that no intermediates are created which exceed this value. The
1728 // largest intermediate is (p+3-2*k)*(p/2-k+1) <= (p^2+p)/2.
1729 if (p < (1UL<<cl_value_len/2)) {
1730 for (unsigned k=1; k<=p/2-1; ++k) {
1731 c = cln::exquo(c * ((p+3-2*k) * (p/2-k+1)), (2*k-1)*k);
1732 b = b + c*results[k-1];
1735 for (unsigned k=1; k<=p/2-1; ++k) {
1736 c = cln::exquo((c * (p+3-2*k)) * (p/2-k+1), cln::cl_I(2*k-1)*k);
1737 b = b + c*results[k-1];
1740 results.push_back(-b/(p+1));
1743 return results[n/2-1];
1747 /** Fibonacci number. The nth Fibonacci number F(n) is defined by the
1748 * recurrence formula F(n)==F(n-1)+F(n-2) with F(0)==0 and F(1)==1.
1750 * @param n an integer
1751 * @return the nth Fibonacci number F(n) (an integer number)
1752 * @exception range_error (argument must be an integer) */
1753 const numeric fibonacci(const numeric &n)
1755 if (!n.is_integer())
1756 throw std::range_error("numeric::fibonacci(): argument must be integer");
1759 // The following addition formula holds:
1761 // F(n+m) = F(m-1)*F(n) + F(m)*F(n+1) for m >= 1, n >= 0.
1763 // (Proof: For fixed m, the LHS and the RHS satisfy the same recurrence
1764 // w.r.t. n, and the initial values (n=0, n=1) agree. Hence all values
1766 // Replace m by m+1:
1767 // F(n+m+1) = F(m)*F(n) + F(m+1)*F(n+1) for m >= 0, n >= 0
1768 // Now put in m = n, to get
1769 // F(2n) = (F(n+1)-F(n))*F(n) + F(n)*F(n+1) = F(n)*(2*F(n+1) - F(n))
1770 // F(2n+1) = F(n)^2 + F(n+1)^2
1772 // F(2n+2) = F(n+1)*(2*F(n) + F(n+1))
1775 if (n.is_negative())
1777 return -fibonacci(-n);
1779 return fibonacci(-n);
1783 cln::cl_I m = cln::the<cln::cl_I>(n.to_cl_N()) >> 1L; // floor(n/2);
1784 for (uintL bit=cln::integer_length(m); bit>0; --bit) {
1785 // Since a squaring is cheaper than a multiplication, better use
1786 // three squarings instead of one multiplication and two squarings.
1787 cln::cl_I u2 = cln::square(u);
1788 cln::cl_I v2 = cln::square(v);
1789 if (cln::logbitp(bit-1, m)) {
1790 v = cln::square(u + v) - u2;
1793 u = v2 - cln::square(v - u);
1798 // Here we don't use the squaring formula because one multiplication
1799 // is cheaper than two squarings.
1800 return u * ((v << 1) - u);
1802 return cln::square(u) + cln::square(v);
1806 /** Absolute value. */
1807 const numeric abs(const numeric& x)
1809 return cln::abs(x.to_cl_N());
1813 /** Modulus (in positive representation).
1814 * In general, mod(a,b) has the sign of b or is zero, and rem(a,b) has the
1815 * sign of a or is zero. This is different from Maple's modp, where the sign
1816 * of b is ignored. It is in agreement with Mathematica's Mod.
1818 * @return a mod b in the range [0,abs(b)-1] with sign of b if both are
1819 * integer, 0 otherwise. */
1820 const numeric mod(const numeric &a, const numeric &b)
1822 if (a.is_integer() && b.is_integer())
1823 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()),
1824 cln::the<cln::cl_I>(b.to_cl_N()));
1830 /** Modulus (in symmetric representation).
1831 * Equivalent to Maple's mods.
1833 * @return a mod b in the range [-iquo(abs(b)-1,2), iquo(abs(b),2)]. */
1834 const numeric smod(const numeric &a, const numeric &b)
1836 if (a.is_integer() && b.is_integer()) {
1837 const cln::cl_I b2 = cln::ceiling1(cln::the<cln::cl_I>(b.to_cl_N()) >> 1) - 1;
1838 return cln::mod(cln::the<cln::cl_I>(a.to_cl_N()) + b2,
1839 cln::the<cln::cl_I>(b.to_cl_N())) - b2;
1845 /** Numeric integer remainder.
1846 * Equivalent to Maple's irem(a,b) as far as sign conventions are concerned.
1847 * In general, mod(a,b) has the sign of b or is zero, and irem(a,b) has the
1848 * sign of a or is zero.
1850 * @return remainder of a/b if both are integer, 0 otherwise.
1851 * @exception overflow_error (division by zero) if b is zero. */
1852 const numeric irem(const numeric &a, const numeric &b)
1855 throw std::overflow_error("numeric::irem(): division by zero");
1856 if (a.is_integer() && b.is_integer())
1857 return cln::rem(cln::the<cln::cl_I>(a.to_cl_N()),
1858 cln::the<cln::cl_I>(b.to_cl_N()));
1864 /** Numeric integer remainder.
1865 * Equivalent to Maple's irem(a,b,'q') it obeyes the relation
1866 * irem(a,b,q) == a - q*b. In general, mod(a,b) has the sign of b or is zero,
1867 * and irem(a,b) has the sign of a or is zero.
1869 * @return remainder of a/b and quotient stored in q if both are integer,
1871 * @exception overflow_error (division by zero) if b is zero. */
1872 const numeric irem(const numeric &a, const numeric &b, numeric &q)
1875 throw std::overflow_error("numeric::irem(): division by zero");
1876 if (a.is_integer() && b.is_integer()) {
1877 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1878 cln::the<cln::cl_I>(b.to_cl_N()));
1879 q = rem_quo.quotient;
1880 return rem_quo.remainder;
1888 /** Numeric integer quotient.
1889 * Equivalent to Maple's iquo as far as sign conventions are concerned.
1891 * @return truncated quotient of a/b if both are integer, 0 otherwise.
1892 * @exception overflow_error (division by zero) if b is zero. */
1893 const numeric iquo(const numeric &a, const numeric &b)
1896 throw std::overflow_error("numeric::iquo(): division by zero");
1897 if (a.is_integer() && b.is_integer())
1898 return cln::truncate1(cln::the<cln::cl_I>(a.to_cl_N()),
1899 cln::the<cln::cl_I>(b.to_cl_N()));
1905 /** Numeric integer quotient.
1906 * Equivalent to Maple's iquo(a,b,'r') it obeyes the relation
1907 * r == a - iquo(a,b,r)*b.
1909 * @return truncated quotient of a/b and remainder stored in r if both are
1910 * integer, 0 otherwise.
1911 * @exception overflow_error (division by zero) if b is zero. */
1912 const numeric iquo(const numeric &a, const numeric &b, numeric &r)
1915 throw std::overflow_error("numeric::iquo(): division by zero");
1916 if (a.is_integer() && b.is_integer()) {
1917 const cln::cl_I_div_t rem_quo = cln::truncate2(cln::the<cln::cl_I>(a.to_cl_N()),
1918 cln::the<cln::cl_I>(b.to_cl_N()));
1919 r = rem_quo.remainder;
1920 return rem_quo.quotient;
1928 /** Greatest Common Divisor.
1930 * @return The GCD of two numbers if both are integer, a numerical 1
1931 * if they are not. */
1932 const numeric gcd(const numeric &a, const numeric &b)
1934 if (a.is_integer() && b.is_integer())
1935 return cln::gcd(cln::the<cln::cl_I>(a.to_cl_N()),
1936 cln::the<cln::cl_I>(b.to_cl_N()));
1942 /** Least Common Multiple.
1944 * @return The LCM of two numbers if both are integer, the product of those
1945 * two numbers if they are not. */
1946 const numeric lcm(const numeric &a, const numeric &b)
1948 if (a.is_integer() && b.is_integer())
1949 return cln::lcm(cln::the<cln::cl_I>(a.to_cl_N()),
1950 cln::the<cln::cl_I>(b.to_cl_N()));
1956 /** Numeric square root.
1957 * If possible, sqrt(x) should respect squares of exact numbers, i.e. sqrt(4)
1958 * should return integer 2.
1960 * @param x numeric argument
1961 * @return square root of x. Branch cut along negative real axis, the negative
1962 * real axis itself where imag(x)==0 and real(x)<0 belongs to the upper part
1963 * where imag(x)>0. */
1964 const numeric sqrt(const numeric &x)
1966 return cln::sqrt(x.to_cl_N());
1970 /** Integer numeric square root. */
1971 const numeric isqrt(const numeric &x)
1973 if (x.is_integer()) {
1975 cln::isqrt(cln::the<cln::cl_I>(x.to_cl_N()), &root);
1982 /** Floating point evaluation of Archimedes' constant Pi. */
1985 return numeric(cln::pi(cln::default_float_format));
1989 /** Floating point evaluation of Euler's constant gamma. */
1992 return numeric(cln::eulerconst(cln::default_float_format));
1996 /** Floating point evaluation of Catalan's constant. */
1999 return numeric(cln::catalanconst(cln::default_float_format));
2003 /** _numeric_digits default ctor, checking for singleton invariance. */
2004 _numeric_digits::_numeric_digits()
2007 // It initializes to 17 digits, because in CLN float_format(17) turns out
2008 // to be 61 (<64) while float_format(18)=65. The reason is we want to
2009 // have a cl_LF instead of cl_SF, cl_FF or cl_DF.
2011 throw(std::runtime_error("I told you not to do instantiate me!"));
2013 cln::default_float_format = cln::float_format(17);
2015 // add callbacks for built-in functions
2016 // like ... add_callback(Li_lookuptable);
2020 /** Assign a native long to global Digits object. */
2021 _numeric_digits& _numeric_digits::operator=(long prec)
2023 long digitsdiff = prec - digits;
2025 cln::default_float_format = cln::float_format(prec);
2027 // call registered callbacks
2028 std::vector<digits_changed_callback>::const_iterator it = callbacklist.begin(), end = callbacklist.end();
2029 for (; it != end; ++it) {
2037 /** Convert global Digits object to native type long. */
2038 _numeric_digits::operator long()
2040 // BTW, this is approx. unsigned(cln::default_float_format*0.301)-1
2041 return (long)digits;
2045 /** Append global Digits object to ostream. */
2046 void _numeric_digits::print(std::ostream &os) const
2052 /** Add a new callback function. */
2053 void _numeric_digits::add_callback(digits_changed_callback callback)
2055 callbacklist.push_back(callback);
2059 std::ostream& operator<<(std::ostream &os, const _numeric_digits &e)
2066 // static member variables
2071 bool _numeric_digits::too_late = false;
2074 /** Accuracy in decimal digits. Only object of this type! Can be set using
2075 * assignment from C++ unsigned ints and evaluated like any built-in type. */
2076 _numeric_digits Digits;
2078 } // namespace GiNaC