#include <DGtal/math/MPolynomial.h>

Inheritance diagram for DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >:

Data Structures
class	EvalFun
class	EvalFun2

Public Types
typedef TRing	Ring
typedef TOwner	Owner
typedef TAlloc	Alloc
typedef TX	X
typedef MPolynomial< n, Ring, Alloc >	MPolyN
	Type for the multivariate polynomial.
typedef MPolynomial< n - 1, X, typename std::allocator_traits< Alloc >::template rebind_alloc< X > >	MPolyNM1

Public Member Functions
	operator MPolyNM1 () const
template<typename XX>
MPolynomialEvaluatorImpl< n - 1, Ring, MPolynomialEvaluatorImpl< n, Ring, Owner, Alloc, X >, Alloc, XX >	operator() (const XX &x) const

Private Member Functions
	MPolynomialEvaluatorImpl (const Owner &owner, const X &evalpoint)
template<typename XX, typename Fun>
void	evaluate (XX &res, const Fun &evalfun) const

Private Attributes
const Owner &	myOwner
const X &	myEvalPoint

Friends
template<int nn, class TT, class AA, class SS>
class	MPolynomialEvaluator
template<int nn, class TT, class HLHL, class AA, class SS>
class	MPolynomialEvaluatorImpl

Detailed Description

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>
class DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >

Description of template class 'MPolynomialEvaluatorImpl'

Another helper for polynomial evaluation. This template is returned from MPolynomialEvaluator<n, TRing, TAlloc>::operator().

The template parameter TOwner is the type of the "owner" of this template, i.e. either MPolynomialEvaluator<n+1, TRing, TAlloc> or MPolynomialEvaluatorImpl<n+1, TRing, ..., TAlloc>.

This class is a backport from Spielwiese.

Definition at line 194 of file MPolynomial.h.

Member Typedef Documentation

◆ Alloc

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef TAlloc DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::Alloc

Definition at line 199 of file MPolynomial.h.

◆ MPolyN

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef MPolynomial< n, Ring, Alloc> DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::MPolyN

Type for the multivariate polynomial.

Definition at line 202 of file MPolynomial.h.

◆ MPolyNM1

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef MPolynomial< n - 1, X, typename std::allocator_traits<Alloc>::template rebind_alloc<X> > DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::MPolyNM1

Type for the "child" multivariate polynomial, where the first variable X has been substituted by its value. Note that the ring type has been substituted by the type of the variable (i.e. X).

Definition at line 211 of file MPolynomial.h.

◆ Owner

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef TOwner DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::Owner

Definition at line 198 of file MPolynomial.h.

◆ Ring

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef TRing DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::Ring

Definition at line 197 of file MPolynomial.h.

◆ X

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

typedef TX DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::X

Definition at line 200 of file MPolynomial.h.

Constructor & Destructor Documentation

◆ MPolynomialEvaluatorImpl()

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::MPolynomialEvaluatorImpl	(	const Owner &	owner,
		const X &	evalpoint )

inlineprivate

Definition at line 224 of file MPolynomial.h.

225 : myOwner(owner), myEvalPoint(evalpoint)

226 {}

DGtal::MPolynomialEvaluatorImpl

Definition MPolynomial.h:195

DGtal::MPolynomialEvaluatorImpl::myEvalPoint

const X & myEvalPoint

Definition MPolynomial.h:221

DGtal::MPolynomialEvaluatorImpl::myOwner

const Owner & myOwner

Definition MPolynomial.h:220

References myEvalPoint, and myOwner.

Member Function Documentation

◆ evaluate()

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

template<typename XX, typename Fun>

void DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::evaluate	(	XX &	res,
		const Fun &	evalfun ) const

inlineprivate

This will be called from a child (i.e. a class of type MPolynomialEvaluatorImpl<n-1, Ring, MPolynomialEvaluator<n,Ring,Owner,Alloc,X>, Alloc, X>) to trigger evaluation.

Definition at line 273 of file MPolynomial.h.

    {
        // We have to pass evaluation on to our owner, but give a new
        // functor which now evaluates polynomials of type poly<n, T>.
      myOwner.evaluate( res, EvalFun< XX, Fun >( *this, evalfun ) );
    }

References myOwner.

◆ operator MPolyNM1()

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::operator MPolyNM1 ( ) const

inline

Allows casting to poly<n-1, S>.

Definition at line 321 of file MPolynomial.h.

    {
      MPolyNM1 res; // missing: determine allocator object
      // We need to pass evaluation on to our owner
      myOwner.evaluate( res, EvalFun2( *this ) );
      return res;
    }

References myOwner.

◆ operator()()

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>

template<typename XX>

MPolynomialEvaluatorImpl< n - 1, Ring, MPolynomialEvaluatorImpl< n, Ring, Owner, Alloc, X >, Alloc, XX > DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::operator() ( const XX & x ) const

inline

Continues evaluation with the next indeterminant. Functor returining a "child" evaluator implementation.

Parameters

x	the next indeterminant.

Definition at line 340 of file MPolynomial.h.

      {
        return MPolynomialEvaluatorImpl
          < n - 1, Ring, MPolynomialEvaluatorImpl< n, Ring, Owner, Alloc, X>, 
            Alloc, XX >( *this, x );
      }