Safe Haskell | None |
---|---|
Language | Haskell2010 |
Bindings.HDF5.Raw.H5
Synopsis
- h5_VERS_MAJOR :: Num a => a
- h5_VERS_MINOR :: Num a => a
- h5_VERS_RELEASE :: Num a => a
- h5_VERS_SUBRELEASE :: String
- vers :: Version
- h5_VERS_INFO :: String
- h5_check :: HErr_t
- newtype HErr_t = HErr_t Int32
- newtype HBool_t = HBool_t Word8
- newtype HTri_t = HTri_t Int32
- newtype CSSize = CSSize Int64
- h5_SIZEOF_SSIZE_T :: CSize
- newtype HSize_t = HSize_t Word64
- newtype HSSize_t = HSSize_t Int64
- h5_SIZEOF_HSIZE_T :: CSize
- h5_SIZEOF_HSSIZE_T :: CSize
- hSIZE_UNDEF :: HSize_t
- newtype HAddr_t = HAddr_t Word64
- hADDR_UNDEF :: HAddr_t
- h5_SIZEOF_HADDR_T :: CSize
- h5_PRINTF_HADDR_FMT :: String
- hADDR_MAX :: HAddr_t
- newtype H5_iter_order_t = H5_iter_order_t Int32
- h5_ITER_UNKNOWN :: H5_iter_order_t
- h5_ITER_INC :: H5_iter_order_t
- h5_ITER_DEC :: H5_iter_order_t
- h5_ITER_NATIVE :: H5_iter_order_t
- h5_ITER_N :: Num a => a
- h5_ITER_ERROR :: HErr_t
- h5_ITER_CONT :: HErr_t
- h5_ITER_STOP :: HErr_t
- newtype H5_index_t = H5_index_t Int32
- h5_INDEX_UNKNOWN :: H5_index_t
- h5_INDEX_NAME :: H5_index_t
- h5_INDEX_CRT_ORDER :: H5_index_t
- h5_INDEX_N :: Num a => a
- data H5_ih_info_t = H5_ih_info_t {}
- p'H5_ih_info_t'index_size :: Ptr H5_ih_info_t -> Ptr HSize_t
- p'H5_ih_info_t'heap_size :: Ptr H5_ih_info_t -> Ptr HSize_t
- h5_open :: IO HErr_t
- p_H5open :: FunPtr (IO HErr_t)
- h5_close :: IO HErr_t
- p_H5close :: FunPtr (IO HErr_t)
- h5_dont_atexit :: IO HErr_t
- p_H5dont_atexit :: FunPtr (IO HErr_t)
- h5_garbage_collect :: IO HErr_t
- p_H5garbage_collect :: FunPtr (IO HErr_t)
- h5_set_free_list_limits :: CInt -> CInt -> CInt -> CInt -> CInt -> CInt -> IO HErr_t
- p_H5set_free_list_limits :: FunPtr (CInt -> CInt -> CInt -> CInt -> CInt -> CInt -> IO HErr_t)
- h5_get_libversion :: Out CUInt -> Out CUInt -> Out CUInt -> IO HErr_t
- p_H5get_libversion :: FunPtr (Out CUInt -> Out CUInt -> Out CUInt -> IO HErr_t)
- h5_check_version :: CUInt -> CUInt -> CUInt -> IO HErr_t
- p_H5check_version :: FunPtr (CUInt -> CUInt -> CUInt -> IO HErr_t)
Version numbers
h5_VERS_MAJOR :: Num a => a Source #
For major interface/format changes
h5_VERS_MINOR :: Num a => a Source #
For minor interface/format changes
h5_VERS_RELEASE :: Num a => a Source #
For tweaks, bug-fixes, or development
h5_VERS_SUBRELEASE :: String Source #
For pre-releases like snap0
h5_VERS_MAJOR
, et al., wrapped up as a Version
h5_VERS_INFO :: String Source #
Full version string
Check that the HDF5 library that is linked with the current executable is the same version that these bindings were compiled against. Returns 0 on success, calls abort() on failure.
Types and constants
Status return values. Failed integer functions in HDF5 result almost always in a negative value (unsigned failing functions sometimes return zero for failure) while successfull return is non-negative (often zero). The negative failure value is most commonly -1, but don't bet on it. The proper way to detect failure is something like:
if((dset = H5Dopen2(file, name)) < 0) fprintf(stderr, "unable to open the requested datasetn");
Constructors
HErr_t Int32 |
Instances
Boolean type. Successful return values are zero (false) or positive
(true). The typical true value is 1 but don't bet on it. Boolean
functions cannot fail. Functions that return htri_t
however return zero
(false), positive (true), or negative (failure). The proper way to test
for truth from a htri_t function is:
if ((retval = H5Tcommitted(type))>0) { printf("data type is committedn"); } else if (!retval) { printf("data type is not committedn"); } else { printf("error determining whether data type is committedn"); }
Constructors
HBool_t Word8 |
Instances
Storable HBool_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods peekElemOff :: Ptr HBool_t -> Int -> IO HBool_t pokeElemOff :: Ptr HBool_t -> Int -> HBool_t -> IO () peekByteOff :: Ptr b -> Int -> IO HBool_t pokeByteOff :: Ptr b -> Int -> HBool_t -> IO () | |
Show HBool_t Source # | |
Eq HBool_t Source # | |
NativeType HBool_t Source # | |
Defined in Bindings.HDF5.Datatype.Internal |
Constructors
HTri_t Int32 |
Instances
Storable HTri_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods peekElemOff :: Ptr HTri_t -> Int -> IO HTri_t pokeElemOff :: Ptr HTri_t -> Int -> HTri_t -> IO () peekByteOff :: Ptr b -> Int -> IO HTri_t pokeByteOff :: Ptr b -> Int -> HTri_t -> IO () | |
Show HTri_t Source # | |
Eq HTri_t Source # | |
HDFResultType HTri_t Source # | |
Defined in Bindings.HDF5.Core.HDFResultType |
C signed size type. This is a semi-standard POSIX type that isn't in the Foreign.C.Types module. It is in System.Posix.Types, but I'm not sure whether that module is available on all platforms.
Constructors
CSSize Int64 |
Instances
h5_SIZEOF_SSIZE_T :: CSize Source #
Constructors
HSize_t Word64 |
Instances
Constructors
HSSize_t Int64 |
Instances
h5_SIZEOF_HSIZE_T :: CSize Source #
h5_SIZEOF_HSSIZE_T :: CSize Source #
Constructors
HAddr_t Word64 |
Instances
h5_SIZEOF_HADDR_T :: CSize Source #
h5_PRINTF_HADDR_FMT :: String Source #
newtype H5_iter_order_t Source #
Common iteration orders
Constructors
H5_iter_order_t Int32 |
Instances
Storable H5_iter_order_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods sizeOf :: H5_iter_order_t -> Int alignment :: H5_iter_order_t -> Int peekElemOff :: Ptr H5_iter_order_t -> Int -> IO H5_iter_order_t pokeElemOff :: Ptr H5_iter_order_t -> Int -> H5_iter_order_t -> IO () peekByteOff :: Ptr b -> Int -> IO H5_iter_order_t pokeByteOff :: Ptr b -> Int -> H5_iter_order_t -> IO () peek :: Ptr H5_iter_order_t -> IO H5_iter_order_t poke :: Ptr H5_iter_order_t -> H5_iter_order_t -> IO () | |
Show H5_iter_order_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods showsPrec :: Int -> H5_iter_order_t -> ShowS show :: H5_iter_order_t -> String showList :: [H5_iter_order_t] -> ShowS | |
HDFResultType H5_iter_order_t Source # | |
Defined in Bindings.HDF5.Core.HDFResultType Methods isError :: H5_iter_order_t -> Bool Source # |
h5_ITER_UNKNOWN :: H5_iter_order_t Source #
Unknown order
h5_ITER_INC :: H5_iter_order_t Source #
Increasing order
h5_ITER_DEC :: H5_iter_order_t Source #
Decreasing order
h5_ITER_NATIVE :: H5_iter_order_t Source #
No particular order, whatever is fastest
h5_ITER_ERROR :: HErr_t Source #
Iteration callback return value indicating that iteration should stop and report an error.
h5_ITER_CONT :: HErr_t Source #
Iteration callback return value indicating that iteration should continue.
h5_ITER_STOP :: HErr_t Source #
Iteration callback return value indicating that iteration should stop without error.
Actually, any postive value will cause the iterator to stop and pass back that positive value to the function that called the iterator
newtype H5_index_t Source #
The types of indices on links in groups/attributes on objects. Primarily used for "<do> <foo> by index" routines and for iterating over links in groups/attributes on objects.
Constructors
H5_index_t Int32 |
Instances
Storable H5_index_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods sizeOf :: H5_index_t -> Int alignment :: H5_index_t -> Int peekElemOff :: Ptr H5_index_t -> Int -> IO H5_index_t pokeElemOff :: Ptr H5_index_t -> Int -> H5_index_t -> IO () peekByteOff :: Ptr b -> Int -> IO H5_index_t pokeByteOff :: Ptr b -> Int -> H5_index_t -> IO () peek :: Ptr H5_index_t -> IO H5_index_t poke :: Ptr H5_index_t -> H5_index_t -> IO () | |
Show H5_index_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods showsPrec :: Int -> H5_index_t -> ShowS show :: H5_index_t -> String showList :: [H5_index_t] -> ShowS | |
HDFResultType H5_index_t Source # | |
Defined in Bindings.HDF5.Core.HDFResultType Methods isError :: H5_index_t -> Bool Source # |
h5_INDEX_UNKNOWN :: H5_index_t Source #
Unknown index type
h5_INDEX_NAME :: H5_index_t Source #
Index on names
h5_INDEX_CRT_ORDER :: H5_index_t Source #
Index on creation order
h5_INDEX_N :: Num a => a Source #
Number of indices defined
data H5_ih_info_t Source #
Storage info struct used by H5O_info_t
and H5F_info_t
Constructors
H5_ih_info_t | |
Fields |
Instances
Storable H5_ih_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods sizeOf :: H5_ih_info_t -> Int alignment :: H5_ih_info_t -> Int peekElemOff :: Ptr H5_ih_info_t -> Int -> IO H5_ih_info_t pokeElemOff :: Ptr H5_ih_info_t -> Int -> H5_ih_info_t -> IO () peekByteOff :: Ptr b -> Int -> IO H5_ih_info_t pokeByteOff :: Ptr b -> Int -> H5_ih_info_t -> IO () peek :: Ptr H5_ih_info_t -> IO H5_ih_info_t poke :: Ptr H5_ih_info_t -> H5_ih_info_t -> IO () | |
Show H5_ih_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5 Methods showsPrec :: Int -> H5_ih_info_t -> ShowS show :: H5_ih_info_t -> String showList :: [H5_ih_info_t] -> ShowS | |
Eq H5_ih_info_t Source # | |
Defined in Bindings.HDF5.Raw.H5 |
Functions in H5.c
p'H5_ih_info_t'index_size :: Ptr H5_ih_info_t -> Ptr HSize_t Source #
Initialize the library. This is normally called automatically, but if you find that an HDF5 library function is failing inexplicably, then try calling this function first.
Return: Non-negative on success/Negative on failure
herr_t H5open(void);
p'H5_ih_info_t'heap_size :: Ptr H5_ih_info_t -> Ptr HSize_t Source #
h5_close :: IO HErr_t Source #
Terminate the library and release all resources.
Return: Non-negative on success/Negative on failure
herr_t H5close(void);
h5_dont_atexit :: IO HErr_t Source #
Indicates that the library is not to clean up after itself when the application exits by calling exit() or returning from main(). This function must be called before any other HDF5 function or constant is used or it will have no effect.
If this function is used then certain memory buffers will not be de-allocated nor will open files be flushed automatically. The application may still call H5close() explicitly to accomplish these things.
Return: non-negative on success, negative if this function is called more than once or if it is called too late.
herr_t H5dont_atexit(void);
p_H5dont_atexit :: FunPtr (IO HErr_t) Source #
h5_garbage_collect :: IO HErr_t Source #
Walks through all the garbage collection routines for the library, which are supposed to free any unused memory they have allocated.
These should probably be registered dynamicly in a linked list of functions to call, but there aren't that many right now, so we hard-wire them...
Return: non-negative on success, negative on failure
herr_t H5garbage_collect(void);
p_H5garbage_collect :: FunPtr (IO HErr_t) Source #
h5_set_free_list_limits :: CInt -> CInt -> CInt -> CInt -> CInt -> CInt -> IO HErr_t Source #
Sets limits on the different kinds of free lists. Setting a value of -1 for a limit means no limit of that type. These limits are global for the entire library. Each "global" limit only applies to free lists of that type, so if an application sets a limit of 1 MB on each of the global lists, up to 3 MB of total storage might be allocated (1MB on each of regular, array and block type lists).
The settings for block free lists are duplicated to factory free lists. Factory free list limits cannot be set independently currently.
Parameters:
reg_global_lim :: CInt
- The limit on all "regular" free list memory used
reg_list_lim :: CInt
- The limit on memory used in each "regular" free list
arr_global_lim :: CInt
- The limit on all "array" free list memory used
arr_list_lim :: CInt
- The limit on memory used in each "array" free list
blk_global_lim :: CInt
- The limit on all "block" free list memory used
blk_list_lim :: CInt
- The limit on memory used in each "block" free list
Return: non-negative on success, negative on failure
herr_t H5set_free_list_limits (int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim);
p_H5set_free_list_limits :: FunPtr (CInt -> CInt -> CInt -> CInt -> CInt -> CInt -> IO HErr_t) Source #
h5_get_libversion :: Out CUInt -> Out CUInt -> Out CUInt -> IO HErr_t Source #
Returns the library version numbers through arguments. MAJNUM will be the major revision number of the library, MINNUM the minor revision number, and RELNUM the release revision number.
Note: When printing an HDF5 version number it should be printed as
printf("%u.%u.%u", maj, min, rel) or printf("version %u.%u release %u", maj, min, rel)
Return: Non-negative on success/Negative on failure
herr_t H5get_libversion(unsigned *majnum, unsigned *minnum, unsigned *relnum);
h5_check_version :: CUInt -> CUInt -> CUInt -> IO HErr_t Source #
Purpose: Verifies that the arguments match the version numbers compiled into the library. This function is intended to be called from user to verify that the versions of header files compiled into the application match the version of the hdf5 library.
Return: Success: 0, Failure: calls abort()
herr_t H5check_version(unsigned majnum, unsigned minnum, unsigned relnum);
p_H5check_version :: FunPtr (CUInt -> CUInt -> CUInt -> IO HErr_t) Source #