pbori_defs.h File Reference

#include <cstddef>
#include <cuddObj.hh>
#include <iostream>
#include <boost/shared_ptr.hpp>

Go to the source code of this file.

Classes
class	polybori::COrderEnums
	This struct contains type definitions and enumerations to be used for order codes. More...
class	polybori::CErrorEnums
	This struct contains type definitions and enumerations to be used for error codes. More...
class	polybori::CCompareEnums
	This struct contains type definitions and enumerations to be used for comparisons. More...
class	polybori::CAuxTypes
	This struct contains auxiliary type definitions. More...
class	polybori::CTypes
	This struct contains type definitions to be used in library classes. More...
Namespaces
namespace	polybori
Defines
#define	LIKELY(expression)   (expression)
	For optimizing if-branches.
#define	UNLIKELY(expression)   (expression)
#define	PBORINAME   polybori
	Name the project.
#define	PBORI_DEVELOPER
	Define deverloper's mode.
#define	BEGIN_NAMESPACE_PBORI   namespace PBORINAME {
	Start project's namespace.
#define	END_NAMESPACE_PBORI   }
	Finish project's namespace.
#define	USING_NAMESPACE_PBORI   using namespace PBORINAME;
	Use project's namespace.
#define	PBORI   PBORINAME
	Access something in project's namespace using PBORI::
#define	USING_PBORI   using PBORI
	Using something from project's namespace.
#define	PBORI_BEGIN_NAMESPACE(sub_space)   namespace sub_space {
	Start some namespace.
#define	PBORI_END_NAMESPACE   }
	Finish some namespace.
#define	PBORI_TRACE_FUNC(text)
	Generate trace function if debugging.
#define	PBORI_OSTREAM   std::ostream
	Get output stream type.
#define	PBORI_SHARED_PTR(Type)   boost::shared_ptr<Type>
	Get shared pointer type.
#define	PBORI_NOT_IMPLEMENTED   throw PBORI::PBoRiError(PBORI::CTypes::not_implemented);
#define	PBORI_ADD_BY_XOR
#define	PBORI_LOWLEVEL_XOR
#define	PBORI_USEDVARS_BY_IDX
Functions
template<class ValueType >
void	polybori::pbori_shared_ptr_postclean (const boost::shared_ptr< ValueType > &, const boost::shared_ptr< ValueType > &)

---

Detailed Description

Author:

Alexander Dreyer

Date:

2006-03-06

This file defines some types, macros and other settings to be used with the polybori library.

Note:

Uses c++ namespace if PBORI_NO_NAMESPACES is undefined.

Copyright:

(c) 2006 by The PolyBoRi Team

---

Define Documentation

#define BEGIN_NAMESPACE_PBORI   namespace PBORINAME {

Start project's namespace.

#define END_NAMESPACE_PBORI   }

Finish project's namespace.

#define LIKELY

(

expression

)

(expression)

For optimizing if-branches.

Referenced by polybori::handle_error< 0 >::operator()(), polybori::CCuddZDD::operator=(), and polybori::CIndexCacheHandle< NaviType >::toNode().

#define PBORI   PBORINAME

Access something in project's namespace using PBORI::

#define PBORI_ADD_BY_XOR

#define PBORI_BEGIN_NAMESPACE

(

sub_space

)

namespace sub_space {

Start some namespace.

#define PBORI_DEVELOPER

Define deverloper's mode.

#define PBORI_END_NAMESPACE   }

Finish some namespace.

#define PBORI_LOWLEVEL_XOR

#define PBORI_NOT_IMPLEMENTED   throw PBORI::PBoRiError(PBORI::CTypes::not_implemented);

#define PBORI_OSTREAM   std::ostream

Get output stream type.

#define PBORI_SHARED_PTR

(

Type

)

boost::shared_ptr<Type>

Get shared pointer type.

Referenced by polybori::get_ordering().

#define PBORI_TRACE_FUNC

(

text

)

Generate trace function if debugging.

Referenced by polybori::BoolePolyRing::activate(), polybori::BooleExponent::BooleExponent(), polybori::BooleMonomial::BooleMonomial(), polybori::BoolePolynomial::BoolePolynomial(), polybori::BoolePolyRing::BoolePolyRing(), polybori::BooleSet::BooleSet(), polybori::BoolePolynomial::boundedLead(), polybori::BoolePolynomial::boundedLeadExp(), polybori::CCuddLastIter::CCuddLastIter(), polybori::PBoRiError::code(), polybori::BoolePolynomial::degBegin(), polybori::BoolePolynomial::degEnd(), polybori::BooleMonomial::exp(), polybori::BooleSet::expBegin(), polybori::BooleSet::expEnd(), polybori::BoolePolynomial::fetchTerms(), polybori::BoolePolynomial::firstTerm(), polybori::BooleMonomial::firstVariable(), polybori::BooleMonomial::GCD(), polybori::BooleMonomial::GCDAssign(), polybori::BoolePolynomial::gradedPart(), greater_variable(), polybori::CCuddNavigator::incrementElse(), polybori::CCuddNavigator::incrementThen(), polybori::BooleExponent::insertConst(), polybori::CCuddNavigator::isConstant(), polybori::BooleMonomial::LCM(), polybori::BooleMonomial::LCMAssign(), polybori::BooleMonomial::LCMDeg(), polybori::BoolePolynomial::lexLead(), polybori::BoolePolynomial::lexLmDeg(), polybori::BoolePolynomial::lmDeg(), polybori::BoolePolynomial::lmStableHash(), polybori::BoolePolynomial::lmTotalDeg(), polybori::BooleMonomial::multiples(), polybori::BooleExponent::multiplyFirst(), polybori::BoolePolynomial::nUsedVariables(), polybori::CCuddNavigator::operator*(), polybori::CCuddLastIter::operator++(), polybori::BoolePolynomial::operator/=(), polybori::BoolePolynomial::orderedBegin(), polybori::BoolePolynomial::orderedEnd(), polybori::BoolePolynomial::orderedExpBegin(), polybori::BoolePolynomial::orderedExpEnd(), polybori::BooleExponent::push_back(), polybori::BoolePolynomial::reducibleBy(), polybori::BooleExponent::remove(), polybori::BooleExponent::removeConst(), polybori::CCuddNavigator::terminalValue(), polybori::CCuddLastIter::terminateConstant(), polybori::BoolePolynomial::terms(), polybori::PBoRiError::text(), polybori::BoolePolynomial::totalDeg(), polybori::BooleSet::usedVariablesExp(), polybori::BooleExponent::~BooleExponent(), polybori::CCuddGetNode::~CCuddGetNode(), polybori::CCuddLastIter::~CCuddLastIter(), and polybori::PBoRiError::~PBoRiError().

#define PBORI_USEDVARS_BY_IDX

#define PBORINAME   polybori

Name the project.

#define UNLIKELY

(

expression

)

(expression)

Referenced by polybori::BoolePolynomial::boundedLead(), polybori::BoolePolynomial::boundedLeadExp(), polybori::CCuddDDBase< CCuddZDD >::checkReturnValue(), polybori::CCuddInterface::checkReturnValue(), polybori::handle_error< ErrorNumber >::found(), polybori::CIndexHandle< NaviType >::fromNode(), polybori::BoolePolynomial::lexLead(), polybori::BoolePolynomial::lexLmDeg(), PBORINAME::groebner::LiteralFactorization::LiteralFactorization(), polybori::BoolePolynomial::lmDeg(), polybori::handle_error< ErrorNumber >::operator()(), polybori::BoolePolynomial::operator/=(), polybori::CCuddZDD::operator=(), polybori::CVariableNames::operator[](), polybori::CCuddZDD::print(), and polybori::CVariableNames::set().

#define USING_NAMESPACE_PBORI   using namespace PBORINAME;

Use project's namespace.

#define USING_PBORI   using PBORI

Using something from project's namespace.