DDD  1.9.0.20240826145154
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
StrongHom Class Referenceabstract

The abstract base class for user defined operations. More...

#include <Hom.h>

Inheritance diagram for StrongHom:
Inheritance graph
Collaboration diagram for StrongHom:
Collaboration graph

Public Member Functions

 StrongHom ()
 Default constructor. More...
 
virtual ~StrongHom ()
 Default destructor. More...
 
virtual GDDD phiOne () const
 Evaluation over terminal GDDD::one. More...
 
virtual GHom phi (int var, int val) const =0
 Evaluation over an arbitrary arc of a SDD. More...
 
virtual bool operator== (const StrongHom &h) const =0
 Comparator is pure virtual. Define a behavior in user homomorphisms. More...
 
bool operator== (const _GHom &h) const
 Comparator for unicity table. More...
 
virtual void print (std::ostream &os) const
 pretty print More...
 
GDDD eval (const GDDD &) const
 The evaluation mechanism of strong homomorphisms. More...
 
virtual GDDD has_image (const GDDD &) const
 
GDDD has_image_skip (const GDDD &) const
 
virtual bool skip_variable (int) const
 The skip_variable predicate indicates which variables are "don't care" with respect to this SHom. More...
 
virtual bool is_selector () const
 The isSelector predicate indicates a homomorphism that only selects paths in the SDD (no modifications, no additions) Tagging with isSelector() allows to enable optimizations and makes the homomorphism eligible as "condition" in ITE construct. More...
 
virtual const GHom::range_t get_range () const
 The range returns the dual of skip_variable, default implem considers that all variables are affected by this homomorphism. More...
 
virtual GHom invert (const GDDD &) const
 returns the predescessor homomorphism, using pot to determine variable domains More...
 
bool operator< (const _GHom &h) const
 Ordering between _GHom. It is the chronological ordering of creation. More...
 
virtual size_t hash () const =0
 Hash key computation. More...
 
virtual _GHomclone () const =0
 
virtual void mark () const
 For garbage collection. Used in first phase of garbage collection. More...
 
virtual GHom negate () const
 returns a negation of a selector homomorphism h, such that h.negate() (d) = d - h(d) More...
 
virtual GHom compose (const GHom &r) const
 

Static Public Member Functions

static const _GHomget_concret (const GHom &ghom)
 

Private Member Functions

GDDD eval_skip (const GDDD &) const
 

Private Attributes

int refCounter
 For garbage collection. More...
 
bool marking
 For garbage collection. More...
 
bool immediat
 For operation cache management. More...
 
size_t creation_counter
 Counter of objects created (see constructors). More...
 

Detailed Description

The abstract base class for user defined operations.

This is the class users should derive their operations from. It defines the interface of a Strong Homomorphism :

Constructor & Destructor Documentation

◆ StrongHom()

StrongHom::StrongHom ( )
inline

Default constructor.

Empty behavior.

Todo:
Is this declaration useful ?

◆ ~StrongHom()

virtual StrongHom::~StrongHom ( )
inlinevirtual

Default destructor.

Empty behavior.

Todo:
Is this declaration useful ?

Member Function Documentation

◆ clone()

virtual _GHom* _GHom::clone ( ) const
pure virtualinherited

◆ compose()

GHom _GHom::compose ( const GHom r) const
virtualinherited

Reimplemented in _VarCompVar, and _VarCompState.

References GHom::id, and GDDD::null.

Referenced by _VarCompState::compose(), _VarCompVar::compose(), and GHom::compose().

◆ eval()

GDDD StrongHom::eval ( const GDDD d) const
virtual

The evaluation mechanism of strong homomorphisms.

Evaluation is defined as :

Let an SDD d= (var, Union_i (val_i, d_i) )

h (d) = Sum_i ( phi(var, val_i) (d_i) )

Implements _GHom.

References DED::add(), GDDD::begin(), GDDD::end(), GDDD::null, GDDD::one, phi(), phiOne(), GDDD::top, and GDDD::variable().

◆ eval_skip()

GDDD _GHom::eval_skip ( const GDDD d) const
privateinherited

◆ get_concret()

static const _GHom* _GHom::get_concret ( const GHom ghom)
inlinestaticinherited

◆ get_range()

virtual const GHom::range_t _GHom::get_range ( ) const
inlinevirtualinherited

The range returns the dual of skip_variable, default implem considers that all variables are affected by this homomorphism.

Reimplemented in _VarCompVar, _incVar, _setVarConst, _VarCompState, Fixpoint, And, Compose, Monotonic, Add, and NotCond.

References GHom::full_range.

Referenced by GHom::get_range().

◆ has_image()

GDDD StrongHom::has_image ( const GDDD d) const
virtual

◆ has_image_skip()

GDDD _GHom::has_image_skip ( const GDDD d) const
inherited

◆ hash()

virtual size_t _GHom::hash ( ) const
pure virtualinherited

Hash key computation.

It is essential for good hash table operation that the spread of the keys be as good as possible. Also, fast hash key computation is a good design goal. Note that bad hash functions will yield more collisions, thus equality comparisons which may be quite costly.

Implemented in _VarCompVar, _incVar, _setVarConst, _VarCompState, MLHomAdapter, Fixpoint, Minus, RightConcat, LeftConcat, And, Compose, Monotonic, Add, NotCond, Inter, Mult, DomExtract, Apply2k, Constant, and Identity.

◆ invert()

virtual GHom _GHom::invert ( const GDDD ) const
inlinevirtualinherited

returns the predescessor homomorphism, using pot to determine variable domains

Reimplemented in _incVar, _setVarConst, Fixpoint, Minus, And, Compose, Monotonic, Add, Inter, Mult, Apply2k, Constant, and Identity.

References _GHom::GHom, _GHom::is_selector(), GDDD::null, and _GHom::print().

Referenced by GHom::invert().

◆ is_selector()

virtual bool _GHom::is_selector ( ) const
inlinevirtualinherited

The isSelector predicate indicates a homomorphism that only selects paths in the SDD (no modifications, no additions) Tagging with isSelector() allows to enable optimizations and makes the homomorphism eligible as "condition" in ITE construct.

Reimplemented in _VarCompVar, _VarCompState, Fixpoint, Minus, And, Compose, Monotonic, Add, NotCond, Inter, Mult, DomExtract, Constant, and Identity.

Referenced by _GHom::invert(), and GHom::is_selector().

◆ mark()

virtual void _GHom::mark ( ) const
inlinevirtualinherited

For garbage collection. Used in first phase of garbage collection.

Reimplemented in MLHomAdapter, Fixpoint, Minus, RightConcat, LeftConcat, And, Compose, Monotonic, Add, NotCond, Inter, Mult, Apply2k, and Constant.

Referenced by GHom::mark().

◆ negate()

GHom _GHom::negate ( ) const
virtualinherited

returns a negation of a selector homomorphism h, such that h.negate() (d) = d - h(d)

Reimplemented in _VarCompState, And, Add, NotCond, Inter, Constant, and Identity.

References _GHom::GHom.

Referenced by GHom::negate().

◆ operator<()

bool _GHom::operator< ( const _GHom h) const
inherited

Ordering between _GHom. It is the chronological ordering of creation.

References _GHom::creation_counter.

◆ operator==() [1/2]

bool StrongHom::operator== ( const _GHom h) const
virtual

Comparator for unicity table.

Users should not use this. The behavior is to check for type mismatch (and return false if that is the case) or call specialized comparators of derived subclasses otherwise.

Implements _GHom.

◆ operator==() [2/2]

virtual bool StrongHom::operator== ( const StrongHom h) const
pure virtual

Comparator is pure virtual. Define a behavior in user homomorphisms.

Implemented in _VarCompVar, _incVar, _setVarConst, and _VarCompState.

◆ phi()

virtual GHom StrongHom::phi ( int  var,
int  val 
) const
pure virtual

Evaluation over an arbitrary arc of a SDD.

Parameters
varthe index of the variable labeling the node.
valthe value labeling the arc.
Returns
a homomorphism to apply on the successor node

Implemented in _VarCompVar, _incVar, _setVarConst, and _VarCompState.

Referenced by eval(), and has_image().

◆ phiOne()

virtual GDDD StrongHom::phiOne ( ) const
inlinevirtual

Evaluation over terminal GDDD::one.

Returns a constant DDD. A homomorphism that does not overload phiOne does not expect to meet the terminal during it's evaluation, therefore default behavior returns GDDD::top

Reimplemented in _VarCompVar, _incVar, _setVarConst, and _VarCompState.

References GDDD::top.

Referenced by eval(), and has_image().

◆ print()

void StrongHom::print ( std::ostream &  os) const
virtual

pretty print

Implements _GHom.

Reimplemented in _VarCompVar, _incVar, _setVarConst, and _VarCompState.

◆ skip_variable()

virtual bool _GHom::skip_variable ( int  ) const
inlinevirtualinherited

The skip_variable predicate indicates which variables are "don't care" with respect to this SHom.

This is defined as a StrongHom with : phi(var,val) { if ( skip_variable(var) ) return GShom( var, val, this ); else { real behavior } }

Reimplemented in Identity, _VarCompVar, _setVarConst, _VarCompState, _incVar, Fixpoint, RightConcat, And, Compose, Monotonic, Add, NotCond, Inter, and DomExtract.

Referenced by _GHom::eval_skip(), _GHom::has_image_skip(), Inter::skip_variable(), NotCond::skip_variable(), Add::skip_variable(), Monotonic::skip_variable(), Compose::skip_variable(), RightConcat::skip_variable(), Fixpoint::skip_variable(), and GHom::skip_variable().

Member Data Documentation

◆ creation_counter

size_t _GHom::creation_counter
privateinherited

Counter of objects created (see constructors).

This is used for the ordering between homomorphisms.

Referenced by _GHom::_GHom(), and _GHom::operator<().

◆ immediat

bool _GHom::immediat
mutableprivateinherited

For operation cache management.

If immediat==true, eval is called without attempting a cache hit. Currently only the constant homomorphism has this attribute set to true.

Referenced by GHom::operator()().

◆ marking

bool _GHom::marking
mutableprivateinherited

For garbage collection.

Used in the two phase garbage collection process. A Hom that is not marked after the first pass over the unicity table, will be sweeped in the second phase. Outside of garbage collection routine, marking should always bear the value false.

Referenced by GHom::garbage(), and GHom::mark().

◆ refCounter

int _GHom::refCounter
mutableprivateinherited

For garbage collection.

Counts the number of times a _GShom is referenced from the context of an Shom.

Referenced by Hom::Hom(), Hom::operator=(), GHom::refCounter(), and Hom::~Hom().


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

Please comment this page and report errors about it on the RefDocComments page.
Generated on Mon Aug 26 2024 14:54:00 for DDD by doxygen 1.9.1