slip::Monomial< DIM > Struct Template Reference

Numerical Monomial structure. More...

#include <MultivariatePolynomial.hpp>

Public Member Functions
std::string	name () const
std::size_t	dim () const
std::size_t	degree () const
bool	is_a_constant () const

Public Attributes
slip::block< unsigned char, DIM >	powers

Friends
class	boost::serialization::access
Comparison operators
bool	operator== (const Monomial< DIM > &x, const Monomial< DIM > &y)
	Monomial equality comparison. More...
bool	operator!= (const Monomial< DIM > &x, const Monomial< DIM > &y)
	Monomial inequality comparison. More...
bool	operator< (const Monomial< DIM > &x, const Monomial< DIM > &y)
	Less than comparison operator (Monomial ordering relation) More...
bool	operator> (const Monomial< DIM > &x, const Monomial< DIM > &y)
	More than comparison operator. More...

Detailed Description

template<std::size_t DIM>
struct slip::Monomial< DIM >

Numerical Monomial structure.

Author

Benoit Tremblais <tremblais_AT_sic.univ-poitiers.fr>

Version

0.0.2

Date

2014/04/01

Since

1.0.0

Parameters

DIM	Dimension of the Monomial

Precondition

DIM must be != 0

Remarks

the powers of the variables are less than 9

The monomials are ordered according to the lexicographical order of the powers of x1,x2,...,xDIM

Definition at line 104 of file MultivariatePolynomial.hpp.

Member Function Documentation

template<std::size_t DIM>

std::size_t slip::Monomial< DIM >::degree ( ) const

inline

Definition at line 154 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

std::size_t slip::Monomial< DIM >::dim ( ) const

inline

Definition at line 153 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

bool slip::Monomial< DIM >::is_a_constant ( ) const

inline

Definition at line 159 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

std::string slip::Monomial< DIM >::name ( ) const

inline

Definition at line 152 of file MultivariatePolynomial.hpp.

Friends And Related Function Documentation

template<std::size_t DIM>

friend class boost::serialization::access

friend

Definition at line 213 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

bool operator!= ( const Monomial< DIM > &  x, const Monomial< DIM > &  y  )

friend

Monomial inequality comparison.

Parameters

x	A Monomial
y	A Monomial of the same type of x

Returns

true if !(x == y)

Definition at line 283 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

bool operator< ( const Monomial< DIM > &  x, const Monomial< DIM > &  y  )

friend

Less than comparison operator (Monomial ordering relation)

Parameters

x	A Monomial
y	A Monomial of the same type of x

Returns

true iff the powers of x is lexicographically less than thoseof y

Definition at line 295 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

bool operator== ( const Monomial< DIM > &  x, const Monomial< DIM > &  y  )

friend

Monomial equality comparison.

Parameters

x	A Monomial
y	A Monomial of the same type of x

Returns

true iff the powers of the Monomials are equal

Definition at line 275 of file MultivariatePolynomial.hpp.

template<std::size_t DIM>

bool operator> ( const Monomial< DIM > &  x, const Monomial< DIM > &  y  )

friend

More than comparison operator.

Parameters

x	A Monomial
y	A Monomial of the same type of x

Returns

true iff y > x

Definition at line 306 of file MultivariatePolynomial.hpp.

Member Data Documentation

template<std::size_t DIM>

slip::block<unsigned char,DIM> slip::Monomial< DIM >::powers

Definition at line 150 of file MultivariatePolynomial.hpp.

---

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

• src/Container/MultivariatePolynomial.hpp