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	COrderEnums
	This struct contains type definitions and enumerations to be used for order codes. More...
class	CErrorEnums
	This struct contains type definitions and enumerations to be used for error codes. More...
class	CCompareEnums
	This struct contains type definitions and enumerations to be used for comparisons. More...
class	CAuxTypes
	This struct contains auxiliary type definitions. More...
class	CTypes
	This struct contains type definitions to be used in library classes. More...
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
#define	PBORI_ADD_BY_XOR
#define	PBORI_USEDVARS_BY_IDX
Functions
template<class ValueType >
BEGIN_NAMESPACE_PBORI void	pbori_shared_ptr_postclean (const PBORI_SHARED_PTR(ValueType)&, const PBORI_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 handle_error< 0 >::operator()(), CCuddZDD::operator=(), and 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_NOT_IMPLEMENTED

#define PBORI_OSTREAM   std::ostream

Get output stream type.

#define PBORI_SHARED_PTR

(

Type

)

boost::shared_ptr<Type>

Get shared pointer type.

#define PBORI_TRACE_FUNC

(

text

)

Generate trace function if debugging.

Referenced by BoolePolyRing::activate(), BooleSet::add(), BooleSet::addAssign(), BooleSet::begin(), BoolePolynomial::begin(), BooleExponent::BooleExponent(), BooleMonomial::BooleMonomial(), BoolePolynomial::BoolePolynomial(), BoolePolyRing::BoolePolyRing(), BooleSet::BooleSet(), BoolePolynomial::boundedLead(), BoolePolynomial::boundedLeadExp(), CCuddGetNode::CCuddGetNode(), CCuddLastIter::CCuddLastIter(), CErrorInfo::CErrorInfo(), BooleMonomial::change(), BooleExponent::change(), BooleMonomial::changeAssign(), BooleExponent::changeAssign(), BoolePolyRing::changeOrdering(), PBoRiError::code(), LexOrder::compare(), DegRevLexAscOrder::compare(), DegLexOrder::compare(), BooleMonomial::compare(), BooleExponent::compare(), BlockDegRevLexAscOrder::compare(), polybori::BlockDegLexOrder::compare(), BoolePolynomial::deg(), BoolePolynomial::degBegin(), BoolePolynomial::degEnd(), BooleExponent::divide(), BooleExponent::divisors(), BooleSet::divisorsOf(), BoolePolynomial::end(), BooleMonomial::exp(), BooleSet::expBegin(), BoolePolynomial::expBegin(), BooleSet::expEnd(), BoolePolynomial::expEnd(), BoolePolynomial::fetchTerms(), BoolePolynomial::firstBegin(), BoolePolynomial::firstDivisors(), BooleSet::firstDivisorsOf(), BoolePolynomial::firstEnd(), BoolePolynomial::firstTerm(), BooleMonomial::firstVariable(), BooleMonomial::GCD(), BooleExponent::GCD(), BooleMonomial::GCDAssign(), BoolePolynomial::genericBegin(), BoolePolynomial::genericEnd(), BoolePolynomial::genericExpBegin(), BoolePolynomial::genericExpEnd(), BooleExponent::get(), BoolePolynomial::gradedPart(), polybori::greater_variable(), CCuddNavigator::incrementElse(), CCuddNavigator::incrementThen(), BooleExponent::insert(), BooleExponent::insertConst(), CCuddNavigator::isConstant(), BooleSet::lastLexicographicalTerm(), BooleMonomial::LCM(), BooleExponent::LCM(), BooleMonomial::LCMAssign(), BooleMonomial::LCMDeg(), BooleExponent::LCMDeg(), LexOrder::lead(), DegRevLexAscOrder::lead(), DegLexOrder::lead(), BoolePolynomial::lead(), BlockDegRevLexAscOrder::lead(), LexOrder::leadExp(), DegRevLexAscOrder::leadExp(), DegLexOrder::leadExp(), BoolePolynomial::leadExp(), BlockDegRevLexAscOrder::leadExp(), LexOrder::leadExpIteratorBegin(), DegRevLexAscOrder::leadExpIteratorBegin(), DegLexOrder::leadExpIteratorBegin(), BlockDegRevLexAscOrder::leadExpIteratorBegin(), LexOrder::leadExpIteratorEnd(), DegRevLexAscOrder::leadExpIteratorEnd(), DegLexOrder::leadExpIteratorEnd(), BlockDegRevLexAscOrder::leadExpIteratorEnd(), BoolePolynomial::leadFirst(), LexOrder::leadIteratorBegin(), DegRevLexAscOrder::leadIteratorBegin(), DegLexOrder::leadIteratorBegin(), BlockDegRevLexAscOrder::leadIteratorBegin(), LexOrder::leadIteratorEnd(), DegRevLexAscOrder::leadIteratorEnd(), DegLexOrder::leadIteratorEnd(), BoolePolynomial::length(), BoolePolynomial::lexLead(), BoolePolynomial::lexLmDeg(), BoolePolynomial::lmDeg(), BoolePolynomial::lmStableHash(), BoolePolynomial::lmTotalDeg(), BooleMonomial::multiples(), BooleExponent::multiples(), BooleExponent::multiply(), BooleExponent::multiplyFirst(), BoolePolynomial::nNodes(), BoolePolynomial::nUsedVariables(), BoolePolynomial::operator%=(), CCuddGetNode::operator()(), CCuddNavigator::operator*(), BoolePolynomial::operator*=(), BooleMonomial::operator*=(), CCuddLastIter::operator++(), BoolePolynomial::operator+=(), BoolePolynomial::operator/=(), BooleMonomial::operator/=(), BoolePolynomial::orderedBegin(), BoolePolynomial::orderedEnd(), BoolePolynomial::orderedExpBegin(), BoolePolynomial::orderedExpEnd(), BooleSet::owns(), PBoRiError::PBoRiError(), BoolePolynomial::prettyPrint(), BoolePolynomial::print(), BooleExponent::print(), BooleExponent::push_back(), BoolePolynomial::reducibleBy(), BooleMonomial::reducibleBy(), BooleExponent::reducibleBy(), BooleExponent::remove(), BooleExponent::removeConst(), CCuddNavigator::terminalValue(), CCuddLastIter::terminateConstant(), BoolePolynomial::terms(), PBoRiError::text(), CErrorInfo::text(), BoolePolynomial::totalDeg(), BoolePolynomial::usedVariables(), BooleSet::usedVariablesExp(), BoolePolynomial::usedVariablesExp(), BooleExponent::~BooleExponent(), CCuddGetNode::~CCuddGetNode(), CCuddLastIter::~CCuddLastIter(), and PBoRiError::~PBoRiError().

#define PBORI_USEDVARS_BY_IDX

#define PBORINAME   polybori

Name the project.

#define UNLIKELY

(

expression

)

(expression)

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

#define USING_NAMESPACE_PBORI   using namespace PBORINAME;

Use project's namespace.

#define USING_PBORI   using PBORI

Using something from project's namespace.

---

Function Documentation

template<class ValueType >

BEGIN_NAMESPACE_PBORI void pbori_shared_ptr_postclean	(	const PBORI_SHARED_PTR(ValueType)&	,
		const PBORI_SHARED_PTR(ValueType)&
	)			[inline]