PolyBoRi
Public Types | Static Public Member Functions
polybori::BooleEnv Class Reference

This class is just a wrapper accessing global structures. More...

#include <BooleEnv.h>

Inheritance diagram for polybori::BooleEnv:
polybori::COrderEnums polybori::CCompareEnums polybori::CAuxTypes

List of all members.

Public Types

typedef BooleEnv self
 generic access to current type
typedef CTypes::orderenums_type base
 generic access to base type
typedef std::vector< idx_typeblock_idx_type
 Type for block indices.
typedef
block_idx_type::const_iterator 
block_iterator
 Type for block iterators.
typedef BoolePolyRing ring_type
typedef COrderingBase order_type
enum  ordercodes
 Explicitely mention ordercodes' enumeration. More...
adopt global type definitions
typedef CTypes::ordercode_type ordercode_type
 Type for ordering codes.
typedef BoolePolyRing::dd_type dd_type
typedef CTypes::vartext_type vartext_type
 Type for setting/getting names of variables.

Static Public Member Functions

static dd_type variable (idx_type idx)
 Access idx-th variable of the active ring.
static ordercode_type getOrderCode ()
 Get numerical code for current ordering.
static ordercode_type getBaseOrderCode ()
static dd_type zero ()
 Get empty decision diagram.
static dd_type one ()
 Get decision diagram with all variables negated.
static size_type nVariables ()
 Get number of ring variables the of active ring.
static ring_typering ()
static order_typeordering ()
static void setVariableName (idx_type idx, vartext_type varname)
 Set name of variable with index idx.
static vartext_type getVariableName (idx_type idx)
 Get name of variable with index idx.
static void changeOrdering (ordercode_type code)
 Change order of current ring.
static ostream_typeprint (ostream_type &)
 Print low-level information.
static void set (ring_type &theRing)
 Activate given ring.
interface for block orderings, if the vcurrent orderins is a block ordering
static block_iterator blockBegin ()
static block_iterator blockEnd ()
 Returns end marker of iteration.
static void appendBlock (idx_type idx)
 Add index where the next block starts.
static void clearBlocks ()
 Reset block-related data.
static idx_type lastBlockStart ()
 Index where the last blocks starts.

Detailed Description

This class is just a wrapper accessing global structures.


Member Typedef Documentation

generic access to base type

Type for block indices.

typedef block_idx_type::const_iterator polybori::BooleEnv::block_iterator

Type for block iterators.

Type for ordering codes.

Reimplemented from polybori::CAuxTypes.

generic access to current type

Type for setting/getting names of variables.

Reimplemented from polybori::CAuxTypes.


Member Enumeration Documentation

Explicitely mention ordercodes' enumeration.


Member Function Documentation

void polybori::BooleEnv::appendBlock ( idx_type  idx) [static]

Add index where the next block starts.

BooleEnv::block_iterator polybori::BooleEnv::blockBegin ( ) [static]

Returns iterator over the indices, where the (next) block starts. (The first one implicitely starts at zero.)

Todo:
needs inlining!!!
BooleEnv::block_iterator polybori::BooleEnv::blockEnd ( ) [static]

Returns end marker of iteration.

void polybori::BooleEnv::changeOrdering ( ordercode_type  code) [static]

Change order of current ring.

void polybori::BooleEnv::clearBlocks ( ) [static]

Reset block-related data.

BooleEnv::ordercode_type polybori::BooleEnv::getBaseOrderCode ( ) [static]

Get numerical code for current base ordering (the same for non-block orderings)

BooleEnv::ordercode_type polybori::BooleEnv::getOrderCode ( ) [static]

Get numerical code for current ordering.

References polybori::COrderingBase::getOrderCode().

BooleEnv::vartext_type polybori::BooleEnv::getVariableName ( idx_type  idx) [static]

Get name of variable with index idx.

BooleEnv::idx_type polybori::BooleEnv::lastBlockStart ( ) [static]

Index where the last blocks starts.

BooleEnv::size_type polybori::BooleEnv::nVariables ( ) [static]

Get number of ring variables the of active ring.

BooleEnv::dd_type polybori::BooleEnv::one ( ) [static]

Get decision diagram with all variables negated.

BooleEnv::order_type & polybori::BooleEnv::ordering ( ) [static]
BooleEnv::ostream_type & polybori::BooleEnv::print ( ostream_type os) [static]

Print low-level information.

static ring_type& polybori::BooleEnv::ring ( ) [inline, static]
void polybori::BooleEnv::set ( ring_type theRing) [static]
void polybori::BooleEnv::setVariableName ( idx_type  idx,
vartext_type  varname 
) [static]

Set name of variable with index idx.

BooleEnv::dd_type polybori::BooleEnv::variable ( idx_type  idx) [static]

Access idx-th variable of the active ring.

BooleEnv::dd_type polybori::BooleEnv::zero ( ) [static]

Get empty decision diagram.


The documentation for this class was generated from the following files: