FlopCpp  trunk
Public Member Functions | List of all members
flopc::MP_domain_set Class Reference

Range over which some other constuct is defined. More...

#include <MP_domain.hpp>

+ Inheritance 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
 Evaluates the index within the domain. More...
 
const MP_set_basegetSet () const
 Getter for the set used in construction. More...
 
MP_indexgetIndex () 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 FunctormakeInsertFunctor () const
 
void display () const
 
virtual size_t size () const
 

Additional Inherited Members

- Public Attributes inherited from flopc::MP_domain_base
const Functordonext
 
- 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.

Definition at line 110 of file MP_domain.hpp.

Constructor & Destructor Documentation

◆ MP_domain_set()

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

Constructor taking a set pointer and an index pointer.

◆ ~MP_domain_set()

flopc::MP_domain_set::~MP_domain_set ( )

Member Function Documentation

◆ operator()()

void flopc::MP_domain_set::operator() ( ) const
virtual
Todo:
should this be public? Should it be called? If so, needs doc.

Implements flopc::Functor.

◆ evaluate()

int flopc::MP_domain_set::evaluate ( ) const
virtual

Evaluates the index within the domain.

Note
For internal use

Implements flopc::MP_index_base.

◆ getSet()

const MP_set_base* flopc::MP_domain_set::getSet ( ) const
virtual

Getter for the set used in construction.

Implements flopc::MP_domain_base.

◆ getIndex()

MP_index* flopc::MP_domain_set::getIndex ( ) const
virtual

Getter for the index used in construction.

Implements flopc::MP_domain_base.

◆ getDomain()

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.


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