From 1dd1e55cb329d01c210da77ceb53027853c35b72 Mon Sep 17 00:00:00 2001 From: Francesc Alted Date: Wed, 21 Feb 2024 11:21:01 +0100 Subject: [PATCH] Complete docs on internal filters --- include/blosc2.h | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/include/blosc2.h b/include/blosc2.h index 00bac616..8aa7f039 100644 --- a/include/blosc2.h +++ b/include/blosc2.h @@ -245,14 +245,22 @@ enum { */ enum { #ifndef BLOSC_H - BLOSC_NOSHUFFLE = 0, //!< No shuffle (for compatibility with Blosc1). - BLOSC_NOFILTER = 0, //!< No filter. - BLOSC_SHUFFLE = 1, //!< Byte-wise shuffle. - BLOSC_BITSHUFFLE = 2, //!< Bit-wise shuffle. + BLOSC_NOSHUFFLE = 0, + //!< No shuffle (for compatibility with Blosc1). + BLOSC_NOFILTER = 0, + //!< No filter. + BLOSC_SHUFFLE = 1, + //!< Byte-wise shuffle. `filters_meta` does not have any effect here. + BLOSC_BITSHUFFLE = 2, + //!< Bit-wise shuffle. `filters_meta` does not have any effect here. #endif // BLOSC_H - BLOSC_DELTA = 3, //!< Delta filter. - BLOSC_TRUNC_PREC = 4, //!< Truncate mantissa precision; positive values in `filters_meta` will keep bits; negative values will zero bits. - BLOSC_LAST_FILTER = 5, //!< sentinel + BLOSC_DELTA = 3, + //!< Delta filter. `filters_meta` does not have any effect here. + BLOSC_TRUNC_PREC = 4, + //!< Truncate mantissa precision. + //!< Positive values in `filters_meta` will keep bits; negative values will zero bits. + BLOSC_LAST_FILTER = 5, + //!< sentinel BLOSC_LAST_REGISTERED_FILTER = BLOSC2_GLOBAL_REGISTERED_FILTERS_START + BLOSC2_GLOBAL_REGISTERED_FILTERS - 1, //!< Determine the last registered filter. It is used to check if a filter is registered or not. };