das2C
das core C utilities (v3)
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
DasDsCubeIter Struct Reference

Simple cubic iterator. More...

#include <das3/iterator.h>

Public Member Functions

DAS_API void DasDsCubeIter_init (DasDsCubeIter *pThis, int nRank, ptrdiff_t *pMin, ptrdiff_t *pMax)
 Initialize an iterator to cubic section in index space.
 
DAS_API bool DasDsCubeIter_next (DasDsCubeIter *pThis)
 Increment a cubic iterator by one position, rolling as needed.
 

Data Fields

bool done
 If true the value in index is valid, false otherwise.
 
ptrdiff_t index [VARIDX_MAX]
 A dataset bulk iteration index suitable for use in DasVar functions like ::DasVar_get.
 

Detailed Description

Simple cubic iterator.

Member Function Documentation

◆ DasDsCubeIter_next()

DAS_API bool DasDsCubeIter_next ( DasDsCubeIter *  pThis)

Increment a cubic iterator by one position, rolling as needed.

Parameters
pThisA pointer to an iterator. The index member of the iterator will be incremented.
Returns
true if the new index is within range, false if the index could not be incremented without producing an invalid location.

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