iterator.h

Go to the documentation of this file.

/* Copyright (C) 2024 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 C Library.
 * 
 * Das2C is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * Das2C is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with das2C; if not, see <http://www.gnu.org/licenses/>. 
 */
 
#ifndef _das_iterator_h_
#define _das_iterator_h_
 
#include <das3/dataset.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dasds_iterator_t{
   
   bool       done;
   
   ptrdiff_t index[VARIDX_MAX];
   
   int        rank;
   ptrdiff_t  shape[VARIDX_MAX];  /* Used for CUBIC datasets */
   ptrdiff_t  nLenIn;            /* Used for ragged datasets */
   bool      ragged;
   const DasDs* pDs;
} DasDsIter;
 
#define dasds_iterator DasDsIter
 
DAS_API void DasDsIter_init(DasDsIter* pThis, const DasDs* pDs);
#define dasds_iter_init DasDsIter_init
 
DAS_API bool DasDsIter_next(DasDsIter* pThis);
#define dasds_iter_next DasDsIter_next
 
/* ************************************************************************* */
 
typedef struct das_uniq_iter_t{
   bool       done;
   
   ptrdiff_t index[VARIDX_MAX];
   
   bool       lock[VARIDX_MAX];
 
   int        first;
   int        last;
   
   int        rank;
   ptrdiff_t  shape[VARIDX_MAX];  /* Used for CUBIC datasets */
   ptrdiff_t  nLenIn;            /* Used for ragged datasets */
   bool       ragged;
   const DasDs* pDs;
} DasDsUniqIter;
 
DAS_API void DasDsUniqIter_init(
   DasDsUniqIter* pThis, const DasDs* pDs, const DasVar* pVar
);
 
DAS_API bool DasDsUniqIter_next(DasDsUniqIter* pThis);
 
/* ************************************************************************* */
 
typedef struct das_cube_iter_t{
   
   bool       done;
   
   ptrdiff_t index[VARIDX_MAX];
   
   int        rank;
   ptrdiff_t  idxmin[VARIDX_MAX]; 
   ptrdiff_t  idxmax[VARIDX_MAX]; 
   
} DasDsCubeIter;
 
#define das_cube_iter DasDsCubeIter
#define das_cube_iter_init DasDsCubeIter_init
#define das_cube_iter_next DasDsCubeIter_next
 
DAS_API void DasDsCubeIter_init(
   das_cube_iter* pThis, int nRank, ptrdiff_t* pMin, ptrdiff_t* pMax 
);
 
DAS_API bool DasDsCubeIter_next(das_cube_iter* pThis);
 
typedef struct das_array_iter_t{
   const DasAry* pAry;
   bool          done;
   bool          ragged;             /* flag for no end_idx */
   bool          bNaturalEnd;       
   int           rank;
   ptrdiff_t     index[VARIDX_MAX];   /* current index */
   ptrdiff_t     end_idx[VARIDX_MAX]; /* 1 after last valid index */
   int           dim_min;
   int           dim_max;
 
   ptrdiff_t  shape[VARIDX_MAX];  /* Used for CUBIC arrays */
   ptrdiff_t  nLenLast;            /* Used for ragged arrays */
} DasAryIter;
 
 
DAS_API void DasAryIter_init(
   DasAryIter* pThis, const DasAry* pAry, int iDimMin, int iDimMax, ptrdiff_t* pBeg, 
   ptrdiff_t* pEnd
);
 
 
DAS_API bool DasAryIter_next(DasAryIter* pThis);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_dataset_h */