The relation between a polyhedron and a constraint. More...

#include <Poly_Con_Relation_defs.hh>

Public Member Functions
flags_t	get_flags () const
	Access the internal flags: this is needed for some language interfaces. More...

void	ascii_dump () const
	Writes to `std::cerr` an ASCII representation of `*this`. More...

void	ascii_dump (std::ostream &s) const
	Writes to `s` an ASCII representation of `*this`. More...

void	print () const
	Prints `*this` to `std::cerr` using `operator<<`. More...

bool	implies (const Poly_Con_Relation &y) const
	True if and only if `*this` implies `y`. More...

bool	OK () const
	Checks if all the invariants are satisfied. More...

Static Public Member Functions
static Poly_Con_Relation	nothing ()
	The assertion that says nothing. More...

static Poly_Con_Relation	is_disjoint ()
	The polyhedron and the set of points satisfying the constraint are disjoint. More...

static Poly_Con_Relation	strictly_intersects ()
	The polyhedron intersects the set of points satisfying the constraint, but it is not included in it. More...

static Poly_Con_Relation	is_included ()
	The polyhedron is included in the set of points satisfying the constraint. More...

static Poly_Con_Relation	saturates ()
	The polyhedron is included in the set of points saturating the constraint. More...

Private Types
typedef unsigned int	flags_t
	Poly_Con_Relation is implemented by means of a finite bitset. More...

Private Member Functions
	Poly_Con_Relation (flags_t mask)
	Construct from a bit-mask. More...

Static Private Member Functions
static bool	implies (flags_t x, flags_t y)
	True if and only if the conjunction `x` implies the conjunction `y`. More...

Private Attributes
flags_t	flags
	This holds the current bitset. More...

Static Private Attributes
static const flags_t	EVERYTHING
	All assertions together. More...

Bit-masks for the individual assertions
static const flags_t	NOTHING = 0U

static const flags_t	IS_DISJOINT = 1U << 0

static const flags_t	STRICTLY_INTERSECTS = 1U << 1

static const flags_t	IS_INCLUDED = 1U << 2

static const flags_t	SATURATES = 1U << 3

Friends
bool	operator== (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

bool	operator!= (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

Poly_Con_Relation	operator&& (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

Poly_Con_Relation	operator- (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

std::ostream &	Parma_Polyhedra_Library::IO_Operators::operator<< (std::ostream &s, const Poly_Con_Relation &r)

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &s, const Poly_Con_Relation &r)

bool	operator== (const Poly_Con_Relation &x, const Poly_Con_Relation &y)
	True if and only if `x` and `y` are logically equivalent. More...

bool	operator!= (const Poly_Con_Relation &x, const Poly_Con_Relation &y)
	True if and only if `x` and `y` are not logically equivalent. More...

Poly_Con_Relation	operator&& (const Poly_Con_Relation &x, const Poly_Con_Relation &y)
	Yields the logical conjunction of `x` and `y`. More...

Poly_Con_Relation	operator- (const Poly_Con_Relation &x, const Poly_Con_Relation &y)
	Yields the assertion with all the conjuncts of `x` that are not in `y`. More...

std::ostream &	operator<< (std::ostream &s, const Poly_Con_Relation &r)
	Output operator. More...

bool	operator== (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

bool	operator!= (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

Poly_Con_Relation	operator&& (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

Poly_Con_Relation	operator- (const Poly_Con_Relation &x, const Poly_Con_Relation &y)

Detailed Description

The relation between a polyhedron and a constraint.

This class implements conjunctions of assertions on the relation between a polyhedron and a constraint.

Definition at line 73 of file Poly_Con_Relation_defs.hh.

Member Typedef Documentation

typedef unsigned int Parma_Polyhedra_Library::Poly_Con_Relation::flags_t

private

Poly_Con_Relation is implemented by means of a finite bitset.

Definition at line 76 of file Poly_Con_Relation_defs.hh.

Constructor & Destructor Documentation

Parma_Polyhedra_Library::Poly_Con_Relation::Poly_Con_Relation ( flags_t mask )

inlineprivate

Construct from a bit-mask.

Definition at line 30 of file Poly_Con_Relation_inlines.hh.

Referenced by is_disjoint(), is_included(), nothing(), saturates(), and strictly_intersects().

31 : flags(mask) {

32 }

Parma_Polyhedra_Library::Poly_Con_Relation::flags

flags_t flags

This holds the current bitset.

Definition: Poly_Con_Relation_defs.hh:95

Member Function Documentation

void Parma_Polyhedra_Library::Poly_Con_Relation::ascii_dump ( ) const

Writes to std::cerr an ASCII representation of *this.

void Parma_Polyhedra_Library::Poly_Con_Relation::ascii_dump ( std::ostream & s ) const

Writes to s an ASCII representation of *this.

Definition at line 33 of file Poly_Con_Relation.cc.

References flags, implies(), IS_DISJOINT, IS_INCLUDED, NOTHING, SATURATES, and STRICTLY_INTERSECTS.

                                                     {
   flags_t f = flags;
   if (f == NOTHING) {
     s << "NOTHING";
     return;
   }
 
   while (true) {
     if (implies(f, IS_DISJOINT)) {
       s << "IS_DISJOINT";
       f &= ~IS_DISJOINT;
     }
     else if (implies(f, STRICTLY_INTERSECTS)) {
       s << "STRICTLY_INTERSECTS";
       f &= ~STRICTLY_INTERSECTS;
     }
     else if (implies(f, IS_INCLUDED)) {
       s << "IS_INCLUDED";
       f &= ~IS_INCLUDED;
     }
     else if (implies(f, SATURATES)) {
       s << "SATURATES";
       f &= ~SATURATES;
     }
     if (f != NOTHING) {
       s << " & ";
     }
     else {
       break;
     }
   }
 }

Poly_Con_Relation::flags_t Parma_Polyhedra_Library::Poly_Con_Relation::get_flags ( ) const

inline

Access the internal flags: this is needed for some language interfaces.

Definition at line 35 of file Poly_Con_Relation_inlines.hh.

References flags.

                                    {
   return flags;
 }

bool Parma_Polyhedra_Library::Poly_Con_Relation::implies	(	flags_t	x,
		flags_t	y
	)

inlinestaticprivate

True if and only if the conjunction x implies the conjunction y.

Definition at line 65 of file Poly_Con_Relation_inlines.hh.

                                                {
   return (x & y) == y;
 }

bool Parma_Polyhedra_Library::Poly_Con_Relation::implies ( const Poly_Con_Relation & y ) const

inline

True if and only if *this implies y.

Definition at line 70 of file Poly_Con_Relation_inlines.hh.

References flags, and implies().

                                                            {
   return implies(flags, y.flags);
 }

Poly_Con_Relation Parma_Polyhedra_Library::Poly_Con_Relation::is_disjoint ( )

inlinestatic

The polyhedron and the set of points satisfying the constraint are disjoint.

Definition at line 45 of file Poly_Con_Relation_inlines.hh.

References IS_DISJOINT, and Poly_Con_Relation().

                                {
   return Poly_Con_Relation(IS_DISJOINT);
 }

Poly_Con_Relation Parma_Polyhedra_Library::Poly_Con_Relation::is_included ( )

inlinestatic

The polyhedron is included in the set of points satisfying the constraint.

Definition at line 55 of file Poly_Con_Relation_inlines.hh.

References IS_INCLUDED, and Poly_Con_Relation().

                                {
   return Poly_Con_Relation(IS_INCLUDED);
 }

Poly_Con_Relation Parma_Polyhedra_Library::Poly_Con_Relation::nothing ( )

inlinestatic

The assertion that says nothing.

Definition at line 40 of file Poly_Con_Relation_inlines.hh.

References NOTHING, and Poly_Con_Relation().

Referenced by Parma_Polyhedra_Library::interval_relation(), Parma_Polyhedra_Library::Box< ITV >::relation_with(), Parma_Polyhedra_Library::Partially_Reduced_Product< D1, D2, R >::relation_with(), and Parma_Polyhedra_Library::Pointset_Powerset< PSET >::relation_with_aux().

                            {
   return Poly_Con_Relation(NOTHING);
 }

bool Parma_Polyhedra_Library::Poly_Con_Relation::OK ( ) const

Checks if all the invariants are satisfied.

Definition at line 76 of file Poly_Con_Relation.cc.

                                {
   return true;
 }

void Parma_Polyhedra_Library::Poly_Con_Relation::print ( ) const

Prints *this to std::cerr using operator<<.

Poly_Con_Relation Parma_Polyhedra_Library::Poly_Con_Relation::saturates ( )

inlinestatic

The polyhedron is included in the set of points saturating the constraint.

Definition at line 60 of file Poly_Con_Relation_inlines.hh.

References Poly_Con_Relation(), and SATURATES.

                              {
   return Poly_Con_Relation(SATURATES);
 }

Poly_Con_Relation Parma_Polyhedra_Library::Poly_Con_Relation::strictly_intersects ( )

inlinestatic

The polyhedron intersects the set of points satisfying the constraint, but it is not included in it.

Definition at line 50 of file Poly_Con_Relation_inlines.hh.

References Poly_Con_Relation(), and STRICTLY_INTERSECTS.

Referenced by Parma_Polyhedra_Library::Polyhedron::BHRZ03_combining_constraints(), Parma_Polyhedra_Library::interval_relation(), Parma_Polyhedra_Library::Box< ITV >::relation_with(), Parma_Polyhedra_Library::Generator_System::relation_with(), Parma_Polyhedra_Library::Polyhedron::relation_with(), Parma_Polyhedra_Library::Grid::relation_with(), Parma_Polyhedra_Library::Octagonal_Shape< T >::relation_with(), Parma_Polyhedra_Library::BD_Shape< T >::relation_with(), and Parma_Polyhedra_Library::Pointset_Powerset< PSET >::relation_with_aux().

                                        {
   return Poly_Con_Relation(STRICTLY_INTERSECTS);
 }

Friends And Related Function Documentation

bool operator!=	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

bool operator!=	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

References flags.

                                                                    {
   return x.flags != y.flags;
 }

bool operator!=	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

friend

Poly_Con_Relation operator&&	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

Poly_Con_Relation operator&&	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

References flags.

                                                                    {
   return Poly_Con_Relation(x.flags | y.flags);
 }

Poly_Con_Relation operator&&	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

friend

Poly_Con_Relation operator-	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

Poly_Con_Relation operator-	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

References flags.

                                                                   {
   return Poly_Con_Relation(x.flags & ~y.flags);
 }

Poly_Con_Relation operator-	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

friend

std::ostream & operator<<	(	std::ostream &	s,
		const Poly_Con_Relation &	r
	)

std::ostream & operator<<	(	std::ostream &	s,
		const Poly_Con_Relation &	r
	)

                                                                      {
   r.ascii_dump(s);
   return s;
 }

bool operator==	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

bool operator==	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

References flags.

                                                                    {
   return x.flags == y.flags;
 }

bool operator==	(	const Poly_Con_Relation &	x,
		const Poly_Con_Relation &	y
	)

friend

std::ostream& Parma_Polyhedra_Library::IO_Operators::operator<<	(	std::ostream &	s,
		const Poly_Con_Relation &	r
	)

friend

Member Data Documentation

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::EVERYTHING

staticprivate

Initial value:

= IS_DISJOINT
  | STRICTLY_INTERSECTS
  | IS_INCLUDED
  | SATURATES

All assertions together.

Definition at line 89 of file Poly_Con_Relation_defs.hh.

flags_t Parma_Polyhedra_Library::Poly_Con_Relation::flags

private

This holds the current bitset.

Definition at line 95 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), get_flags(), implies(), operator!=(), operator&&(), operator-(), and operator==().

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::IS_DISJOINT = 1U << 0

staticprivate

Definition at line 81 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), and is_disjoint().

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::IS_INCLUDED = 1U << 2

staticprivate

Definition at line 83 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), and is_included().

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::NOTHING = 0U

staticprivate

Definition at line 80 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), and nothing().

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::SATURATES = 1U << 3

staticprivate

Definition at line 84 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), and saturates().

const flags_t Parma_Polyhedra_Library::Poly_Con_Relation::STRICTLY_INTERSECTS = 1U << 1

staticprivate

Definition at line 82 of file Poly_Con_Relation_defs.hh.

Referenced by ascii_dump(), and strictly_intersects().

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

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Related Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation