Library (H5)

General-purpose functions for use with entire HDF5 library

Description

Use the MATLAB^® HDF5 library interface, H5, to perform basic operations and access information on the HDF5 library.

Functions

H5.garbage_collect

Free unused memory in HDF5 library

H5.garbage_collect frees unused memory in the HDF5 library.

H5.get_libversion

Version of HDF5 library

[major,minor,relnum] = H5.get_libversion returns the version of the HDF5 library in use.

 Details

Output Arguments

• major — Major version of the library.

• minor — Minor version of the library.

• relnum — Release number of the library.

H5.set_free_list_limits

Set size limits on free lists

H5.set_free_list_limits(regGlobalLim,regListLim,arrGlobalLim,arrListLim,blkGlobalLim,blkListLim) sets size limits on all types of free lists.

 Details

Input Arguments

• regGlobalLim — The cumulative limit, in bytes, on memory used for all regular free lists (Default: 1 MB).

• regListLim — The limit, in bytes, on memory used for each regular free list (Default: 64 KB).

• arrGlobalLim —The cumulative limit, in bytes, on memory used for all array free lists (Default: 4 MB).

• arrListLim — The limit, in bytes, on memory used for each array free list (Default: 256 KB).

• blkGlobalLim — The cumulative limit, in bytes, on memory used for all block free lists and, separately, for all factory free lists (Default: 16 MB).

• blkListLim — The limit, in bytes, on memory used for each block or factory free list (Default: 1 MB).

H5.close

(Not recommended) No effect

H5.close is not recommended and has no effect.

Before R2026a: H5.close closes the HDF5 library.

H5.open

(Not recommended) No effect

H5.open is not recommended and has no effect.

Before R2026a: H5.open opens the HDF5 library.

Version History

Introduced before R2006a

R2026a: H5.open and H5.close functions are not recommended and have no effect

The H5.open and H5.close functions are not recommended and have no effect. Previously, these functions could be used to open and close the HDF5 library in MATLAB. You can still use type-specific functions to open and close HDF5 objects. For example, use the H5F.open and H5F.close functions to open and close an HDF5 file.