Dune Core Modules (2.9.0)
Public Member Functions |
Static Public Member Functions |
Static Public Attributes |
List of all members
Dune::SPMultiIndex< dim > Class Template Reference
multiindex More...
#include <dune/grid/spgrid/multiindex.hh>
Public Member Functions | |
SPMultiIndex () | |
default constructor | |
template<int d, std::enable_if_t<(d==dimension &&d > 0), int > = 0> | |
SPMultiIndex (const int(&index)[d]) | |
constructor from int array More... | |
SPMultiIndex (const std::array< int, dimension > &index) | |
constructor from int array More... | |
SPMultiIndex (const This &other) | |
copy constructor | |
This & | operator= (const This &other) |
copy assignment | |
template<int d, std::enable_if_t<(d==dimension &&d > 0), int > = 0> | |
This & | operator= (const int(&index)[d]) |
assignment operator from int array | |
This & | operator+= (const This &other) |
add another multiindex to this one (vector operation) | |
This & | operator-= (const This &other) |
subtract another multiindex from this one (vector operation) | |
This & | operator*= (int a) |
scale this multiindex (vector operation) | |
This & | operator/= (int a) |
scale this multiindex (vector operation) | |
const int & | operator[] (int i) const |
access i-th component | |
int & | operator[] (int i) |
access i-th component | |
bool | operator== (const This &other) const |
compare two multiindices for equality | |
bool | operator!= (const This &other) const |
compare two multiindices for inequality | |
void | axpy (const int a, const This &other) |
add multiple of a multiindex to this one (vector operation) | |
void | clear () |
initialize to zero | |
void | increment (const This &bound, const int k=1) |
int | codimension () const |
Static Public Member Functions | |
static This | zero () |
obtain the zero multiindex | |
Static Public Attributes | |
static const int | dimension = dim |
dimension of the multiindex | |
Detailed Description
template<int dim>
class Dune::SPMultiIndex< dim >
class Dune::SPMultiIndex< dim >
multiindex
- Template Parameters
-
dim dimension of the multiindex
Constructor & Destructor Documentation
◆ SPMultiIndex() [1/2]
template<int dim>
template<int d, std::enable_if_t<(d==dimension &&d > 0), int > = 0>
|
inline |
constructor from int array
- Note
- This constructor defines an implicit conversion.
- Parameters
-
[in] index int array to copy
◆ SPMultiIndex() [2/2]
template<int dim>
|
inline |
constructor from int array
- Note
- This constructor defines an implicit conversion.
- Parameters
-
[in] index int array to copy
Member Function Documentation
◆ codimension()
template<int dim>
|
inline |
- Todo:
- please doc me
References Dune::SPMultiIndex< dim >::dimension.
◆ increment()
template<int dim>
|
inline |
- Todo:
- please doc me
References Dune::SPMultiIndex< dim >::dimension.
The documentation for this class was generated from the following file:
- dune/grid/spgrid/multiindex.hh
|
Legal Statements / Impressum |
Hosted by TU Dresden |
generated with Hugo v0.111.3
(Oct 6, 22:30, 2024)