Aim: Specialization of MPolynomial for degree 0. More...

#include <DGtal/math/MPolynomial.h>

Public Types
typedef TRing	Ring

typedef TAlloc	Alloc

Public Member Functions
	MPolynomial (const Ring &v=0, const Alloc &allocator=Alloc())

	MPolynomial (const Alloc &allocator)

bool	isZero () const

	operator const Ring & () const

MPolynomial &	operator= (const Ring &v)

Ring	operator() () const

MPolynomial	operator* (const Ring &v) const

MPolynomial	operator/ (const Ring &v) const

MPolynomial	operator+ (const Ring &v) const

MPolynomial	operator- (const Ring &v) const

MPolynomial	operator- () const

MPolynomial &	operator*= (const Ring &v)

MPolynomial &	operator/= (const Ring &v)

MPolynomial &	operator+= (const Ring &v)

MPolynomial &	operator-= (const Ring &v)

bool	operator== (const Ring &v) const

bool	operator!= (const Ring &v) const

void	selfDisplay (std::ostream &s, int) const

void	swap (MPolynomial &p)

Alloc	getAllocator () const

Private Attributes
Alloc	myAllocator

Ring	myValue

Detailed Description

template<typename TRing, typename TAlloc>
class DGtal::MPolynomial< 0, TRing, TAlloc >

Aim: Specialization of MPolynomial for degree 0.

Description of template class 'MPolynomial'

Stores a polynomial of degree 0, i.e. a scalar of type T. We assume that the type T is not "too" complex, otherwise this class will be partially not very effective.

Template Parameters

TRing	the type chosen for the polynomial, defines also the type of the coefficents (generally int, float or double).
TAlloc	is an allocator for TRing, for example std::allocator<TRing>; this is also the default parameter. Usually this parameter does not needs to be changed.

This class is a backport from Spielwiese.

Author: Felix Fontein (felix.nosp@m.@fon.nosp@m.tein..nosp@m.de), University of Zurich, Switzerland

Definition at line 507 of file MPolynomial.h.

Member Typedef Documentation

◆ Alloc

template<typename TRing , typename TAlloc >

typedef TAlloc DGtal::MPolynomial< 0, TRing, TAlloc >::Alloc

Definition at line 511 of file MPolynomial.h.

◆ Ring

template<typename TRing , typename TAlloc >

typedef TRing DGtal::MPolynomial< 0, TRing, TAlloc >::Ring

Definition at line 510 of file MPolynomial.h.

Constructor & Destructor Documentation

◆ MPolynomial() [1/2]

template<typename TRing , typename TAlloc >

DGtal::MPolynomial< 0, TRing, TAlloc >::MPolynomial	(	const Ring &	v = `0`,
		const Alloc &	allocator = `Alloc()`
	)

inline

Constructor (default, or from ring value). Creates the constant polynomial v.

Parameters

v	any value in the ring.
allocator	an allocator for the polynomial.

Definition at line 526 of file MPolynomial.h.

527 : myAllocator(allocator), myValue(v)

528 {}

DGtal::MPolynomial< 0, TRing, TAlloc >::myValue

Ring myValue

Definition MPolynomial.h:515

DGtal::MPolynomial< 0, TRing, TAlloc >::myAllocator

Alloc myAllocator

Definition MPolynomial.h:514

◆ MPolynomial() [2/2]

template<typename TRing , typename TAlloc >

DGtal::MPolynomial< 0, TRing, TAlloc >::MPolynomial ( const Alloc & allocator )

inline

Allocator constructor. Creates the constant polynomial 0, where 0 is the default value of the ring.

Parameters

allocator an allocator for the polynomial.

Definition at line 537 of file MPolynomial.h.

538 : myAllocator(allocator), myValue( Ring() )

539 {}

DGtal::MPolynomial< 0, TRing, TAlloc >::Ring

TRing Ring

Definition MPolynomial.h:510

Member Function Documentation

◆ getAllocator()

template<typename TRing , typename TAlloc >

Alloc DGtal::MPolynomial< 0, TRing, TAlloc >::getAllocator ( ) const

inline

Returns: the allocator for this object.

Definition at line 712 of file MPolynomial.h.

    {
      return myAllocator;
    }

◆ isZero()

template<typename TRing , typename TAlloc >

bool DGtal::MPolynomial< 0, TRing, TAlloc >::isZero ( ) const

inline

Returns: true if the polynomial is 0.

Definition at line 544 of file MPolynomial.h.

    {
      return myValue == 0;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator const Ring &()

template<typename TRing , typename TAlloc >

DGtal::MPolynomial< 0, TRing, TAlloc >::operator const Ring & ( ) const

inline

Const cast operator to Ring value. Returns the coefficient value of this constant polynomial.

Definition at line 553 of file MPolynomial.h.

    {
        return myValue;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator!=()

template<typename TRing , typename TAlloc >

bool DGtal::MPolynomial< 0, TRing, TAlloc >::operator!= ( const Ring & v ) const

inline

Difference operator.

Parameters

v	any value in the ring.

Returns: true iff myValue is different from v.

Definition at line 686 of file MPolynomial.h.

    {
        return myValue != v;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator()()

template<typename TRing , typename TAlloc >

Ring DGtal::MPolynomial< 0, TRing, TAlloc >::operator() ( ) const

inline

Evaluation operator for the polynomial.

Returns: the value of its coefficient.

Definition at line 573 of file MPolynomial.h.

    {
      return myValue;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator*()

template<typename TRing , typename TAlloc >

MPolynomial DGtal::MPolynomial< 0, TRing, TAlloc >::operator* ( const Ring & v ) const

inline

Multiplication by value v.

Parameters

v	any value in the ring.

Returns: a constant polynomial of coefficient myValue*v.

Definition at line 583 of file MPolynomial.h.

    {
        return MPolynomial(myValue * v);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator*=()

template<typename TRing , typename TAlloc >

MPolynomial & DGtal::MPolynomial< 0, TRing, TAlloc >::operator*= ( const Ring & v )

inline

Self-multiplication by value v.

Parameters

v	any value in the ring.

Returns: itself

Definition at line 632 of file MPolynomial.h.

    {
      myValue *= v;
      return *this;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator+()

template<typename TRing , typename TAlloc >

MPolynomial DGtal::MPolynomial< 0, TRing, TAlloc >::operator+ ( const Ring & v ) const

inline

Addition by value v.

Parameters

v	any value in the ring.

Returns: a constant polynomial of coefficient myValue+v.

Definition at line 603 of file MPolynomial.h.

    {
        return MPolynomial(myValue + v);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator+=()

template<typename TRing , typename TAlloc >

MPolynomial & DGtal::MPolynomial< 0, TRing, TAlloc >::operator+= ( const Ring & v )

inline

Self-addition by value v.

Parameters

v	any value in the ring.

Returns: itself

Definition at line 654 of file MPolynomial.h.

    {
      myValue += v;
      return *this;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator-() [1/2]

template<typename TRing , typename TAlloc >

MPolynomial DGtal::MPolynomial< 0, TRing, TAlloc >::operator- ( ) const

inline

Unary minus operator.

Returns: a constant polynomial of coefficient -myValue.

Definition at line 622 of file MPolynomial.h.

    {
      return MPolynomial(-myValue);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator-() [2/2]

template<typename TRing , typename TAlloc >

MPolynomial DGtal::MPolynomial< 0, TRing, TAlloc >::operator- ( const Ring & v ) const

inline

Subtraction by value v.

Parameters

v	any value in the ring.

Returns: a constant polynomial of coefficient myValue-v.

Definition at line 613 of file MPolynomial.h.

    {
        return MPolynomial(myValue - v);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator-=()

template<typename TRing , typename TAlloc >

MPolynomial & DGtal::MPolynomial< 0, TRing, TAlloc >::operator-= ( const Ring & v )

inline

Self-subtraction by value v.

Parameters

v	any value in the ring.

Returns: itself

Definition at line 665 of file MPolynomial.h.

    {
      myValue -= v;
      return *this;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator/()

template<typename TRing , typename TAlloc >

MPolynomial DGtal::MPolynomial< 0, TRing, TAlloc >::operator/ ( const Ring & v ) const

inline

Division by value v.

Parameters

v	any value in the ring.

Returns: a constant polynomial of coefficient myValue/v.

Definition at line 593 of file MPolynomial.h.

    {
        return MPolynomial(myValue / v);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator/=()

template<typename TRing , typename TAlloc >

MPolynomial & DGtal::MPolynomial< 0, TRing, TAlloc >::operator/= ( const Ring & v )

inline

Self-division by value v.

Parameters

v	any value in the ring.

Returns: itself

Definition at line 643 of file MPolynomial.h.

    {
      myValue /= v;
      return *this;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator=()

template<typename TRing , typename TAlloc >

MPolynomial & DGtal::MPolynomial< 0, TRing, TAlloc >::operator= ( const Ring & v )

inline

Assigment from coefficient in the ring.

Parameters

v	any value in the ring.

Returns: itself

Definition at line 563 of file MPolynomial.h.

    {
      myValue = v;
      return *this;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ operator==()

template<typename TRing , typename TAlloc >

bool DGtal::MPolynomial< 0, TRing, TAlloc >::operator== ( const Ring & v ) const

inline

Equality operator.

Parameters

v	any value in the ring.

Returns: true iff myValue is equal to v.

Definition at line 676 of file MPolynomial.h.

    {
        return myValue == v;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ selfDisplay()

template<typename TRing , typename TAlloc >

void DGtal::MPolynomial< 0, TRing, TAlloc >::selfDisplay	(	std::ostream &	s,
		int
	)		const

inline

Outputs itself in the stream s.

Parameters

s	any stream

Definition at line 695 of file MPolynomial.h.

    {
      s << myValue;
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

◆ swap()

template<typename TRing , typename TAlloc >

void DGtal::MPolynomial< 0, TRing, TAlloc >::swap ( MPolynomial< 0, TRing, TAlloc > & p )

inline

Swaps two polynomials.

Parameters

p	any zero-degree polynomial.

Definition at line 704 of file MPolynomial.h.

    {
      std::swap(myValue, p.myValue);
    }

References DGtal::MPolynomial< n, TRing, TAlloc >::myValue.

Field Documentation

◆ myAllocator

template<typename TRing , typename TAlloc >

Alloc DGtal::MPolynomial< 0, TRing, TAlloc >::myAllocator

private

Definition at line 514 of file MPolynomial.h.

◆ myValue

template<typename TRing , typename TAlloc >

Ring DGtal::MPolynomial< 0, TRing, TAlloc >::myValue

private

Definition at line 515 of file MPolynomial.h.

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

MPolynomial.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Alloc

◆ Ring

Constructor & Destructor Documentation

◆ MPolynomial() [1/2]

◆ MPolynomial() [2/2]

Member Function Documentation

◆ getAllocator()

◆ isZero()

◆ operator const Ring &()

◆ operator!=()

◆ operator()()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator=()

◆ operator==()

◆ selfDisplay()

◆ swap()

Field Documentation

◆ myAllocator

◆ myValue