polybori::BooleConstant Class Reference
This class wraps a bool value, which was not converted to a boolean polynomial or monomial yet. More...
#include <BooleConstant.h>
Public Types | |
| typedef const self * | const_iterator |
| Define dummy iterator. | |
Public Member Functions | |
| BooleConstant () | |
| Default constructor. | |
| BooleConstant (bool value) | |
| constructor for bool values | |
| BooleConstant (short value) | |
| Constructor for short integer values (nontrivial conversion). | |
| BooleConstant (unsigned short value) | |
| Constructor for unsigned shoer integer values (nontrivial conversion). | |
| BooleConstant (int value) | |
| Constructor for integer values (nontrivial conversion). | |
| BooleConstant (unsigned int value) | |
| Constructor for unsigned integer values (nontrivial conversion). | |
| BooleConstant (long value) | |
| Constructor for long integer values (nontrivial conversion). | |
| BooleConstant (unsigned long value) | |
| Constructor for unsigned long integer values (nontrivial conversion). | |
| operator bool () const | |
| Convert to bool value. | |
| BooleConstant | operator! () const |
| Negation operation. | |
| deg_type | deg () const |
| Get constant degree. | |
| const_iterator | orderedBegin () const |
| Start polynomial-style iterations. | |
| const_iterator | orderedEnd () const |
| Finish polynomial-style iterations. | |
| const_iterator | variableBegin () const |
| Start empty monomial iteration. | |
| const_iterator | variableEnd () const |
| Finish empty monomial iteration. | |
| bool | isOne () const |
| Mimic constant monomial or polynmomial term. | |
| bool | isZero () const |
| bool | isConstant () const |
| bool | hasConstantPart () const |
Protected Attributes | |
| const bool | m_value |
| Boolean value is stored as simple bool. | |
Detailed Description
This class wraps a bool value, which was not converted to a boolean polynomial or monomial yet.
This is mostly equivalent to the built-in type bool. Only conversion from integer values to BooleConstant is nontrivial, as it involves the modulo 2 operation.
The class partially implements the interfaces of BoolePolynomial and BooleMonomial.
- Note:
- Since BooleConstant(1) may be interpreted as monomial as well as polynomial, we skip member functions, that have different meanings for polynomials and monomials (like begin() and end()).
Member Typedef Documentation
| typedef const self* polybori::BooleConstant::const_iterator |
Define dummy iterator.
Constructor & Destructor Documentation
| polybori::BooleConstant::BooleConstant | ( | ) | [inline] |
Default constructor.
| polybori::BooleConstant::BooleConstant | ( | bool | value | ) | [inline] |
constructor for bool values
| polybori::BooleConstant::BooleConstant | ( | short | value | ) | [inline] |
Constructor for short integer values (nontrivial conversion).
| polybori::BooleConstant::BooleConstant | ( | unsigned short | value | ) | [inline] |
Constructor for unsigned shoer integer values (nontrivial conversion).
| polybori::BooleConstant::BooleConstant | ( | int | value | ) | [inline] |
Constructor for integer values (nontrivial conversion).
| polybori::BooleConstant::BooleConstant | ( | unsigned int | value | ) | [inline] |
Constructor for unsigned integer values (nontrivial conversion).
| polybori::BooleConstant::BooleConstant | ( | long | value | ) | [inline] |
Constructor for long integer values (nontrivial conversion).
| polybori::BooleConstant::BooleConstant | ( | unsigned long | value | ) | [inline] |
Constructor for unsigned long integer values (nontrivial conversion).
Member Function Documentation
| polybori::BooleConstant::operator bool | ( | ) | const [inline] |
Convert to bool value.
| BooleConstant polybori::BooleConstant::operator! | ( | ) | const [inline] |
Negation operation.
| deg_type polybori::BooleConstant::deg | ( | ) | const [inline] |
Get constant degree.
| const_iterator polybori::BooleConstant::orderedBegin | ( | ) | const [inline] |
Start polynomial-style iterations.
| const_iterator polybori::BooleConstant::orderedEnd | ( | ) | const [inline] |
Finish polynomial-style iterations.
| const_iterator polybori::BooleConstant::variableBegin | ( | ) | const [inline] |
Start empty monomial iteration.
| const_iterator polybori::BooleConstant::variableEnd | ( | ) | const [inline] |
Finish empty monomial iteration.
| bool polybori::BooleConstant::isOne | ( | ) | const [inline] |
| bool polybori::BooleConstant::isZero | ( | ) | const [inline] |
| bool polybori::BooleConstant::isConstant | ( | ) | const [inline] |
| bool polybori::BooleConstant::hasConstantPart | ( | ) | const [inline] |
Member Data Documentation
const bool polybori::BooleConstant::m_value [protected] |
Boolean value is stored as simple bool.
The documentation for this class was generated from the following file:
