BooleRing Class Reference

This class is just a wrapper for reinterpreting decicion diagram managers as Boolean polynomial rings. More...

#include <BooleRing.h>

Inheritance diagram for BooleRing:
COrderEnums CCompareEnums CAuxTypes BoolePolyRing

List of all members.

Public Types

typedef BooleRing self
 generic access to current type
typedef CTypes::orderenums_type base
 generic access to base type
enum  ordercodes
 

Explicitely mention ordercodes' enumeration.

More...
adopt global type definitions

typedef CTypes::ordercode_type ordercode_type
 Type for ordering codes.
typedef CTypes::manager_type manager_type
typedef CTypes::manager_reference manager_reference
typedef CTypes::manager_ptr manager_ptr
typedef CTypes::dd_type dd_type
typedef CTypes::vartext_type vartext_type
 Type for setting/getting names of variables.

Public Member Functions

 BooleRing (size_type nvars=100)
 Constructor for nvars variables.
 BooleRing (const manager_type &mgr)
 ~BooleRing ()
 destructor
manager_typemanager ()
 Access to decision diagram manager.
const manager_typemanager () const
 Constant access to decision diagram manager.
dd_type ddVariable (idx_type nvar) const
 Access nvar-th variable of decision diagram manager.
dd_type variable (idx_type nvar) const
 Access nvar-th ring variable.
dd_type persistentVariable (idx_type nvar) const
 Access nvar-th ring variable.
dd_type zero () const
 Get empty decision diagram.
dd_type one () const
 Get decision diagram with all variables negated.
size_type nVariables () const
 Get number of ring variables.
vartext_type getVariableName (idx_type idx)
 Get name of variable with index idx.
void setVariableName (idx_type idx, vartext_type varname)
 Set name of variable with index idx.
void clearCache ()
 Clears the function cache.
void printInfo ()
 Print out statistics and settings for current ring.
self clone () const
 Generate ring based on the same manager.
hash_type hash () const
 Get unique identifier for *this.

Protected Attributes

manager_type m_mgr
 Interprete m_mgr as structure of Boolean polynomial ring.

Detailed Description

This class is just a wrapper for reinterpreting decicion diagram managers as Boolean polynomial rings.


Member Typedef Documentation

generic access to base type

Reimplemented in BoolePolyRing.

typedef CTypes::manager_ptr BooleRing::manager_ptr

Type for ordering codes.

Reimplemented from CAuxTypes.

generic access to current type

Reimplemented in BoolePolyRing.

Type for setting/getting names of variables.

Reimplemented from CAuxTypes.


Member Enumeration Documentation

Explicitely mention ordercodes' enumeration.


Constructor & Destructor Documentation

BooleRing::BooleRing ( size_type  nvars = 100  )  [inline]

Constructor for nvars variables.

BooleRing::BooleRing ( const manager_type mgr  )  [inline]
BooleRing::~BooleRing (  )  [inline]

destructor


Member Function Documentation

void BooleRing::clearCache (  )  [inline]

Clears the function cache.

References m_mgr.

self BooleRing::clone (  )  const [inline]

Generate ring based on the same manager.

Reimplemented in BoolePolyRing.

References m_mgr.

Referenced by BoolePolyRing::clone().

dd_type BooleRing::ddVariable ( idx_type  nvar  )  const [inline]

Access nvar-th variable of decision diagram manager.

References m_mgr.

vartext_type BooleRing::getVariableName ( idx_type  idx  )  [inline]

Get name of variable with index idx.

References m_mgr.

Referenced by BooleEnv::getVariableName().

hash_type BooleRing::hash (  )  const [inline]

Get unique identifier for *this.

References m_mgr.

const manager_type& BooleRing::manager (  )  const [inline]

Constant access to decision diagram manager.

References m_mgr.

manager_type& BooleRing::manager (  )  [inline]

Access to decision diagram manager.

References m_mgr.

Referenced by BooleEnv::manager().

size_type BooleRing::nVariables (  )  const [inline]

Get number of ring variables.

References m_mgr.

dd_type BooleRing::one (  )  const [inline]

Get decision diagram with all variables negated.

References m_mgr.

Referenced by BooleEnv::one(), and BoolePolynomial::operator+=().

dd_type BooleRing::persistentVariable ( idx_type  nvar  )  const [inline]

Access nvar-th ring variable.

References m_mgr.

void BooleRing::printInfo (  )  [inline]

Print out statistics and settings for current ring.

References m_mgr.

Referenced by BooleEnv::printInfo().

void BooleRing::setVariableName ( idx_type  idx,
vartext_type  varname 
) [inline]

Set name of variable with index idx.

References m_mgr.

Referenced by BooleEnv::setVariableName().

dd_type BooleRing::variable ( idx_type  nvar  )  const [inline]

Access nvar-th ring variable.

References m_mgr.

dd_type BooleRing::zero (  )  const [inline]

Get empty decision diagram.

References m_mgr.

Referenced by BoolePolynomial::operator*=(), and BooleEnv::zero().


Member Data Documentation

Interprete m_mgr as structure of Boolean polynomial ring.

Referenced by clearCache(), clone(), ddVariable(), getVariableName(), hash(), manager(), nVariables(), one(), persistentVariable(), printInfo(), setVariableName(), variable(), and zero().


The documentation for this class was generated from the following file:
Generated on Thu Aug 5 12:57:28 2010 for PolyBoRi by  doxygen 1.6.3