flopc::MP_domain_set Class Reference

Range over which some other constuct is defined.This is one of the main public interface classes. One uses this in the context of a constraint, objective, variable, or data. This class in the MP_domain family uses an MP_set and and index for defining the Range over which the construct is defined. More...

#include <MP_domain.hpp>

Inheritance diagram for flopc::MP_domain_set:

Collaboration diagram for flopc::MP_domain_set:

Public Member Functions
	MP_domain_set (const MP_set *s, MP_index *i)
	Constructor taking a set pointer and an index pointer. More...
void	operator() () const
int	evaluate () const
const MP_set_base *	getSet () const
	Getter for the set used in construction. More...
MP_index *	getIndex () const
	Getter for the index used in construction. More...
MP_domain	getDomain (MP_set *s) const
	~MP_domain_set ()
Public Member Functions inherited from flopc::MP_domain_base
	MP_domain_base ()
virtual	~MP_domain_base ()
virtual Functor *	makeInsertFunctor () const
void	display () const
virtual size_t	size () const

Private Attributes
const MP_set *	S
MP_index *	I

Additional Inherited Members
Public Attributes inherited from flopc::MP_domain_base
const Functor *	donext
Protected Member Functions inherited from flopc::Functor
	Functor ()
virtual	~Functor ()
Protected Member Functions inherited from flopc::MP_index_base
	MP_index_base ()
virtual	~MP_index_base ()

Detailed Description

Range over which some other constuct is defined.

This is one of the main public interface classes. One uses this in the context of a constraint, objective, variable, or data. This class in the MP_domain family uses an MP_set and and index for defining the Range over which the construct is defined.

• This defines the domain as the contents of the set when referred into by the index.

Definition at line 110 of file MP_domain.hpp.

Constructor & Destructor Documentation

flopc::MP_domain_set::MP_domain_set	(	const MP_set *	s,
		MP_index *	i
	)

Constructor taking a set pointer and an index pointer.

Definition at line 15 of file MP_domain.cpp.

flopc::MP_domain_set::~MP_domain_set

(

)

Definition at line 17 of file MP_domain.cpp.

Member Function Documentation

int MP_domain_set::evaluate ( ) const

virtual

Evaluates the index within the domain.

Note

For internal use

Implements flopc::MP_index_base.

Definition at line 102 of file MP_domain.cpp.

References flopc::MP_index::evaluate(), and I.

MP_domain flopc::MP_domain_set::getDomain ( MP_set *  s ) const

virtual

Note

Internal use.

Todo:

Is internal? can be private? or needs more doc.

Implements flopc::MP_index_base.

Definition at line 18 of file MP_domain.cpp.

References flopc::MP_domain_base::MP_domain.

MP_index * MP_domain_set::getIndex ( ) const

virtual

Getter for the index used in construction.

Implements flopc::MP_domain_base.

Definition at line 120 of file MP_domain.cpp.

References I.

const MP_set_base * MP_domain_set::getSet ( ) const

virtual

Getter for the set used in construction.

Implements flopc::MP_domain_base.

Definition at line 94 of file MP_domain.cpp.

References S.

void MP_domain_set::operator() ( ) const

virtual

Todo:

should this be public? Should it be called? If so, needs doc.

Implements flopc::Functor.

Definition at line 106 of file MP_domain.cpp.

References flopc::MP_index::assign(), I, flopc::MP_index::instantiate(), flopc::MP_index::isInstantiated(), S, flopc::MP_set::size(), and flopc::MP_index::unInstantiate().

Member Data Documentation

MP_index* flopc::MP_domain_set::I

private

Definition at line 131 of file MP_domain.hpp.

Referenced by evaluate(), getIndex(), and operator()().

const MP_set* flopc::MP_domain_set::S

private

Definition at line 130 of file MP_domain.hpp.

Referenced by getSet(), and operator()().

---

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

• MP_domain.hpp
• MP_domain.cpp