File failed to load: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.3/config/TeX-MML-AM_CHTML/MathJax.js
DGtal 2.0.0
DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX > Class Template Reference

#include <DGtal/math/MPolynomial.h>

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

Data Structures

class  EvalFun
class  EvalFun2

Public Types

typedef TRing Ring
typedef TOwner Owner
typedef TAlloc Alloc
typedef TX X
typedef MPolynomial< n, Ring, AllocMPolyN
 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 OwnermyOwner
const XmyEvalPoint

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

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.

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

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.

323 {
324 MPolyNM1 res; // missing: determine allocator object
325 // We need to pass evaluation on to our owner
326 myOwner.evaluate( res, EvalFun2( *this ) );
327 return res;
328 }
MPolynomial< n - 1, X, typename std::allocator_traits< Alloc >::template rebind_alloc< X > > MPolyNM1

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
xthe next indeterminant.

Definition at line 340 of file MPolynomial.h.

References MPolynomialEvaluatorImpl.

◆ MPolynomialEvaluator

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>
template<int nn, class TT, class AA, class SS>
friend class MPolynomialEvaluator
friend

Definition at line 214 of file MPolynomial.h.

References MPolynomialEvaluator.

Referenced by MPolynomialEvaluator.

◆ MPolynomialEvaluatorImpl

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>
template<int nn, class TT, class HLHL, class AA, class SS>
friend class MPolynomialEvaluatorImpl
friend

Field Documentation

◆ myEvalPoint

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>
const X& DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::myEvalPoint
private

◆ myOwner

template<int n, typename TRing, typename TOwner, typename TAlloc, typename TX>
const Owner& DGtal::MPolynomialEvaluatorImpl< n, TRing, TOwner, TAlloc, TX >::myOwner
private

Definition at line 220 of file MPolynomial.h.

Referenced by evaluate(), MPolynomialEvaluatorImpl(), and operator MPolyNM1().


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