Polynomial Class Reference

Detailed Description

Represents symbolic polynomials.

A symbolic polynomial keeps a mapping from a monomial of indeterminates to its coefficient in a symbolic expression.

A polynomial p has to satisfy an invariant such that p.decision_variables() ∩ p.indeterminates() = ∅. We have CheckInvariant() method to check the invariant.

Note that arithmetic operations (+,-,*) between a Polynomial and a Variable are not provided. The problem is that Variable class has no intrinsic information if a variable is a decision variable or an indeterminate while we need this information to perform arithmetic operations over Polynomials.

#include <drake/common/symbolic_polynomial.h>

Public Types
using	MapType = std::map< Monomial, Expression, internal::CompareMonomial >

Public Member Functions
	Polynomial ()=default
	Constructs a zero polynomial. More...
	Polynomial (std::nullptr_t)
	Constructs a default value. More...
	Polynomial (MapType init)
	Constructs a polynomial from a map, Monomial → Expression. More...
	Polynomial (const Monomial &m)
	Constructs a polynomial from a monomial m. More...
	Polynomial (const Expression &e)
	Constructs a polynomial from an expression e. More...
	Polynomial (const Expression &e, Variables indeterminates)
	Constructs a polynomial from an expression e by decomposing it with respect to indeterminates. More...
const Variables &	indeterminates () const
	Returns the indeterminates of this polynomial. More...
const Variables &	decision_variables () const
	Returns the decision variables of this polynomial. More...
void	SetIndeterminates (const Variables &new_indeterminates)
	Sets the indeterminates to new_indeterminates. More...
int	Degree (const Variable &v) const
	Returns the highest degree of this polynomial in a variable v. More...
int	TotalDegree () const
	Returns the total degree of this polynomial. More...
const MapType &	monomial_to_coefficient_map () const
	Returns the mapping from a Monomial to its corresponding coefficient of this polynomial. More...
Expression	ToExpression () const
	Returns an equivalent symbolic expression of this polynomial. More...
Polynomial	Differentiate (const Variable &x) const
	Differentiates this polynomial with respect to the variable x. More...
template<typename Derived >
Eigen::Matrix< Polynomial, 1, Derived::RowsAtCompileTime >	Jacobian (const Eigen::MatrixBase< Derived > &vars) const
	Computes the Jacobian matrix J of the polynomial with respect to vars. More...
Polynomial	Integrate (const Variable &x) const
	Integrates this polynomial with respect to an indeterminate x. More...
Polynomial	Integrate (const Variable &x, double a, double b) const
	Computes the definite integrate of this polynomial with respect to the indeterminate x over the domain [a, b]. More...
double	Evaluate (const Environment &env) const
	Evaluates this polynomial under a given environment env. More...
Polynomial	EvaluatePartial (const Environment &env) const
	Partially evaluates this polynomial using an environment env. More...
Polynomial	EvaluatePartial (const Variable &var, double c) const
	Partially evaluates this polynomial by substituting var with c. More...
Polynomial &	AddProduct (const Expression &coeff, const Monomial &m)
	Adds coeff * m to this polynomial. More...
Polynomial	RemoveTermsWithSmallCoefficients (double coefficient_tol) const
	Removes the terms whose absolute value of the coefficients are smaller than or equal to coefficient_tol For example, if the polynomial is 2x² + 3xy + 10⁻⁴x - 10⁻⁵, then after calling RemoveTermsWithSmallCoefficients(1e-3), the returned polynomial becomes 2x² + 3xy. More...
Polynomial &	operator+= (const Polynomial &p)
Polynomial &	operator+= (const Monomial &m)
Polynomial &	operator+= (double c)
Polynomial &	operator+= (const Variable &v)
Polynomial &	operator-= (const Polynomial &p)
Polynomial &	operator-= (const Monomial &m)
Polynomial &	operator-= (double c)
Polynomial &	operator-= (const Variable &v)
Polynomial &	operator *= (const Polynomial &p)
Polynomial &	operator *= (const Monomial &m)
Polynomial &	operator *= (double c)
Polynomial &	operator *= (const Variable &v)
bool	EqualTo (const Polynomial &p) const
	Returns true if this polynomial and p are structurally equal. More...
bool	EqualToAfterExpansion (const Polynomial &p) const
	Returns true if this polynomial and p are equal, after expanding the coefficients. More...
bool	CoefficientsAlmostEqual (const Polynomial &p, double tol) const
	Returns true if this polynomial and are almost equal (the difference in the corresponding coefficients are all less than tol), after expanding the coefficients. More...
Formula	operator== (const Polynomial &p) const
	Returns a symbolic formula representing the condition where this polynomial and p are the same. More...
Formula	operator!= (const Polynomial &p) const
	Returns a symbolic formula representing the condition where this polynomial and p are not the same. More...
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	Polynomial (const Polynomial &)=default
Polynomial &	operator= (const Polynomial &)=default
	Polynomial (Polynomial &&)=default
Polynomial &	operator= (Polynomial &&)=default

Friends
template<class HashAlgorithm >
void	hash_append (HashAlgorithm &hasher, const Polynomial &item) noexcept
	Implements the hash_append generic hashing concept. More...
Polynomial	operator/ (Polynomial p, double v)
	Returns p / v. More...

Member Typedef Documentation

MapType

using MapType = std::map<Monomial, Expression, internal::CompareMonomial>

Constructor & Destructor Documentation

Polynomial() [1/8]

Polynomial ( )

default

Constructs a zero polynomial.

Polynomial() [2/8]

Polynomial ( const Polynomial &  )

default

Polynomial() [3/8]

Polynomial ( Polynomial &&  )

default

Polynomial() [4/8]

Polynomial ( std::nullptr_t  )

explicit

Constructs a default value.

This overload is used by Eigen when EIGEN_INITIALIZE_MATRICES_BY_ZERO is enabled.

Polynomial() [5/8]

Polynomial ( MapType  init )

explicit

Constructs a polynomial from a map, Monomial → Expression.

Polynomial() [6/8]

Polynomial

(

const Monomial &

m

)

Constructs a polynomial from a monomial m.

Note that all variables in m are considered as indeterminates.

Polynomial() [7/8]

Polynomial ( const Expression &  e )

explicit

Constructs a polynomial from an expression e.

Note that all variables in e are considered as indeterminates.

Exceptions

std::runtime_error

if e is not a polynomial.

Polynomial() [8/8]

Polynomial	(	const Expression &	e,
		Variables	indeterminates
	)

Constructs a polynomial from an expression e by decomposing it with respect to indeterminates.

Note

It collects the intersection of the variables appeared in e and the provided indeterminates.

Exceptions

std::runtime_error

if e is not a polynomial in indeterminates.

Member Function Documentation

AddProduct()

Polynomial& AddProduct	(	const Expression &	coeff,
		const Monomial &	m
	)

Adds coeff * m to this polynomial.

CoefficientsAlmostEqual()

bool CoefficientsAlmostEqual	(	const Polynomial &	p,
		double	tol
	)		const

Returns true if this polynomial and are almost equal (the difference in the corresponding coefficients are all less than tol), after expanding the coefficients.

decision_variables()

const Variables& decision_variables

(

)

const

Returns the decision variables of this polynomial.

Degree()

int Degree

(

const Variable &

v

)

const

Returns the highest degree of this polynomial in a variable v.

Differentiate()

Polynomial Differentiate

(

const Variable &

x

)

const

Differentiates this polynomial with respect to the variable x.

Note that a variable x can be either a decision variable or an indeterminate.

EqualTo()

bool EqualTo

(

const Polynomial &

p

)

const

Returns true if this polynomial and p are structurally equal.

EqualToAfterExpansion()

bool EqualToAfterExpansion

(

const Polynomial &

p

)

const

Returns true if this polynomial and p are equal, after expanding the coefficients.

Evaluate()

double Evaluate

(

const Environment &

env

)

const

Evaluates this polynomial under a given environment env.

Exceptions

std::out_of_range

if there is a variable in this polynomial whose assignment is not provided by env.

EvaluatePartial() [1/2]

Polynomial EvaluatePartial

(

const Environment &

env

)

const

Partially evaluates this polynomial using an environment env.

Exceptions

std::runtime_error

if NaN is detected during evaluation.

EvaluatePartial() [2/2]

Polynomial EvaluatePartial	(	const Variable &	var,
		double	c
	)		const

Partially evaluates this polynomial by substituting var with c.

Exceptions

std::runtime_error

if NaN is detected at any point during evaluation.

indeterminates()

const Variables& indeterminates

(

)

const

Returns the indeterminates of this polynomial.

Integrate() [1/2]

Polynomial Integrate

(

const Variable &

x

)

const

Integrates this polynomial with respect to an indeterminate x.

Integration with respect to decision variables is not supported yet. If x is not an indeterminate nor decision variable, then it will be added to the list of indeterminates.

Exceptions

std::exception

if x is a decision variable.

Integrate() [2/2]

Polynomial Integrate	(	const Variable &	x,
		double	a,
		double	b
	)		const

Computes the definite integrate of this polynomial with respect to the indeterminate x over the domain [a, b].

Integration with respect to decision variables is not supported yet.

Exceptions

std::exception

if x is a decision variable.

Jacobian()

Eigen::Matrix<Polynomial, 1, Derived::RowsAtCompileTime> Jacobian

(

const Eigen::MatrixBase< Derived > &

vars

)

const

Computes the Jacobian matrix J of the polynomial with respect to vars.

J(0,i) contains ∂f/∂vars(i).

monomial_to_coefficient_map()

const MapType& monomial_to_coefficient_map

(

)

const

Returns the mapping from a Monomial to its corresponding coefficient of this polynomial.

operator *=() [1/4]

Polynomial& operator *=

(

const Polynomial &

p

)

operator *=() [2/4]

Polynomial& operator *=

(

const Monomial &

m

)

operator *=() [3/4]

Polynomial& operator *=

(

double

c

)

operator *=() [4/4]

Polynomial& operator *=

(

const Variable &

v

)

operator!=()

Formula operator!=

(

const Polynomial &

p

)

const

Returns a symbolic formula representing the condition where this polynomial and p are not the same.

operator+=() [1/4]

Polynomial& operator+=

(

const Polynomial &

p

)

operator+=() [2/4]

Polynomial& operator+=

(

const Monomial &

m

)

operator+=() [3/4]

Polynomial& operator+=

(

double

c

)

operator+=() [4/4]

Polynomial& operator+=

(

const Variable &

v

)

operator-=() [1/4]

Polynomial& operator-=

(

const Polynomial &

p

)

operator-=() [2/4]

Polynomial& operator-=

(

const Monomial &

m

)

operator-=() [3/4]

Polynomial& operator-=

(

double

c

)

operator-=() [4/4]

Polynomial& operator-=

(

const Variable &

v

)

operator=() [1/2]

Polynomial& operator= ( const Polynomial &  )

default

operator=() [2/2]

Polynomial& operator= ( Polynomial &&  )

default

operator==()

Formula operator==

(

const Polynomial &

p

)

const

Returns a symbolic formula representing the condition where this polynomial and p are the same.

RemoveTermsWithSmallCoefficients()

Polynomial RemoveTermsWithSmallCoefficients

(

double

coefficient_tol

)

const

Removes the terms whose absolute value of the coefficients are smaller than or equal to coefficient_tol For example, if the polynomial is 2x² + 3xy + 10⁻⁴x - 10⁻⁵, then after calling RemoveTermsWithSmallCoefficients(1e-3), the returned polynomial becomes 2x² + 3xy.

Parameters

coefficient_tol

A positive scalar.

Return values

polynomial_cleaned

A polynomial whose terms with small coefficients are removed.

SetIndeterminates()

void SetIndeterminates

(

const Variables &

new_indeterminates

)

Sets the indeterminates to new_indeterminates.

Changing the indeterminates would change monomial_to_coefficient_map(), and also potentially the degree of the polynomial. Here is an example.

// p is a quadratic polynomial with x being the indeterminates.
symbolic::Polynomial p(a * x * x + b * x + c, {x});
// p.monomial_to_coefficient_map() contains {1: c, x: b, x*x:a}.
std::cout << p.TotalDegree(); // prints 2.
// Now set (a, b, c) to the indeterminates. p becomes a linear
// polynomial of a, b, c.
p.SetIndeterminates({a, b, c});
// p.monomial_to_coefficient_map() now is {a: x * x, b: x, c: 1}.
std::cout << p.TotalDegree(); // prints 1.

ToExpression()

Expression ToExpression

(

)

const

Returns an equivalent symbolic expression of this polynomial.

TotalDegree()

int TotalDegree

(

)

const

Returns the total degree of this polynomial.

Friends And Related Function Documentation

hash_append

void hash_append ( HashAlgorithm &  hasher, const Polynomial &  item  )

friend

Implements the hash_append generic hashing concept.

operator/

Polynomial operator/ ( Polynomial  p, double  v  )

friend

Returns p / v.

---

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

• drake/common/symbolic_polynomial.h