Representation of an index.This is one of the main public interface classes. It is used to iterate through, or index into an MP_domain. It is also used to share the 'current' index offsets between expressions which share an index. More...
#include <MP_index.hpp>
Public Member Functions | |
| MP_index () | |
| Default constructor. More... | |
| int | evaluate () const |
| bool | isInstantiated () const |
| void | assign (int i) |
| void | unInstantiate () |
| void | instantiate () |
| MP_index * | getIndex () const |
| virtual MP_domain | getDomain (MP_set *s) const |
| Getter for domain over which this index is applied. More... | |
 Public Member Functions inherited from flopc::MP_index_base | |
| virtual void | display () const |
Static Public Member Functions | |
| static MP_index & | getEmpty () |
| returns a reference to the distinct "empty" index. More... | |
Static Public Attributes | |
| static MP_index & | Any = *new MP_index() |
Private Attributes | |
| int | index |
| bool | instantiated |
Static Private Attributes | |
| static MP_index & | Empty = *new MP_index() |
Additional Inherited Members | |
| Protected Member Functions inherited from flopc::MP_index_base | |
| MP_index_base () | |
| virtual | ~MP_index_base () |
Detailed Description
Representation of an index.
This is one of the main public interface classes. It is used to iterate through, or index into an MP_domain. It is also used to share the 'current' index offsets between expressions which share an index.
- these can be built stand-alone
- these are sometime constructed as needed.
- there is a special "empty" which is a unique constant. \ This constant is used when defaulting passed parameters for \ extra dimensions which are unused.
Definition at line 53 of file MP_index.hpp.
Constructor & Destructor Documentation
|
inline |
Default constructor.
Definition at line 56 of file MP_index.hpp.
Member Function Documentation
|
inline |
Setter for the index.
- Todo:
should this be private?
should this assert "instatiated"?
Definition at line 70 of file MP_index.hpp.
References index.
Referenced by flopc::MP_domain_set::operator()().
|
inlinevirtual |
Implements flopc::MP_index_base.
Definition at line 57 of file MP_index.hpp.
References index.
Referenced by flopc::MP_domain_set::evaluate(), flopc::VariableRef::level(), and flopc::MP_variable::operator()().
Getter for domain over which this index is applied.
Implements flopc::MP_index_base.
Definition at line 97 of file MP_index.cpp.
|
static |
returns a reference to the distinct "empty" index.
Definition at line 20 of file MP_index.cpp.
References Empty.
Referenced by flopc::MP_domain_subset< nbr >::operator()().
|
inlinevirtual |
getter for MP_index * data type.
- Todo:
should this be private?
should this be virtual?
Implements flopc::MP_index_base.
Definition at line 89 of file MP_index.hpp.
|
inline |
setter for instatiated.
- Todo:
- should this be private?
Definition at line 82 of file MP_index.hpp.
References instantiated.
Referenced by flopc::MP_domain_set::operator()().
|
inline |
interrogate state of instatiation of data.
- Todo:
- should this be private?
Definition at line 63 of file MP_index.hpp.
References instantiated.
Referenced by flopc::MP_domain_set::operator()().
|
inline |
unsetter for instatiated.
- Todo:
- should this be private?
Definition at line 76 of file MP_index.hpp.
References instantiated.
Referenced by flopc::MP_domain_set::operator()().
Member Data Documentation
- Todo:
should this be private?
doc purpose.
Definition at line 97 of file MP_index.hpp.
Definition at line 102 of file MP_index.hpp.
Referenced by getEmpty().
|
private |
Definition at line 103 of file MP_index.hpp.
Referenced by assign(), and evaluate().
|
private |
Definition at line 104 of file MP_index.hpp.
Referenced by instantiate(), isInstantiated(), and unInstantiate().
The documentation for this class was generated from the following files:
