FleCSI User API Version: 2.3.0
 
Loading...
Searching...
No Matches
my_key< DIM, T > Struct Template Reference

Example implementation of filling curve derived from the filling_curve_key CRTP. More...

Public Member Functions

 my_key (T it)
 Construct a key based on a key value.
 
- Public Member Functions inherited from filling_curve_key< DIM, T, my_key< DIM, T > >
std::size_t depth () const
 Find the depth of the current key.
 
constexpr filling_curve_key ()
 Default constructor: create an invalid key containing only zeros.
 
constexpr filling_curve_key (int_t value)
 Construct a key from an integer of type int_t.
 
int_t last_value () const
 Return the last bits of the key.
 
constexpr filling_curve_key parent () const
 Return the parent of this key (depth - 1)
 
int_t pop ()
 Pop last bits and return its value.
 
void pop (std::size_t d)
 Pop the depth d bits from the end of this key.
 
constexpr auto push (int_t bits) const
 Push bits onto the end of this key.
 
constexpr int_t value () const
 Get the value associated to this key.
 
constexpr bool operator<= (const filling_curve_key &bid) const
 Less than or equal to operator.
 
constexpr bool operator>= (const filling_curve_key &bid) const
 Greater than or equal to operator.
 
constexpr bool operator> (const filling_curve_key &bid) const
 Greater than operator.
 
constexpr bool operator< (const filling_curve_key &bid) const
 Less than operator.
 
constexpr bool operator!= (const filling_curve_key &bid) const
 Inequality operator.
 

Additional Inherited Members

- Public Types inherited from filling_curve_key< DIM, T, my_key< DIM, T > >
using int_t = T
 Integer type used to represent the key.
 
- Static Public Member Functions inherited from filling_curve_key< DIM, T, my_key< DIM, T > >
static constexpr my_key< DIM, T > max ()
 Biggest value possible at max_depth.
 
static constexpr std::size_t max_depth ()
 Max depth possible for this type of key.
 
static constexpr my_key< DIM, T > min ()
 Smallest value possible at max_depth.
 
static constexpr my_key< DIM, T > root ()
 Get the root key (depth 0)
 
- Protected Attributes inherited from filling_curve_key< DIM, T, my_key< DIM, T > >
int_t value_
 Value of the filling curve key.
 

Detailed Description

template<Dimension DIM, typename T>
struct flecsi::util::my_key< DIM, T >

Example implementation of filling curve derived from the filling_curve_key CRTP.

This class is not really implemented.

Constructor & Destructor Documentation

◆ my_key()

template<Dimension DIM, typename T >
my_key ( it)
explicit

Construct a key based on a key value.