NuriKit v0.1.0b2
Loading...
Searching...
No Matches
nuri::CyclicIndex< O, N > Class Template Reference

Cyclic indexer for Eigen types with a given offset. More...

#include <nuri/eigen_config.h>

Public Member Functions

constexpr int operator[] (int i) const

Static Public Member Functions

static constexpr int size ()

Detailed Description

template<int O = 0, int N = 0>
class nuri::CyclicIndex< O, N >

Cyclic indexer for Eigen types with a given offset.

Template Parameters
OOffset of the cyclic index. If 0, it is determined at runtime.
NSize of the cyclic index. If 0, it is determined at runtime.

This will produce an index that is cyclic with a given offset, i.e., (O, O+1, ..., N-1, 0, 1, ..., O-1).

Member Function Documentation

◆ operator[]()

template<int O = 0, int N = 0>
int nuri::CyclicIndex< O, N >::operator[] ( int i) const
inlineconstexpr

◆ size()

template<int O = 0, int N = 0>
constexpr int nuri::CyclicIndex< O, N >::size ( )
inlinestaticconstexpr

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