Function grid_map::incrementIndex

Function Documentation

bool grid_map::incrementIndex(Index &index, const Size &bufferSize, const Index &bufferStartIndex = Index::Zero())

Increases the index by one to iterate through the map. Increments either to the neighboring index to the right or to the start of the lower row. Returns false if end of iterations are reached.

Parameters:

  • [in/out] – index the index in the map that is incremented (corrected for the circular buffer).

  • bufferSize – [in] the map buffer size.

  • bufferStartIndex – [in] the map buffer start index.

Returns:

true if successfully incremented indeces, false if end of iteration limits are reached.