carl::ReductorEntry< Polynomial > Class Template Reference
An entry in the reduction polynomial. More...
#include <ReductorEntry.h>
Collaboration diagram for carl::ReductorEntry< Polynomial >:
Public Member Functions | |
| ReductorEntry (const Term< Coeff > &multiple, const Polynomial &pol) | |
| Constructor with a factor and a polynomial. More... | |
| ReductorEntry (const Term< Coeff > &pol) | |
| Constructor with implicit factor = 1. More... | |
| const Polynomial & | getTail () const |
| const Term< Coeff > & | getLead () const |
| const Term< Coeff > & | getMultiple () const |
| void | removeLeadingTerm () |
| Calculate p - lt(p). More... | |
| bool | addCoefficient (const Coeff &coeffToBeAdded) |
| bool | empty () const |
| void | print (std::ostream &os=std::cout) |
| Output the current polynomial. More... | |
Protected Types | |
| using | Coeff = typename Polynomial::CoeffType |
Protected Attributes | |
| Polynomial | mTail |
| Term< Coeff > | mLead |
| Term< Coeff > | mMultiple |
Friends | |
| template<class C > | |
| std::ostream & | operator<< (std::ostream &os, const ReductorEntry< C > rhs) |
Detailed Description
template<class Polynomial>
class carl::ReductorEntry< Polynomial >
An entry in the reduction polynomial.
The class decodes a polynomial given by mLead + mMultiple * mTail.
Definition at line 24 of file ReductorEntry.h.
Member Typedef Documentation
◆ Coeff
template<class Polynomial >
|
protected |
Definition at line 27 of file ReductorEntry.h.
Constructor & Destructor Documentation
◆ ReductorEntry() [1/2]
template<class Polynomial >
|
inline |
Constructor with a factor and a polynomial.
- Parameters
-
multiple pol Resulting polynomial = multiple * pol.
Definition at line 39 of file ReductorEntry.h.
Here is the call graph for this function:
◆ ReductorEntry() [2/2]
template<class Polynomial >
|
inlineexplicit |
Member Function Documentation
◆ addCoefficient()
template<class Polynomial >
|
inline |
- Parameters
-
coeffToBeAdded
- Returns
Definition at line 96 of file ReductorEntry.h.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ empty()
template<class Polynomial >
|
inline |
- Returns
- true iff the polynomial equals zero
Definition at line 121 of file ReductorEntry.h.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getLead()
template<class Polynomial >
|
inline |
◆ getMultiple()
template<class Polynomial >
|
inline |
- Returns
Definition at line 75 of file ReductorEntry.h.
◆ getTail()
template<class Polynomial >
|
inline |
- Returns
- The tail of the polynomial, not multiplied by the correct factor!
Definition at line 57 of file ReductorEntry.h.
◆ print()
template<class Polynomial >
|
inline |
Output the current polynomial.
- Parameters
-
os
Definition at line 131 of file ReductorEntry.h.
Here is the call graph for this function:
◆ removeLeadingTerm()
template<class Polynomial >
|
inline |
Calculate p - lt(p).
Definition at line 83 of file ReductorEntry.h.
Here is the call graph for this function:
Here is the caller graph for this function:
Friends And Related Function Documentation
◆ operator<<
template<class Polynomial >
template<class C >
|
friend |
Definition at line 150 of file ReductorEntry.h.
Field Documentation
◆ mLead
template<class Polynomial >
|
protected |
Definition at line 29 of file ReductorEntry.h.
◆ mMultiple
template<class Polynomial >
|
protected |
Definition at line 30 of file ReductorEntry.h.
◆ mTail
template<class Polynomial >
|
protected |
Definition at line 28 of file ReductorEntry.h.
The documentation for this class was generated from the following file:
- carl-arith/groebner/ReductorEntry.h
