The base class for integration kernels for iterated integrals. More...

#include <integration_kernel.h>

Inheritance diagram for GiNaC::integration_kernel:

Public Member Functions
ex	series (const relational &r, int order, unsigned options=0) const override
	Default implementation of ex::series(). More...

virtual bool	has_trailing_zero (void) const
	This routine returns true, if the integration kernel has a trailing zero. More...

virtual bool	is_numeric (void) const
	This routine returns true, if the integration kernel can be evaluated numerically. More...

virtual ex	Laurent_series (const ex &x, int order) const
	Returns the Laurent series, starting possibly with the pole term. More...

virtual ex	get_numerical_value (const ex &lambda, int N_trunc=0) const
	Evaluates the integrand at lambda. More...

size_t	get_cache_size (void) const
	Returns the current size of the cache. More...

void	set_cache_step (int cache_steps) const
	Sets the step size by which the cache is increased. More...

ex	get_series_coeff (int i) const
	Wrapper around series_coeff(i), converts cl_N to numeric. More...

cln::cl_N	series_coeff (int i) const
	Subclasses have either to implement series_coeff_impl or the two methods Laurent_series and uses_Laurent_series. More...

Public Member Functions inherited from GiNaC::basic
virtual	~basic ()
	basic destructor, virtual because class ex will delete objects of derived classes via a basic*. More...

	basic (const basic &other)

const basic &	operator= (const basic &other)
	basic assignment operator: the other object might be of a derived class. More...

virtual basic *	duplicate () const
	Create a clone of this object on the heap. More...

virtual ex	eval () const
	Perform automatic non-interruptive term rewriting rules. More...

virtual ex	evalf () const
	Evaluate object numerically. More...

virtual ex	evalm () const
	Evaluate sums, products and integer powers of matrices. More...

virtual ex	eval_integ () const
	Evaluate integrals, if result is known. More...

virtual ex	eval_indexed (const basic &i) const
	Perform automatic symbolic evaluations on indexed expression that contains this object as the base expression. More...

virtual void	print (const print_context &c, unsigned level=0) const
	Output to stream. More...

virtual void	dbgprint () const
	Little wrapper around print to be called within a debugger. More...

virtual void	dbgprinttree () const
	Little wrapper around printtree to be called within a debugger. More...

virtual unsigned	precedence () const
	Return relative operator precedence (for parenthezing output). More...

virtual bool	info (unsigned inf) const
	Information about the object. More...

virtual size_t	nops () const
	Number of operands/members. More...

virtual ex	op (size_t i) const
	Return operand/member at position i. More...

virtual ex	operator[] (const ex &index) const

virtual ex	operator[] (size_t i) const

virtual ex &	let_op (size_t i)
	Return modifiable operand/member at position i. More...

virtual ex &	operator[] (const ex &index)

virtual ex &	operator[] (size_t i)

virtual bool	has (const ex &other, unsigned options=0) const
	Test for occurrence of a pattern. More...

virtual bool	match (const ex &pattern, exmap &repls) const
	Check whether the expression matches a given pattern. More...

virtual ex	subs (const exmap &m, unsigned options=0) const
	Substitute a set of objects by arbitrary expressions. More...

virtual ex	map (map_function &f) const
	Construct new expression by applying the specified function to all sub-expressions (one level only, not recursively). More...

virtual void	accept (GiNaC::visitor &v) const

virtual bool	is_polynomial (const ex &var) const
	Check whether this is a polynomial in the given variables. More...

virtual int	degree (const ex &s) const
	Return degree of highest power in object s. More...

virtual int	ldegree (const ex &s) const
	Return degree of lowest power in object s. More...

virtual ex	coeff (const ex &s, int n=1) const
	Return coefficient of degree n in object s. More...

virtual ex	expand (unsigned options=0) const
	Expand expression, i.e. More...

virtual ex	collect (const ex &s, bool distributed=false) const
	Sort expanded expression in terms of powers of some object(s). More...

virtual ex	series (const relational &r, int order, unsigned options=0) const
	Default implementation of ex::series(). More...

virtual ex	normal (exmap &repl, exmap &rev_lookup, lst &modifier) const
	Default implementation of ex::normal(). More...

virtual ex	to_rational (exmap &repl) const
	Default implementation of ex::to_rational(). More...

virtual ex	to_polynomial (exmap &repl) const

virtual numeric	integer_content () const

virtual ex	smod (const numeric &xi) const
	Apply symmetric modular homomorphism to an expanded multivariate polynomial. More...

virtual numeric	max_coefficient () const
	Implementation ex::max_coefficient(). More...

virtual exvector	get_free_indices () const
	Return a vector containing the free indices of an expression. More...

virtual ex	add_indexed (const ex &self, const ex &other) const
	Add two indexed expressions. More...

virtual ex	scalar_mul_indexed (const ex &self, const numeric &other) const
	Multiply an indexed expression with a scalar. More...

virtual bool	contract_with (exvector::iterator self, exvector::iterator other, exvector &v) const
	Try to contract two indexed expressions that appear in the same product. More...

virtual unsigned	return_type () const

virtual return_type_t	return_type_tinfo () const

virtual ex	conjugate () const

virtual ex	real_part () const

virtual ex	imag_part () const

template<class T >
void	print_dispatch (const print_context &c, unsigned level) const
	Like print(), but dispatch to the specified class. More...

void	print_dispatch (const registered_class_info &ri, const print_context &c, unsigned level) const
	Like print(), but dispatch to the specified class. More...

virtual void	archive (archive_node &n) const
	Save (serialize) the object into archive node. More...

virtual void	read_archive (const archive_node &n, lst &syms)
	Load (deserialize) the object from an archive node. More...

ex	subs_one_level (const exmap &m, unsigned options) const
	Helper function for subs(). More...

ex	diff (const symbol &s, unsigned nth=1) const
	Default interface of nth derivative ex::diff(s, n). More...

int	compare (const basic &other) const
	Compare objects syntactically to establish canonical ordering. More...

bool	is_equal (const basic &other) const
	Test for syntactic equality. More...

const basic &	hold () const
	Stop further evaluation. More...

unsigned	gethash () const

const basic &	setflag (unsigned f) const
	Set some status_flags. More...

const basic &	clearflag (unsigned f) const
	Clear some status_flags. More...

Public Member Functions inherited from GiNaC::refcounted
	refcounted () noexcept

unsigned int	add_reference () noexcept

unsigned int	remove_reference () noexcept

unsigned int	get_refcount () const noexcept

void	set_refcount (unsigned int r) noexcept

Protected Member Functions
virtual bool	uses_Laurent_series () const
	Returns true, if the coefficients are computed from the Laurent series (in which case the method Laurent_series needs to be implemented). More...

virtual cln::cl_N	series_coeff_impl (int i) const
	For $\omega = d\lambda$ only the coefficient of $\lambda^0$ is non-zero. More...

ex	get_numerical_value_impl (const ex &lambda, const ex &pre, int shift, int N_trunc) const
	The actual implementation for computing a numerical value for the integrand. More...

void	do_print (const print_context &c, unsigned level) const

Protected Member Functions inherited from GiNaC::basic
	basic ()

virtual ex	eval_ncmul (const exvector &v) const

virtual bool	match_same_type (const basic &other) const
	Returns true if the attributes of two objects are similar enough for a match. More...

virtual ex	derivative (const symbol &s) const
	Default implementation of ex::diff(). More...

virtual int	compare_same_type (const basic &other) const
	Returns order relation between two objects of same type. More...

virtual bool	is_equal_same_type (const basic &other) const
	Returns true if two objects of same type are equal. More...

virtual unsigned	calchash () const
	Compute the hash value of an object and if it makes sense to store it in the objects status_flags, do so. More...

void	ensure_if_modifiable () const
	Ensure the object may be modified without hurting others, throws if this is not the case. More...

void	do_print (const print_context &c, unsigned level) const
	Default output to stream. More...

void	do_print_tree (const print_tree &c, unsigned level) const
	Tree output to stream. More...

void	do_print_python_repr (const print_python_repr &c, unsigned level) const
	Python parsable output to stream. More...

Protected Attributes
int	cache_step_size

std::vector< cln::cl_N >	series_vec

Protected Attributes inherited from GiNaC::basic
unsigned	flags
	of type status_flags More...

unsigned	hashvalue
	hash value More...

Detailed Description

The base class for integration kernels for iterated integrals.

This class represents the differential one-form

$\omega = d\lambda$

The integration variable is a dummy variable and does not need to be specified.

Definition at line 55 of file integration_kernel.h.

Member Function Documentation

◆ series()

ex GiNaC::integration_kernel::series	(	const relational &	r,
		int	order,
		unsigned	options = `0`
	)		const

overridevirtual

Default implementation of ex::series().

This performs Taylor expansion.

See also: ex::series

Reimplemented from GiNaC::basic.

Reimplemented in GiNaC::Eisenstein_kernel, GiNaC::Eisenstein_h_kernel, and GiNaC::modular_form_kernel.

Definition at line 571 of file integration_kernel.cpp.

References order, and r.

◆ has_trailing_zero()

bool GiNaC::integration_kernel::has_trailing_zero ( void ) const

virtual

This routine returns true, if the integration kernel has a trailing zero.

Definition at line 585 of file integration_kernel.cpp.

◆ is_numeric()

bool GiNaC::integration_kernel::is_numeric ( void ) const

virtual

This routine returns true, if the integration kernel can be evaluated numerically.

Reimplemented in GiNaC::multiple_polylog_kernel, GiNaC::ELi_kernel, GiNaC::Ebar_kernel, GiNaC::Kronecker_dtau_kernel, GiNaC::Kronecker_dz_kernel, GiNaC::Eisenstein_kernel, GiNaC::Eisenstein_h_kernel, GiNaC::modular_form_kernel, and GiNaC::user_defined_kernel.

Definition at line 599 of file integration_kernel.cpp.

◆ Laurent_series()

ex GiNaC::integration_kernel::Laurent_series	(	const ex &	x,
		int	order
	)		const

virtual

Returns the Laurent series, starting possibly with the pole term.

Neglected terms are of order .

Reimplemented in GiNaC::modular_form_kernel, GiNaC::Eisenstein_kernel, GiNaC::Eisenstein_h_kernel, and GiNaC::user_defined_kernel.

Definition at line 664 of file integration_kernel.cpp.

References n, order, GiNaC::pow(), GiNaC::ex::series(), and x.

◆ get_numerical_value()

ex GiNaC::integration_kernel::get_numerical_value	(	const ex &	lambda,
		int	N_trunc = `0`
	)		const

virtual

Evaluates the integrand at lambda.

Reimplemented in GiNaC::ELi_kernel, GiNaC::Ebar_kernel, GiNaC::Kronecker_dtau_kernel, GiNaC::Eisenstein_kernel, GiNaC::Eisenstein_h_kernel, GiNaC::modular_form_kernel, and GiNaC::Kronecker_dz_kernel.

Definition at line 681 of file integration_kernel.cpp.

◆ uses_Laurent_series()

bool GiNaC::integration_kernel::uses_Laurent_series ( ) const

protectedvirtual

Returns true, if the coefficients are computed from the Laurent series (in which case the method Laurent_series needs to be implemented).

Returns false if this is not the case (and the class has an implementation of series_coeff_impl).

Reimplemented in GiNaC::Eisenstein_kernel, GiNaC::Eisenstein_h_kernel, GiNaC::modular_form_kernel, and GiNaC::user_defined_kernel.

Definition at line 695 of file integration_kernel.cpp.

◆ series_coeff_impl()

cln::cl_N GiNaC::integration_kernel::series_coeff_impl ( int i ) const

protectedvirtual

For $\omega = d\lambda$ only the coefficient of $\lambda^0$ is non-zero.

The i-th coefficient corresponds to the power $\lambda^{i-1}$ .

Reimplemented in GiNaC::basic_log_kernel, GiNaC::multiple_polylog_kernel, GiNaC::ELi_kernel, GiNaC::Ebar_kernel, GiNaC::Kronecker_dtau_kernel, and GiNaC::Kronecker_dz_kernel.

Definition at line 649 of file integration_kernel.cpp.

◆ get_cache_size()

size_t GiNaC::integration_kernel::get_cache_size ( void ) const

Returns the current size of the cache.

Definition at line 705 of file integration_kernel.cpp.

◆ set_cache_step()

void GiNaC::integration_kernel::set_cache_step ( int cache_steps ) const

Sets the step size by which the cache is increased.

Definition at line 715 of file integration_kernel.cpp.

◆ get_series_coeff()

ex GiNaC::integration_kernel::get_series_coeff ( int i ) const

Wrapper around series_coeff(i), converts cl_N to numeric.

Definition at line 725 of file integration_kernel.cpp.

◆ series_coeff()

cln::cl_N GiNaC::integration_kernel::series_coeff ( int i ) const

Subclasses have either to implement series_coeff_impl or the two methods Laurent_series and uses_Laurent_series.

The method series_coeff_impl can be used, if a single coefficient can be computed independently of the others.

The method Laurent_series can be used, if it is more efficient to compute a Laurent series in one shot and to determine a range of coefficients from this Laurent series.

Definition at line 616 of file integration_kernel.cpp.

References GiNaC::ex::coeff(), GiNaC::ex::evalf(), and x.

◆ get_numerical_value_impl()

ex GiNaC::integration_kernel::get_numerical_value_impl	(	const ex &	lambda,
		const ex &	pre,
		int	shift,
		int	N_trunc
	)		const

protected

The actual implementation for computing a numerical value for the integrand.

Definition at line 735 of file integration_kernel.cpp.

References GiNaC::Digits, GiNaC::ex::evalf(), and one.

Referenced by GiNaC::ELi_kernel::get_numerical_value(), GiNaC::Ebar_kernel::get_numerical_value(), GiNaC::Kronecker_dtau_kernel::get_numerical_value(), GiNaC::Eisenstein_kernel::get_numerical_value(), GiNaC::Eisenstein_h_kernel::get_numerical_value(), GiNaC::modular_form_kernel::get_numerical_value(), and GiNaC::Kronecker_dz_kernel::get_numerical_value().

◆ do_print()

void GiNaC::integration_kernel::do_print	(	const print_context &	c,
		unsigned	level
	)		const

protected

Definition at line 776 of file integration_kernel.cpp.

References c.

Member Data Documentation

◆ cache_step_size

int GiNaC::integration_kernel::cache_step_size

mutableprotected

Definition at line 96 of file integration_kernel.h.

◆ series_vec

std::vector<cln::cl_N> GiNaC::integration_kernel::series_vec

mutableprotected

Definition at line 98 of file integration_kernel.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ series()

◆ has_trailing_zero()

◆ is_numeric()

◆ Laurent_series()

◆ get_numerical_value()

◆ uses_Laurent_series()

◆ series_coeff_impl()

◆ get_cache_size()

◆ set_cache_step()

◆ get_series_coeff()

◆ series_coeff()

◆ get_numerical_value_impl()

◆ do_print()

Member Data Documentation

◆ cache_step_size

◆ series_vec