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

#include <SHom.h>

Inheritance diagram for StrongShom:

Collaboration diagram for StrongShom:

Public Member Functions
	StrongShom ()
	Default constructor. More...

virtual	~StrongShom ()
	Default destructor. More...

virtual GSDD	phiOne () const
	Evaluation over terminal GSDD::one. More...

virtual GShom	phi (int var, const DataSet &val) const =0
	Evaluation over an arbitrary arc of a SDD. More...

virtual bool	operator== (const StrongShom &h) const =0
	Comparator is pure virtual. Define a behavior in user homomorphisms. More...

bool	operator== (const _GShom &h) const
	Comparator for unicity table. More...

virtual void	print (std::ostream &os) const
	pretty print More...

GSDD	eval (const GSDD &) const
	The evaluation mechanism of strong homomorphisms. More...

virtual GSDD	has_image (const GSDD &d) const

GSDD	has_image_skip (const GSDD &) 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 GShom::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 size_t	hash () const =0
	Hash key computation. More...

virtual _GShom *	clone () const =0

virtual GShom	compose (const GShom &) const

virtual void	mark () const
	For garbage collection. Used in first phase of garbage collection. More...

void	mark_if_refd () const

void	ref () const

void	deref () const

unsigned long int	refCounter () const

bool	is_marked () const

void	set_mark (bool val) const

virtual GShom	invert (const GSDD &) const

Static Public Member Functions
static const _GShom *	get_concret (const GShom &gshom)
	TODO : this is a dirty trick to allow us to do terms rewriting in Add, Fixpoint etc... More...

Private Member Functions
GSDD	eval_skip (const GSDD &) const
	The procedure responsible for propagating efficiently across "skipped" variable nodes. More...

virtual bool	immediat () const
	For operation cache management. More...

Private Attributes
int	_refCounter
	For garbage collection. 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 :

evaluation over terminal GSDD::one, which should return a constant SDD
evaluation over an arbitrary var–val--> pair, that returns a homomorphism to apply to the successor node Users also have to provide a comparison function, and a hash function (from _GShom). See the demo folder for examples of user defined homomorphisms.

Constructor & Destructor Documentation

◆ StrongShom()

StrongShom::StrongShom ( )

inline

Default constructor.

Empty behavior.

Todo:: Is this declaration useful ?

◆ ~StrongShom()

virtual StrongShom::~StrongShom ( )

inlinevirtual

Default destructor.

Empty behavior.

Todo:: Is this declaration useful ?

Member Function Documentation

◆ clone()

virtual _GShom* _GShom::clone ( ) const

pure virtualinherited

Implemented in sns::MLShomAdapter, sns::Fixpoint, sns::HomMinus, sns::Minus, sns::RightConcat, sns::LeftConcat, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, sns::LocalApply, sns::SDomExtract, sns::Inter, sns::Mult, sns::SApply2k, sns::Constant, and sns::Identity.

◆ compose()

GShom _GShom::compose ( const GShom & r ) const

virtualinherited

References GShom::id, and GSDD::null.

Referenced by GShom::compose().

◆ deref()

void _GShom::deref ( ) const

inlineinherited

References _GShom::_refCounter.

Referenced by Shom::operator=(), and Shom::~Shom().

◆ eval()

GSDD StrongShom::eval ( const GSDD & 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 _GShom.

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

◆ eval_skip()

GSDD _GShom::eval_skip ( const GSDD & d ) const

privateinherited

The procedure responsible for propagating efficiently across "skipped" variable nodes.

References GSDD::begin(), GSDD::end(), _GShom::eval(), GShom::id, _GShom::immediat(), GSDD::nbsons(), GSDD::null, GSDD::one, _GShom::skip_variable(), square_union(), GSDD::top, and GSDD::variable().

Referenced by GShom::eval().

◆ get_concret()

static const _GShom* _GShom::get_concret ( const GShom & gshom )

inlinestaticinherited

TODO : this is a dirty trick to allow us to do terms rewriting in Add, Fixpoint etc...

A more elegant architecture would be nice.

References GShom::concret.

Referenced by addCompositionParameter(), addParameter(), buildUnionParameters(), sns::RecFireSat::eval(), sns::Fixpoint::eval(), sns::Add::factorizeByLevel(), GShom::GShom(), sns::Fixpoint::has_image(), operator!(), operator*(), sns::recFireSat(), sns::Inter::skip_variable(), sns::Add::skip_variable(), and sns::RightConcat::skip_variable().

◆ get_range()

virtual const GShom::range_t _GShom::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 sns::Fixpoint, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, and sns::LocalApply.

References GShom::full_range.

Referenced by GShom::get_range().

◆ has_image()

GSDD StrongShom::has_image ( const GSDD & d ) const

virtual

Reimplemented from _GShom.

References GSDD::begin(), GSDD::end(), GSDD::null, GSDD::one, phi(), phiOne(), GSDD::top, and GSDD::variable().

◆ has_image_skip()

GSDD _GShom::has_image_skip ( const GSDD & d ) const

inherited

References GSDD::begin(), GSDD::end(), GShom::has_image(), _GShom::has_image(), GShom::id, GSDD::null, GSDD::one, _GShom::skip_variable(), GSDD::top, and GSDD::variable().

◆ hash()

virtual size_t _GShom::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 sns::MLShomAdapter, sns::Fixpoint, sns::HomMinus, sns::Minus, sns::RightConcat, sns::LeftConcat, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, sns::LocalApply, sns::SDomExtract, sns::Inter, sns::Mult, sns::SApply2k, sns::Constant, and sns::Identity.

◆ immediat()

virtual bool _GShom::immediat ( ) const

inlineprivatevirtualinherited

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. Overload and return true for immediate computations.

Reimplemented in sns::Constant, and sns::Identity.

Referenced by _GShom::eval_skip(), and GShom::operator()().

◆ invert()

virtual GShom _GShom::invert ( const GSDD & ) const

inlinevirtualinherited

Reimplemented in sns::Fixpoint, sns::HomMinus, sns::Minus, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SLocalApply, sns::LocalApply, sns::Inter, sns::Mult, sns::SApply2k, sns::Constant, and sns::Identity.

References _GShom::is_selector(), Shom::null, and _GShom::print().

Referenced by GShom::invert().

◆ is_marked()

bool _GShom::is_marked ( ) const

inlineinherited

References _GShom::_refCounter.

Referenced by _GShom::set_mark().

◆ is_selector()

virtual bool _GShom::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 sns::Fixpoint, sns::HomMinus, sns::Minus, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, sns::LocalApply, sns::SDomExtract, sns::Inter, sns::Mult, sns::SApply2k, sns::Constant, and sns::Identity.

Referenced by _GShom::invert(), and GShom::is_selector().

◆ mark()

virtual void _GShom::mark ( ) const

inlinevirtualinherited

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

Reimplemented in sns::MLShomAdapter, sns::Fixpoint, sns::HomMinus, sns::Minus, sns::RightConcat, sns::LeftConcat, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, sns::LocalApply, sns::Inter, sns::Mult, sns::SApply2k, and sns::Constant.

Referenced by _GShom::set_mark().

◆ mark_if_refd()

void _GShom::mark_if_refd ( ) const

inlineinherited

References _GShom::refCounter(), and _GShom::set_mark().

◆ operator==() [1/2]

bool StrongShom::operator== ( const _GShom & 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 _GShom.

◆ operator==() [2/2]

virtual bool StrongShom::operator== ( const StrongShom & h ) const

pure virtual

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

◆ phi()

virtual GShom StrongShom::phi	(	int	var,
		const DataSet &	val
	)		const

pure virtual

Evaluation over an arbitrary arc of a SDD.

Parameters

var	the index of the variable labeling the node.
val	the set of values labeling the arc.

Returns: a homomorphism to apply on the successor node

Referenced by eval(), and has_image().

◆ phiOne()

virtual GSDD StrongShom::phiOne ( ) const

inlinevirtual

Evaluation over terminal GSDD::one.

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

References GSDD::top.

Referenced by eval(), and has_image().

◆ print()

void StrongShom::print ( std::ostream & os ) const

virtual

pretty print

Implements _GShom.

◆ ref()

void _GShom::ref ( ) const

inlineinherited

References _GShom::_refCounter.

Referenced by Shom::operator=(), and Shom::Shom().

◆ refCounter()

unsigned long int _GShom::refCounter ( ) const

inlineinherited

References _GShom::_refCounter.

Referenced by _GShom::mark_if_refd(), Shom::operator=(), GShom::refCounter(), and Shom::~Shom().

◆ set_mark()

void _GShom::set_mark ( bool val ) const

inlineinherited

References _GShom::_refCounter, _GShom::is_marked(), and _GShom::mark().

Referenced by GShom::garbage(), GShom::mark(), and _GShom::mark_if_refd().

◆ skip_variable()

virtual bool _GShom::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 sns::SDomExtract, sns::Identity, sns::Fixpoint, sns::RightConcat, sns::Compose, sns::RecFireSat, sns::Add, sns::And, sns::SNotCond, sns::SLocalApply, sns::LocalApply, sns::Inter, and sns::SApply2k.

Referenced by _GShom::eval_skip(), _GShom::has_image_skip(), sns::Inter::skip_variable(), sns::Add::skip_variable(), sns::RightConcat::skip_variable(), and GShom::skip_variable().

Member Data Documentation

◆ _refCounter

int _GShom::_refCounter

mutableprivateinherited

For garbage collection.

Counts the number of times a _GShom is referenced from the context of an Shom. For garbage collection: lowest bit of refCounter gives marking value for mark&sweep. Used in the two phase garbage collection process. A Shom 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 _GShom::deref(), _GShom::is_marked(), _GShom::ref(), _GShom::refCounter(), and _GShom::set_mark().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StrongShom()

◆ ~StrongShom()

Member Function Documentation

◆ clone()

◆ compose()

◆ deref()

◆ eval()

◆ eval_skip()

◆ get_concret()

◆ get_range()

◆ has_image()

◆ has_image_skip()

◆ hash()

◆ immediat()

◆ invert()

◆ is_marked()

◆ is_selector()

◆ mark()

◆ mark_if_refd()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ phi()

◆ phiOne()

◆ print()

◆ ref()

◆ refCounter()

◆ set_mark()

◆ skip_variable()

Member Data Documentation

◆ _refCounter