From b03f64f9495342d3987376af3b6607c9ce7fd123 Mon Sep 17 00:00:00 2001 From: "Documenter.jl" Date: Mon, 4 Sep 2023 08:16:41 +0000 Subject: [PATCH] build based on 897c476 --- dev/api_bindings/index.html | 8 +++---- dev/example2.h5 | Bin 4176 -> 4176 bytes dev/index.html | 10 ++++---- dev/interface/attributes/index.html | 6 ++--- dev/interface/configuration/index.html | 2 +- dev/interface/dataset/index.html | 2 +- dev/interface/dataspaces/index.html | 6 ++--- dev/interface/datatype/index.html | 2 +- dev/interface/files/index.html | 8 +++---- dev/interface/filters/index.html | 6 ++--- dev/interface/groups/index.html | 4 ++-- dev/interface/objects/index.html | 6 ++--- dev/interface/properties/index.html | 32 ++++++++++++------------- dev/mpi/index.html | 2 +- dev/search/index.html | 2 +- dev/search_index.js | 2 +- 16 files changed, 49 insertions(+), 49 deletions(-) diff --git a/dev/api_bindings/index.html b/dev/api_bindings/index.html index 1f8209dfe..a129db2e0 100644 --- a/dev/api_bindings/index.html +++ b/dev/api_bindings/index.html @@ -1,10 +1,10 @@ Low-level library bindings · HDF5.jl
Edit on GitHub

Low-level library bindings

At the lowest level, HDF5.jl operates by calling the public API of the HDF5 shared library through a set of ccall wrapper functions. This page documents the function names and nominal C argument types of the API which have bindings in this package. Note that in many cases, high-level data types are valid arguments through automatic ccall conversions. For instance, HDF5.Datatype objects will be automatically converted to their hid_t ID by Julia's cconvert+unsafe_convert ccall rules.

There are additional helper wrappers (often for out-argument functions) which are not documented here.

H5 — General Library Functions

H5A — Attribute Interface

HDF5.API.h5a_create — Function
h5a_create(loc_id::hid_t, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Acreate2.

source
HDF5.API.h5a_create_by_name — Function
h5a_create_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Acreate_by_name.

source
HDF5.API.h5a_iterate — Function
h5a_iterate(obj_id::hid_t, idx_type::Cint, order::Cint, n::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)

See libhdf5 documentation for H5Aiterate2.

source
h5a_iterate(f, loc_id, idx_type, order, idx = 0) -> hsize_t

Executes h5a_iterate with the user-provided callback function f, returning the index where iteration ends.

The callback function must correspond to the signature

f(loc::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5A_info_t}) -> Union{Bool, Integer}

where a negative return value halts iteration abnormally (triggering an error), a true or a positive value halts iteration successfully, and false or zero continues iteration.

Examples

julia> HDF5.API.h5a_iterate(obj, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do loc, name, info
+gen/gen_wrappers.jl script -->
Low-level library bindings
At the lowest level, HDF5.jl operates by calling the public API of the HDF5 shared library through a set of ccall wrapper functions. This page documents the function names and nominal C argument types of the API which have bindings in this package. Note that in many cases, high-level data types are valid arguments through automatic ccall conversions. For instance, HDF5.Datatype objects will be automatically converted to their hid_t ID by Julia's cconvert+unsafe_convert ccall rules.
There are additional helper wrappers (often for out-argument functions) which are not documented here.
H5 — General Library Functions
H5A — Attribute Interface
HDF5.API.h5a_create — Function
h5a_create(loc_id::hid_t, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Acreate2.
source
HDF5.API.h5a_create_by_name — Function
h5a_create_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Acreate_by_name.
source
HDF5.API.h5a_iterate — Function
h5a_iterate(obj_id::hid_t, idx_type::Cint, order::Cint, n::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)
See libhdf5 documentation for H5Aiterate2.
source
h5a_iterate(f, loc_id, idx_type, order, idx = 0) -> hsize_t
Executes h5a_iterate with the user-provided callback function f, returning the index where iteration ends.
The callback function must correspond to the signature
f(loc::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5A_info_t}) -> Union{Bool, Integer}
where a negative return value halts iteration abnormally (triggering an error), a true or a positive value halts iteration successfully, and false or zero continues iteration.
Examples
julia> HDF5.API.h5a_iterate(obj, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do loc, name, info
            println(unsafe_string(name))
            return false
-       end
source
H5D — Dataset Interface
HDF5.API.h5d_chunk_iter — Function
h5d_chunk_iter(dset_id::hid_t, dxpl_id::hid_t, cb::Ptr{Nothing}, op_data::Any)
See libhdf5 documentation for H5Dchunk_iter.
source
h5d_chunk_iter(f, dataset, [dxpl_id=H5P_DEFAULT])
Call f(offset::Ptr{hsize_t}, filter_mask::Cuint, addr::haddr_t, size::hsize_t) for each chunk. dataset maybe a HDF5.Dataset or a dataset id. dxpl_id is the the dataset transfer property list and is optional.
Available only for HDF5 1.10.x series for 1.10.9 and greater or for version HDF5 1.12.3 or greater.
source
HDF5.API.h5d_create — Function
h5d_create(loc_id::hid_t, pathname::Cstring, dtype_id::hid_t, space_id::hid_t, lcpl_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Dcreate2.
source
HDF5.API.h5d_fill — Function
h5d_fill(fill::Ptr{Cvoid}, fill_type_id::hid_t, buf::Ptr{Cvoid}, buf_type_id::hid_t, space_id::hid_t)
See libhdf5 documentation for H5Dfill.
source
HDF5.API.h5d_gather — Function
h5d_gather(src_space_id::hid_t, src_buf::Ptr{Cvoid}, type_id::hid_t, dst_buf_size::Csize_t, dst_buf::Ptr{Cvoid}, op::Ptr{Cvoid}, op_data::Any)
See libhdf5 documentation for H5Dgather.
source
HDF5.API.h5d_get_chunk_info — Function
h5d_get_chunk_info(dataset_id::hid_t, fspace_id::hid_t, index::hsize_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_info.
source
h5d_get_chunk_info(dataset_id, fspace_id, index)
-h5d_get_chunk_info(dataset_id, index; fspace_id = HDF5.API.H5S_ALL)
Helper method to retrieve chunk information.
Returns a NamedTuple{(:offset, :filter_mask, :addr, :size), Tuple{HDF5.API.hsize_t, UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.
source
HDF5.API.h5d_get_chunk_info_by_coord — Function
h5d_get_chunk_info_by_coord(dataset_id::hid_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_info_by_coord.
source
h5d_get_chunk_info_by_coord(dataset_id, offset)
Helper method to read chunk information by coordinate. Returns a NamedTuple{(:filter_mask, :addr, :size), Tuple{UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.
source
HDF5.API.h5d_get_chunk_storage_size — Function
h5d_get_chunk_storage_size(dataset_id::hid_t, offset::Ptr{hsize_t}, chunk_nbytes::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_storage_size.
source
h5d_get_chunk_storage_size(dataset_id, offset)
Helper method to retrieve the chunk storage size in bytes. Returns an integer of type HDF5.API.hsize_t.
source
HDF5.API.h5d_get_space_status — Function
h5d_get_space_status(dataset_id::hid_t, status::Ref{Cint})
See libhdf5 documentation for H5Dget_space_status.
source
h5d_get_space_status(dataset_id)
Helper method to retrieve the status of the dataset space. Returns a HDF5.API.H5D_space_status_t (Cint) indicating the status, see HDF5.API.H5D_SPACE_STATUS_* constants.
source
HDF5.API.h5d_iterate — Function
h5d_iterate(buf::Ptr{Cvoid}, type_id::hid_t, space_id::hid_t, operator::Ptr{Cvoid}, operator_data::Any)
See libhdf5 documentation for H5Diterate.
source
HDF5.API.h5d_read — Function
h5d_read(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})
See libhdf5 documentation for H5Dread.
source
HDF5.API.h5d_vlen_get_buf_size — Function
h5d_vlen_get_buf_size(dset_id::hid_t, type_id::hid_t, space_id::hid_t, buf::Ptr{hsize_t})
See libhdf5 documentation for H5Dvlen_get_buf_size.
source
h5d_vlen_get_buf_size(dataset_id, type_id, space_id)
Helper method to determines the number of bytes required to store the variable length data from the dataset. Returns a value of type HDF5.API.hsize_t.
source
HDF5.API.h5d_write — Function
h5d_write(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})
See libhdf5 documentation for H5Dwrite.
source
H5E — Error Interface
HDF5.API.h5e_get_msg — Function
h5e_get_msg(mesg_id::hid_t, mesg_type::Ref{Cint}, mesg::Ref{UInt8}, len::Csize_t) -> Cssize_t
See libhdf5 documentation for H5Eget_msg.
source
mesg_type, mesg = h5e_get_msg(meshg_id)
source
H5F — File Interface
HDF5.API.h5f_get_free_sections — Function
h5f_get_free_sections(file_id::hid_t, type::H5F_mem_t, nsects::Csize_t, sect_info::Ptr{H5F_sect_info_t}) -> Cssize_t
See libhdf5 documentation for H5Fget_free_sections.
source
h5f_get_free_sections(file_id, type, [sect_info::AbstractVector{H5F_sect_info_t}])::AbstractVector{H5F_sect_info_t}
Return an AbstractVector of the free section information. If sect_info is not provided a new Vector will be allocated and returned. If sect_info is provided, a view, a SubArray, will be returned.
source
HDF5.API.h5f_get_mdc_size — Function
h5f_get_mdc_size(file_id::hid_t, max_size_ptr::Ptr{Csize_t}, min_clean_size_ptr::Ptr{Csize_t}, cur_size_ptr::Ptr{Csize_t}, cur_num_entries_ptr::Ptr{Cint})
See libhdf5 documentation for H5Fget_mdc_size.
source
H5G — Group Interface
HDF5.API.h5g_create — Function
h5g_create(loc_id::hid_t, pathname::Cstring, lcpl_id::hid_t, gcpl_id::hid_t, gapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Gcreate2.
source
H5I — Identifier Interface
H5L — Link Interface
HDF5.API.h5l_iterate — Function
h5l_iterate(group_id::hid_t, idx_type::Cint, order::Cint, idx::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)
See libhdf5 documentation for H5Literate1.
source
h5l_iterate(f, group_id, idx_type, order, idx = 0) -> hsize_t
Executes h5l_iterate with the user-provided callback function f, returning the index where iteration ends.
The callback function must correspond to the signature
f(group::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5L_info_t}) -> Union{Bool, Integer}
where a negative return value halts iteration abnormally, true or a positive value halts iteration successfully, and false or zero continues iteration.
Examples
julia> HDF5.API.h5l_iterate(hfile, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do group, name, info
+       end
source
H5D — Dataset Interface
HDF5.API.h5d_chunk_iter — Function
h5d_chunk_iter(dset_id::hid_t, dxpl_id::hid_t, cb::Ptr{Nothing}, op_data::Any)
See libhdf5 documentation for H5Dchunk_iter.
source
h5d_chunk_iter(f, dataset, [dxpl_id=H5P_DEFAULT])
Call f(offset::Ptr{hsize_t}, filter_mask::Cuint, addr::haddr_t, size::hsize_t) for each chunk. dataset maybe a HDF5.Dataset or a dataset id. dxpl_id is the the dataset transfer property list and is optional.
Available only for HDF5 1.10.x series for 1.10.9 and greater or for version HDF5 1.12.3 or greater.
source
HDF5.API.h5d_create — Function
h5d_create(loc_id::hid_t, pathname::Cstring, dtype_id::hid_t, space_id::hid_t, lcpl_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Dcreate2.
source
HDF5.API.h5d_fill — Function
h5d_fill(fill::Ptr{Cvoid}, fill_type_id::hid_t, buf::Ptr{Cvoid}, buf_type_id::hid_t, space_id::hid_t)
See libhdf5 documentation for H5Dfill.
source
HDF5.API.h5d_gather — Function
h5d_gather(src_space_id::hid_t, src_buf::Ptr{Cvoid}, type_id::hid_t, dst_buf_size::Csize_t, dst_buf::Ptr{Cvoid}, op::Ptr{Cvoid}, op_data::Any)
See libhdf5 documentation for H5Dgather.
source
HDF5.API.h5d_get_chunk_info — Function
h5d_get_chunk_info(dataset_id::hid_t, fspace_id::hid_t, index::hsize_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_info.
source
h5d_get_chunk_info(dataset_id, fspace_id, index)
+h5d_get_chunk_info(dataset_id, index; fspace_id = HDF5.API.H5S_ALL)
Helper method to retrieve chunk information.
Returns a NamedTuple{(:offset, :filter_mask, :addr, :size), Tuple{HDF5.API.hsize_t, UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.
source
HDF5.API.h5d_get_chunk_info_by_coord — Function
h5d_get_chunk_info_by_coord(dataset_id::hid_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_info_by_coord.
source
h5d_get_chunk_info_by_coord(dataset_id, offset)
Helper method to read chunk information by coordinate. Returns a NamedTuple{(:filter_mask, :addr, :size), Tuple{UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.
source
HDF5.API.h5d_get_chunk_storage_size — Function
h5d_get_chunk_storage_size(dataset_id::hid_t, offset::Ptr{hsize_t}, chunk_nbytes::Ptr{hsize_t})
See libhdf5 documentation for H5Dget_chunk_storage_size.
source
h5d_get_chunk_storage_size(dataset_id, offset)
Helper method to retrieve the chunk storage size in bytes. Returns an integer of type HDF5.API.hsize_t.
source
HDF5.API.h5d_get_space_status — Function
h5d_get_space_status(dataset_id::hid_t, status::Ref{Cint})
See libhdf5 documentation for H5Dget_space_status.
source
h5d_get_space_status(dataset_id)
Helper method to retrieve the status of the dataset space. Returns a HDF5.API.H5D_space_status_t (Cint) indicating the status, see HDF5.API.H5D_SPACE_STATUS_* constants.
source
HDF5.API.h5d_iterate — Function
h5d_iterate(buf::Ptr{Cvoid}, type_id::hid_t, space_id::hid_t, operator::Ptr{Cvoid}, operator_data::Any)
See libhdf5 documentation for H5Diterate.
source
HDF5.API.h5d_read — Function
h5d_read(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})
See libhdf5 documentation for H5Dread.
source
HDF5.API.h5d_vlen_get_buf_size — Function
h5d_vlen_get_buf_size(dset_id::hid_t, type_id::hid_t, space_id::hid_t, buf::Ptr{hsize_t})
See libhdf5 documentation for H5Dvlen_get_buf_size.
source
h5d_vlen_get_buf_size(dataset_id, type_id, space_id)
Helper method to determines the number of bytes required to store the variable length data from the dataset. Returns a value of type HDF5.API.hsize_t.
source
HDF5.API.h5d_write — Function
h5d_write(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})
See libhdf5 documentation for H5Dwrite.
source
H5E — Error Interface
HDF5.API.h5e_get_msg — Function
h5e_get_msg(mesg_id::hid_t, mesg_type::Ref{Cint}, mesg::Ref{UInt8}, len::Csize_t) -> Cssize_t
See libhdf5 documentation for H5Eget_msg.
source
mesg_type, mesg = h5e_get_msg(meshg_id)
source
H5F — File Interface
HDF5.API.h5f_get_free_sections — Function
h5f_get_free_sections(file_id::hid_t, type::H5F_mem_t, nsects::Csize_t, sect_info::Ptr{H5F_sect_info_t}) -> Cssize_t
See libhdf5 documentation for H5Fget_free_sections.
source
h5f_get_free_sections(file_id, type, [sect_info::AbstractVector{H5F_sect_info_t}])::AbstractVector{H5F_sect_info_t}
Return an AbstractVector of the free section information. If sect_info is not provided a new Vector will be allocated and returned. If sect_info is provided, a view, a SubArray, will be returned.
source
HDF5.API.h5f_get_mdc_size — Function
h5f_get_mdc_size(file_id::hid_t, max_size_ptr::Ptr{Csize_t}, min_clean_size_ptr::Ptr{Csize_t}, cur_size_ptr::Ptr{Csize_t}, cur_num_entries_ptr::Ptr{Cint})
See libhdf5 documentation for H5Fget_mdc_size.
source
H5G — Group Interface
HDF5.API.h5g_create — Function
h5g_create(loc_id::hid_t, pathname::Cstring, lcpl_id::hid_t, gcpl_id::hid_t, gapl_id::hid_t) -> hid_t
See libhdf5 documentation for H5Gcreate2.
source
H5I — Identifier Interface
H5L — Link Interface
HDF5.API.h5l_iterate — Function
h5l_iterate(group_id::hid_t, idx_type::Cint, order::Cint, idx::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)
See libhdf5 documentation for H5Literate1.
source
h5l_iterate(f, group_id, idx_type, order, idx = 0) -> hsize_t
Executes h5l_iterate with the user-provided callback function f, returning the index where iteration ends.
The callback function must correspond to the signature
f(group::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5L_info_t}) -> Union{Bool, Integer}
where a negative return value halts iteration abnormally, true or a positive value halts iteration successfully, and false or zero continues iteration.
Examples
julia> HDF5.API.h5l_iterate(hfile, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do group, name, info
            println(unsafe_string(name))
            return HDF5.API.herr_t(0)
-       end
source
HDF5.API.h5l_move — Function
h5l_move(src_obj_id::hid_t, src_name::Cstring, dest_obj_id::hid_t, dest_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)
See libhdf5 documentation for H5Lmove.
source
H5O — Object Interface
HDF5.API.h5o_copy — Function
h5o_copy(src_loc_id::hid_t, src_name::Cstring, dst_loc_id::hid_t, dst_name::Cstring, ocpypl_id::hid_t, lcpl_id::hid_t)
See libhdf5 documentation for H5Ocopy.
source
HDF5.API.h5o_get_info_by_idx — Function
h5o_get_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)
See libhdf5 documentation for H5Oget_info_by_idx3.
source
HDF5.API.h5o_link — Function
h5o_link(obj_id::hid_t, new_loc_id::hid_t, new_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)
See libhdf5 documentation for H5Olink.
source
HDF5.API.h5o_visit — Function
h5o_visit(obj_id::hid_t, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint)
See libhdf5 documentation for H5Ovisit3.
source
HDF5.API.h5o_visit_by_name — Function
h5o_visit_by_name(loc_id::hid_t, obj_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint, lapl_id::hid_t)
See libhdf5 documentation for H5Ovisit_by_name3.
source
H5PL — Plugin Interface
H5P — Property Interface
HDF5.API.h5p_create_class — Function
h5p_create_class(parent::hid_t, name::Cstring, create::H5P_cls_create_func_t, create_data::Ptr{Cvoid}, copy::H5P_cls_copy_func_t, copy_data::Ptr{Cvoid}, close::H5P_cls_close_func_t, close_data::Ptr{Cvoid}) -> hid_t
See libhdf5 documentation for H5Pcreate_class.
source
HDF5.API.h5p_encode — Function
h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t})
See libhdf5 documentation for H5Pencode1.
source
h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t}, fapl_id::hid_t)
See libhdf5 documentation for H5Pencode2.
source
HDF5.API.h5p_get_cache — Function
h5p_get_cache(plist_id::hid_t, mdc_nelmts::Ptr{Cint}, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})
See libhdf5 documentation for H5Pget_cache.
source
HDF5.API.h5p_get_fapl_multi — Function
h5p_get_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Ptr{Cchar}}, memb_addr::Ptr{haddr_t}, relax::Ptr{hbool_t})
See libhdf5 documentation for H5Pget_fapl_multi.
source
HDF5.API.h5p_get_filter — Function
h5p_get_filter(plist_id::hid_t, idx::Cuint, flags::Ptr{Cuint}, cd_nemlts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{Cchar}, filter_config::Ptr{Cuint}) -> H5Z_filter_t
See libhdf5 documentation for H5Pget_filter2.
source
HDF5.API.h5p_get_filter_by_id — Function
h5p_get_filter_by_id(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Ref{Cuint}, cd_nelmts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{UInt8}, filter_config::Ptr{Cuint})
See libhdf5 documentation for H5Pget_filter_by_id2.
source
HDF5.API.h5p_insert — Function
h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_delete::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)
See libhdf5 documentation for H5Pinsert1.
source
h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)
See libhdf5 documentation for H5Pinsert2.
source
HDF5.API.h5p_register — Function
h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, prp_create::H5P_prp_create_func_t, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)
See libhdf5 documentation for H5Pregister1.
source
h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, create::H5P_prp_create_func_t, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)
See libhdf5 documentation for H5Pregister2.
source
H5R — Reference Interface
HDF5.API.h5r_create — Function
h5r_create(ref::Ptr{Cvoid}, loc_id::hid_t, pathname::Cstring, ref_type::Cint, space_id::hid_t)
See libhdf5 documentation for H5Rcreate.
source
H5S — Dataspace Interface
H5T — Datatype Interface
HDF5.API.h5t_commit — Function
h5t_commit(loc_id::hid_t, name::Cstring, dtype_id::hid_t, lcpl_id::hid_t, tcpl_id::hid_t, tapl_id::hid_t)
See libhdf5 documentation for H5Tcommit2.
source
HDF5.API.h5t_get_fields — Function
h5t_get_fields(dtype_id::hid_t, spos::Ref{Csize_t}, epos::Ref{Csize_t}, esize::Ref{Csize_t}, mpos::Ref{Csize_t}, msize::Ref{Csize_t})
See libhdf5 documentation for H5Tget_fields.
source
H5Z — Filter Interface
H5FD — File Drivers
H5DO — Optimized Functions Interface
HDF5.API.h5do_append — Function
h5do_append(dset_id::hid_t, dxpl_id::hid_t, index::Cuint, num_elem::hsize_t, memtype::hid_t, buffer::Ptr{Cvoid})
See libhdf5 documentation for H5DOappend.
source
H5DS — Dimension Scale Interface
H5LT — Lite Interface
H5TB — Table Interface
HDF5.API.h5tb_append_records — Function
h5tb_append_records(loc_id::hid_t, dset_name::Cstring, nrecords::hsize_t, type_size::Csize_t, field_offset::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})
See libhdf5 documentation for H5TBappend_records.
source
HDF5.API.h5tb_get_field_info — Function
h5tb_get_field_info(loc_id::hid_t, table_name::Cstring, field_names::Ptr{Ptr{UInt8}}, field_sizes::Ptr{Csize_t}, field_offsets::Ptr{Csize_t}, type_size::Ptr{Csize_t})
See libhdf5 documentation for H5TBget_field_info.
source
HDF5.API.h5tb_make_table — Function
h5tb_make_table(table_title::Cstring, loc_id::hid_t, dset_name::Cstring, nfields::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_names::Ptr{Cstring}, field_offset::Ptr{Csize_t}, field_types::Ptr{hid_t}, chunk_size::hsize_t, fill_data::Ptr{Cvoid}, compress::Cint, data::Ptr{Cvoid})
See libhdf5 documentation for H5TBmake_table.
source
HDF5.API.h5tb_read_records — Function
h5tb_read_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})
See libhdf5 documentation for H5TBread_records.
source
HDF5.API.h5tb_read_table — Function
h5tb_read_table(loc_id::hid_t, table_name::Cstring, dst_size::Csize_t, dst_offset::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, dst_buf::Ptr{Cvoid})
See libhdf5 documentation for H5TBread_table.
source
HDF5.API.h5tb_write_records — Function
h5tb_write_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})
See libhdf5 documentation for H5TBwrite_records.
source
+ endsource
HDF5.API.h5l_move — Function
h5l_move(src_obj_id::hid_t, src_name::Cstring, dest_obj_id::hid_t, dest_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)

See libhdf5 documentation for H5Lmove.

source

H5O — Object Interface

HDF5.API.h5o_are_mdc_flushes_disabled — Function
h5o_are_mdc_flushes_disabled(object_id::hid_t, are_disabled::Ptr{hbool_t})

See libhdf5 documentation for H5Oare_mdc_flushes_disabled.

source
HDF5.API.h5o_close — Function
h5o_close(object_id::hid_t)

See libhdf5 documentation for H5Oclose.

source
HDF5.API.h5o_copy — Function
h5o_copy(src_loc_id::hid_t, src_name::Cstring, dst_loc_id::hid_t, dst_name::Cstring, ocpypl_id::hid_t, lcpl_id::hid_t)

See libhdf5 documentation for H5Ocopy.

source
HDF5.API.h5o_decr_refcount — Function
h5o_decr_refcount(object_id::hid_t)

See libhdf5 documentation for H5Odecr_refcount.

source
HDF5.API.h5o_disable_mdc_flushes — Function
h5o_disable_mdc_flushes(object_id::hid_t)

See libhdf5 documentation for H5Odisable_mdc_flushes.

source
HDF5.API.h5o_enable_mdc_flushes — Function
h5o_enable_mdc_flushes(object_id::hid_t)

See libhdf5 documentation for H5Oenable_mdc_flushes.

source
HDF5.API.h5o_exists_by_name — Function
h5o_exists_by_name(loc_id::hid_t, name::Cstring, lapl_id::hid_t) -> Bool

See libhdf5 documentation for H5Oexists_by_name.

source
HDF5.API.h5o_flush — Function
h5o_flush(obj_id::hid_t)

See libhdf5 documentation for H5Oflush.

source
HDF5.API.h5o_get_comment — Function
h5o_get_comment(obj_id::hid_t, comment::Ptr{Cchar}, bufsize::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Oget_comment.

source
HDF5.API.h5o_get_comment_by_name — Function
h5o_get_comment_by_name(loc_id::hid_t, name::Cstring, comment::Ptr{Cchar}, bufsize::Csize_t, lapl_id::hid_t) -> Cssize_t

See libhdf5 documentation for H5Oget_comment_by_name.

source
HDF5.API.h5o_get_info — Function
h5o_get_info(loc_id::hid_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint)

See libhdf5 documentation for H5Oget_info3.

source
HDF5.API.h5o_get_info1 — Function
h5o_get_info1(object_id, [buf])

Deprecated HDF5 function. Use h5o_get_info or h5o_get_native_info if possible.

See libhdf5 documentation for H5Oget_info1.

source
HDF5.API.h5o_get_info_by_idx — Function
h5o_get_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)

See libhdf5 documentation for H5Oget_info_by_idx3.

source
HDF5.API.h5o_get_info_by_name — Function
h5o_get_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)

See libhdf5 documentation for H5Oget_info_by_name3.

source
HDF5.API.h5o_get_native_info — Function
h5o_get_native_info(loc_id::hid_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint)

See libhdf5 documentation for H5Oget_native_info.

source
HDF5.API.h5o_get_native_info_by_idx — Function
h5o_get_native_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)

See libhdf5 documentation for H5Oget_native_info_by_idx.

source
HDF5.API.h5o_get_native_info_by_name — Function
h5o_get_native_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)

See libhdf5 documentation for H5Oget_native_info_by_name.

source
HDF5.API.h5o_incr_refcount — Function
h5o_incr_refcount(object_id::hid_t)

See libhdf5 documentation for H5Oincr_refcount.

source
HDF5.API.h5o_link — Function
h5o_link(obj_id::hid_t, new_loc_id::hid_t, new_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)

See libhdf5 documentation for H5Olink.

source
HDF5.API.h5o_open — Function
h5o_open(loc_id::hid_t, pathname::Cstring, lapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Oopen.

source
HDF5.API.h5o_open_by_addr — Function
h5o_open_by_addr(loc_id::hid_t, addr::haddr_t) -> hid_t

See libhdf5 documentation for H5Oopen_by_addr.

source
HDF5.API.h5o_open_by_idx — Function
h5o_open_by_idx(loc_id::hid_t, group_name::Cstring, index_type::Cint, order::Cint, n::hsize_t, lapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Oopen_by_idx.

source
HDF5.API.h5o_refresh — Function
h5o_refresh(oid::hid_t)

See libhdf5 documentation for H5Orefresh.

source
HDF5.API.h5o_set_comment — Function
h5o_set_comment(obj_id::hid_t, comment::Cstring)

See libhdf5 documentation for H5Oset_comment.

source
HDF5.API.h5o_set_comment_by_name — Function
h5o_set_comment_by_name(loc_id::hid_t, name::Cstring, comment::Cstring, lapl_id::hid_t)

See libhdf5 documentation for H5Oset_comment_by_name.

source
HDF5.API.h5o_token_cmp — Function
h5o_token_cmp(loc_id::hid_t, token1::Ptr{H5O_token_t}, token2::Ptr{H5O_token_t}, cmp_value::Ptr{Cint})

See libhdf5 documentation for H5Otoken_cmp.

source
HDF5.API.h5o_token_from_str — Function
h5o_token_from_str(loc_id::hid_t, token_str::Cstring, token::Ptr{H5O_token_t})

See libhdf5 documentation for H5Otoken_from_str.

source
HDF5.API.h5o_token_to_str — Function
h5o_token_to_str(loc_id::hid_t, token::Ptr{H5O_token_t}, token_str::Ptr{Ptr{Cchar}})

See libhdf5 documentation for H5Otoken_to_str.

source
HDF5.API.h5o_visit — Function
h5o_visit(obj_id::hid_t, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint)

See libhdf5 documentation for H5Ovisit3.

source
HDF5.API.h5o_visit_by_name — Function
h5o_visit_by_name(loc_id::hid_t, obj_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint, lapl_id::hid_t)

See libhdf5 documentation for H5Ovisit_by_name3.

source

H5PL — Plugin Interface

HDF5.API.h5pl_append — Function
h5pl_append(search_path::Cstring)

See libhdf5 documentation for H5PLappend.

source
HDF5.API.h5pl_get — Function
h5pl_get(index::Cuint, path_buf::Ptr{Cchar}, buf_size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5PLget.

source
HDF5.API.h5pl_get_loading_state — Function
h5pl_get_loading_state(plugin_control_mask::Ptr{Cuint})

See libhdf5 documentation for H5PLget_loading_state.

source
HDF5.API.h5pl_insert — Function
h5pl_insert(search_path::Cstring, index::Cuint)

See libhdf5 documentation for H5PLinsert.

source
HDF5.API.h5pl_prepend — Function
h5pl_prepend(search_path::Cstring)

See libhdf5 documentation for H5PLprepend.

source
HDF5.API.h5pl_remove — Function
h5pl_remove(index::Cuint)

See libhdf5 documentation for H5PLremove.

source
HDF5.API.h5pl_replace — Function
h5pl_replace(search_path::Cstring, index::Cuint)

See libhdf5 documentation for H5PLreplace.

source
HDF5.API.h5pl_set_loading_state — Function
h5pl_set_loading_state(plugin_control_mask::Cuint)

See libhdf5 documentation for H5PLset_loading_state.

source
HDF5.API.h5pl_size — Function
h5pl_size(num_paths::Ptr{Cuint})

See libhdf5 documentation for H5PLsize.

source

H5P — Property Interface

HDF5.API.h5p_add_merge_committed_dtype_path — Function
h5p_add_merge_committed_dtype_path(plist_id::hid_t, path::Cstring)

See libhdf5 documentation for H5Padd_merge_committed_dtype_path.

source
HDF5.API.h5p_all_filters_avail — Function
h5p_all_filters_avail(plist_id::hid_t) -> Bool

See libhdf5 documentation for H5Pall_filters_avail.

source
HDF5.API.h5p_close — Function
h5p_close(id::hid_t)

See libhdf5 documentation for H5Pclose.

source
HDF5.API.h5p_close_class — Function
h5p_close_class(plist_id::hid_t)

See libhdf5 documentation for H5Pclose_class.

source
HDF5.API.h5p_copy — Function
h5p_copy(plist_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pcopy.

source
HDF5.API.h5p_copy_prop — Function
h5p_copy_prop(dst_id::hid_t, src_id::hid_t, name::Cstring)

See libhdf5 documentation for H5Pcopy_prop.

source
HDF5.API.h5p_create — Function
h5p_create(cls_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pcreate.

source
HDF5.API.h5p_create_class — Function
h5p_create_class(parent::hid_t, name::Cstring, create::H5P_cls_create_func_t, create_data::Ptr{Cvoid}, copy::H5P_cls_copy_func_t, copy_data::Ptr{Cvoid}, close::H5P_cls_close_func_t, close_data::Ptr{Cvoid}) -> hid_t

See libhdf5 documentation for H5Pcreate_class.

source
HDF5.API.h5p_decode — Function
h5p_decode(buf::Ptr{Cvoid}) -> hid_t

See libhdf5 documentation for H5Pdecode.

source
HDF5.API.h5p_encode — Function
h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t})

See libhdf5 documentation for H5Pencode1.

source
h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t}, fapl_id::hid_t)

See libhdf5 documentation for H5Pencode2.

source
HDF5.API.h5p_equal — Function
h5p_equal(id1::hid_t, id2::hid_t) -> Bool

See libhdf5 documentation for H5Pequal.

source
HDF5.API.h5p_exist — Function
h5p_exist(plist_id::hid_t, name::Cstring) -> Bool

See libhdf5 documentation for H5Pexist.

source
HDF5.API.h5p_fill_value_defined — Function
h5p_fill_value_defined(plist::hid_t, status::Ptr{H5D_fill_value_t})

See libhdf5 documentation for H5Pfill_value_defined.

source
HDF5.API.h5p_free_merge_committed_dtype_paths — Function
h5p_free_merge_committed_dtype_paths(plist_id::hid_t)

See libhdf5 documentation for H5Pfree_merge_committed_dtype_paths.

source
HDF5.API.h5p_get — Function
h5p_get(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})

See libhdf5 documentation for H5Pget.

source
HDF5.API.h5p_get_alignment — Function
h5p_get_alignment(fapl_id::hid_t, threshold::Ref{hsize_t}, alignment::Ref{hsize_t})

See libhdf5 documentation for H5Pget_alignment.

source
HDF5.API.h5p_get_alloc_time — Function
h5p_get_alloc_time(plist_id::hid_t, alloc_time::Ptr{Cint})

See libhdf5 documentation for H5Pget_alloc_time.

source
HDF5.API.h5p_get_append_flush — Function
h5p_get_append_flush(dapl_id::hid_t, dims::Cuint, boundary::Ptr{hsize_t}, func::Ptr{H5D_append_cb_t}, udata::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_append_flush.

source
HDF5.API.h5p_get_attr_creation_order — Function
h5p_get_attr_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})

See libhdf5 documentation for H5Pget_attr_creation_order.

source
HDF5.API.h5p_get_attr_phase_change — Function
h5p_get_attr_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})

See libhdf5 documentation for H5Pget_attr_phase_change.

source
HDF5.API.h5p_get_btree_ratios — Function
h5p_get_btree_ratios(plist_id::hid_t, left::Ptr{Cdouble}, middle::Ptr{Cdouble}, right::Ptr{Cdouble})

See libhdf5 documentation for H5Pget_btree_ratios.

source
HDF5.API.h5p_get_buffer — Function
h5p_get_buffer(plist_id::hid_t, tconv::Ptr{Ptr{Cvoid}}, bkg::Ptr{Ptr{Cvoid}}) -> Csize_t

See libhdf5 documentation for H5Pget_buffer.

source
HDF5.API.h5p_get_cache — Function
h5p_get_cache(plist_id::hid_t, mdc_nelmts::Ptr{Cint}, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})

See libhdf5 documentation for H5Pget_cache.

source
HDF5.API.h5p_get_char_encoding — Function
h5p_get_char_encoding(plist_id::hid_t, encoding::Ref{Cint})

See libhdf5 documentation for H5Pget_char_encoding.

source
HDF5.API.h5p_get_chunk — Function
h5p_get_chunk(plist_id::hid_t, n_dims::Cint, dims::Ptr{hsize_t}) -> Int

See libhdf5 documentation for H5Pget_chunk.

source
HDF5.API.h5p_get_chunk_cache — Function
h5p_get_chunk_cache(dapl_id::hid_t, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})

See libhdf5 documentation for H5Pget_chunk_cache.

source
HDF5.API.h5p_get_chunk_opts — Function
h5p_get_chunk_opts(plist_id::hid_t, opts::Ptr{Cuint})

See libhdf5 documentation for H5Pget_chunk_opts.

source
HDF5.API.h5p_get_class — Function
h5p_get_class(plist_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pget_class.

source
HDF5.API.h5p_get_class_name — Function
h5p_get_class_name(pcid::hid_t) -> String

See libhdf5 documentation for H5P_GET_CLASS_NAME.

source
HDF5.API.h5p_get_class_parent — Function
h5p_get_class_parent(pclass_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pget_class_parent.

source
HDF5.API.h5p_get_copy_object — Function
h5p_get_copy_object(plist_id::hid_t, copy_options::Ptr{Cuint})

See libhdf5 documentation for H5Pget_copy_object.

source
HDF5.API.h5p_get_core_write_tracking — Function
h5p_get_core_write_tracking(fapl_id::hid_t, is_enabled::Ptr{hbool_t}, page_size::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_core_write_tracking.

source
HDF5.API.h5p_get_create_intermediate_group — Function
h5p_get_create_intermediate_group(lcpl_id::hid_t, crt_intermed_group::Ref{Cuint})

See libhdf5 documentation for H5Pget_create_intermediate_group.

source
HDF5.API.h5p_get_data_transform — Function
h5p_get_data_transform(plist_id::hid_t, expression::Ptr{Cchar}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_data_transform.

source
HDF5.API.h5p_get_driver — Function
h5p_get_driver(plist_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5p_get_driver_info — Function
h5p_get_driver_info(plist_id::hid_t) -> Ptr{Cvoid}

See libhdf5 documentation for H5Pget_driver_info.

source
HDF5.API.h5p_get_dset_no_attrs_hint — Function
h5p_get_dset_no_attrs_hint(dcpl_id::hid_t, minimize::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_dset_no_attrs_hint.

source
HDF5.API.h5p_get_dxpl_mpio — Function
h5p_get_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Ptr{Cint})

See libhdf5 documentation for H5Pget_dxpl_mpio.

source
HDF5.API.h5p_get_edc_check — Function
h5p_get_edc_check(plist_id::hid_t) -> H5Z_EDC_t

See libhdf5 documentation for H5Pget_edc_check.

source
HDF5.API.h5p_get_efile_prefix — Function
h5p_get_efile_prefix(dapl_id::hid_t, prefix::Ptr{UInt8}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_efile_prefix.

source
HDF5.API.h5p_get_elink_acc_flags — Function
h5p_get_elink_acc_flags(lapl_id::hid_t, flags::Ptr{Cuint})

See libhdf5 documentation for H5Pget_elink_acc_flags.

source
HDF5.API.h5p_get_elink_cb — Function
h5p_get_elink_cb(lapl_id::hid_t, func::Ptr{H5L_elink_traverse_t}, op_data::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_elink_cb.

source
HDF5.API.h5p_get_elink_fapl — Function
h5p_get_elink_fapl(lapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Pget_elink_fapl.

source
HDF5.API.h5p_get_elink_file_cache_size — Function
h5p_get_elink_file_cache_size(plist_id::hid_t, efc_size::Ptr{Cuint})

See libhdf5 documentation for H5Pget_elink_file_cache_size.

source
HDF5.API.h5p_get_elink_prefix — Function
h5p_get_elink_prefix(plist_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_elink_prefix.

source
HDF5.API.h5p_get_est_link_info — Function
h5p_get_est_link_info(plist_id::hid_t, est_num_entries::Ptr{Cuint}, est_name_len::Ptr{Cuint})

See libhdf5 documentation for H5Pget_est_link_info.

source
HDF5.API.h5p_get_evict_on_close — Function
h5p_get_evict_on_close(fapl_id::hid_t, evict_on_close::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_evict_on_close.

source
HDF5.API.h5p_get_external — Function
h5p_get_external(plist::hid_t, idx::Cuint, name_size::Csize_t, name::Ptr{Cuchar}, offset::Ptr{off_t}, size::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_external.

source
HDF5.API.h5p_get_external_count — Function
h5p_get_external_count(plist::hid_t) -> Int

See libhdf5 documentation for H5Pget_external_count.

source
HDF5.API.h5p_get_family_offset — Function
h5p_get_family_offset(fapl_id::hid_t, offset::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_family_offset.

source
HDF5.API.h5p_get_fapl_core — Function
h5p_get_fapl_core(fapl_id::hid_t, increment::Ptr{Csize_t}, backing_store::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_fapl_core.

source
HDF5.API.h5p_get_fapl_family — Function
h5p_get_fapl_family(fapl_id::hid_t, memb_size::Ptr{hsize_t}, memb_fapl_id::Ptr{hid_t})

See libhdf5 documentation for H5Pget_fapl_family.

source
HDF5.API.h5p_get_fapl_hdfs — Function
h5p_get_fapl_hdfs(fapl_id::hid_t, fa_out::Ptr{H5FD_hdfs_fapl_t})

See libhdf5 documentation for H5Pget_fapl_hdfs.

source
HDF5.API.h5p_get_fapl_mpio — Function
h5p_get_fapl_mpio(fapl_id::hid_t, comm::Ptr{MPI.MPI_Comm}, info::Ptr{MPI.MPI_Info})

See libhdf5 documentation for H5Pget_fapl_mpio.

source
HDF5.API.h5p_get_fapl_multi — Function
h5p_get_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Ptr{Cchar}}, memb_addr::Ptr{haddr_t}, relax::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_fapl_multi.

source
HDF5.API.h5p_get_fapl_ros3 — Function
h5p_get_fapl_ros3(fapl_id::hid_t, fa_out::Ptr{H5FD_ros3_fapl_t})

See libhdf5 documentation for H5Pget_fapl_ros3.

source
HDF5.API.h5p_get_fapl_splitter — Function
h5p_get_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})

See libhdf5 documentation for H5Pget_fapl_splitter.

source
HDF5.API.h5p_get_fclose_degree — Function
h5p_get_fclose_degree(fapl_id::hid_t, fc_degree::Ref{Cint})

See libhdf5 documentation for H5Pget_fclose_degree.

source
HDF5.API.h5p_get_file_image — Function
h5p_get_file_image(fapl_id::hid_t, buf_ptr_ptr::Ptr{Ptr{Cvoid}}, buf_len_ptr::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_file_image.

source
HDF5.API.h5p_get_file_image_callbacks — Function
h5p_get_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})

See libhdf5 documentation for H5Pget_file_image_callbacks.

source
HDF5.API.h5p_get_file_locking — Function
h5p_get_file_locking(fapl_id::hid_t, use_file_locking::Ptr{hbool_t}, ignore_when_disabled::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_file_locking.

source
HDF5.API.h5p_get_file_space — Function
h5p_get_file_space(plist_id::hid_t, strategy::Ptr{H5F_file_space_type_t}, threshold::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_file_space.

source
HDF5.API.h5p_get_file_space_page_size — Function
h5p_get_file_space_page_size(plist_id::hid_t, fsp_size::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_file_space_page_size.

source
HDF5.API.h5p_get_file_space_strategy — Function
h5p_get_file_space_strategy(plist_id::hid_t, strategy::Ptr{H5F_fspace_strategy_t}, persist::Ptr{hbool_t}, threshold::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_file_space_strategy.

source
HDF5.API.h5p_get_fill_time — Function
h5p_get_fill_time(plist_id::hid_t, fill_time::Ptr{H5D_fill_time_t})

See libhdf5 documentation for H5Pget_fill_time.

source
HDF5.API.h5p_get_fill_value — Function
h5p_get_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})

See libhdf5 documentation for H5Pget_fill_value.

source
HDF5.API.h5p_get_filter — Function
h5p_get_filter(plist_id::hid_t, idx::Cuint, flags::Ptr{Cuint}, cd_nemlts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{Cchar}, filter_config::Ptr{Cuint}) -> H5Z_filter_t

See libhdf5 documentation for H5Pget_filter2.

source
HDF5.API.h5p_get_filter_by_id — Function
h5p_get_filter_by_id(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Ref{Cuint}, cd_nelmts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{UInt8}, filter_config::Ptr{Cuint})

See libhdf5 documentation for H5Pget_filter_by_id2.

source
HDF5.API.h5p_get_gc_references — Function
h5p_get_gc_references(fapl_id::hid_t, gc_ref::Ptr{Cuint})

See libhdf5 documentation for H5Pget_gc_references.

source
HDF5.API.h5p_get_hyper_vector_size — Function
h5p_get_hyper_vector_size(fapl_id::hid_t, size::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_hyper_vector_size.

source
HDF5.API.h5p_get_istore_k — Function
h5p_get_istore_k(plist_id::hid_t, ik::Ptr{Cuint})

See libhdf5 documentation for H5Pget_istore_k.

source
HDF5.API.h5p_get_layout — Function
h5p_get_layout(plist_id::hid_t) -> Int

See libhdf5 documentation for H5Pget_layout.

source
HDF5.API.h5p_get_libver_bounds — Function
h5p_get_libver_bounds(fapl_id::hid_t, low::Ref{Cint}, high::Ref{Cint})

See libhdf5 documentation for H5Pget_libver_bounds.

source
HDF5.API.h5p_get_link_creation_order — Function
h5p_get_link_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})

See libhdf5 documentation for H5Pget_link_creation_order.

source
HDF5.API.h5p_get_link_phase_change — Function
h5p_get_link_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})

See libhdf5 documentation for H5Pget_link_phase_change.

source
HDF5.API.h5p_get_local_heap_size_hint — Function
h5p_get_local_heap_size_hint(plist_id::hid_t, size_hint::Ref{Csize_t})

See libhdf5 documentation for H5Pget_local_heap_size_hint.

source
HDF5.API.h5p_get_mcdt_search_cb — Function
h5p_get_mcdt_search_cb(plist_id::hid_t, func::Ptr{H5O_mcdt_search_cb_t}, op_data::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_mcdt_search_cb.

source
HDF5.API.h5p_get_mdc_config — Function
h5p_get_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})

See libhdf5 documentation for H5Pget_mdc_config.

source
HDF5.API.h5p_get_mdc_image_config — Function
h5p_get_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})

See libhdf5 documentation for H5Pget_mdc_image_config.

source
HDF5.API.h5p_get_mdc_log_options — Function
h5p_get_mdc_log_options(plist_id::hid_t, is_enabled::Ptr{hbool_t}, location::Ptr{Cchar}, location_size::Ptr{Csize_t}, start_on_access::Ptr{hbool_t})

See libhdf5 documentation for H5Pget_mdc_log_options.

source
HDF5.API.h5p_get_meta_block_size — Function
h5p_get_meta_block_size(fapl_id::hid_t, size::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_meta_block_size.

source
HDF5.API.h5p_get_metadata_read_attempts — Function
h5p_get_metadata_read_attempts(plist_id::hid_t, attempts::Ptr{Cuint})

See libhdf5 documentation for H5Pget_metadata_read_attempts.

source
HDF5.API.h5p_get_multi_type — Function
h5p_get_multi_type(fapl_id::hid_t, type::Ptr{H5FD_mem_t})

See libhdf5 documentation for H5Pget_multi_type.

source
HDF5.API.h5p_get_nfilters — Function
h5p_get_nfilters(plist_id::hid_t) -> Int

See libhdf5 documentation for H5Pget_nfilters.

source
HDF5.API.h5p_get_nlinks — Function
h5p_get_nlinks(plist_id::hid_t, nlinks::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_nlinks.

source
HDF5.API.h5p_get_nprops — Function
h5p_get_nprops(id::hid_t, nprops::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_nprops.

source
HDF5.API.h5p_get_obj_track_times — Function
h5p_get_obj_track_times(plist_id::hid_t, track_times::Ref{UInt8})

See libhdf5 documentation for H5Pget_obj_track_times.

source
HDF5.API.h5p_get_object_flush_cb — Function
h5p_get_object_flush_cb(plist_id::hid_t, func::Ptr{H5F_flush_cb_t}, udata::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_object_flush_cb.

source
HDF5.API.h5p_get_page_buffer_size — Function
h5p_get_page_buffer_size(plist_id::hid_t, buf_size::Ptr{Csize_t}, min_meta_perc::Ptr{Cuint}, min_raw_perc::Ptr{Cuint})

See libhdf5 documentation for H5Pget_page_buffer_size.

source
HDF5.API.h5p_get_preserve — Function
h5p_get_preserve(plist_id::hid_t) -> Int

See libhdf5 documentation for H5Pget_preserve.

source
HDF5.API.h5p_get_shared_mesg_index — Function
h5p_get_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Ptr{Cuint}, min_mesg_size::Ptr{Cuint})

See libhdf5 documentation for H5Pget_shared_mesg_index.

source
HDF5.API.h5p_get_shared_mesg_nindexes — Function
h5p_get_shared_mesg_nindexes(plist_id::hid_t, nindexes::Ptr{Cuint})

See libhdf5 documentation for H5Pget_shared_mesg_nindexes.

source
HDF5.API.h5p_get_shared_mesg_phase_change — Function
h5p_get_shared_mesg_phase_change(plist_id::hid_t, max_list::Ptr{Cuint}, min_btree::Ptr{Cuint})

See libhdf5 documentation for H5Pget_shared_mesg_phase_change.

source
HDF5.API.h5p_get_sieve_buf_size — Function
h5p_get_sieve_buf_size(fapl_id::hid_t, size::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_sieve_buf_size.

source
HDF5.API.h5p_get_size — Function
h5p_get_size(id::hid_t, name::Ptr{Cchar}, size::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_size.

source
HDF5.API.h5p_get_sizes — Function
h5p_get_sizes(plist_id::hid_t, sizeof_addr::Ptr{Csize_t}, sizeof_size::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_sizes.

source
HDF5.API.h5p_get_small_data_block_size — Function
h5p_get_small_data_block_size(fapl_id::hid_t, size::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_small_data_block_size.

source
HDF5.API.h5p_get_sym_k — Function
h5p_get_sym_k(plist_id::hid_t, ik::Ptr{Cuint}, lk::Ptr{Cuint})

See libhdf5 documentation for H5Pget_sym_k.

source
HDF5.API.h5p_get_type_conv_cb — Function
h5p_get_type_conv_cb(dxpl_id::hid_t, op::Ptr{H5T_conv_except_func_t}, operate_data::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_type_conv_cb.

source
HDF5.API.h5p_get_userblock — Function
h5p_get_userblock(plist_id::hid_t, len::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_userblock.

source
HDF5.API.h5p_get_version — Function
h5p_get_version(plist_id::hid_t, boot::Ptr{Cuint}, freelist::Ptr{Cuint}, stab::Ptr{Cuint}, shhdr::Ptr{Cuint})

See libhdf5 documentation for H5Pget_version.

source
HDF5.API.h5p_get_virtual_count — Function
h5p_get_virtual_count(dcpl_id::hid_t, count::Ptr{Csize_t})

See libhdf5 documentation for H5Pget_virtual_count.

source
HDF5.API.h5p_get_virtual_dsetname — Function
h5p_get_virtual_dsetname(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_virtual_dsetname.

source
HDF5.API.h5p_get_virtual_filename — Function
h5p_get_virtual_filename(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_virtual_filename.

source
HDF5.API.h5p_get_virtual_prefix — Function
h5p_get_virtual_prefix(dapl_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5Pget_virtual_prefix.

source
HDF5.API.h5p_get_virtual_printf_gap — Function
h5p_get_virtual_printf_gap(dapl_id::hid_t, gap_size::Ptr{hsize_t})

See libhdf5 documentation for H5Pget_virtual_printf_gap.

source
HDF5.API.h5p_get_virtual_srcspace — Function
h5p_get_virtual_srcspace(dcpl_id::hid_t, index::Csize_t) -> hid_t

See libhdf5 documentation for H5Pget_virtual_srcspace.

source
HDF5.API.h5p_get_virtual_view — Function
h5p_get_virtual_view(dapl_id::hid_t, view::Ptr{H5D_vds_view_t})

See libhdf5 documentation for H5Pget_virtual_view.

source
HDF5.API.h5p_get_virtual_vspace — Function
h5p_get_virtual_vspace(dcpl_id::hid_t, index::Csize_t) -> hid_t

See libhdf5 documentation for H5Pget_virtual_vspace.

source
HDF5.API.h5p_get_vlen_mem_manager — Function
h5p_get_vlen_mem_manager(plist_id::hid_t, alloc_func::Ptr{H5MM_allocate_t}, alloc_info::Ptr{Ptr{Cvoid}}, free_func::Ptr{H5MM_free_t}, free_info::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_vlen_mem_manager.

source
HDF5.API.h5p_get_vol_id — Function
h5p_get_vol_id(plist_id::hid_t, vol_id::Ptr{hid_t})

See libhdf5 documentation for H5Pget_vol_id.

source
HDF5.API.h5p_get_vol_info — Function
h5p_get_vol_info(plist_id::hid_t, vol_info::Ptr{Ptr{Cvoid}})

See libhdf5 documentation for H5Pget_vol_info.

source
HDF5.API.h5p_insert — Function
h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_delete::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)

See libhdf5 documentation for H5Pinsert1.

source
h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)

See libhdf5 documentation for H5Pinsert2.

source
HDF5.API.h5p_isa_class — Function
h5p_isa_class(plist_id::hid_t, pclass_id::hid_t) -> Bool

See libhdf5 documentation for H5Pisa_class.

source
HDF5.API.h5p_iterate — Function
h5p_iterate(id::hid_t, idx::Ptr{Cint}, iter_func::H5P_iterate_t, iter_data::Ptr{Cvoid}) -> Int

See libhdf5 documentation for H5Piterate.

source
HDF5.API.h5p_modify_filter — Function
h5p_modify_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})

See libhdf5 documentation for H5Pmodify_filter.

source
HDF5.API.h5p_register — Function
h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, prp_create::H5P_prp_create_func_t, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)

See libhdf5 documentation for H5Pregister1.

source
h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, create::H5P_prp_create_func_t, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)

See libhdf5 documentation for H5Pregister2.

source
HDF5.API.h5p_remove — Function
h5p_remove(plist_id::hid_t, name::Cstring)

See libhdf5 documentation for H5Premove.

source
HDF5.API.h5p_remove_filter — Function
h5p_remove_filter(plist_id::hid_t, filter_id::H5Z_filter_t)

See libhdf5 documentation for H5Premove_filter.

source
HDF5.API.h5p_set — Function
h5p_set(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})

See libhdf5 documentation for H5Pset.

source
HDF5.API.h5p_set_alignment — Function
h5p_set_alignment(plist_id::hid_t, threshold::hsize_t, alignment::hsize_t)

See libhdf5 documentation for H5Pset_alignment.

source
HDF5.API.h5p_set_alloc_time — Function
h5p_set_alloc_time(plist_id::hid_t, alloc_time::Cint)

See libhdf5 documentation for H5Pset_alloc_time.

source
HDF5.API.h5p_set_append_flush — Function
h5p_set_append_flush(dapl_id::hid_t, ndims::Cuint, boundary::Ptr{hsize_t}, func::H5D_append_cb_t, udata::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_append_flush.

source
HDF5.API.h5p_set_attr_creation_order — Function
h5p_set_attr_creation_order(plist_id::hid_t, crt_order_flags::Cuint)

See libhdf5 documentation for H5Pset_attr_creation_order.

source
HDF5.API.h5p_set_attr_phase_change — Function
h5p_set_attr_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)

See libhdf5 documentation for H5Pset_attr_phase_change.

source
HDF5.API.h5p_set_btree_ratios — Function
h5p_set_btree_ratios(plist_id::hid_t, left::Cdouble, middle::Cdouble, right::Cdouble)

See libhdf5 documentation for H5Pset_btree_ratios.

source
HDF5.API.h5p_set_buffer — Function
h5p_set_buffer(plist_id::hid_t, size::Csize_t, tconv::Ptr{Cvoid}, bkg::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_buffer.

source
HDF5.API.h5p_set_cache — Function
h5p_set_cache(plist_id::hid_t, mdc_nelmts::Cint, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)

See libhdf5 documentation for H5Pset_cache.

source
HDF5.API.h5p_set_char_encoding — Function
h5p_set_char_encoding(plist_id::hid_t, encoding::Cint)

See libhdf5 documentation for H5Pset_char_encoding.

source
HDF5.API.h5p_set_chunk — Function
h5p_set_chunk(plist_id::hid_t, ndims::Cint, dims::Ptr{hsize_t})

See libhdf5 documentation for H5Pset_chunk.

source
HDF5.API.h5p_set_chunk_cache — Function
h5p_set_chunk_cache(dapl_id::hid_t, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)

See libhdf5 documentation for H5Pset_chunk_cache.

source
HDF5.API.h5p_set_chunk_opts — Function
h5p_set_chunk_opts(plist_id::hid_t, opts::Cuint)

See libhdf5 documentation for H5Pset_chunk_opts.

source
HDF5.API.h5p_set_copy_object — Function
h5p_set_copy_object(plist_id::hid_t, copy_options::Cuint)

See libhdf5 documentation for H5Pset_copy_object.

source
HDF5.API.h5p_set_core_write_tracking — Function
h5p_set_core_write_tracking(fapl_id::hid_t, is_enabled::hbool_t, page_size::Csize_t)

See libhdf5 documentation for H5Pset_core_write_tracking.

source
HDF5.API.h5p_set_create_intermediate_group — Function
h5p_set_create_intermediate_group(plist_id::hid_t, setting::Cuint)

See libhdf5 documentation for H5Pset_create_intermediate_group.

source
HDF5.API.h5p_set_data_transform — Function
h5p_set_data_transform(plist_id::hid_t, expression::Cstring)

See libhdf5 documentation for H5Pset_data_transform.

source
HDF5.API.h5p_set_deflate — Function
h5p_set_deflate(plist_id::hid_t, setting::Cuint)

See libhdf5 documentation for H5Pset_deflate.

source
HDF5.API.h5p_set_driver — Function
h5p_set_driver(plist_id::hid_t, driver_id::hid_t, driver_info::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_driver.

source
HDF5.API.h5p_set_dset_no_attrs_hint — Function
h5p_set_dset_no_attrs_hint(dcpl_id::hid_t, minimize::hbool_t)

See libhdf5 documentation for H5Pset_dset_no_attrs_hint.

source
HDF5.API.h5p_set_dxpl_mpio — Function
h5p_set_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Cint)

See libhdf5 documentation for H5Pset_dxpl_mpio.

source
HDF5.API.h5p_set_edc_check — Function
h5p_set_edc_check(plist_id::hid_t, check::H5Z_EDC_t)

See libhdf5 documentation for H5Pset_edc_check.

source
HDF5.API.h5p_set_efile_prefix — Function
h5p_set_efile_prefix(plist_id::hid_t, prefix::Cstring)

See libhdf5 documentation for H5Pset_efile_prefix.

source
HDF5.API.h5p_set_elink_acc_flags — Function
h5p_set_elink_acc_flags(lapl_id::hid_t, flags::Cuint)

See libhdf5 documentation for H5Pset_elink_acc_flags.

source
HDF5.API.h5p_set_elink_cb — Function
h5p_set_elink_cb(lapl_id::hid_t, func::H5L_elink_traverse_t, op_data::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_elink_cb.

source
HDF5.API.h5p_set_elink_fapl — Function
h5p_set_elink_fapl(lapl_id::hid_t, fapl_id::hid_t)

See libhdf5 documentation for H5Pset_elink_fapl.

source
HDF5.API.h5p_set_elink_file_cache_size — Function
h5p_set_elink_file_cache_size(plist_id::hid_t, efc_size::Cuint)

See libhdf5 documentation for H5Pset_elink_file_cache_size.

source
HDF5.API.h5p_set_elink_prefix — Function
h5p_set_elink_prefix(plist_id::hid_t, prefix::Cstring)

See libhdf5 documentation for H5Pset_elink_prefix.

source
HDF5.API.h5p_set_est_link_info — Function
h5p_set_est_link_info(plist_id::hid_t, est_num_entries::Cuint, est_name_len::Cuint)

See libhdf5 documentation for H5Pset_est_link_info.

source
HDF5.API.h5p_set_evict_on_close — Function
h5p_set_evict_on_close(fapl_id::hid_t, evict_on_close::hbool_t)

See libhdf5 documentation for H5Pset_evict_on_close.

source
HDF5.API.h5p_set_external — Function
h5p_set_external(plist_id::hid_t, name::Cstring, offset::off_t, size::hsize_t)

See libhdf5 documentation for H5Pset_external.

source
HDF5.API.h5p_set_family_offset — Function
h5p_set_family_offset(fapl_id::hid_t, offset::hsize_t)

See libhdf5 documentation for H5Pset_family_offset.

source
HDF5.API.h5p_set_fapl_core — Function
h5p_set_fapl_core(fapl_id::hid_t, increment::Csize_t, backing_store::hbool_t)

See libhdf5 documentation for H5Pset_fapl_core.

source
HDF5.API.h5p_set_fapl_family — Function
h5p_set_fapl_family(fapl_id::hid_t, memb_size::hsize_t, memb_fapl_id::hid_t)

See libhdf5 documentation for H5Pset_fapl_family.

source
HDF5.API.h5p_set_fapl_hdfs — Function
h5p_set_fapl_hdfs(fapl_id::hid_t, fa::Ptr{H5FD_hdfs_fapl_t})

See libhdf5 documentation for H5Pset_fapl_hdfs.

source
HDF5.API.h5p_set_fapl_log — Function
h5p_set_fapl_log(fapl_id::hid_t, logfile::Cstring, flags::Culonglong, buf_size::Csize_t)

See libhdf5 documentation for H5Pset_fapl_log.

source
HDF5.API.h5p_set_fapl_mpio — Function
h5p_set_fapl_mpio(fapl_id::hid_t, comm::MPI.MPI_Comm, info::MPI.MPI_Info)

See libhdf5 documentation for H5Pset_fapl_mpio.

source
HDF5.API.h5p_set_fapl_multi — Function
h5p_set_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Cstring}, memb_addr::Ptr{haddr_t}, relax::hbool_t)

See libhdf5 documentation for H5Pset_fapl_multi.

source
HDF5.API.h5p_set_fapl_ros3 — Function
h5p_set_fapl_ros3(fapl_id::hid_t, fa::Ptr{H5FD_ros3_fapl_t})

See libhdf5 documentation for H5Pset_fapl_ros3.

source
HDF5.API.h5p_set_fapl_sec2 — Function
h5p_set_fapl_sec2(fapl_id::hid_t)

See libhdf5 documentation for H5Pset_fapl_sec2.

source
HDF5.API.h5p_set_fapl_split — Function
h5p_set_fapl_split(fapl::hid_t, meta_ext::Cstring, meta_plist_id::hid_t, raw_ext::Cstring, raw_plist_id::hid_t)

See libhdf5 documentation for H5Pset_fapl_split.

source
HDF5.API.h5p_set_fapl_splitter — Function
h5p_set_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})

See libhdf5 documentation for H5Pset_fapl_splitter.

source
HDF5.API.h5p_set_fapl_stdio — Function
h5p_set_fapl_stdio(fapl_id::hid_t)

See libhdf5 documentation for H5Pset_fapl_stdio.

source
HDF5.API.h5p_set_fapl_windows — Function
h5p_set_fapl_windows(fapl_id::hid_t)

See libhdf5 documentation for H5Pset_fapl_windows.

source
HDF5.API.h5p_set_fclose_degree — Function
h5p_set_fclose_degree(plist_id::hid_t, fc_degree::Cint)

See libhdf5 documentation for H5Pset_fclose_degree.

source
HDF5.API.h5p_set_file_image — Function
h5p_set_file_image(fapl_id::hid_t, buf_ptr::Ptr{Cvoid}, buf_len::Csize_t)

See libhdf5 documentation for H5Pset_file_image.

source
HDF5.API.h5p_set_file_image_callbacks — Function
h5p_set_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})

See libhdf5 documentation for H5Pset_file_image_callbacks.

source
HDF5.API.h5p_set_file_locking — Function
h5p_set_file_locking(fapl_id::hid_t, use_file_locking::hbool_t, ignore_when_disabled::hbool_t)

See libhdf5 documentation for H5Pset_file_locking.

source
HDF5.API.h5p_set_file_space — Function
h5p_set_file_space(plist_id::hid_t, strategy::H5F_file_space_type_t, threshold::hsize_t)

See libhdf5 documentation for H5Pset_file_space.

source
HDF5.API.h5p_set_file_space_page_size — Function
h5p_set_file_space_page_size(plist_id::hid_t, fsp_size::hsize_t)

See libhdf5 documentation for H5Pset_file_space_page_size.

source
HDF5.API.h5p_set_file_space_strategy — Function
h5p_set_file_space_strategy(plist_id::hid_t, strategy::H5F_fspace_strategy_t, persist::hbool_t, threshold::hsize_t)

See libhdf5 documentation for H5Pset_file_space_strategy.

source
HDF5.API.h5p_set_fill_time — Function
h5p_set_fill_time(plist_id::hid_t, fill_time::H5D_fill_time_t)

See libhdf5 documentation for H5Pset_fill_time.

source
HDF5.API.h5p_set_fill_value — Function
h5p_set_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_fill_value.

source
HDF5.API.h5p_set_filter — Function
h5p_set_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})

See libhdf5 documentation for H5Pset_filter.

source
HDF5.API.h5p_set_filter_callback — Function
h5p_set_filter_callback(plist_id::hid_t, func::H5Z_filter_func_t, op_data::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_filter_callback.

source
HDF5.API.h5p_set_fletcher32 — Function
h5p_set_fletcher32(plist_id::hid_t)

See libhdf5 documentation for H5Pset_fletcher32.

source
HDF5.API.h5p_set_gc_references — Function
h5p_set_gc_references(fapl_id::hid_t, gc_ref::Cuint)

See libhdf5 documentation for H5Pset_gc_references.

source
HDF5.API.h5p_set_hyper_vector_size — Function
h5p_set_hyper_vector_size(plist_id::hid_t, size::Csize_t)

See libhdf5 documentation for H5Pset_hyper_vector_size.

source
HDF5.API.h5p_set_istore_k — Function
h5p_set_istore_k(plist_id::hid_t, ik::Cuint)

See libhdf5 documentation for H5Pset_istore_k.

source
HDF5.API.h5p_set_layout — Function
h5p_set_layout(plist_id::hid_t, setting::Cint)

See libhdf5 documentation for H5Pset_layout.

source
HDF5.API.h5p_set_libver_bounds — Function
h5p_set_libver_bounds(fapl_id::hid_t, low::Cint, high::Cint)

See libhdf5 documentation for H5Pset_libver_bounds.

source
HDF5.API.h5p_set_link_creation_order — Function
h5p_set_link_creation_order(plist_id::hid_t, crt_order_flags::Cuint)

See libhdf5 documentation for H5Pset_link_creation_order.

source
HDF5.API.h5p_set_link_phase_change — Function
h5p_set_link_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)

See libhdf5 documentation for H5Pset_link_phase_change.

source
HDF5.API.h5p_set_local_heap_size_hint — Function
h5p_set_local_heap_size_hint(plist_id::hid_t, size_hint::Csize_t)

See libhdf5 documentation for H5Pset_local_heap_size_hint.

source
HDF5.API.h5p_set_mcdt_search_cb — Function
h5p_set_mcdt_search_cb(plist_id::hid_t, func::H5O_mcdt_search_cb_t, op_data::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_mcdt_search_cb.

source
HDF5.API.h5p_set_mdc_config — Function
h5p_set_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})

See libhdf5 documentation for H5Pset_mdc_config.

source
HDF5.API.h5p_set_mdc_image_config — Function
h5p_set_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})

See libhdf5 documentation for H5Pset_mdc_image_config.

source
HDF5.API.h5p_set_mdc_log_options — Function
h5p_set_mdc_log_options(plist_id::hid_t, is_enabled::hbool_t, location::Cstring, start_on_access::hbool_t)

See libhdf5 documentation for H5Pset_mdc_log_options.

source
HDF5.API.h5p_set_meta_block_size — Function
h5p_set_meta_block_size(fapl_id::hid_t, size::hsize_t)

See libhdf5 documentation for H5Pset_meta_block_size.

source
HDF5.API.h5p_set_metadata_read_attempts — Function
h5p_set_metadata_read_attempts(plist_id::hid_t, attempts::Cuint)

See libhdf5 documentation for H5Pset_metadata_read_attempts.

source
HDF5.API.h5p_set_multi_type — Function
h5p_set_multi_type(fapl_id::hid_t, type::H5FD_mem_t)

See libhdf5 documentation for H5Pset_multi_type.

source
HDF5.API.h5p_set_nbit — Function
h5p_set_nbit(plist_id::hid_t)

See libhdf5 documentation for H5Pset_nbit.

source
HDF5.API.h5p_set_nlinks — Function
h5p_set_nlinks(plist_id::hid_t, nlinks::Csize_t)

See libhdf5 documentation for H5Pset_nlinks.

source
HDF5.API.h5p_set_obj_track_times — Function
h5p_set_obj_track_times(plist_id::hid_t, track_times::UInt8)

See libhdf5 documentation for H5Pset_obj_track_times.

source
HDF5.API.h5p_set_object_flush_cb — Function
h5p_set_object_flush_cb(plist_id::hid_t, func::H5F_flush_cb_t, udata::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_object_flush_cb.

source
HDF5.API.h5p_set_page_buffer_size — Function
h5p_set_page_buffer_size(plist_id::hid_t, buf_size::Csize_t, min_meta_per::Cuint, min_raw_per::Cuint)

See libhdf5 documentation for H5Pset_page_buffer_size.

source
HDF5.API.h5p_set_preserve — Function
h5p_set_preserve(plist_id::hid_t, status::hbool_t)

See libhdf5 documentation for H5Pset_preserve.

source
HDF5.API.h5p_set_scaleoffset — Function
h5p_set_scaleoffset(plist_id::hid_t, scale_type::Cint, scale_factor::Cint)

See libhdf5 documentation for H5Pset_scaleoffset.

source
HDF5.API.h5p_set_shared_mesg_index — Function
h5p_set_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Cuint, min_mesg_size::Cuint)

See libhdf5 documentation for H5Pset_shared_mesg_index.

source
HDF5.API.h5p_set_shared_mesg_nindexes — Function
h5p_set_shared_mesg_nindexes(plist_id::hid_t, nindexes::Cuint)

See libhdf5 documentation for H5Pset_shared_mesg_nindexes.

source
HDF5.API.h5p_set_shared_mesg_phase_change — Function
h5p_set_shared_mesg_phase_change(plist_id::hid_t, max_list::Cuint, min_btree::Cuint)

See libhdf5 documentation for H5Pset_shared_mesg_phase_change.

source
HDF5.API.h5p_set_shuffle — Function
h5p_set_shuffle(plist_id::hid_t)

See libhdf5 documentation for H5Pset_shuffle.

source
HDF5.API.h5p_set_sieve_buf_size — Function
h5p_set_sieve_buf_size(fapl_id::hid_t, size::Csize_t)

See libhdf5 documentation for H5Pset_sieve_buf_size.

source
HDF5.API.h5p_set_sizes — Function
h5p_set_sizes(plist_id::hid_t, sizeof_addr::Csize_t, sizeof_size::Csize_t)

See libhdf5 documentation for H5Pset_sizes.

source
HDF5.API.h5p_set_small_data_block_size — Function
h5p_set_small_data_block_size(fapl_id::hid_t, size::hsize_t)

See libhdf5 documentation for H5Pset_small_data_block_size.

source
HDF5.API.h5p_set_sym_k — Function
h5p_set_sym_k(plist_id::hid_t, ik::Cuint, lk::Cuint)

See libhdf5 documentation for H5Pset_sym_k.

source
HDF5.API.h5p_set_szip — Function
h5p_set_szip(plist_id::hid_t, options_mask::Cuint, pixels_per_block::Cuint)

See libhdf5 documentation for H5Pset_szip.

source
HDF5.API.h5p_set_type_conv_cb — Function
h5p_set_type_conv_cb(dxpl_id::hid_t, op::H5T_conv_except_func_t, operate_data::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_type_conv_cb.

source
HDF5.API.h5p_set_userblock — Function
h5p_set_userblock(plist_id::hid_t, len::hsize_t)

See libhdf5 documentation for H5Pset_userblock.

source
HDF5.API.h5p_set_virtual — Function
h5p_set_virtual(dcpl_id::hid_t, vspace_id::hid_t, src_file_name::Cstring, src_dset_name::Cstring, src_space_id::hid_t)

See libhdf5 documentation for H5Pset_virtual.

source
HDF5.API.h5p_set_virtual_prefix — Function
h5p_set_virtual_prefix(dapl_id::hid_t, prefix::Cstring)

See libhdf5 documentation for H5Pset_virtual_prefix.

source
HDF5.API.h5p_set_virtual_printf_gap — Function
h5p_set_virtual_printf_gap(dapl_id::hid_t, gap_size::hsize_t)

See libhdf5 documentation for H5Pset_virtual_printf_gap.

source
HDF5.API.h5p_set_virtual_view — Function
h5p_set_virtual_view(dapl_id::hid_t, view::H5D_vds_view_t)

See libhdf5 documentation for H5Pset_virtual_view.

source
HDF5.API.h5p_set_vlen_mem_manager — Function
h5p_set_vlen_mem_manager(plist_id::hid_t, alloc_func::H5MM_allocate_t, alloc_info::Ptr{Cvoid}, free_func::H5MM_free_t, free_info::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_vlen_mem_manager.

source
HDF5.API.h5p_set_vol — Function
h5p_set_vol(plist_id::hid_t, new_vol_id::hid_t, new_vol_info::Ptr{Cvoid})

See libhdf5 documentation for H5Pset_vol.

source
HDF5.API.h5p_unregister — Function
h5p_unregister(pclass_id::hid_t, name::Cstring)

See libhdf5 documentation for H5Punregister.

source

H5R — Reference Interface

HDF5.API.h5r_create — Function
h5r_create(ref::Ptr{Cvoid}, loc_id::hid_t, pathname::Cstring, ref_type::Cint, space_id::hid_t)

See libhdf5 documentation for H5Rcreate.

source
HDF5.API.h5r_dereference — Function
h5r_dereference(obj_id::hid_t, oapl_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t

See libhdf5 documentation for H5Rdereference2.

source
HDF5.API.h5r_get_obj_type — Function
h5r_get_obj_type(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}, obj_type::Ptr{Cint})

See libhdf5 documentation for H5Rget_obj_type2.

source
HDF5.API.h5r_get_region — Function
h5r_get_region(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t

See libhdf5 documentation for H5Rget_region.

source

H5S — Dataspace Interface

HDF5.API.h5s_close — Function
h5s_close(space_id::hid_t)

See libhdf5 documentation for H5Sclose.

source
HDF5.API.h5s_combine_hyperslab — Function
h5s_combine_hyperslab(dspace_id::hid_t, seloper::H5S_seloper_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})

See libhdf5 documentation for H5Scombine_hyperslab.

source
HDF5.API.h5s_combine_select — Function
h5s_combine_select(space1_id::hid_t, op::H5S_seloper_t, space2_id::hid_t) -> hid_t

See libhdf5 documentation for H5Scombine_select.

source
HDF5.API.h5s_copy — Function
h5s_copy(space_id::hid_t) -> hid_t

See libhdf5 documentation for H5Scopy.

source
HDF5.API.h5s_create — Function
h5s_create(class::Cint) -> hid_t

See libhdf5 documentation for H5Screate.

source
HDF5.API.h5s_create_simple — Function
h5s_create_simple(rank::Cint, current_dims::Ptr{hsize_t}, maximum_dims::Ptr{hsize_t}) -> hid_t

See libhdf5 documentation for H5Screate_simple.

source
HDF5.API.h5s_extent_copy — Function
h5s_extent_copy(dst::hid_t, src::hid_t)

See libhdf5 documentation for H5Sextent_copy.

source
HDF5.API.h5s_extent_equal — Function
h5s_extent_equal(space1_id::hid_t, space2_id::hid_t) -> Bool

See libhdf5 documentation for H5Sextent_equal.

source
HDF5.API.h5s_get_regular_hyperslab — Function
h5s_get_regular_hyperslab(space_id::hid_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})

See libhdf5 documentation for H5Sget_regular_hyperslab.

source
HDF5.API.h5s_get_select_bounds — Function
h5s_get_select_bounds(space_id::hid_t, starts::Ptr{hsize_t}, ends::Ptr{hsize_t})

See libhdf5 documentation for H5Sget_select_bounds.

source
HDF5.API.h5s_get_select_elem_npoints — Function
h5s_get_select_elem_npoints(space_id::hid_t) -> hssize_t

See libhdf5 documentation for H5Sget_select_elem_npoints.

source
HDF5.API.h5s_get_select_elem_pointlist — Function
h5s_get_select_elem_pointlist(space_id::hid_t, startpoint::hsize_t, numpoints::hsize_t, buf::Ptr{hsize_t})

See libhdf5 documentation for H5Sget_select_elem_pointlist.

source
HDF5.API.h5s_get_select_hyper_blocklist — Function
h5s_get_select_hyper_blocklist(space_id::hid_t, startblock::hsize_t, numblocks::hsize_t, buf::Ptr{hsize_t})

See libhdf5 documentation for H5Sget_select_hyper_blocklist.

source
HDF5.API.h5s_get_select_hyper_nblocks — Function
h5s_get_select_hyper_nblocks(space_id::hid_t) -> hssize_t

See libhdf5 documentation for H5Sget_select_hyper_nblocks.

source
HDF5.API.h5s_get_select_npoints — Function
h5s_get_select_npoints(space_id::hid_t) -> hsize_t

See libhdf5 documentation for H5Sget_select_npoints.

source
HDF5.API.h5s_get_select_type — Function
h5s_get_select_type(space_id::hid_t) -> H5S_sel_type

See libhdf5 documentation for H5Sget_select_type.

source
HDF5.API.h5s_get_simple_extent_dims — Function
h5s_get_simple_extent_dims(space_id::hid_t, dims::Ptr{hsize_t}, maxdims::Ptr{hsize_t}) -> Int

See libhdf5 documentation for H5Sget_simple_extent_dims.

source
HDF5.API.h5s_get_simple_extent_ndims — Function
h5s_get_simple_extent_ndims(space_id::hid_t) -> Int

See libhdf5 documentation for H5Sget_simple_extent_ndims.

source
HDF5.API.h5s_get_simple_extent_type — Function
h5s_get_simple_extent_type(space_id::hid_t) -> H5S_class_t

See libhdf5 documentation for H5Sget_simple_extent_type.

source
HDF5.API.h5s_is_regular_hyperslab — Function
h5s_is_regular_hyperslab(space_id::hid_t) -> Bool

See libhdf5 documentation for H5Sis_regular_hyperslab.

source
HDF5.API.h5s_is_simple — Function
h5s_is_simple(space_id::hid_t) -> Bool

See libhdf5 documentation for H5Sis_simple.

source
HDF5.API.h5s_modify_select — Function
h5s_modify_select(space_id::hid_t, op::H5S_seloper_t, space2_id::hid_t)

See libhdf5 documentation for H5Smodify_select.

source
HDF5.API.h5s_offset_simple — Function
h5s_offset_simple(space_id::hid_t, offset::Ptr{hssize_t})

See libhdf5 documentation for H5Soffset_simple.

source
HDF5.API.h5s_select_adjust — Function
h5s_select_adjust(space_id::hid_t, offset::Ptr{hssize_t})

See libhdf5 documentation for H5Sselect_adjust.

source
HDF5.API.h5s_select_all — Function
h5s_select_all(space_id::hid_t)

See libhdf5 documentation for H5Sselect_all.

source
HDF5.API.h5s_select_copy — Function
h5s_select_copy(dst::hid_t, src::hid_t)

See libhdf5 documentation for H5Sselect_copy.

source
HDF5.API.h5s_select_elements — Function
h5s_select_elements(space_id::hid_t, op::H5S_seloper_t, num_elem::Csize_t, coord::Ptr{hsize_t})

See libhdf5 documentation for H5Sselect_elements.

source
HDF5.API.h5s_select_hyperslab — Function
h5s_select_hyperslab(dspace_id::hid_t, seloper::H5S_seloper_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})

See libhdf5 documentation for H5Sselect_hyperslab.

source
HDF5.API.h5s_select_intersect_block — Function
h5s_select_intersect_block(space_id::hid_t, starts::Ptr{hsize_t}, ends::Ptr{hsize_t}) -> Bool

See libhdf5 documentation for H5Sselect_intersect_block.

source
HDF5.API.h5s_select_shape_same — Function
h5s_select_shape_same(space1_id::hid_t, space2_id::hid_t) -> Bool

See libhdf5 documentation for H5Sselect_shape_same.

source
HDF5.API.h5s_select_valid — Function
h5s_select_valid(spaceid::hid_t) -> Bool

See libhdf5 documentation for H5Sselect_valid.

source
HDF5.API.h5s_set_extent_none — Function
h5s_set_extent_none(space_id::hid_t)

See libhdf5 documentation for H5Sset_extent_none.

source
HDF5.API.h5s_set_extent_simple — Function
h5s_set_extent_simple(dspace_id::hid_t, rank::Cint, current_size::Ptr{hsize_t}, maximum_size::Ptr{hsize_t})

See libhdf5 documentation for H5Sset_extent_simple.

source

H5T — Datatype Interface

HDF5.API.h5t_array_create — Function
h5t_array_create(basetype_id::hid_t, ndims::Cuint, sz::Ptr{hsize_t}) -> hid_t

See libhdf5 documentation for H5Tarray_create2.

source
HDF5.API.h5t_close — Function
h5t_close(dtype_id::hid_t)

See libhdf5 documentation for H5Tclose.

source
HDF5.API.h5t_commit — Function
h5t_commit(loc_id::hid_t, name::Cstring, dtype_id::hid_t, lcpl_id::hid_t, tcpl_id::hid_t, tapl_id::hid_t)

See libhdf5 documentation for H5Tcommit2.

source
HDF5.API.h5t_committed — Function
h5t_committed(dtype_id::hid_t) -> Bool

See libhdf5 documentation for H5Tcommitted.

source
HDF5.API.h5t_copy — Function
h5t_copy(dtype_id::hid_t) -> hid_t

See libhdf5 documentation for H5Tcopy.

source
HDF5.API.h5t_create — Function
h5t_create(class_id::Cint, sz::Csize_t) -> hid_t

See libhdf5 documentation for H5Tcreate.

source
HDF5.API.h5t_enum_insert — Function
h5t_enum_insert(dtype_id::hid_t, name::Cstring, value::Ptr{Cvoid})

See libhdf5 documentation for H5Tenum_insert.

source
HDF5.API.h5t_equal — Function
h5t_equal(dtype_id1::hid_t, dtype_id2::hid_t) -> Bool

See libhdf5 documentation for H5Tequal.

source
HDF5.API.h5t_get_array_dims — Function
h5t_get_array_dims(dtype_id::hid_t, dims::Ptr{hsize_t}) -> Int

See libhdf5 documentation for H5Tget_array_dims2.

source
HDF5.API.h5t_get_array_ndims — Function
h5t_get_array_ndims(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_array_ndims.

source
HDF5.API.h5t_get_class — Function
h5t_get_class(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_class.

source
HDF5.API.h5t_get_cset — Function
h5t_get_cset(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_cset.

source
HDF5.API.h5t_get_ebias — Function
h5t_get_ebias(dtype_id::hid_t) -> Csize_t

See libhdf5 documentation for H5Tget_ebias.

source
HDF5.API.h5t_get_fields — Function
h5t_get_fields(dtype_id::hid_t, spos::Ref{Csize_t}, epos::Ref{Csize_t}, esize::Ref{Csize_t}, mpos::Ref{Csize_t}, msize::Ref{Csize_t})

See libhdf5 documentation for H5Tget_fields.

source
HDF5.API.h5t_get_member_class — Function
h5t_get_member_class(dtype_id::hid_t, index::Cuint) -> Int

See libhdf5 documentation for H5Tget_member_class.

source
HDF5.API.h5t_get_member_index — Function
h5t_get_member_index(dtype_id::hid_t, membername::Cstring) -> Int

See libhdf5 documentation for H5Tget_member_index.

source
HDF5.API.h5t_get_member_name — Function
h5t_get_member_name(type_id::hid_t, index::Cuint) -> String

See libhdf5 documentation for H5Oopen.

source
HDF5.API.h5t_get_member_offset — Function
h5t_get_member_offset(dtype_id::hid_t, index::Cuint) -> Csize_t

See libhdf5 documentation for H5Tget_member_offset.

source
HDF5.API.h5t_get_member_type — Function
h5t_get_member_type(dtype_id::hid_t, index::Cuint) -> hid_t

See libhdf5 documentation for H5Tget_member_type.

source
HDF5.API.h5t_get_native_type — Function
h5t_get_native_type(dtype_id::hid_t, direction::Cint) -> hid_t

See libhdf5 documentation for H5Tget_native_type.

source
HDF5.API.h5t_get_nmembers — Function
h5t_get_nmembers(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_nmembers.

source
HDF5.API.h5t_get_offset — Function
h5t_get_offset(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_offset.

source
HDF5.API.h5t_get_order — Function
h5t_get_order(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_order.

source
HDF5.API.h5t_get_precision — Function
h5t_get_precision(dtype_id::hid_t) -> Csize_t

See libhdf5 documentation for H5Tget_precision.

source
HDF5.API.h5t_get_sign — Function
h5t_get_sign(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_sign.

source
HDF5.API.h5t_get_size — Function
h5t_get_size(dtype_id::hid_t) -> Csize_t

See libhdf5 documentation for H5Tget_size.

source
HDF5.API.h5t_get_strpad — Function
h5t_get_strpad(dtype_id::hid_t) -> Int

See libhdf5 documentation for H5Tget_strpad.

source
HDF5.API.h5t_get_super — Function
h5t_get_super(dtype_id::hid_t) -> hid_t

See libhdf5 documentation for H5Tget_super.

source
HDF5.API.h5t_get_tag — Function
h5t_get_tag(type_id::hid_t) -> String

See libhdf5 documentation for H5Oopen.

source
HDF5.API.h5t_insert — Function
h5t_insert(dtype_id::hid_t, fieldname::Cstring, offset::Csize_t, field_id::hid_t)

See libhdf5 documentation for H5Tinsert.

source
HDF5.API.h5t_is_variable_str — Function
h5t_is_variable_str(type_id::hid_t) -> Bool

See libhdf5 documentation for H5Tis_variable_str.

source
HDF5.API.h5t_lock — Function
h5t_lock(type_id::hid_t)

See libhdf5 documentation for H5Tlock.

source
HDF5.API.h5t_open — Function
h5t_open(loc_id::hid_t, name::Cstring, tapl_id::hid_t) -> hid_t

See libhdf5 documentation for H5Topen2.

source
HDF5.API.h5t_set_cset — Function
h5t_set_cset(dtype_id::hid_t, cset::Cint)

See libhdf5 documentation for H5Tset_cset.

source
HDF5.API.h5t_set_ebias — Function
h5t_set_ebias(dtype_id::hid_t, ebias::Csize_t)

See libhdf5 documentation for H5Tset_ebias.

source
HDF5.API.h5t_set_fields — Function
h5t_set_fields(dtype_id::hid_t, spos::Csize_t, epos::Csize_t, esize::Csize_t, mpos::Csize_t, msize::Csize_t)

See libhdf5 documentation for H5Tset_fields.

source
HDF5.API.h5t_set_offset — Function
h5t_set_offset(dtype_id::hid_t, offset::Csize_t)

See libhdf5 documentation for H5Tset_offset.

source
HDF5.API.h5t_set_order — Function
h5t_set_order(dtype_id::hid_t, order::Cint)

See libhdf5 documentation for H5Tset_order.

source
HDF5.API.h5t_set_precision — Function
h5t_set_precision(dtype_id::hid_t, sz::Csize_t)

See libhdf5 documentation for H5Tset_precision.

source
HDF5.API.h5t_set_size — Function
h5t_set_size(dtype_id::hid_t, sz::Csize_t)

See libhdf5 documentation for H5Tset_size.

source
HDF5.API.h5t_set_strpad — Function
h5t_set_strpad(dtype_id::hid_t, sz::Cint)

See libhdf5 documentation for H5Tset_strpad.

source
HDF5.API.h5t_set_tag — Function
h5t_set_tag(dtype_id::hid_t, tag::Cstring)

See libhdf5 documentation for H5Tset_tag.

source
HDF5.API.h5t_vlen_create — Function
h5t_vlen_create(base_type_id::hid_t) -> hid_t

See libhdf5 documentation for H5Tvlen_create.

source

H5Z — Filter Interface

HDF5.API.h5z_filter_avail — Function
h5z_filter_avail(id::H5Z_filter_t) -> Bool

See libhdf5 documentation for H5Zfilter_avail.

source
HDF5.API.h5z_get_filter_info — Function
h5z_get_filter_info(filter::H5Z_filter_t, filter_config_flags::Ptr{Cuint})

See libhdf5 documentation for H5Zget_filter_info.

source
HDF5.API.h5z_register — Function
h5z_register(filter_class::Ref{H5Z_class_t})

See libhdf5 documentation for H5Zregister.

source
HDF5.API.h5z_unregister — Function
h5z_unregister(id::H5Z_filter_t)

See libhdf5 documentation for H5Zunregister.

source

H5FD — File Drivers

HDF5.API.h5fd_core_init — Function
h5fd_core_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_CORE. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_family_init — Function
h5fd_family_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_FAMILY. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_log_init — Function
h5fd_log_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_LOG. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_mpio_init — Function
h5fd_mpio_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_MPIO. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_multi_init — Function
h5fd_multi_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_MULTI. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_sec2_init — Function
h5fd_sec2_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_SEC2. See libhdf5 documentation for H5Pget_driver.

source
HDF5.API.h5fd_stdio_init — Function
h5fd_stdio_init() -> hid_t

This function is exposed in libhdf5 as the macro H5FD_STDIO. See libhdf5 documentation for H5Pget_driver.

source

H5DO — Optimized Functions Interface

HDF5.API.h5do_append — Function
h5do_append(dset_id::hid_t, dxpl_id::hid_t, index::Cuint, num_elem::hsize_t, memtype::hid_t, buffer::Ptr{Cvoid})

See libhdf5 documentation for H5DOappend.

source
HDF5.API.h5do_write_chunk — Function
h5do_write_chunk(dset_id::hid_t, dxpl_id::hid_t, filter_mask::UInt32, offset::Ptr{hsize_t}, bufsize::Csize_t, buf::Ptr{Cvoid})

See libhdf5 documentation for H5DOwrite_chunk.

source

H5DS — Dimension Scale Interface

HDF5.API.h5ds_attach_scale — Function
h5ds_attach_scale(did::hid_t, dsid::hid_t, idx::Cuint)

See libhdf5 documentation for H5DSattach_scale.

source
HDF5.API.h5ds_detach_scale — Function
h5ds_detach_scale(did::hid_t, dsid::hid_t, idx::Cuint)

See libhdf5 documentation for H5DSdetach_scale.

source
HDF5.API.h5ds_get_label — Function
h5ds_get_label(did::hid_t, idx::Cuint, label::Ptr{UInt8}, size::hsize_t)

See libhdf5 documentation for H5DSget_label.

source
HDF5.API.h5ds_get_num_scales — Function
h5ds_get_num_scales(did::hid_t, idx::Cuint) -> Int

See libhdf5 documentation for H5DSget_num_scales.

source
HDF5.API.h5ds_get_scale_name — Function
h5ds_get_scale_name(did::hid_t, name::Ptr{UInt8}, size::Csize_t) -> Cssize_t

See libhdf5 documentation for H5DSget_scale_name.

source
HDF5.API.h5ds_is_attached — Function
h5ds_is_attached(did::hid_t, dsid::hid_t, idx::Cuint) -> Bool

See libhdf5 documentation for H5DSis_attached.

source
HDF5.API.h5ds_is_scale — Function
h5ds_is_scale(did::hid_t) -> Bool

See libhdf5 documentation for H5DSis_scale.

source
HDF5.API.h5ds_set_label — Function
h5ds_set_label(did::hid_t, idx::Cuint, label::Ref{UInt8})

See libhdf5 documentation for H5DSset_label.

source
HDF5.API.h5ds_set_scale — Function
h5ds_set_scale(dsid::hid_t, dimname::Cstring)

See libhdf5 documentation for H5DSset_scale.

source

H5LT — Lite Interface

HDF5.API.h5lt_dtype_to_text — Function
h5lt_dtype_to_text(datatype::hid_t, str::Ptr{UInt8}, lang_type::Cint, len::Ref{Csize_t})

See libhdf5 documentation for H5LTdtype_to_text.

source

H5TB — Table Interface

HDF5.API.h5tb_append_records — Function
h5tb_append_records(loc_id::hid_t, dset_name::Cstring, nrecords::hsize_t, type_size::Csize_t, field_offset::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})

See libhdf5 documentation for H5TBappend_records.

source
HDF5.API.h5tb_get_field_info — Function
h5tb_get_field_info(loc_id::hid_t, table_name::Cstring, field_names::Ptr{Ptr{UInt8}}, field_sizes::Ptr{Csize_t}, field_offsets::Ptr{Csize_t}, type_size::Ptr{Csize_t})

See libhdf5 documentation for H5TBget_field_info.

source
HDF5.API.h5tb_get_table_info — Function
h5tb_get_table_info(loc_id::hid_t, table_name::Cstring, nfields::Ptr{hsize_t}, nrecords::Ptr{hsize_t})

See libhdf5 documentation for H5TBget_table_info.

source
HDF5.API.h5tb_make_table — Function
h5tb_make_table(table_title::Cstring, loc_id::hid_t, dset_name::Cstring, nfields::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_names::Ptr{Cstring}, field_offset::Ptr{Csize_t}, field_types::Ptr{hid_t}, chunk_size::hsize_t, fill_data::Ptr{Cvoid}, compress::Cint, data::Ptr{Cvoid})

See libhdf5 documentation for H5TBmake_table.

source
HDF5.API.h5tb_read_records — Function
h5tb_read_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})

See libhdf5 documentation for H5TBread_records.

source
HDF5.API.h5tb_read_table — Function
h5tb_read_table(loc_id::hid_t, table_name::Cstring, dst_size::Csize_t, dst_offset::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, dst_buf::Ptr{Cvoid})

See libhdf5 documentation for H5TBread_table.

source
HDF5.API.h5tb_write_records — Function
h5tb_write_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})

See libhdf5 documentation for H5TBwrite_records.

source
diff --git a/dev/example2.h5 b/dev/example2.h5 index 34f14972e3f459539dbdec9bde6ca34f38b77586..1e8d3a792380c6516b501657f24aaadca70da6ff 100644 GIT binary patch delta 97 zcmV-n0G|KQAkZMNyaoeKlJ&E{20;l>;NQJJQ|OsLMqexeez(^@cqe&MPI{a2Ylo|l}XAL1)JkP2L9C|I^y0xj4!YB z;|#<c?WkecT|zoIQ!t=8>7UdaNy$hh7=D#$;=U{cyY Dov$y7 diff --git a/dev/index.html b/dev/index.html index c41154d0f..602f9cc54 100644 --- a/dev/index.html +++ b/dev/index.html @@ -15,15 +15,15 @@ [HDF5] libhdf5 = "/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5.so" -libhdf5_hl = "/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so"

If you want to switch to another HDF5 library or the library moved, you can call the set_preferences! commands again (or manually edit LocalPreferences.toml) to set the new paths. Using the default implementation provided by HDF5_jll can be done by simply manually deleting the LocalPreferences.toml file.

Opening and closing files

"Plain" (i.e., with no extra formatting conventions) HDF5 files are created and/or opened with the h5open command:

fid = h5open(filename, mode)

The mode can be any one of the following:

modeMeaning
"r"read-only
"r+"read-write, preserving any existing contents
"cw"read-write, create file if not existing, preserve existing contents
"w"read-write, destroying any existing contents (if any)

For example

julia> using HDF5
julia> fname = tempname(); # temporary file
julia> fid = h5open(fname, "w")🗂️ HDF5.File: (read-write) /tmp/jl_kLwPCbwjoP

This produces an object of type HDF5File, a subtype of the abstract type DataFile. This file will have no elements (groups, datasets, or attributes) that are not explicitly created by the user.

When you're finished with a file, you should close it:

close(fid)

Closing a file also closes any other open objects (e.g., datasets, groups) in that file. In general, you need to close an HDF5 file to "release" it for use by other applications.

Creating a group or dataset

Groups can be created via the function create_group

julia> create_group(fid, "mygroup")📂 HDF5.Group: /mygroup (file: /tmp/jl_kLwPCbwjoP)

We can write the "mydataset" by indexing into fid. This also happens to write data to the dataset.

julia> fid["mydataset"] = rand()0.4947383487843061

Alternatively, we can call create_dataset, which does not write data to the dataset. It merely creates the dataset.

julia> create_dataset(fid, "myvector", Int, (10,))🔢 HDF5.Dataset: /myvector (file: /tmp/jl_kLwPCbwjoP xfer_mode: 0)

Creating a dataset within a group is as simple as indexing into the group with the name of the dataset or calling create_dataset with the group as the first argument.

julia> g = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_kLwPCbwjoP)
julia> g["mydataset"] = "Hello World!""Hello World!"
julia> create_dataset(g, "myvector", Int, (10,))🔢 HDF5.Dataset: /mygroup/myvector (file: /tmp/jl_kLwPCbwjoP xfer_mode: 0)

The do syntax is also supported. The file, group, and dataset handles will automatically be closed after the do block terminates.

julia> h5open("example2.h5", "w") do fid
+libhdf5_hl = "/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so"

If you want to switch to another HDF5 library or the library moved, you can call the set_preferences! commands again (or manually edit LocalPreferences.toml) to set the new paths. Using the default implementation provided by HDF5_jll can be done by simply manually deleting the LocalPreferences.toml file.

Opening and closing files

"Plain" (i.e., with no extra formatting conventions) HDF5 files are created and/or opened with the h5open command:

fid = h5open(filename, mode)

The mode can be any one of the following:

modeMeaning
"r"read-only
"r+"read-write, preserving any existing contents
"cw"read-write, create file if not existing, preserve existing contents
"w"read-write, destroying any existing contents (if any)

For example

julia> using HDF5
julia> fname = tempname(); # temporary file
julia> fid = h5open(fname, "w")🗂️ HDF5.File: (read-write) /tmp/jl_UZ8rMBoHqv

This produces an object of type HDF5File, a subtype of the abstract type DataFile. This file will have no elements (groups, datasets, or attributes) that are not explicitly created by the user.

When you're finished with a file, you should close it:

close(fid)

Closing a file also closes any other open objects (e.g., datasets, groups) in that file. In general, you need to close an HDF5 file to "release" it for use by other applications.

Creating a group or dataset

Groups can be created via the function create_group

julia> create_group(fid, "mygroup")📂 HDF5.Group: /mygroup (file: /tmp/jl_UZ8rMBoHqv)

We can write the "mydataset" by indexing into fid. This also happens to write data to the dataset.

julia> fid["mydataset"] = rand()0.09702089426723681

Alternatively, we can call create_dataset, which does not write data to the dataset. It merely creates the dataset.

julia> create_dataset(fid, "myvector", Int, (10,))🔢 HDF5.Dataset: /myvector (file: /tmp/jl_UZ8rMBoHqv xfer_mode: 0)

Creating a dataset within a group is as simple as indexing into the group with the name of the dataset or calling create_dataset with the group as the first argument.

julia> g = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_UZ8rMBoHqv)
julia> g["mydataset"] = "Hello World!""Hello World!"
julia> create_dataset(g, "myvector", Int, (10,))🔢 HDF5.Dataset: /mygroup/myvector (file: /tmp/jl_UZ8rMBoHqv xfer_mode: 0)

The do syntax is also supported. The file, group, and dataset handles will automatically be closed after the do block terminates.

julia> h5open("example2.h5", "w") do fid
            g = create_group(fid, "mygroup")
            dset = create_dataset(g, "myvector", Float64, (10,))
            write(dset,rand(10))
-       end

Opening and closing objects

If you have a file object fid, and this has a group or dataset called "mygroup" at the top level of a file, you can open it in the following way:

julia> obj = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_kLwPCbwjoP)
+       end

Opening and closing objects

If you have a file object fid, and this has a group or dataset called "mygroup" at the top level of a file, you can open it in the following way:

julia> obj = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_UZ8rMBoHqv)
 ├─ 🔢 mydataset
-└─ 🔢 myvector

This does not read any data or attributes associated with the object, it's simply a handle for further manipulations. For example:

julia> g = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_kLwPCbwjoP)
+└─ 🔢 myvector

This does not read any data or attributes associated with the object, it's simply a handle for further manipulations. For example:

julia> g = fid["mygroup"]📂 HDF5.Group: /mygroup (file: /tmp/jl_UZ8rMBoHqv)
 ├─ 🔢 mydataset
-└─ 🔢 myvector
julia> dset = g["mydataset"]🔢 HDF5.Dataset: /mygroup/mydataset (file: /tmp/jl_kLwPCbwjoP xfer_mode: 0)

or simply

julia> dset = fid["mygroup/mydataset"]🔢 HDF5.Dataset: /mygroup/mydataset (file: /tmp/jl_kLwPCbwjoP xfer_mode: 0)

When you're done with an object, you can close it using close(obj). If you forget to do this, it will be closed for you anyway when the file is closed, or if obj goes out of scope and gets garbage collected.

Reading and writing data

Suppose you have a group g which contains a dataset with path "mydataset", and that you've also opened this dataset as dset = g["mydataset"]. You can read information in this dataset in any of the following ways:

A = read(dset)
+└─ 🔢 myvector
julia> dset = g["mydataset"]🔢 HDF5.Dataset: /mygroup/mydataset (file: /tmp/jl_UZ8rMBoHqv xfer_mode: 0)

or simply

julia> dset = fid["mygroup/mydataset"]🔢 HDF5.Dataset: /mygroup/mydataset (file: /tmp/jl_UZ8rMBoHqv xfer_mode: 0)

When you're done with an object, you can close it using close(obj). If you forget to do this, it will be closed for you anyway when the file is closed, or if obj goes out of scope and gets garbage collected.

Reading and writing data

Suppose you have a group g which contains a dataset with path "mydataset", and that you've also opened this dataset as dset = g["mydataset"]. You can read information in this dataset in any of the following ways:

A = read(dset)
 A = read(g, "mydataset")
 Asub = dset[2:3, 1:3]

The last syntax reads just a subset of the data array (assuming that dset is an array of sufficient size). libhdf5 has internal mechanisms for slicing arrays, and consequently if you need only a small piece of a large array, it can be faster to read just what you need rather than reading the entire array and discarding most of it.

Datasets can be created with either

g["mydataset"] = rand(3,5)
 write(g, "mydataset", rand(3,5))

One can use the high level interface load and save from FileIO, where an optional OrderedDict can be passed (track_order inferred). Note that using track_order=true or passing an OrderedDict is a promise that the read file has been created with the appropriate ordering flags.

julia> using OrderedCollections, FileIO
@@ -83,4 +83,4 @@
 HDF5.set_extent_dims(b, (10000,))
 b[1:10000] = collect(1:10000)

when dimensions are reduced, the truncated data is lost. A maximum dimension of -1 is often referred to as unlimited dimensions, though it is limited by the maximum size of an unsigned integer.

You can copy data from one file to another:

copy_object(source, data_name, target, name)
 copy_object(source[data_name], target, name)

Finally, it's possible to delete objects:

delete_object(parent, name)   # for groups, datasets, and datatypes
-delete_attribute(parent, name)   # for attributes

Low-level routines

Many of the most commonly-used libhdf5 functions have been wrapped in a submodule API. The library follows a consistent convention: for example, libhdf5's H5Adelete is wrapped with a Julia function called h5a_delete. The arguments are exactly as specified in the HDF5 reference manual. Note that the functions in the API submodule are not exported, so unless you import them specifically, you need to preface them with HDF5.API to use them: for example, HDF5.API.h5a_delete.

HDF5 is a large library, and the low-level wrap is not complete. However, many of the most-commonly used functions are wrapped, and in general wrapping a new function takes only a single line of code. Users who need additional functionality are encouraged to contribute it.

Note that Julia's HDF5 directly uses the "2" interfaces, e.g., H5Dcreate2, so you need to have version 1.8 of the HDF5 library or later.

Language interoperability with row- and column-major order arrays

There are two main methods for storing multidimensional arrays in linear storage row-major order and column-major order. Julia, like Fortran and MATLAB, stores multidimensional arrays in column-major order, while other languages, including C and Python (NumPy), use row-major order. Therefore when reading an array in Julia from row-major order language the dimensions may be inverted.

To read a multidimensional array into the original shape from an HDF5 file written by Python (numpy and h5py) or C/C++/Objective-C, simply reverse the dimensions. For example, one may add the following line after reading the dataset dset:

dset = permutedims(dset, reverse(1:ndims(dset)))

Note that some languages or libraries use both methods, so please check the datset's description for details. For example, NumPy arrays are row-major by default, but NumPy can use either row-major or column-major ordered arrays.

Credits

  • Konrad Hinsen initiated Julia's support for HDF5

  • Tim Holy and Simon Kornblith (primary authors)

  • Tom Short contributed code and ideas to the dictionary-like interface

  • Blake Johnson made several improvements, such as support for iterating over attributes

  • Isaiah Norton and Elliot Saba improved installation on Windows and OSX

  • Steve Johnson contributed the do syntax and Blosc compression

  • Mike Nolta and Jameson Nash contributed code or suggestions for improving the handling of HDF5's constants

  • Thanks also to the users who have reported bugs and tested fixes

+delete_attribute(parent, name) # for attributes

Low-level routines

Many of the most commonly-used libhdf5 functions have been wrapped in a submodule API. The library follows a consistent convention: for example, libhdf5's H5Adelete is wrapped with a Julia function called h5a_delete. The arguments are exactly as specified in the HDF5 reference manual. Note that the functions in the API submodule are not exported, so unless you import them specifically, you need to preface them with HDF5.API to use them: for example, HDF5.API.h5a_delete.

HDF5 is a large library, and the low-level wrap is not complete. However, many of the most-commonly used functions are wrapped, and in general wrapping a new function takes only a single line of code. Users who need additional functionality are encouraged to contribute it.

Note that Julia's HDF5 directly uses the "2" interfaces, e.g., H5Dcreate2, so you need to have version 1.8 of the HDF5 library or later.

Language interoperability with row- and column-major order arrays

There are two main methods for storing multidimensional arrays in linear storage row-major order and column-major order. Julia, like Fortran and MATLAB, stores multidimensional arrays in column-major order, while other languages, including C and Python (NumPy), use row-major order. Therefore when reading an array in Julia from row-major order language the dimensions may be inverted.

To read a multidimensional array into the original shape from an HDF5 file written by Python (numpy and h5py) or C/C++/Objective-C, simply reverse the dimensions. For example, one may add the following line after reading the dataset dset:

dset = permutedims(dset, reverse(1:ndims(dset)))

Note that some languages or libraries use both methods, so please check the datset's description for details. For example, NumPy arrays are row-major by default, but NumPy can use either row-major or column-major ordered arrays.

Credits

  • Konrad Hinsen initiated Julia's support for HDF5

  • Tim Holy and Simon Kornblith (primary authors)

  • Tom Short contributed code and ideas to the dictionary-like interface

  • Blake Johnson made several improvements, such as support for iterating over attributes

  • Isaiah Norton and Elliot Saba improved installation on Windows and OSX

  • Steve Johnson contributed the do syntax and Blosc compression

  • Mike Nolta and Jameson Nash contributed code or suggestions for improving the handling of HDF5's constants

  • Thanks also to the users who have reported bugs and tested fixes

diff --git a/dev/interface/attributes/index.html b/dev/interface/attributes/index.html index 0a350fca6..0eb9a9462 100644 --- a/dev/interface/attributes/index.html +++ b/dev/interface/attributes/index.html @@ -2,6 +2,6 @@ Attributes · HDF5.jl
Edit on GitHub

Attributes

Dictionary interface

HDF5.attrs — Function
attrs(object::Union{File,Group,Dataset,Datatype})

The attributes dictionary of object. Returns an AttributeDict, a Dict-like object for accessing the attributes of object.

attrs(object)["name"] = value  # create/overwrite an attribute
 attr = attrs(object)["name"]   # read an attribute
 delete!(attrs(object), "name") # delete an attribute
-keys(attrs(object))            # list the attribute names
source
HDF5.attributes — Function
attributes(object::Union{File,Object})

The attributes of a file or object: this returns an Attributes object, which is Dict-like object for accessing the attributes of object: getindex will return an Attribute object, and setindex! will call write_attribute.

source

Mid-level Interface

HDF5.create_attribute — Function
create_attribute(parent::Union{File,Object}, name::AbstractString, dtype::Datatype, space::Dataspace)
-create_attribute(parent::Union{File,Object}, name::AbstractString, data)

Create a new Attribute object named name on the object parent, either by specifying the Datatype and Dataspace of the attribute, or by providing the data. Note that no data will be written: use write_attribute to write the data.

source
HDF5.read_attribute — Function
read_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)

Read the value of the named attribute on the parent object.

Example

julia> HDF5.read_attribute(g, "time")
-2.45
source
HDF5.rename_attribute — Function
rename_attribute(parent::Union{File,Object}, oldname::AbstractString, newname::AbstractString)

Rename the Attribute of the object parent named oldname to newname.

source

Convenience interface

HDF5.h5readattr — Function
h5readattr(filename, name::AbstractString, data::Dict)

Read the attributes of the object at name in the HDF5 file filename, returning a Dict.

source
HDF5.h5writeattr — Function
h5writeattr(filename, name::AbstractString, data::Dict)

Write data as attributes to the object at name in the HDF5 file filename.

source
+keys(attrs(object)) # list the attribute namessource
HDF5.attributes — Function
attributes(object::Union{File,Object})

The attributes of a file or object: this returns an Attributes object, which is Dict-like object for accessing the attributes of object: getindex will return an Attribute object, and setindex! will call write_attribute.

source

Mid-level Interface

HDF5.create_attribute — Function
create_attribute(parent::Union{File,Object}, name::AbstractString, dtype::Datatype, space::Dataspace)
+create_attribute(parent::Union{File,Object}, name::AbstractString, data)

Create a new Attribute object named name on the object parent, either by specifying the Datatype and Dataspace of the attribute, or by providing the data. Note that no data will be written: use write_attribute to write the data.

source
HDF5.read_attribute — Function
read_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)

Read the value of the named attribute on the parent object.

Example

julia> HDF5.read_attribute(g, "time")
+2.45
source
HDF5.rename_attribute — Function
rename_attribute(parent::Union{File,Object}, oldname::AbstractString, newname::AbstractString)

Rename the Attribute of the object parent named oldname to newname.

source

Convenience interface

HDF5.h5readattr — Function
h5readattr(filename, name::AbstractString, data::Dict)

Read the attributes of the object at name in the HDF5 file filename, returning a Dict.

source
HDF5.h5writeattr — Function
h5writeattr(filename, name::AbstractString, data::Dict)

Write data as attributes to the object at name in the HDF5 file filename.

source
diff --git a/dev/interface/configuration/index.html b/dev/interface/configuration/index.html index 68d6f054d..fc1c398ea 100644 --- a/dev/interface/configuration/index.html +++ b/dev/interface/configuration/index.html @@ -1,2 +1,2 @@ -Configuration · HDF5.jl
Edit on GitHub

Configuration

HDF5.has_ros3 — Function
has_ros3()

Returns true if the HDF5 libraries were compiled with ros3 support

source

Display

HDF5.SHOW_TREE_ICONS — Constant
SHOW_TREE_ICONS = Ref{Bool}(true)

Configurable option to control whether emoji icons (true) or a plain-text annotation (false) is used to indicate the object type by show_tree.

source

Internals

HDF5.get_context_property — Function
get_context_property(name::Symbol)

Internal API

Retrieve a property list from the task local context, defaulting to HDF5.CONTEXT if task_local_storage()[:hdf5_context] does not exist.

source
HDF5.HDF5Context — Type
HDF5Context

Internal API

An HDF5Context is a collection of HDF5 property lists. It is meant to be used as a Task local mechanism to store state and change the default property lists for new objects.

Use the function get_context_property(name::Symbol) to access a property list within the local context.

The context in task_local_storage()[:hdf5_context] will be checked first. A common global HDF5Context is stored in the constant HDF5.CONTEXT and serves as the default context if the current task does not have a :hdf5_context.

Fields

  • attribute_access
  • attribute_create
  • dataset_access
  • dataset_create
  • dataset_tranfer
  • datatype_access
  • datatype_create
  • file_access
  • file_create
  • file_mount
  • group_access
  • group_create
  • link_access
  • link_create
  • object_copy
  • object_create
  • string_create
source
+Configuration · HDF5.jl
Edit on GitHub

Configuration

HDF5.has_ros3 — Function
has_ros3()

Returns true if the HDF5 libraries were compiled with ros3 support

source

Display

HDF5.SHOW_TREE_ICONS — Constant
SHOW_TREE_ICONS = Ref{Bool}(true)

Configurable option to control whether emoji icons (true) or a plain-text annotation (false) is used to indicate the object type by show_tree.

source

Internals

HDF5.get_context_property — Function
get_context_property(name::Symbol)

Internal API

Retrieve a property list from the task local context, defaulting to HDF5.CONTEXT if task_local_storage()[:hdf5_context] does not exist.

source
HDF5.HDF5Context — Type
HDF5Context

Internal API

An HDF5Context is a collection of HDF5 property lists. It is meant to be used as a Task local mechanism to store state and change the default property lists for new objects.

Use the function get_context_property(name::Symbol) to access a property list within the local context.

The context in task_local_storage()[:hdf5_context] will be checked first. A common global HDF5Context is stored in the constant HDF5.CONTEXT and serves as the default context if the current task does not have a :hdf5_context.

Fields

  • attribute_access
  • attribute_create
  • dataset_access
  • dataset_create
  • dataset_tranfer
  • datatype_access
  • datatype_create
  • file_access
  • file_create
  • file_mount
  • group_access
  • group_create
  • link_access
  • link_create
  • object_copy
  • object_create
  • string_create
source
diff --git a/dev/interface/dataset/index.html b/dev/interface/dataset/index.html index 99e9068fa..76a6bdea2 100644 --- a/dev/interface/dataset/index.html +++ b/dev/interface/dataset/index.html @@ -1,2 +1,2 @@ -Dataset · HDF5.jl
Edit on GitHub

Dataset

Many dataset operations are available through the indexing interface, which is aliased to the functional interface. Below describes the functional interface.

HDF5.Dataset — Type
HDF5.Dataset

A mutable wrapper for a HDF5 Dataset HDF5.API.hid_t.

source
HDF5.create_dataset — Function
create_dataset(parent, path, datatype, dataspace; properties...)

Arguments

  • parent - File or Group
  • path - String describing the path of the dataset within the HDF5 file or nothing to create an anonymous dataset
  • datatype - Datatype or Type or the dataset
  • dataspace - Dataspace or Dims of the dataset
  • properties - keyword name-value pairs set properties of the dataset

Keywords

There are many keyword properties that can be set. Below are a few select keywords.

  • chunk - Dims describing the size of a chunk. Needed to apply filters.
  • filters - AbstractVector{<: Filters.Filter} describing the order of the filters to apply to the data. See Filters
  • external - Tuple{AbstractString, Intger, Integer} (filepath, offset, filesize) External dataset file location, data offset, and file size. See API.h5p_set_external.

Additionally, the initial create, transfer, and access properties can be provided as a keyword:

source
Base.copyto! — Function
copyto!(output_buffer::AbstractArray{T}, obj::Union{DatasetOrAttribute}) where T

Copy [part of] a HDF5 dataset or attribute to a preallocated output buffer. The output buffer must be convertible to a pointer and have a contiguous layout.

source
Base.similar — Function
similar(obj::DatasetOrAttribute, [::Type{T}], [dims::Integer...]; normalize = true)

Return a Array{T} or Matrix{UInt8} to that can contain [part of] the dataset.

The normalize keyword will normalize the buffer for string and array datatypes.

source
HDF5.create_external_dataset — Function
create_external_dataset(parent, name, filepath, dtype, dspace, offset = 0)

Create an external dataset with data in an external file.

  • parent - File or Group
  • name - Name of the Dataset
  • filepath - File path to where the data is tored
  • dtype - Datatype, Type, or value where datatype is applicable
  • offset - Offset, in bytes, from the beginning of the file to the location in the file where the data starts.

See also API.h5p_set_external to link to multiple segments.

source
HDF5.get_datasets — Function
get_datasets(file::HDF5.File) -> datasets::Vector{HDF5.Dataset}

Get all the datasets in an hdf5 file without loading the data.

source
HDF5.write_dataset — Function
write_dataset(parent::Union{File,Group}, name::Union{AbstractString,Nothing}, data; pv...)

Create and write a dataset with data. Keywords are forwarded to create_dataset. Providing nothing as the name will create an anonymous dataset.

See also create_dataset

source
HDF5.read_dataset — Function
read_dataset(parent::Union{File,Group}, name::AbstractString)

Read a dataset with named name from parent. This will typically return an array. The dataset will be opened, read, and closed.

See also HDF5.open_dataset, Base.read

source

Chunks

HDF5.do_read_chunk — Function
do_read_chunk(dataset::Dataset, offset)

Read a raw chunk at a given offset. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.

source
do_read_chunk(dataset::Dataset, index::Integer)

Read a raw chunk at a given index. index is 1-based and consecutive up to the number of chunks.

source
HDF5.do_write_chunk — Function
do_write_chunk(dataset::Dataset, offset, chunk_bytes::AbstractArray, filter_mask=0)

Write a raw chunk at a given offset. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.

source
do_write_chunk(dataset::Dataset, index, chunk_bytes::AbstractArray, filter_mask=0)

Write a raw chunk at a given linear index. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. index is 1-based and consecutive up to the number of chunks.

source
HDF5.get_chunk_index — Function
HDF5.get_chunk_index(dataset_id, offset)

Get 0-based index of chunk from 0-based offset returned in Julia's column-major order. For a 1-based API, see HDF5.ChunkStorage.

source
HDF5.get_chunk_info_all — Function
HDF5.get_chunk_info_all(dataset, [dxpl])

Obtain information on all the chunks in a dataset. Returns a Vector{ChunkInfo{N}}. The fields of ChunkInfo{N} are

  • offset - NTuple{N, Int} indicating the offset of the chunk in terms of elements, reversed to F-order
  • filter_mask - Cuint, 32-bit flags indicating whether filters have been applied to the cunk
  • addr - haddr_t, byte-offset of the chunk in the file
  • size - hsize_t, size of the chunk in bytes
source
HDF5.get_chunk_length — Function
HDF5.get_chunk_length(dataset_id)

Retrieves the chunk size in bytes. Equivalent to API.h5d_get_chunk_info(dataset_id, index)[:size].

source
HDF5.get_chunk_offset — Function
HDF5.get_chunk_offset(dataset_id, index)

Get 0-based offset of chunk from 0-based index. The offsets are returned in Julia's column-major order rather than hdf5 row-major order. For a 1-based API, see HDF5.ChunkStorage.

source
HDF5.get_num_chunks — Function
HDF5.get_num_chunks(dataset_id)

Returns the number of chunks in a dataset. Equivalent to API.h5d_get_num_chunks(dataset_id, HDF5.H5S_ALL).

source
HDF5.read_chunk — Function
HDF5.read_chunk(dataset_id, offset, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())

Helper method to read chunks via 0-based offsets in a Tuple.

Argument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.get_chunk_length. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.

This method returns Vector{UInt8}.

source
HDF5.read_chunk(dataset_id, index::Integer, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())

Helper method to read chunks via 0-based integer index.

Argument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.API.h5d_get_chunk_info. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.

This method returns Vector{UInt8}.

source
HDF5.write_chunk — Function
HDF5.write_chunk(dataset_id, offset, buf::AbstractArray; dxpl_id = HDF5.API.H5P_DEFAULT, filter_mask = 0)

Helper method to write chunks via 0-based offsets offset as a Tuple.

source
HDF5.write_chunk(dataset_id, index::Integer, buf::AbstractArray; dxpl_id = API.H5P_DEFAULT, filter_mask = 0)

Helper method to write chunks via 0-based integer index.

source

Private Implementation

These functions select private implementations of the public high-level API. They should be used for diagnostic purposes only.

+Dataset · HDF5.jl
Edit on GitHub

Dataset

Many dataset operations are available through the indexing interface, which is aliased to the functional interface. Below describes the functional interface.

HDF5.Dataset — Type
HDF5.Dataset

A mutable wrapper for a HDF5 Dataset HDF5.API.hid_t.

source
HDF5.create_dataset — Function
create_dataset(parent, path, datatype, dataspace; properties...)

Arguments

  • parent - File or Group
  • path - String describing the path of the dataset within the HDF5 file or nothing to create an anonymous dataset
  • datatype - Datatype or Type or the dataset
  • dataspace - Dataspace or Dims of the dataset
  • properties - keyword name-value pairs set properties of the dataset

Keywords

There are many keyword properties that can be set. Below are a few select keywords.

  • chunk - Dims describing the size of a chunk. Needed to apply filters.
  • filters - AbstractVector{<: Filters.Filter} describing the order of the filters to apply to the data. See Filters
  • external - Tuple{AbstractString, Intger, Integer} (filepath, offset, filesize) External dataset file location, data offset, and file size. See API.h5p_set_external.

Additionally, the initial create, transfer, and access properties can be provided as a keyword:

source
Base.copyto! — Function
copyto!(output_buffer::AbstractArray{T}, obj::Union{DatasetOrAttribute}) where T

Copy [part of] a HDF5 dataset or attribute to a preallocated output buffer. The output buffer must be convertible to a pointer and have a contiguous layout.

source
Base.similar — Function
similar(obj::DatasetOrAttribute, [::Type{T}], [dims::Integer...]; normalize = true)

Return a Array{T} or Matrix{UInt8} to that can contain [part of] the dataset.

The normalize keyword will normalize the buffer for string and array datatypes.

source
HDF5.create_external_dataset — Function
create_external_dataset(parent, name, filepath, dtype, dspace, offset = 0)

Create an external dataset with data in an external file.

  • parent - File or Group
  • name - Name of the Dataset
  • filepath - File path to where the data is tored
  • dtype - Datatype, Type, or value where datatype is applicable
  • offset - Offset, in bytes, from the beginning of the file to the location in the file where the data starts.

See also API.h5p_set_external to link to multiple segments.

source
HDF5.get_datasets — Function
get_datasets(file::HDF5.File) -> datasets::Vector{HDF5.Dataset}

Get all the datasets in an hdf5 file without loading the data.

source
HDF5.write_dataset — Function
write_dataset(parent::Union{File,Group}, name::Union{AbstractString,Nothing}, data; pv...)

Create and write a dataset with data. Keywords are forwarded to create_dataset. Providing nothing as the name will create an anonymous dataset.

See also create_dataset

source
HDF5.read_dataset — Function
read_dataset(parent::Union{File,Group}, name::AbstractString)

Read a dataset with named name from parent. This will typically return an array. The dataset will be opened, read, and closed.

See also HDF5.open_dataset, Base.read

source

Chunks

HDF5.do_read_chunk — Function
do_read_chunk(dataset::Dataset, offset)

Read a raw chunk at a given offset. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.

source
do_read_chunk(dataset::Dataset, index::Integer)

Read a raw chunk at a given index. index is 1-based and consecutive up to the number of chunks.

source
HDF5.do_write_chunk — Function
do_write_chunk(dataset::Dataset, offset, chunk_bytes::AbstractArray, filter_mask=0)

Write a raw chunk at a given offset. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.

source
do_write_chunk(dataset::Dataset, index, chunk_bytes::AbstractArray, filter_mask=0)

Write a raw chunk at a given linear index. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. index is 1-based and consecutive up to the number of chunks.

source
HDF5.get_chunk_index — Function
HDF5.get_chunk_index(dataset_id, offset)

Get 0-based index of chunk from 0-based offset returned in Julia's column-major order. For a 1-based API, see HDF5.ChunkStorage.

source
HDF5.get_chunk_info_all — Function
HDF5.get_chunk_info_all(dataset, [dxpl])

Obtain information on all the chunks in a dataset. Returns a Vector{ChunkInfo{N}}. The fields of ChunkInfo{N} are

  • offset - NTuple{N, Int} indicating the offset of the chunk in terms of elements, reversed to F-order
  • filter_mask - Cuint, 32-bit flags indicating whether filters have been applied to the cunk
  • addr - haddr_t, byte-offset of the chunk in the file
  • size - hsize_t, size of the chunk in bytes
source
HDF5.get_chunk_length — Function
HDF5.get_chunk_length(dataset_id)

Retrieves the chunk size in bytes. Equivalent to API.h5d_get_chunk_info(dataset_id, index)[:size].

source
HDF5.get_chunk_offset — Function
HDF5.get_chunk_offset(dataset_id, index)

Get 0-based offset of chunk from 0-based index. The offsets are returned in Julia's column-major order rather than hdf5 row-major order. For a 1-based API, see HDF5.ChunkStorage.

source
HDF5.get_num_chunks — Function
HDF5.get_num_chunks(dataset_id)

Returns the number of chunks in a dataset. Equivalent to API.h5d_get_num_chunks(dataset_id, HDF5.H5S_ALL).

source
HDF5.read_chunk — Function
HDF5.read_chunk(dataset_id, offset, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())

Helper method to read chunks via 0-based offsets in a Tuple.

Argument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.get_chunk_length. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.

This method returns Vector{UInt8}.

source
HDF5.read_chunk(dataset_id, index::Integer, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())

Helper method to read chunks via 0-based integer index.

Argument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.API.h5d_get_chunk_info. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.

This method returns Vector{UInt8}.

source
HDF5.write_chunk — Function
HDF5.write_chunk(dataset_id, offset, buf::AbstractArray; dxpl_id = HDF5.API.H5P_DEFAULT, filter_mask = 0)

Helper method to write chunks via 0-based offsets offset as a Tuple.

source
HDF5.write_chunk(dataset_id, index::Integer, buf::AbstractArray; dxpl_id = API.H5P_DEFAULT, filter_mask = 0)

Helper method to write chunks via 0-based integer index.

source

Private Implementation

These functions select private implementations of the public high-level API. They should be used for diagnostic purposes only.

diff --git a/dev/interface/dataspaces/index.html b/dev/interface/dataspaces/index.html index 71ba4257f..2d7e5062e 100644 --- a/dev/interface/dataspaces/index.html +++ b/dev/interface/dataspaces/index.html @@ -1,7 +1,7 @@ -Dataspaces · HDF5.jl
Edit on GitHub

Dataspaces

HDF5.Dataspace — Type
HDF5.Dataspace

A dataspace defines the size and the shape of a dataset or an attribute.

A dataspace is typically constructed by calling dataspace.

The following functions have methods defined for Dataspace objects

  • ==
  • ndims
  • size
  • length
  • isempty
  • isnull
source
HDF5.dataspace — Function
dataspace(obj::Union{Attribute, Dataset, Dataspace})

The Dataspace of obj.

source
dataspace(data)

The default Dataspace used for representing a Julia object data:

  • strings or numbers: a scalar Dataspace
  • arrays: a simple Dataspace
  • struct types: a scalar Dataspace
  • nothing or an EmptyArray: a null dataspace
source
dataspace(dims::Tuple; max_dims::Tuple=dims)
-dataspace(dims::Tuple, max_dims::Tuple)

Construct a simple Dataspace for the given dimensions dims. The maximum dimensions maxdims specifies the maximum possible size: -1 can be used to indicate unlimited dimensions.

source
HDF5.isnull — Function
isnull(dspace::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute})

Determines whether the given object has no size (consistent with the API.H5S_NULL dataspace).

Examples

julia> HDF5.isnull(dataspace(HDF5.EmptyArray{Float64}()))
+Dataspaces · HDF5.jl
Edit on GitHub
Dataspaces
HDF5.Dataspace — Type
HDF5.Dataspace
A dataspace defines the size and the shape of a dataset or an attribute.
A dataspace is typically constructed by calling dataspace.
The following functions have methods defined for Dataspace objects
  • ==
  • ndims
  • size
  • length
  • isempty
  • isnull
source
HDF5.dataspace — Function
dataspace(obj::Union{Attribute, Dataset, Dataspace})
The Dataspace of obj.
source
dataspace(data)
The default Dataspace used for representing a Julia object data:
  • strings or numbers: a scalar Dataspace
  • arrays: a simple Dataspace
  • struct types: a scalar Dataspace
  • nothing or an EmptyArray: a null dataspace
source
dataspace(dims::Tuple; max_dims::Tuple=dims)
+dataspace(dims::Tuple, max_dims::Tuple)
Construct a simple Dataspace for the given dimensions dims. The maximum dimensions maxdims specifies the maximum possible size: -1 can be used to indicate unlimited dimensions.
source
HDF5.isnull — Function
isnull(dspace::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute})
Determines whether the given object has no size (consistent with the API.H5S_NULL dataspace).
Examples
julia> HDF5.isnull(dataspace(HDF5.EmptyArray{Float64}()))
 true
 
 julia> HDF5.isnull(dataspace((0,)))
-false
source
HDF5.get_extent_dims — Function
HDF5.get_extent_dims(obj::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute}) -> dims, maxdims
Get the array dimensions from a dataspace, dataset, or attribute and return a tuple of dims and maxdims.
source
HDF5.set_extent_dims — Function
HDF5.set_extent_dims(dset::HDF5.Dataset, new_dims::Dims)
Change the current dimensions of a dataset to new_dims, limited by max_dims = get_extent_dims(dset)[2]. Reduction is possible and leads to loss of truncated data.
source
HDF5.set_extent_dims(dspace::HDF5.Dataspace, new_dims::Dims, max_dims::Union{Dims,Nothing} = nothing)
Change the dimensions of a dataspace dspace to new_dims, optionally with the maximum possible dimensions max_dims different from the active size new_dims. If not given, max_dims is set equal to new_dims.
source
Hyperslab
HDF5.BlockRange — Type
HDF5.BlockRange(;start::Integer, stride::Integer=1, count::Integer=1, block::Integer=1)
A BlockRange represents a selection along a single dimension of a HDF5 hyperslab. It is similar to a Julia range object, with some extra features for selecting multiple contiguous blocks.
  • start: the index of the first element in the first block (1-based).
  • stride: the step between the first element of each block (must be >0)
  • count: the number of blocks (can be -1 for an unlimited number of blocks)
  • block: the number of elements in each block.
HDF5.BlockRange(obj::Union{Integer, OrdinalRange})
Convert obj to a BlockRange object.
External links
source
HDF5.select_hyperslab! — Function
HDF5.select_hyperslab!(dspace::Dataspace, [op, ], idxs::Tuple)
Selects a hyperslab region of the dspace. idxs should be a tuple of integers, ranges or BlockRange objects.
  • op determines how the new selection is to be combined with the already selected dataspace:
    • :select (default): replace the existing selection with the new selection.
    • :or: adds the new selection to the existing selection.  Aliases: |, ∪, union.
    • :and: retains only the overlapping portions of the new and existing selection. Aliases: &, ∩, intersect.
    • :xor: retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. Aliases: ⊻, xor
    • :notb: retains only elements of the existing selection that are not in the new selection. Alias: setdiff.
    • :nota: retains only elements of the new selection that are not in the existing selection.
source

+false
source
HDF5.get_extent_dims — Function
HDF5.get_extent_dims(obj::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute}) -> dims, maxdims

Get the array dimensions from a dataspace, dataset, or attribute and return a tuple of dims and maxdims.

source
HDF5.set_extent_dims — Function
HDF5.set_extent_dims(dset::HDF5.Dataset, new_dims::Dims)

Change the current dimensions of a dataset to new_dims, limited by max_dims = get_extent_dims(dset)[2]. Reduction is possible and leads to loss of truncated data.

source
HDF5.set_extent_dims(dspace::HDF5.Dataspace, new_dims::Dims, max_dims::Union{Dims,Nothing} = nothing)

Change the dimensions of a dataspace dspace to new_dims, optionally with the maximum possible dimensions max_dims different from the active size new_dims. If not given, max_dims is set equal to new_dims.

source

Hyperslab

HDF5.BlockRange — Type
HDF5.BlockRange(;start::Integer, stride::Integer=1, count::Integer=1, block::Integer=1)

A BlockRange represents a selection along a single dimension of a HDF5 hyperslab. It is similar to a Julia range object, with some extra features for selecting multiple contiguous blocks.

  • start: the index of the first element in the first block (1-based).
  • stride: the step between the first element of each block (must be >0)
  • count: the number of blocks (can be -1 for an unlimited number of blocks)
  • block: the number of elements in each block.
HDF5.BlockRange(obj::Union{Integer, OrdinalRange})

Convert obj to a BlockRange object.

External links

source
HDF5.select_hyperslab! — Function
HDF5.select_hyperslab!(dspace::Dataspace, [op, ], idxs::Tuple)

Selects a hyperslab region of the dspace. idxs should be a tuple of integers, ranges or BlockRange objects.

  • op determines how the new selection is to be combined with the already selected dataspace:
    • :select (default): replace the existing selection with the new selection.
    • :or: adds the new selection to the existing selection. Aliases: |, ∪, union.
    • :and: retains only the overlapping portions of the new and existing selection. Aliases: &, ∩, intersect.
    • :xor: retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. Aliases: ⊻, xor
    • :notb: retains only elements of the existing selection that are not in the new selection. Alias: setdiff.
    • :nota: retains only elements of the new selection that are not in the existing selection.
source
diff --git a/dev/interface/datatype/index.html b/dev/interface/datatype/index.html index a5f42d4fa..579be5b18 100644 --- a/dev/interface/datatype/index.html +++ b/dev/interface/datatype/index.html @@ -1,2 +1,2 @@ -Datatypes · HDF5.jl
Edit on GitHub

Datatypes

HDF5.Datatype — Type
HDF5.Datatype(id, toclose = true)

Wrapper for a HDF5 datatype id. If toclose is true, the finalizer will close the datatype.

source
+Datatypes · HDF5.jl
Edit on GitHub

Datatypes

HDF5.Datatype — Type
HDF5.Datatype(id, toclose = true)

Wrapper for a HDF5 datatype id. If toclose is true, the finalizer will close the datatype.

source
diff --git a/dev/interface/files/index.html b/dev/interface/files/index.html index cb24b9685..1ddb5fcc8 100644 --- a/dev/interface/files/index.html +++ b/dev/interface/files/index.html @@ -1,6 +1,6 @@ -Files · HDF5.jl
Edit on GitHub

Files

HDF5.h5open — Function
h5open(filename::AbstractString, mode::AbstractString="r"; swmr=false, pv...)

Open or create an HDF5 file where mode is one of:

  • "r" read only
  • "r+" read and write
  • "cw" read and write, create file if not existing, do not truncate
  • "w" read and write, create a new file (destroys any existing contents)

Pass swmr=true to enable (Single Writer Multiple Reader) SWMR write access for "w" and "r+", or SWMR read access for "r".

Properties can be specified as keywords for FileAccessProperties and FileCreateProperties.

Also the keywords fapl and fcpl can be used to provide default instances of these property lists. Property lists passed in via keyword will be closed. This is useful to set properties not currently defined by HDF5.jl.

Note that h5open uses fclose_degree = :strong by default, but this can be overriden by the fapl keyword.

source
function h5open(f::Function, args...; pv...)

Apply the function f to the result of h5open(args...; kwargs...) and close the resulting HDF5.File upon completion. For example with a do block:

h5open("foo.h5","w") do h5
+Files · HDF5.jl
Edit on GitHub
Files
HDF5.h5open — Function
h5open(filename::AbstractString, mode::AbstractString="r"; swmr=false, pv...)
Open or create an HDF5 file where mode is one of:
  • "r"  read only
  • "r+" read and write
  • "cw" read and write, create file if not existing, do not truncate
  • "w"  read and write, create a new file (destroys any existing contents)
Pass swmr=true to enable (Single Writer Multiple Reader) SWMR write access for "w" and "r+", or SWMR read access for "r".
Properties can be specified as keywords for FileAccessProperties and FileCreateProperties.
Also the keywords fapl and fcpl can be used to provide default instances of these property lists. Property lists passed in via keyword will be closed. This is useful to set properties not currently defined by HDF5.jl.
Note that h5open uses fclose_degree = :strong by default, but this can be overriden by the fapl keyword.
source
function h5open(f::Function, args...; pv...)
Apply the function f to the result of h5open(args...; kwargs...) and close the resulting HDF5.File upon completion. For example with a do block:
h5open("foo.h5","w") do h5
     h5["foo"]=[1,2,3]
-end
source
HDF5.ishdf5 — Function
ishdf5(name::AbstractString)
Returns true if the file specified by name is in the HDF5 format, and false otherwise.
source
Base.isopen — Function
isopen(obj::HDF5.File)
Returns true if obj has not been closed, false if it has been closed.
source
Base.read — Function
read(parent::H5DataStore)
-read(parent::H5DataStore, names...)
Read a list of variables, read(parent, "A", "B", "x", ...). If no variables are specified, read every variable in the file.
source
read(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString; pv...)
-read(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString => dt::HDF5.Datatype; pv...)
Read a dataset or attribute from a HDF5 file of group identified by name. Optionally, specify the HDF5.Datatype to be read.
source
read(obj::HDF5.DatasetOrAttribute}
Read the data within a HDF5.Dataset or HDF5.Attribute.
source

+end
source
HDF5.ishdf5 — Function
ishdf5(name::AbstractString)

Returns true if the file specified by name is in the HDF5 format, and false otherwise.

source
Base.isopen — Function

isopen(obj::HDF5.File)

Returns true if obj has not been closed, false if it has been closed.

source
Base.read — Function
read(parent::H5DataStore)
+read(parent::H5DataStore, names...)

Read a list of variables, read(parent, "A", "B", "x", ...). If no variables are specified, read every variable in the file.

source
read(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString; pv...)
+read(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString => dt::HDF5.Datatype; pv...)

Read a dataset or attribute from a HDF5 file of group identified by name. Optionally, specify the HDF5.Datatype to be read.

source
read(obj::HDF5.DatasetOrAttribute}

Read the data within a HDF5.Dataset or HDF5.Attribute.

source
diff --git a/dev/interface/filters/index.html b/dev/interface/filters/index.html index cc8377c70..558553789 100644 --- a/dev/interface/filters/index.html +++ b/dev/interface/filters/index.html @@ -30,9 +30,9 @@ write(dsfiltdef, data) write(dsfiltshufdef, data) -close(f)

Additonal Examples

See test/filter.jl for further examples.

source

Built-in Filters

HDF5.Filters.Shuffle — Type
Shuffle()

The shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.

As implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.

External links

source
HDF5.Filters.Szip — Type
Szip(coding=:nn, pixels_per_block=8)

Szip compression lossless filter. Options:

  • coding: the coding method: either :ec (entropy coding) or :nn (nearest neighbors, default)
  • pixels_per_block: The number of pixels or data elements in each data block (typically 8, 10, 16, or 32)

External links

source

Built-in Filters

HDF5.Filters.Shuffle — Type
Shuffle()

The shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.

As implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.

External links

source
HDF5.Filters.Szip — Type
Szip(coding=:nn, pixels_per_block=8)

Szip compression lossless filter. Options:

  • coding: the coding method: either :ec (entropy coding) or :nn (nearest neighbors, default)
  • pixels_per_block: The number of pixels or data elements in each data block (typically 8, 10, 16, or 32)

External links

source
HDF5.Filters.ExternalFilter — Type
ExternalFilter(filter_id::API.H5Z_filter_t, flags::Cuint, data::Vector{Cuint}, name::String, config::Cuint)
 ExternalFilter(filter_id, flags, data::Integer...)
-ExternalFilter(filter_id, data::AbstractVector{<:Integer} = Cuint[])

Intended to support arbitrary, unregistered, external filters. Allows the quick creation of filters using internal/proprietary filters without subtyping HDF5.Filters.Filter. Users are instead encouraged to define subtypes on HDF5.Filters.Filter.

Fields / Arguments

  • filter_id - (required) Integer filter identifer.
  • flags - (optional) bit vector describing general properties of the filter. Defaults to API.H5Z_FLAG_MANDATORY
  • data - (optional) auxillary data for the filter. See cd_values. Defaults to Cuint[]
  • name - (optional) String describing the name of the filter. Defaults to "Unknown Filter with id [filter_id]"
  • config - (optional) bit vector representing information about the filter regarding whether it is able to encode data, decode data, neither, or both. Defaults to 0.

See also:

flags bits

  • API.H5Z_FLAG_OPTIONAL
  • API.H5Z_FLAG_MANDATORY

config bits

  • API.H5Z_FILTER_CONFIG_ENCODE_ENABLED
  • API.H5Z_FILTER_CONFIG_DECODE_ENABLED
source

External Filter Packages

Several external Julia packages implement HDF5 filter plugins in Julia. As they are independent of HDF5.jl, they must be installed in order to use their plugins.

The H5Zblosc.jl, H5Zbzip2.jl, H5Zlz4.jl, and H5Zzstd.jl packages are maintained as independent subdirectory packages within the HDF5.jl repository.

H5Zblosc.jl

H5Zbzip2.jl

H5Zlz4.jl

H5Zzstd.jl

Other External Filters

Additional filters can be dynamically loaded by the HDF5 library. See External Links below for more information.

Using an ExternalFilter

ExternalFilter can be used to insert a dynamically loaded filter into the FilterPipeline in an ad-hoc fashion.

Example for bitshuffle

If we do not have a defined subtype of Filter for the bitshuffle filter we can create an ExternalFilter. From the header file or list of registered plugins, we see that the bitshuffle filter has an id of 32008.

Furthermore, the header describes two options:

  1. block_size (optional). Default is 0.
  2. compression - This can be 0 or BSHUF_H5_COMPRESS_LZ4 (2 as defined in the C header)
using HDF5.Filters
+ExternalFilter(filter_id, data::AbstractVector{<:Integer} = Cuint[])

Intended to support arbitrary, unregistered, external filters. Allows the quick creation of filters using internal/proprietary filters without subtyping HDF5.Filters.Filter. Users are instead encouraged to define subtypes on HDF5.Filters.Filter.

Fields / Arguments

  • filter_id - (required) Integer filter identifer.
  • flags - (optional) bit vector describing general properties of the filter. Defaults to API.H5Z_FLAG_MANDATORY
  • data - (optional) auxillary data for the filter. See cd_values. Defaults to Cuint[]
  • name - (optional) String describing the name of the filter. Defaults to "Unknown Filter with id [filter_id]"
  • config - (optional) bit vector representing information about the filter regarding whether it is able to encode data, decode data, neither, or both. Defaults to 0.

See also:

flags bits

  • API.H5Z_FLAG_OPTIONAL
  • API.H5Z_FLAG_MANDATORY

config bits

  • API.H5Z_FILTER_CONFIG_ENCODE_ENABLED
  • API.H5Z_FILTER_CONFIG_DECODE_ENABLED
source

External Filter Packages

Several external Julia packages implement HDF5 filter plugins in Julia. As they are independent of HDF5.jl, they must be installed in order to use their plugins.

The H5Zblosc.jl, H5Zbzip2.jl, H5Zlz4.jl, and H5Zzstd.jl packages are maintained as independent subdirectory packages within the HDF5.jl repository.

H5Zblosc.jl

H5Zbzip2.jl

H5Zlz4.jl

H5Zzstd.jl

Other External Filters

Additional filters can be dynamically loaded by the HDF5 library. See External Links below for more information.

Using an ExternalFilter

ExternalFilter can be used to insert a dynamically loaded filter into the FilterPipeline in an ad-hoc fashion.

Example for bitshuffle

If we do not have a defined subtype of Filter for the bitshuffle filter we can create an ExternalFilter. From the header file or list of registered plugins, we see that the bitshuffle filter has an id of 32008.

Furthermore, the header describes two options:

  1. block_size (optional). Default is 0.
  2. compression - This can be 0 or BSHUF_H5_COMPRESS_LZ4 (2 as defined in the C header)
using HDF5.Filters
 
 bitshuf = ExternalFilter(32008, Cuint[0, 0])
 bitshuf_comp = ExternalFilter(32008, Cuint[0, 2])
@@ -70,4 +70,4 @@
         API.h5p_set_filter(p.plist, H5Z_BSHUF_ID, API.H5Z_FLAG_OPTIONAL, 2, pointer_from_objref(ref) + sizeof(Cuint)*3)
     end
     return p
-end

Because the first three elements are not provided directly via h5p_set_filter, we also needed to implement a custom Base.push! into the FilterPipeline.

Filter Interface

The filter interface is used to describe filters and obtain information on them.

HDF5.Filters.Filter — Type
Filter

Abstract type to describe HDF5 Filters. See the Extended Help for information on implementing a new filter.

Extended Help

Filter interface

The Filter interface is implemented upon the Filter subtype.

See API.h5z_register for details.

Required Methods to Implement

  • filterid - registered filter ID
  • filter_func - implement the actual filter

Optional Methods to Implement

  • filtername - defaults to "Unnamed Filter"
  • encoder_present - defaults to true
  • decoder_present - defaults to true
  • can_apply_func - defaults to nothing
  • set_local_func - defaults to nothing

Advanced Methods to Implement

  • can_apply_cfunc - Defaults to wrapping @cfunction around the result of can_apply_func
  • set_local_cfunc - Defaults to wrapping @cfunction around the result of set_local_func
  • filter_cfunc - Defaults to wrapping @cfunction around the result of filter_func
  • register_filter - Defaults to using the above functions to register the filter

Implement the Advanced Methods to avoid @cfunction from generating a runtime closure which may not work on all systems.

source
HDF5.Filters.FilterPipeline — Type
FilterPipeline(plist::DatasetCreateProperties)

The filter pipeline associated with plist. Acts like a AbstractVector{Filter}, supporting the following operations:

  • length(pipeline): the number of filters.
  • pipeline[i] to return the ith filter.
  • pipeline[FilterType] to return a filter of type FilterType
  • push!(pipline, filter) to add an extra filter to the pipeline.
  • append!(pipeline, filters) to add multiple filters to the pipeline.
  • delete!(pipeline, FilterType) to remove a filter of type FilterType from the pipeline.
  • empty!(pipeline) to remove all filters from the pipeline.
source
HDF5.Filters.isavailable — Function
isavailable(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter is available and false otherwise.

source
HDF5.Filters.isdecoderenabled — Function
isdecoderenabled(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can decode or decompress data.

source
HDF5.Filters.isencoderenabled — Function
isencoderenabled(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can encode or compress data.

source
HDF5.Filters.can_apply_func — Function
can_apply_func(::Type{F}) where {F<:Filter}

Return a function indicating whether the filter can be applied or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register

source
HDF5.Filters.can_apply_cfunc — Function
can_apply_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the can apply function. By default, this will return the result of using @cfunction on the function specified by can_apply_func(F) or C_NULL if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
HDF5.Filters.set_local_func — Function
set_local_func(::Type{F}) where {F<:Filter}

Return a function that sets dataset specific parameters or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register.

source
HDF5.Filters.set_local_cfunc — Function
set_local_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the set local function. By default, this will return the result of using @cfunction on the function specified by set_local_func(F) or C_NULL if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
HDF5.Filters.filter_cfunc — Function
filter_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the filter function. By default, this will return the result of using @cfunction on the function specified by filter_func(F) or will throw an error if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
+end

Because the first three elements are not provided directly via h5p_set_filter, we also needed to implement a custom Base.push! into the FilterPipeline.

Filter Interface

The filter interface is used to describe filters and obtain information on them.

HDF5.Filters.Filter — Type
Filter

Abstract type to describe HDF5 Filters. See the Extended Help for information on implementing a new filter.

Extended Help

Filter interface

The Filter interface is implemented upon the Filter subtype.

See API.h5z_register for details.

Required Methods to Implement

  • filterid - registered filter ID
  • filter_func - implement the actual filter

Optional Methods to Implement

  • filtername - defaults to "Unnamed Filter"
  • encoder_present - defaults to true
  • decoder_present - defaults to true
  • can_apply_func - defaults to nothing
  • set_local_func - defaults to nothing

Advanced Methods to Implement

  • can_apply_cfunc - Defaults to wrapping @cfunction around the result of can_apply_func
  • set_local_cfunc - Defaults to wrapping @cfunction around the result of set_local_func
  • filter_cfunc - Defaults to wrapping @cfunction around the result of filter_func
  • register_filter - Defaults to using the above functions to register the filter

Implement the Advanced Methods to avoid @cfunction from generating a runtime closure which may not work on all systems.

source
HDF5.Filters.FilterPipeline — Type
FilterPipeline(plist::DatasetCreateProperties)

The filter pipeline associated with plist. Acts like a AbstractVector{Filter}, supporting the following operations:

  • length(pipeline): the number of filters.
  • pipeline[i] to return the ith filter.
  • pipeline[FilterType] to return a filter of type FilterType
  • push!(pipline, filter) to add an extra filter to the pipeline.
  • append!(pipeline, filters) to add multiple filters to the pipeline.
  • delete!(pipeline, FilterType) to remove a filter of type FilterType from the pipeline.
  • empty!(pipeline) to remove all filters from the pipeline.
source
HDF5.Filters.isavailable — Function
isavailable(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter is available and false otherwise.

source
HDF5.Filters.isdecoderenabled — Function
isdecoderenabled(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can decode or decompress data.

source
HDF5.Filters.isencoderenabled — Function
isencoderenabled(filter_or_id)

Given a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can encode or compress data.

source
HDF5.Filters.can_apply_func — Function
can_apply_func(::Type{F}) where {F<:Filter}

Return a function indicating whether the filter can be applied or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register

source
HDF5.Filters.can_apply_cfunc — Function
can_apply_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the can apply function. By default, this will return the result of using @cfunction on the function specified by can_apply_func(F) or C_NULL if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
HDF5.Filters.set_local_func — Function
set_local_func(::Type{F}) where {F<:Filter}

Return a function that sets dataset specific parameters or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register.

source
HDF5.Filters.set_local_cfunc — Function
set_local_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the set local function. By default, this will return the result of using @cfunction on the function specified by set_local_func(F) or C_NULL if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
HDF5.Filters.filter_cfunc — Function
filter_cfunc(::Type{F}) where {F<:Filter}

Return a C function pointer for the filter function. By default, this will return the result of using @cfunction on the function specified by filter_func(F) or will throw an error if nothing.

Overriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.

source
diff --git a/dev/interface/groups/index.html b/dev/interface/groups/index.html index 17636e596..559b27f24 100644 --- a/dev/interface/groups/index.html +++ b/dev/interface/groups/index.html @@ -1,3 +1,3 @@ -Groups · HDF5.jl
Edit on GitHub

Groups

HDF5.open_group — Function
open_group(parent::Union{File,Group}, path::AbstractString; properties...)

Open an existing Group at path under the parent object.

Optional keyword arguments include any keywords that that belong to GroupAccessProperties.

source
HDF5.create_external — Function
create_external(source::Union{HDF5.File, HDF5.Group}, source_relpath, target_filename, target_path;
-                lcpl_id=HDF5.API.H5P_DEFAULT, lapl_id=HDF5.H5P.DEFAULT)

Create an external link such that source[source_relpath] points to target_path within the file with path target_filename.

See also

API.h5l_create_external

source
+Groups · HDF5.jl
Edit on GitHub

Groups

HDF5.open_group — Function
open_group(parent::Union{File,Group}, path::AbstractString; properties...)

Open an existing Group at path under the parent object.

Optional keyword arguments include any keywords that that belong to GroupAccessProperties.

source
HDF5.create_external — Function
create_external(source::Union{HDF5.File, HDF5.Group}, source_relpath, target_filename, target_path;
+                lcpl_id=HDF5.API.H5P_DEFAULT, lapl_id=HDF5.H5P.DEFAULT)

Create an external link such that source[source_relpath] points to target_path within the file with path target_filename.

See also

API.h5l_create_external

source
diff --git a/dev/interface/objects/index.html b/dev/interface/objects/index.html index 00efa9125..a7d3c19cf 100644 --- a/dev/interface/objects/index.html +++ b/dev/interface/objects/index.html @@ -2,6 +2,6 @@ Objects · HDF5.jl
Edit on GitHub

Objects

HDF5.copy_object — Function
copy_object(src_parent::Union{File,Group}, src_path::AbstractString, dst_parent::Union{File,Group}, dst_path::AbstractString)

Copy data from src_parent[src_path] to dst_parent[dst_path].

Examples

f = h5open("f.h5", "r")
 g = h5open("g.h5", "cw")
 copy_object(f, "Group1", g, "GroupA")
-copy_object(f["Group1"], "data1", g, "DataSet/data_1")
source
copy_object(src_obj::Object, dst_parent::Union{File,Group}, dst_path::AbstractString)

Examples

copy_object(f["Group1"], g, "GroupA")
-copy_object(f["Group1/data1"], g, "DataSet/data_1")
source
HDF5.delete_object — Function
delete_object(parent::Union{File,Group}, path::AbstractString)

Delete the object at parent[path].

Examples

f = h5open("f.h5", "r+")
-delete_object(f, "Group1")
source
+copy_object(f["Group1"], "data1", g, "DataSet/data_1")source
copy_object(src_obj::Object, dst_parent::Union{File,Group}, dst_path::AbstractString)

Examples

copy_object(f["Group1"], g, "GroupA")
+copy_object(f["Group1/data1"], g, "DataSet/data_1")
source
HDF5.delete_object — Function
delete_object(parent::Union{File,Group}, path::AbstractString)

Delete the object at parent[path].

Examples

f = h5open("f.h5", "r+")
+delete_object(f, "Group1")
source
diff --git a/dev/interface/properties/index.html b/dev/interface/properties/index.html index 40b5bbb1e..d52881c54 100644 --- a/dev/interface/properties/index.html +++ b/dev/interface/properties/index.html @@ -1,22 +1,22 @@ -Properties · HDF5.jl
Edit on GitHub

Properties

HDF5 property lists are collections of name-value pairs which can be passed to other HDF5 functions to control features that are typically unimportant or whose default values are usually used. In HDF5.jl, these options are typically handled by keyword arguments to such functions, which will internally create the appropriate Properties objects, and so users will not usually be required to construct them manually.

Not all properties defined by the HDF5 library are currently available in HDF5.jl. If you require additional properties, please open an issue or pull request.

Common functions

HDF5.setproperties! — Function
setproperties!(props::Properties...; kwargs...)

For each (key, value) pair in kwargs, set the corresponding properties in each Properties object in props. Returns a Dict of any pairs which didn't match properties in props.

source

Properties types

HDF5.AttributeCreateProperties — Type
AttributeCreateProperties(;kws...)
-AttributeCreateProperties(f::Function; kws...)

Properties used when creating attributes.

  • char_encoding: the character enconding, either :ascii or :utf8.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.FileAccessProperties — Type
FileAccessProperties(;kws...)
-FileAccessProperties(f::Function; kws...)

Properties used when accessing files.

  • alignment :: Tuple{Integer, Integer}: a (threshold, alignment) pair: any file object greater than or equal in size to threshold bytes will be aligned on an address which is a multiple of alignment. Default values are 1, implying no alignment.

  • driver: the file driver used to access the file. See Drivers.

  • driver_info (get only)

  • fclose_degree: file close degree property. One of:

    • :weak
    • :semi
    • :strong
    • :default

  • libver_bounds: a (low, high) pair: low sets the earliest possible format versions that the library will use when creating objects in the file; high sets the latest format versions that the library will be allowed to use when creating objects in the file. Values can be a VersionNumber for the hdf5 library, :earliest, or :latest . See H5P_SET_LIBVER_BOUNDS

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.FileCreateProperties — Type
FileCreateProperties(;kws...)
-FileCreateProperties(f::Function; kws...)

Properties used when creating a new File. Inherits from ObjectCreateProperties, with additional properties:

  • userblock :: Integer: user block size in bytes. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). See H5P_SET_USERBLOCK.
  • track_order :: Bool: tracks the file creation order.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.GroupCreateProperties — Type
GroupCreateProperties(;kws...)
-GroupCreateProperties(f::Function; kws...)

Properties used when creating a new Group. Inherits from ObjectCreateProperties, with additional options:

  • local_heap_size_hint :: Integer: the anticipated maximum local heap size in bytes. See H5P_SET_LOCAL_HEAP_SIZE_HINT.
  • track_order :: Bool: tracks the group creation order.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.DatasetCreateProperties — Type
DatasetCreateProperties(;kws...)
-DatasetCreateProperties(f::Function; kws...)

Properties used when creating a new Dataset. Inherits from ObjectCreateProperties, with additional properties:

  • alloc_time: the timing for the allocation of storage space for a dataset's raw data; one of:

    • :default

    • :early: allocate all space when the dataset is created

    • :incremental: Allocate space incrementally, as data is written to the dataset

    • :late: Allocate all space when data is first written to the dataset.

    See H5P_SET_ALLOC_TIME.

  • fill_time: the timing of when the dataset should be filled; one of:

    • :alloc: Fill when allocated
    • :never: Never fill
    • :ifset: Fill if a value is set

  • fill_value: the fill value for a dataset. See H5P_SET_FILL_VALUE.

  • chunk: a tuple containing the size of the chunks to store each dimension. See H5P_SET_CHUNK (note that this uses Julia's column-major ordering).

  • external: A tuple of (name,offset,size), See H5P_SET_EXTERNAL.

  • filters (only valid when layout=:chunked): a filter or vector of filters that are applied to applied to each chunk of a dataset, see Filters. When accessed, will return a Filters.FilterPipeline object that can be modified in-place.

  • layout: the type of storage used to store the raw data for a dataset. Can be one of:

    • :compact: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data.

    • :contiguous: Store raw data separately from the object header in one large chunk in the file.

    • :chunked: Store raw data separately from the object header as chunks of data in separate locations in the file.

    • :virtual: Draw raw data from multiple datasets in different files. See the virtual property below.

    See H5P_SET_LAYOUT.

  • no_attrs_hint: Minimize the space for dataset metadata by hinting that no attributes will be added if set to true. Attributes can still be added but may exist elsewhere within the file. See H5P_SET_DSET_NO_ATTRS_HINT.

  • virtual: when specified, creates a virtual dataset (VDS). The argument should be a "virtuala collection of VirtualMapping objects for describing the mapping from the dataset to the source datasets. When accessed, returns a VirtualLayout object.

The following options are shortcuts for the various filters, and are set-only. They will be appended to the filter pipeline in the order in which they appear

  • blosc = true | level: set the H5Zblosc.BloscFilter compression filter; argument can be either true, or the compression level.

  • deflate = true | level: set the Filters.Deflate compression filter; argument can be either true, or the compression level.

  • fletcher32 = true: set the Filters.Fletcher32 checksum filter.

  • shuffle = true: set the Filters.Shuffle filter.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.DatasetAccessProperties — Type
DatasetAccessProperties(;kws...)
-DatasetAccessProperties(f::Function; kws...)

Properties that control access to data in external, virtual, and chunked datasets.

  • chunk_cache: Chunk cache parameters as (nslots, nbytes, w0). Default: (521, 0x100000, 0.75)
  • efile_prefix: Path prefix for reading external files. The default is the current working directory.
    • :origin: alias for raw"$ORIGIN" will make the external file relative to the HDF5 file.
  • virtual_prefix: Path prefix for reading virtual datasets.
  • virtual_printf_gap: The maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset
  • virtual_view: Influences whether the view of the virtual dataset includes or excludes missing mapped elements
    • :first_missing: includes all data before the first missing mapped data
    • :last_available: includes all available mapped data

A function argument passed via do will be given an initialized property list that will be closed.

See Dataset Access Properties

source
HDF5.DatasetTransferProperties — Type
DatasetTransferProperties(;kws...)
-DatasetTransferProperties(f::Function; kws...)

Properties used when transferring data to/from datasets

  • dxpl_mpio: MPI transfer mode when using Drivers.MPIO file driver:
    • :independent: use independent I/O access (default),
    • :collective: use collective I/O access.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.LinkCreateProperties — Type
LinkCreateProperties(;kws...)
-LinkCreateProperties(f::Function; kws...)

Properties used when creating links.

  • char_encoding: the character enconding, either :ascii or :utf8.

  • create_intermediate_group :: Bool: if true, will create missing intermediate groups.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.ObjectCreateProperties — Type
ObjectCreateProperties(;kws...)
-ObjectCreateProperties(f::Function; kws...)

Properties used when creating a new object. Available options:

  • obj_track_times :: Bool: governs the recording of times associated with an object. If set to true, time data will be recorded. See H5P_SET_OBJ_TRACK_TIMES.

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.StringCreateProperties — Type
StringCreateProperties(;kws...)
-StringCreateProperties(f::Function; kws...)

A function argument passed via do will be given an initialized property list that will be closed.

source
HDF5.DatatypeCreateProperties — Type
DatatypeCreateProperties(;kws...)
-DatatypeCreateProperties(f::Function; kws...)

A function argument passed via do will be given an initialized property list that will be closed.

source

Virtual Datasets

HDF5.VirtualMapping — Type
VirtualMapping(
+Properties · HDF5.jl
Edit on GitHub
Properties
HDF5 property lists are collections of name-value pairs which can be passed to other HDF5 functions to control features that are typically unimportant or whose default values are usually used. In HDF5.jl, these options are typically handled by keyword arguments to such functions, which will internally create the appropriate Properties objects, and so users will not usually be required to construct them manually.
Not all properties defined by the HDF5 library are currently available in HDF5.jl. If you require additional properties, please open an issue or pull request.
Common functions
HDF5.setproperties! — Function
setproperties!(props::Properties...; kwargs...)
For each (key, value) pair in kwargs, set the corresponding properties in each Properties object in props. Returns a Dict of any pairs which didn't match properties in props.
source
Properties types
HDF5.AttributeCreateProperties — Type
AttributeCreateProperties(;kws...)
+AttributeCreateProperties(f::Function; kws...)
Properties used when creating attributes.
  • char_encoding: the character enconding, either :ascii or :utf8.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.FileAccessProperties — Type
FileAccessProperties(;kws...)
+FileAccessProperties(f::Function; kws...)
Properties used when accessing files.
  • alignment :: Tuple{Integer, Integer}: a (threshold, alignment) pair: any file object greater than or equal in size to threshold bytes will be aligned on an address which is a multiple of alignment. Default values are 1, implying no alignment.
  • driver: the file driver used to access the file. See Drivers.
  • driver_info (get only)
  • fclose_degree: file close degree property. One of:
    • :weak
    • :semi
    • :strong
    • :default
  • libver_bounds: a (low, high) pair: low sets the earliest possible format versions that the library will use when creating objects in the file; high sets the latest format versions that the library will be allowed to use when creating objects in the file. Values can be a VersionNumber for the hdf5 library, :earliest, or :latest . See H5P_SET_LIBVER_BOUNDS
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.FileCreateProperties — Type
FileCreateProperties(;kws...)
+FileCreateProperties(f::Function; kws...)
Properties used when creating a new File. Inherits from ObjectCreateProperties,  with additional properties:
  • userblock :: Integer: user block size in bytes. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). See H5P_SET_USERBLOCK.
  • track_order :: Bool: tracks the file creation order.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.GroupCreateProperties — Type
GroupCreateProperties(;kws...)
+GroupCreateProperties(f::Function; kws...)
Properties used when creating a new Group. Inherits from ObjectCreateProperties, with additional options:
  • local_heap_size_hint :: Integer: the anticipated maximum local heap size in bytes. See H5P_SET_LOCAL_HEAP_SIZE_HINT.
  • track_order :: Bool: tracks the group creation order.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.DatasetCreateProperties — Type
DatasetCreateProperties(;kws...)
+DatasetCreateProperties(f::Function; kws...)
Properties used when creating a new Dataset. Inherits from ObjectCreateProperties, with additional properties:
  • alloc_time: the timing for the allocation of storage space for a dataset's raw data; one of:
    • :default
    • :early: allocate all space when the dataset is created
    • :incremental: Allocate space incrementally, as data is  written to the dataset
    • :late: Allocate all space when data is first written to the dataset.
    See H5P_SET_ALLOC_TIME.
  • fill_time: the timing of when the dataset should be filled; one of:
    • :alloc: Fill when allocated
    • :never: Never fill
    • :ifset: Fill if a value is set
  • fill_value: the fill value for a dataset. See H5P_SET_FILL_VALUE.
  • chunk: a tuple containing the size of the chunks to store each dimension. See H5P_SET_CHUNK (note that this uses Julia's column-major ordering).
  • external: A tuple of (name,offset,size), See H5P_SET_EXTERNAL.
  • filters (only valid when layout=:chunked): a filter or vector of filters that are applied to applied to each chunk of a dataset, see Filters. When accessed, will return a Filters.FilterPipeline object that can be modified in-place.
  • layout: the type of storage used to store the raw data for a dataset. Can be one of:
    • :compact: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data.
    • :contiguous: Store raw data separately from the object header in one large chunk in the file.
    • :chunked: Store raw data separately from the object header as chunks of data in separate locations in the file.
    • :virtual:  Draw raw data from multiple datasets in different files. See the virtual property below.
    See H5P_SET_LAYOUT.
  • no_attrs_hint: Minimize the space for dataset metadata by hinting that no  attributes will be added if set to true. Attributes can still be added but  may exist elsewhere within the file. See  H5P_SET_DSET_NO_ATTRS_HINT.
  • virtual: when specified, creates a virtual dataset (VDS). The argument should be a "virtuala collection of VirtualMapping objects for describing the mapping from the dataset to the source datasets. When accessed, returns a VirtualLayout object.
The following options are shortcuts for the various filters, and are set-only. They will be appended to the filter pipeline in the order in which they appear
  • blosc = true | level: set the H5Zblosc.BloscFilter compression filter; argument can be either true, or the compression level.
  • deflate = true | level: set the Filters.Deflate compression filter; argument can be either true, or the compression level.
  • fletcher32 = true: set the Filters.Fletcher32 checksum filter.
  • shuffle = true: set the Filters.Shuffle filter.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.DatasetAccessProperties — Type
DatasetAccessProperties(;kws...)
+DatasetAccessProperties(f::Function; kws...)
Properties that control access to data in external, virtual, and chunked datasets.
  • chunk_cache: Chunk cache parameters as (nslots, nbytes, w0). Default: (521, 0x100000, 0.75)
  • efile_prefix: Path prefix for reading external files. The default is the current working directory.
    • :origin: alias for raw"$ORIGIN" will make the external file relative to the HDF5 file.
  • virtual_prefix: Path prefix for reading virtual datasets.
  • virtual_printf_gap: The maximum number of missing source files and/or  datasets with the printf-style names when getting the extent of an unlimited  virtual dataset
  • virtual_view: Influences whether the view of the virtual dataset includes or excludes missing mapped elements
    • :first_missing: includes all data before the first missing mapped data
    • :last_available: includes all available mapped data
A function argument passed via do will be given an initialized property list that will be closed.
See Dataset Access Properties
source
HDF5.DatasetTransferProperties — Type
DatasetTransferProperties(;kws...)
+DatasetTransferProperties(f::Function; kws...)
Properties used when transferring data to/from datasets
  • dxpl_mpio: MPI transfer mode when using Drivers.MPIO file driver:
    • :independent: use independent I/O access (default),
    • :collective: use collective I/O access.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.LinkCreateProperties — Type
LinkCreateProperties(;kws...)
+LinkCreateProperties(f::Function; kws...)
Properties used when creating links.
  • char_encoding: the character enconding, either :ascii or :utf8.
  • create_intermediate_group :: Bool: if true, will create missing intermediate groups.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.ObjectCreateProperties — Type
ObjectCreateProperties(;kws...)
+ObjectCreateProperties(f::Function; kws...)
Properties used when creating a new object. Available options:
  • obj_track_times :: Bool: governs the recording of times associated with an object. If set to true, time data will be recorded. See H5P_SET_OBJ_TRACK_TIMES.
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.StringCreateProperties — Type
StringCreateProperties(;kws...)
+StringCreateProperties(f::Function; kws...)
A function argument passed via do will be given an initialized property list that will be closed.
source
HDF5.DatatypeCreateProperties — Type
DatatypeCreateProperties(;kws...)
+DatatypeCreateProperties(f::Function; kws...)
A function argument passed via do will be given an initialized property list that will be closed.
source
Virtual Datasets
HDF5.VirtualMapping — Type
VirtualMapping(
     vspace::Dataspace,
     srcfile::AbstractString,
     srcdset::AbstractString,
     srcspace::Dataspace
-)
Specify a map of elements of the virtual dataset (VDS) described by vspace to the elements of the source dataset described by srcspace. The source dataset is identified by the name of the file where it is located, srcfile, and the name of the dataset, srcdset.
Both srcfile and srcdset support "printf"-style formats with %b being replaced by the block count of the selection.
For more details on how source file resolution works, see H5P_SET_VIRTUAL.
source
HDF5.VirtualLayout — Type
VirtualLayout(dcpl::DatasetCreateProperties)
The collection of VirtualMappings associated with dcpl. This is an AbstractVector{VirtualMapping}, supporting length, getindex and push!.
source
Drivers
File drivers determine how the HDF5 is accessed. These can be set as the driver property in FileAccessProperties.
HDF5.Drivers.Core — Type
Core([increment::Csize_t, backing_store::Cuint, [write_tracking::Cuint, page_size::Csize_t]])
-Core(; increment::Csize_t = 8192, backing_store::Cuint = true, write_tracking::Cuint = false, page_size::Csize_t = 524288)
Arguments
  • increment: specifies the increment by which allocated memory is to be increased each time more memory is required. (default: 8192)
  • backing_store: Boolean flag indicating whether to write the file contents to disk when the file is closed. (default: false)
  • write_tracking: Boolean flag indicating whether write tracking is enabled. (default: false)
  • page_size: Size, in bytes, of write aggregation pages. (default: 524288)
source
HDF5.Drivers.POSIX — Type
POSIX()
Also referred to as SEC2, this driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems.
source
HDF5.Drivers.ROS3 — Type
ROS3()
+)
Specify a map of elements of the virtual dataset (VDS) described by vspace to the elements of the source dataset described by srcspace. The source dataset is identified by the name of the file where it is located, srcfile, and the name of the dataset, srcdset.
Both srcfile and srcdset support "printf"-style formats with %b being replaced by the block count of the selection.
For more details on how source file resolution works, see H5P_SET_VIRTUAL.
source
HDF5.VirtualLayout — Type
VirtualLayout(dcpl::DatasetCreateProperties)
The collection of VirtualMappings associated with dcpl. This is an AbstractVector{VirtualMapping}, supporting length, getindex and push!.
source
Drivers
File drivers determine how the HDF5 is accessed. These can be set as the driver property in FileAccessProperties.
HDF5.Drivers.Core — Type
Core([increment::Csize_t, backing_store::Cuint, [write_tracking::Cuint, page_size::Csize_t]])
+Core(; increment::Csize_t = 8192, backing_store::Cuint = true, write_tracking::Cuint = false, page_size::Csize_t = 524288)
Arguments
  • increment: specifies the increment by which allocated memory is to be increased each time more memory is required. (default: 8192)
  • backing_store: Boolean flag indicating whether to write the file contents to disk when the file is closed. (default: false)
  • write_tracking: Boolean flag indicating whether write tracking is enabled. (default: false)
  • page_size: Size, in bytes, of write aggregation pages. (default: 524288)
source
HDF5.Drivers.POSIX — Type
POSIX()
Also referred to as SEC2, this driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems.
source
HDF5.Drivers.ROS3 — Type
ROS3()
 ROS3(aws_region::String, secret_id::String, secret_key::String)
-ROS3(version::Int32, authenticate::Bool, aws_region::String, secret_id::String, secret_key::String)
This is the read-only virtual driver that enables access to HDF5 objects stored in AWS S3
source
Internals
The following macros are used for defining new properties and property getters/setters.
HDF5.@propertyclass — Macro
@propertyclass P classid
Define a new subtype of P <: Properties corresponding to a HDF5 property list with class identifier classid.
Once defined, the following interfaces can be defined:
superclass(::Type{P})
This should return the type from which P inherits. If not defined, it will inherit from GenericProperties.
class_propertynames(::Type{P})
This should return a Tuple of Symbols, being the names of the properties associated with P.
class_getproperty(::Type{P}, p::Properties, name::Symbol)
If name is an associated property of type P, this should return the value of the property, otherwise call class_getproperty(superclass(P), p, name).
class_setproperty!(::Type{P}, p::Properties, name::Symbol, val)
If name is an associated property of type P, this should set the value of the property, otherwise call class_setproperty!(superclass(P), p, name, val).
source
HDF5.@bool_property — Macro
@bool_property(name)
Wrap property getter/setter API functions that use 0/1 to use Bool values
source
HDF5.@enum_property — Macro
@enum_property(name, sym1 => enumvalue1, sym2 => enumvalue2, ...)
Wrap property getter/setter API functions that use enum values to use symbol instead.
source

+ROS3(version::Int32, authenticate::Bool, aws_region::String, secret_id::String, secret_key::String)

This is the read-only virtual driver that enables access to HDF5 objects stored in AWS S3

source

Internals

The following macros are used for defining new properties and property getters/setters.

HDF5.@propertyclass — Macro
@propertyclass P classid

Define a new subtype of P <: Properties corresponding to a HDF5 property list with class identifier classid.

Once defined, the following interfaces can be defined:

superclass(::Type{P})

This should return the type from which P inherits. If not defined, it will inherit from GenericProperties.

class_propertynames(::Type{P})

This should return a Tuple of Symbols, being the names of the properties associated with P.

class_getproperty(::Type{P}, p::Properties, name::Symbol)

If name is an associated property of type P, this should return the value of the property, otherwise call class_getproperty(superclass(P), p, name).

class_setproperty!(::Type{P}, p::Properties, name::Symbol, val)

If name is an associated property of type P, this should set the value of the property, otherwise call class_setproperty!(superclass(P), p, name, val).

source
HDF5.@bool_property — Macro
@bool_property(name)

Wrap property getter/setter API functions that use 0/1 to use Bool values

source
HDF5.@enum_property — Macro
@enum_property(name, sym1 => enumvalue1, sym2 => enumvalue2, ...)

Wrap property getter/setter API functions that use enum values to use symbol instead.

source
diff --git a/dev/mpi/index.html b/dev/mpi/index.html index 61ddc62e6..d70244c47 100644 --- a/dev/mpi/index.html +++ b/dev/mpi/index.html @@ -29,4 +29,4 @@ dset = create_dataset(ff, "/data", datatype(eltype(A)), dataspace(dims)) # Write local data -dset[:, myrank + 1] = A

Note that metadata operations, such as create_dataset, must be called collectively (on all processes at the same time, with the same arguments), but the actual writing to the dataset may be done independently. See Collective Calling Requirements in Parallel HDF5 Applications for the exact requirements.

Sometimes, it may be more efficient to write data in chunks, so that each process writes to a separate chunk of the file. This is especially the case when data is uniformly distributed among MPI processes. In this example, this can be achieved by passing chunk=(M, 1) to create_dataset.

For better performance, it is sometimes preferable to perform collective I/O when reading and writing datasets in parallel. This is achieved by passing dxpl_mpio=:collective to create_dataset. See also the HDF5 docs.

A few more examples are available in test/mpio.jl.

+dset[:, myrank + 1] = A

Note that metadata operations, such as create_dataset, must be called collectively (on all processes at the same time, with the same arguments), but the actual writing to the dataset may be done independently. See Collective Calling Requirements in Parallel HDF5 Applications for the exact requirements.

Sometimes, it may be more efficient to write data in chunks, so that each process writes to a separate chunk of the file. This is especially the case when data is uniformly distributed among MPI processes. In this example, this can be achieved by passing chunk=(M, 1) to create_dataset.

For better performance, it is sometimes preferable to perform collective I/O when reading and writing datasets in parallel. This is achieved by passing dxpl_mpio=:collective to create_dataset. See also the HDF5 docs.

A few more examples are available in test/mpio.jl.

diff --git a/dev/search/index.html b/dev/search/index.html index be2cc3a7c..dec425335 100644 --- a/dev/search/index.html +++ b/dev/search/index.html @@ -1,2 +1,2 @@ -Search · HDF5.jl

Loading search...

    +Search · HDF5.jl

    Loading search...

      diff --git a/dev/search_index.js b/dev/search_index.js index f2a3ff0f0..fe31510e9 100644 --- a/dev/search_index.js +++ b/dev/search_index.js @@ -1,3 +1,3 @@ var documenterSearchIndex = {"docs": -[{"location":"mpi/#Parallel-HDF5","page":"Parallel HDF5","title":"Parallel HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"It is possible to read and write parallel HDF5 files using MPI. For this, the HDF5 binaries loaded by HDF5.jl must have been compiled with parallel support, and linked to the specific MPI implementation that will be used for parallel I/O.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Parallel-enabled HDF5 libraries are usually included in computing clusters and linked to the available MPI implementations. They are also available via the package manager of a number of Linux distributions.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Finally, note that the MPI.jl package is lazy-loaded by HDF5.jl using Requires. In practice, this means that in Julia code, MPI must be imported before HDF5 for parallel functionality to be available.","category":"page"},{"location":"mpi/#Setting-up-Parallel-HDF5","page":"Parallel HDF5","title":"Setting-up Parallel HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"The following step-by-step guide assumes one already has access to parallel-enabled HDF5 libraries linked to an existent MPI installation.","category":"page"},{"location":"mpi/#using_system_MPI","page":"Parallel HDF5","title":"1. Using system-provided MPI libraries","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Using a system-provided MPI library can be done with MPIPreferences.jl. After installing MPIPreferences.jl and running julia --project -e 'using MPIPreferences; MPIPreferences.use_system_binary()' MPIPreferences.jl identifies any available MPI implementation and stores the information in a file LocalPreferences.toml. See the MPI.jl docs for details.","category":"page"},{"location":"mpi/#using_parallel_HDF5","page":"Parallel HDF5","title":"2. Using parallel HDF5 libraries","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"note: Migration from HDF5.jl v0.16 and earlier\nHow to use a system-provided HDF5 library has been changed in HDF5.jl v0.17. Previously, the library path was set by the environment variable JULIA_HDF5_PATH, which required to rebuild HDF5.jl afterwards. The environment variable has been removed and no longer has an effect (for backward compatibility it is still recommended to also set the environment variable). Instead, proceed as described below.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"As detailed in Using custom or system provided HDF5 binaries, set the preferences libhdf5 and libhdf5_hl to the full path, where the parallel HDF5 binaries are located. This can be done by:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"julia> using Preferences, UUIDs\n\njulia> set_preferences!(\n UUID(\"f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f\"), # UUID of HDF5.jl\n \"libhdf5\" => \"/path/to/your/libhdf5.so\",\n \"libhdf5_hl\" => \"/path/to/your/libhdf5_hl.so\",\n force = true)","category":"page"},{"location":"mpi/#.-Loading-MPI-enabled-HDF5","page":"Parallel HDF5","title":"3. Loading MPI-enabled HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"In Julia code, MPI.jl must be loaded before HDF5.jl for MPI functionality to be available:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"using MPI\nusing HDF5\n\n@assert HDF5.has_parallel()","category":"page"},{"location":"mpi/#Notes-to-HPC-cluster-administrators","page":"Parallel HDF5","title":"Notes to HPC cluster administrators","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"More information for a setup at an HPC cluster can be found in the docs of MPI.jl. After performing the steps 1. and 2. the LocalPreferences.toml file could look something like the following:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"[MPIPreferences]\n_format = \"1.0\"\nabi = \"OpenMPI\"\nbinary = \"system\"\nlibmpi = \"/software/mpi/lib/libmpi.so\"\nmpiexec = \"/software/mpi/bin/mpiexec\"\n\n[HDF5]\nlibhdf5 = \"/path/to/your/libhdf5.so\"\nlibhdf5_hl = \"/path/to/your/libhdf5_hl.so\"","category":"page"},{"location":"mpi/#Reading-and-writing-data-in-parallel","page":"Parallel HDF5","title":"Reading and writing data in parallel","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"A parallel HDF5 file may be opened by passing a MPI.Comm (and optionally a MPI.Info) object to h5open. For instance:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"comm = MPI.COMM_WORLD\ninfo = MPI.Info()\nff = h5open(filename, \"w\", comm, info)","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"MPI-distributed data is typically written by first creating a dataset describing the global dimensions of the data. The following example writes a 10 × Nproc array distributed over Nproc MPI processes.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Nproc = MPI.Comm_size(comm)\nmyrank = MPI.Comm_rank(comm)\nM = 10\nA = fill(myrank, M) # local data\ndims = (M, Nproc) # dimensions of global data\n\n# Create dataset\ndset = create_dataset(ff, \"/data\", datatype(eltype(A)), dataspace(dims))\n\n# Write local data\ndset[:, myrank + 1] = A","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Note that metadata operations, such as create_dataset, must be called collectively (on all processes at the same time, with the same arguments), but the actual writing to the dataset may be done independently. See Collective Calling Requirements in Parallel HDF5 Applications for the exact requirements.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Sometimes, it may be more efficient to write data in chunks, so that each process writes to a separate chunk of the file. This is especially the case when data is uniformly distributed among MPI processes. In this example, this can be achieved by passing chunk=(M, 1) to create_dataset.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"For better performance, it is sometimes preferable to perform collective I/O when reading and writing datasets in parallel. This is achieved by passing dxpl_mpio=:collective to create_dataset. See also the HDF5 docs.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"A few more examples are available in test/mpio.jl.","category":"page"},{"location":"interface/filters/#Filters","page":"Filters","title":"Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"HDF5 supports filters for compression and validation: these are applied sequentially to each chunk of a dataset when writing data, and in reverse order when reading data.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"These can be set by passing a filter or vector of filters as a filters property to DatasetCreateProperties or via the filters keyword argument of create_dataset.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/#Example","page":"Filters","title":"Example","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Filters","category":"page"},{"location":"interface/filters/#HDF5.Filters","page":"Filters","title":"HDF5.Filters","text":"HDF5.Filters\n\nThis module contains the interface for using filters in HDF5.jl.\n\nExample Usage\n\nusing HDF5\nusing HDF5.Filters\n\n# Create a new file\nfn = tempname()\n\n# Create test data\ndata = rand(1000, 1000)\n\n# Open temp file for writing\nf = h5open(fn, \"w\") \n\n# Create datasets\ndsdeflate = create_dataset(f, \"deflate\", datatype(data), dataspace(data),\n chunk=(100, 100), deflate=3)\n\ndsshufdef = create_dataset(f, \"shufdef\", datatype(data), dataspace(data),\n chunk=(100, 100), shuffle=true, deflate=3)\n\ndsfiltdef = create_dataset(f, \"filtdef\", datatype(data), dataspace(data),\n chunk=(100, 100), filters=Filters.Deflate(3))\n\ndsfiltshufdef = create_dataset(f, \"filtshufdef\", datatype(data), dataspace(data),\n chunk=(100, 100), filters=[Filters.Shuffle(), Filters.Deflate(3)])\n\n# Write data\nwrite(dsdeflate, data)\nwrite(dsshufdef, data)\nwrite(dsfiltdef, data)\nwrite(dsfiltshufdef, data)\n\nclose(f)\n\nAdditonal Examples\n\nSee test/filter.jl for further examples.\n\n\n\n\n\n","category":"module"},{"location":"interface/filters/#Built-in-Filters","page":"Filters","title":"Built-in Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Deflate\nShuffle\nFletcher32\nSzip\nNBit\nScaleOffset\nExternalFilter","category":"page"},{"location":"interface/filters/#HDF5.Filters.Deflate","page":"Filters","title":"HDF5.Filters.Deflate","text":"Deflate(level=5)\n\nDeflate/ZLIB lossless compression filter. level is an integer between 0 and 9, inclusive, denoting the compression level, with 0 being no compression, 9 being the highest compression (but slowest speed).\n\nExternal links\n\nH5P_SET_DEFLATE\nDeflate on Wikipedia\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Shuffle","page":"Filters","title":"HDF5.Filters.Shuffle","text":"Shuffle()\n\nThe shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.\n\nAs implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.\n\nExternal links\n\nH5P_SET_SHUFFLE\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Fletcher32","page":"Filters","title":"HDF5.Filters.Fletcher32","text":"Fletcher32()\n\nThe Fletcher32 checksum filter. This doesn't perform compression, but instead checks the validity of the stored data.\n\nThis should be applied after any lossy filters have been applied.\n\nExternal links\n\nH5P_SET_FLETCHER32\nFletcher's checksum on Wikipedia\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Szip","page":"Filters","title":"HDF5.Filters.Szip","text":"Szip(coding=:nn, pixels_per_block=8)\n\nSzip compression lossless filter. Options:\n\ncoding: the coding method: either :ec (entropy coding) or :nn (nearest neighbors, default)\npixels_per_block: The number of pixels or data elements in each data block (typically 8, 10, 16, or 32)\n\nExternal links\n\nH5P_SET_SZIP\nSzip Compression in HDF Products\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.NBit","page":"Filters","title":"HDF5.Filters.NBit","text":"NBit()\n\nThe N-Bit filter.\n\nExternal links\n\nH5P_SET_NBIT\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.ScaleOffset","page":"Filters","title":"HDF5.Filters.ScaleOffset","text":"ScaleOffset(scale_type::Integer, scale_offset::Integer)\n\nThe scale-offset filter.\n\nExternal links\n\nH5P_SET_SCALEOFFSET\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.ExternalFilter","page":"Filters","title":"HDF5.Filters.ExternalFilter","text":"ExternalFilter(filter_id::API.H5Z_filter_t, flags::Cuint, data::Vector{Cuint}, name::String, config::Cuint)\nExternalFilter(filter_id, flags, data::Integer...)\nExternalFilter(filter_id, data::AbstractVector{<:Integer} = Cuint[])\n\nIntended to support arbitrary, unregistered, external filters. Allows the quick creation of filters using internal/proprietary filters without subtyping HDF5.Filters.Filter. Users are instead encouraged to define subtypes on HDF5.Filters.Filter.\n\nFields / Arguments\n\nfilter_id - (required) Integer filter identifer.\nflags - (optional) bit vector describing general properties of the filter. Defaults to API.H5Z_FLAG_MANDATORY\ndata - (optional) auxillary data for the filter. See cd_values. Defaults to Cuint[]\nname - (optional) String describing the name of the filter. Defaults to \"Unknown Filter with id [filter_id]\"\nconfig - (optional) bit vector representing information about the filter regarding whether it is able to encode data, decode data, neither, or both. Defaults to 0.\n\nSee also:\n\nAPI.h5p_set_filter\nH5Z_GET_FILTER_INFO.\nRegistered Filter Plugins\n\nflags bits\n\nAPI.H5Z_FLAG_OPTIONAL\nAPI.H5Z_FLAG_MANDATORY\n\nconfig bits \n\nAPI.H5Z_FILTER_CONFIG_ENCODE_ENABLED\nAPI.H5Z_FILTER_CONFIG_DECODE_ENABLED\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#External-Filter-Packages","page":"Filters","title":"External Filter Packages","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Several external Julia packages implement HDF5 filter plugins in Julia. As they are independent of HDF5.jl, they must be installed in order to use their plugins.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The H5Zblosc.jl, H5Zbzip2.jl, H5Zlz4.jl, and H5Zzstd.jl packages are maintained as independent subdirectory packages within the HDF5.jl repository.","category":"page"},{"location":"interface/filters/#H5Zblosc.jl","page":"Filters","title":"H5Zblosc.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zblosc","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"BloscFilter","category":"page"},{"location":"interface/filters/#H5Zblosc.BloscFilter","page":"Filters","title":"H5Zblosc.BloscFilter","text":"BloscFilter(;level=5, shuffle=true, compressor=\"blosclz\")\n\nThe Blosc compression filter, using Blosc.jl. Options:\n\nlevel: compression level\nshuffle: whether to shuffle data before compressing (this option should be used instead of the Shuffle filter)\ncompressor: the compression algorithm. Call Blosc.compressors() for the available compressors.\n\nExternal links\n\nWhat Is Blosc?\nBlosc HDF5 Filter ID 32001\nBlosc HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zbzip2.jl","page":"Filters","title":"H5Zbzip2.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zbzip2","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Bzip2Filter","category":"page"},{"location":"interface/filters/#H5Zbzip2.Bzip2Filter","page":"Filters","title":"H5Zbzip2.Bzip2Filter","text":"Bzip2Filter(blockSize100k)\n\nApply Bzip2 compression. The filter id is 307.\n\nExternal Links\n\nBZIP2 HDF5 Filter ID 307\nPyTables Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zlz4.jl","page":"Filters","title":"H5Zlz4.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zlz4","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Lz4Filter","category":"page"},{"location":"interface/filters/#H5Zlz4.Lz4Filter","page":"Filters","title":"H5Zlz4.Lz4Filter","text":"Lz4Filter(blockSize)\n\nApply LZ4 compression. blockSize is the main argument. The filter id is 32004.\n\nExternal Links\n\nLZ4 HDF5 Filter ID 32004\nLZ4 HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zzstd.jl","page":"Filters","title":"H5Zzstd.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zzstd","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"ZstdFilter","category":"page"},{"location":"interface/filters/#H5Zzstd.ZstdFilter","page":"Filters","title":"H5Zzstd.ZstdFilter","text":"ZstdFilter(clevel)\n\nZstandard compression filter. clevel determines the compression level.\n\nExternal Links\n\nZstandard HDF5 Filter ID 32015\nZstandard HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#Other-External-Filters","page":"Filters","title":"Other External Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Additional filters can be dynamically loaded by the HDF5 library. See External Links below for more information.","category":"page"},{"location":"interface/filters/#Using-an-ExternalFilter","page":"Filters","title":"Using an ExternalFilter","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"ExternalFilter can be used to insert a dynamically loaded filter into the FilterPipeline in an ad-hoc fashion.","category":"page"},{"location":"interface/filters/#Example-for-bitshuffle","page":"Filters","title":"Example for bitshuffle","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"If we do not have a defined subtype of Filter for the bitshuffle filter we can create an ExternalFilter. From the header file or list of registered plugins, we see that the bitshuffle filter has an id of 32008.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Furthermore, the header describes two options:","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"block_size (optional). Default is 0.\ncompression - This can be 0 or BSHUF_H5_COMPRESS_LZ4 (2 as defined in the C header)","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"using HDF5.Filters\n\nbitshuf = ExternalFilter(32008, Cuint[0, 0])\nbitshuf_comp = ExternalFilter(32008, Cuint[0, 2])\n\ndata_A = rand(0:31, 1024)\ndata_B = rand(32:63, 1024)\n\nfilename, _ = mktemp()\nh5open(filename, \"w\") do h5f\n # Indexing style\n h5f[\"ex_data_A\", chunk=(32,), filters=bitshuf] = data_A\n # Procedural style\n d, dt = create_dataset(h5f, \"ex_data_B\", data_B, chunk=(32,), filters=[bitshuf_comp])\n write(d, data_B)\nend","category":"page"},{"location":"interface/filters/#Creating-a-new-Filter-type","page":"Filters","title":"Creating a new Filter type","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Examining the bitshuffle filter source code we see that three additional data components get prepended to the options. These are","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The major version\nThe minor version\nThe element size in bytes of the type via H5Tget_size.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"import HDF5.Filters: FILTERS, Filter, FilterPipeline, filterid\nusing HDF5.API\n\nconst H5Z_BSHUF_ID = API.H5Z_filter_t(32008)\nstruct BitShuffleFilter <: HDF5.Filters.Filter\n major::Cuint\n minor::Cuint\n elem_size::Cuint\n block_size::Cuint\n compression::Cuint\n BitShuffleFilter(block_size, compression) = new(0, 0, 0, block_size, compression)\nend\n# filterid is the only required method of the filter interface\n# since we are using an externally registered filter\nfilterid(::Type{BitShuffleFilter}) = H5Z_BSHUF_ID\nFILTERS[H5Z_BSHUF_ID] = BitShuffleFilter\n\nfunction Base.push!(p::FilterPipeline, f::BitShuffleFilter)\n ref = Ref(f)\n GC.@preserve ref begin\n API.h5p_set_filter(p.plist, H5Z_BSHUF_ID, API.H5Z_FLAG_OPTIONAL, 2, pointer_from_objref(ref) + sizeof(Cuint)*3)\n end\n return p\nend","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Because the first three elements are not provided directly via h5p_set_filter, we also needed to implement a custom Base.push! into the FilterPipeline.","category":"page"},{"location":"interface/filters/#Filter-Interface","page":"Filters","title":"Filter Interface","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The filter interface is used to describe filters and obtain information on them.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Filter\nFilterPipeline\nUnknownFilter\nFILTERS\nEXTERNAL_FILTER_JULIA_PACKAGES\nfilterid\nisavailable\nisdecoderenabled\nisencoderenabled\ndecoder_present\nencoder_present\nensure_filters_available\nfiltername\ncan_apply_func\ncan_apply_cfunc\nset_local_func\nset_local_cfunc\nfilter_func\nfilter_cfunc\nregister_filter","category":"page"},{"location":"interface/filters/#HDF5.Filters.Filter","page":"Filters","title":"HDF5.Filters.Filter","text":"Filter\n\nAbstract type to describe HDF5 Filters. See the Extended Help for information on implementing a new filter.\n\nExtended Help\n\nFilter interface\n\nThe Filter interface is implemented upon the Filter subtype.\n\nSee API.h5z_register for details.\n\nRequired Methods to Implement\n\nfilterid - registered filter ID\nfilter_func - implement the actual filter\n\nOptional Methods to Implement\n\nfiltername - defaults to \"Unnamed Filter\"\nencoder_present - defaults to true\ndecoder_present - defaults to true\ncan_apply_func - defaults to nothing\nset_local_func - defaults to nothing\n\nAdvanced Methods to Implement\n\ncan_apply_cfunc - Defaults to wrapping @cfunction around the result of can_apply_func\nset_local_cfunc - Defaults to wrapping @cfunction around the result of set_local_func\nfilter_cfunc - Defaults to wrapping @cfunction around the result of filter_func\nregister_filter - Defaults to using the above functions to register the filter\n\nImplement the Advanced Methods to avoid @cfunction from generating a runtime closure which may not work on all systems.\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.FilterPipeline","page":"Filters","title":"HDF5.Filters.FilterPipeline","text":"FilterPipeline(plist::DatasetCreateProperties)\n\nThe filter pipeline associated with plist. Acts like a AbstractVector{Filter}, supporting the following operations:\n\nlength(pipeline): the number of filters.\npipeline[i] to return the ith filter.\npipeline[FilterType] to return a filter of type FilterType\npush!(pipline, filter) to add an extra filter to the pipeline.\nappend!(pipeline, filters) to add multiple filters to the pipeline.\ndelete!(pipeline, FilterType) to remove a filter of type FilterType from the pipeline.\nempty!(pipeline) to remove all filters from the pipeline.\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.UnknownFilter","page":"Filters","title":"HDF5.Filters.UnknownFilter","text":"UnknownFilter\n\nUnknown filter type. Alias for ExternalFilter (see related documentation).\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.FILTERS","page":"Filters","title":"HDF5.Filters.FILTERS","text":"FILTERS\n\nMaps filter id to filter type.\n\n\n\n\n\n","category":"constant"},{"location":"interface/filters/#HDF5.Filters.EXTERNAL_FILTER_JULIA_PACKAGES","page":"Filters","title":"HDF5.Filters.EXTERNAL_FILTER_JULIA_PACKAGES","text":"EXTERNAL_FILTER_JULIA_PACKAGES\n\nMaps filter id to the Julia package name that contains the filter.\n\n\n\n\n\n","category":"constant"},{"location":"interface/filters/#HDF5.Filters.filterid","page":"Filters","title":"HDF5.Filters.filterid","text":"filterid(F) where {F <: Filter}\n\nThe internal filter id of a filter of type F.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isavailable","page":"Filters","title":"HDF5.Filters.isavailable","text":"isavailable(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter is available and false otherwise.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isdecoderenabled","page":"Filters","title":"HDF5.Filters.isdecoderenabled","text":"isdecoderenabled(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can decode or decompress data.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isencoderenabled","page":"Filters","title":"HDF5.Filters.isencoderenabled","text":"isencoderenabled(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can encode or compress data.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.decoder_present","page":"Filters","title":"HDF5.Filters.decoder_present","text":"decoder_present(::Type{F}) where {F<:Filter}\n\nCan the filter decode or decompress the data? Defaults to true. Returns a Bool. See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.encoder_present","page":"Filters","title":"HDF5.Filters.encoder_present","text":"encoder_present(::Type{F}) where {F<:Filter}\n\nCan the filter have an encode or compress the data? Defaults to true. Returns a Bool. See API.h5z_register.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.ensure_filters_available","page":"Filters","title":"HDF5.Filters.ensure_filters_available","text":"Error if all filters in a filter pipeline are not available.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filtername","page":"Filters","title":"HDF5.Filters.filtername","text":"filtername(::Type{F}) where {F<:Filter}\n\nWhat is the name of a filter? Defaults to \"Unnamed Filter\" Returns a String describing the filter. See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.can_apply_func","page":"Filters","title":"HDF5.Filters.can_apply_func","text":"can_apply_func(::Type{F}) where {F<:Filter}\n\nReturn a function indicating whether the filter can be applied or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.can_apply_cfunc","page":"Filters","title":"HDF5.Filters.can_apply_cfunc","text":"can_apply_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the can apply function. By default, this will return the result of using @cfunction on the function specified by can_apply_func(F) or C_NULL if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.set_local_func","page":"Filters","title":"HDF5.Filters.set_local_func","text":"set_local_func(::Type{F}) where {F<:Filter}\n\nReturn a function that sets dataset specific parameters or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.set_local_cfunc","page":"Filters","title":"HDF5.Filters.set_local_cfunc","text":"set_local_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the set local function. By default, this will return the result of using @cfunction on the function specified by set_local_func(F) or C_NULL if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filter_func","page":"Filters","title":"HDF5.Filters.filter_func","text":"filter_func(::Type{F}) where {F<:Filter}\n\nReturns a function that performs the actual filtering.\n\nSee API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filter_cfunc","page":"Filters","title":"HDF5.Filters.filter_cfunc","text":"filter_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the filter function. By default, this will return the result of using @cfunction on the function specified by filter_func(F) or will throw an error if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.register_filter","page":"Filters","title":"HDF5.Filters.register_filter","text":"register_filter(::Type{F}) where F <: Filter\n\nRegister the filter with the HDF5 library via API.h5z_register. Also add F to the FILTERS dictionary.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#External-Links","page":"Filters","title":"External Links","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"A list of registered filter plugins can be found on the HDF Group website.\nSee the HDF5 Documentation of HDF5 Filter Plugins for details.\nThe source code for many external plugins have been collected in the HDFGroup hdf5_plugins repository.\nCompiled binaries of dynamically downloaded plugins by downloaded from HDF5 Group.","category":"page"},{"location":"interface/groups/#Groups","page":"Groups","title":"Groups","text":"","category":"section"},{"location":"interface/groups/","page":"Groups","title":"Groups","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/groups/","page":"Groups","title":"Groups","text":"Group\ncreate_group\nopen_group\ncreate_external","category":"page"},{"location":"interface/groups/#HDF5.Group","page":"Groups","title":"HDF5.Group","text":"HDF5.Group\n\nAn object representing a HDF5 group. A group is analagous to a file system directory, in that, except for the root group, every object must be a member of at least one group.\n\nSee also\n\ncreate_group\nopen_group\n\n\n\n\n\n","category":"type"},{"location":"interface/groups/#HDF5.create_group","page":"Groups","title":"HDF5.create_group","text":"create_group(parent::Union{File,Group}, path::AbstractString; properties...)\n\nCreate a new Group at path under the parent object. Optional keyword arguments include any keywords that that belong to LinkCreateProperties or GroupCreateProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/groups/#HDF5.open_group","page":"Groups","title":"HDF5.open_group","text":"open_group(parent::Union{File,Group}, path::AbstractString; properties...)\n\nOpen an existing Group at path under the parent object.\n\nOptional keyword arguments include any keywords that that belong to GroupAccessProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/groups/#HDF5.create_external","page":"Groups","title":"HDF5.create_external","text":"create_external(source::Union{HDF5.File, HDF5.Group}, source_relpath, target_filename, target_path;\n lcpl_id=HDF5.API.H5P_DEFAULT, lapl_id=HDF5.H5P.DEFAULT)\n\nCreate an external link such that source[source_relpath] points to target_path within the file with path target_filename.\n\nSee also\n\nAPI.h5l_create_external\n\n\n\n\n\n","category":"function"},{"location":"interface/objects/#Objects","page":"Objects","title":"Objects","text":"","category":"section"},{"location":"interface/objects/","page":"Objects","title":"Objects","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/objects/","page":"Objects","title":"Objects","text":"copy_object\ndelete_object","category":"page"},{"location":"interface/objects/#HDF5.copy_object","page":"Objects","title":"HDF5.copy_object","text":"copy_object(src_parent::Union{File,Group}, src_path::AbstractString, dst_parent::Union{File,Group}, dst_path::AbstractString)\n\nCopy data from src_parent[src_path] to dst_parent[dst_path].\n\nExamples\n\nf = h5open(\"f.h5\", \"r\")\ng = h5open(\"g.h5\", \"cw\")\ncopy_object(f, \"Group1\", g, \"GroupA\")\ncopy_object(f[\"Group1\"], \"data1\", g, \"DataSet/data_1\")\n\n\n\n\n\ncopy_object(src_obj::Object, dst_parent::Union{File,Group}, dst_path::AbstractString)\n\nExamples\n\ncopy_object(f[\"Group1\"], g, \"GroupA\")\ncopy_object(f[\"Group1/data1\"], g, \"DataSet/data_1\")\n\n\n\n\n\n","category":"function"},{"location":"interface/objects/#HDF5.delete_object","page":"Objects","title":"HDF5.delete_object","text":"delete_object(parent::Union{File,Group}, path::AbstractString)\n\nDelete the object at parent[path].\n\nExamples\n\nf = h5open(\"f.h5\", \"r+\")\ndelete_object(f, \"Group1\")\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Dataset","page":"Dataset","title":"Dataset","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"Many dataset operations are available through the indexing interface, which is aliased to the functional interface. Below describes the functional interface.","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"Dataset\ncreate_dataset\nBase.copyto!\nBase.similar\ncreate_external_dataset\nget_datasets\nopen_dataset\nwrite_dataset\nread_dataset","category":"page"},{"location":"interface/dataset/#HDF5.Dataset","page":"Dataset","title":"HDF5.Dataset","text":"HDF5.Dataset\n\nA mutable wrapper for a HDF5 Dataset HDF5.API.hid_t.\n\n\n\n\n\n","category":"type"},{"location":"interface/dataset/#HDF5.create_dataset","page":"Dataset","title":"HDF5.create_dataset","text":"create_dataset(parent, path, datatype, dataspace; properties...)\n\nArguments\n\nparent - File or Group\npath - String describing the path of the dataset within the HDF5 file or nothing to create an anonymous dataset\ndatatype - Datatype or Type or the dataset\ndataspace - Dataspace or Dims of the dataset\nproperties - keyword name-value pairs set properties of the dataset\n\nKeywords\n\nThere are many keyword properties that can be set. Below are a few select keywords.\n\nchunk - Dims describing the size of a chunk. Needed to apply filters.\nfilters - AbstractVector{<: Filters.Filter} describing the order of the filters to apply to the data. See Filters\nexternal - Tuple{AbstractString, Intger, Integer} (filepath, offset, filesize) External dataset file location, data offset, and file size. See API.h5p_set_external.\n\nAdditionally, the initial create, transfer, and access properties can be provided as a keyword:\n\ndcpl - DatasetCreateProperties\ndxpl - DatasetTransferProperties\ndapl - DatasetAccessProperties\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Base.copyto!","page":"Dataset","title":"Base.copyto!","text":"copyto!(output_buffer::AbstractArray{T}, obj::Union{DatasetOrAttribute}) where T\n\nCopy [part of] a HDF5 dataset or attribute to a preallocated output buffer. The output buffer must be convertible to a pointer and have a contiguous layout.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Base.similar","page":"Dataset","title":"Base.similar","text":"similar(obj::DatasetOrAttribute, [::Type{T}], [dims::Integer...]; normalize = true)\n\nReturn a Array{T} or Matrix{UInt8} to that can contain [part of] the dataset.\n\nThe normalize keyword will normalize the buffer for string and array datatypes.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.create_external_dataset","page":"Dataset","title":"HDF5.create_external_dataset","text":"create_external_dataset(parent, name, filepath, dtype, dspace, offset = 0)\n\nCreate an external dataset with data in an external file.\n\nparent - File or Group\nname - Name of the Dataset\nfilepath - File path to where the data is tored\ndtype - Datatype, Type, or value where datatype is applicable\noffset - Offset, in bytes, from the beginning of the file to the location in the file where the data starts.\n\nSee also API.h5p_set_external to link to multiple segments.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_datasets","page":"Dataset","title":"HDF5.get_datasets","text":"get_datasets(file::HDF5.File) -> datasets::Vector{HDF5.Dataset}\n\nGet all the datasets in an hdf5 file without loading the data.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.open_dataset","page":"Dataset","title":"HDF5.open_dataset","text":"open_dataset(parent::Union{File, Group}, path::AbstractString; properties...)\n\nOpen an existing HDF5.Dataset at path under parent\n\nOptional keyword arguments include any keywords that that belong to DatasetAccessProperties or DatasetTransferProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.write_dataset","page":"Dataset","title":"HDF5.write_dataset","text":"write_dataset(parent::Union{File,Group}, name::Union{AbstractString,Nothing}, data; pv...)\n\nCreate and write a dataset with data. Keywords are forwarded to create_dataset. Providing nothing as the name will create an anonymous dataset.\n\nSee also create_dataset\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.read_dataset","page":"Dataset","title":"HDF5.read_dataset","text":"read_dataset(parent::Union{File,Group}, name::AbstractString)\n\nRead a dataset with named name from parent. This will typically return an array. The dataset will be opened, read, and closed.\n\nSee also HDF5.open_dataset, Base.read\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Chunks","page":"Dataset","title":"Chunks","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"do_read_chunk\ndo_write_chunk\nget_chunk_index\nget_chunk_info_all\nget_chunk_length\nget_chunk_offset\nget_num_chunks\nget_num_chunks_per_dim\nread_chunk\nwrite_chunk","category":"page"},{"location":"interface/dataset/#HDF5.do_read_chunk","page":"Dataset","title":"HDF5.do_read_chunk","text":"do_read_chunk(dataset::Dataset, offset)\n\nRead a raw chunk at a given offset. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.\n\n\n\n\n\ndo_read_chunk(dataset::Dataset, index::Integer)\n\nRead a raw chunk at a given index. index is 1-based and consecutive up to the number of chunks.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.do_write_chunk","page":"Dataset","title":"HDF5.do_write_chunk","text":"do_write_chunk(dataset::Dataset, offset, chunk_bytes::AbstractArray, filter_mask=0)\n\nWrite a raw chunk at a given offset. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.\n\n\n\n\n\ndo_write_chunk(dataset::Dataset, index, chunk_bytes::AbstractArray, filter_mask=0)\n\nWrite a raw chunk at a given linear index. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. index is 1-based and consecutive up to the number of chunks.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_index","page":"Dataset","title":"HDF5.get_chunk_index","text":"HDF5.get_chunk_index(dataset_id, offset)\n\nGet 0-based index of chunk from 0-based offset returned in Julia's column-major order. For a 1-based API, see HDF5.ChunkStorage.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_info_all","page":"Dataset","title":"HDF5.get_chunk_info_all","text":"HDF5.get_chunk_info_all(dataset, [dxpl])\n\nObtain information on all the chunks in a dataset. Returns a Vector{ChunkInfo{N}}. The fields of ChunkInfo{N} are\n\noffset - NTuple{N, Int} indicating the offset of the chunk in terms of elements, reversed to F-order\nfilter_mask - Cuint, 32-bit flags indicating whether filters have been applied to the cunk\naddr - haddr_t, byte-offset of the chunk in the file\nsize - hsize_t, size of the chunk in bytes\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_length","page":"Dataset","title":"HDF5.get_chunk_length","text":"HDF5.get_chunk_length(dataset_id)\n\nRetrieves the chunk size in bytes. Equivalent to API.h5d_get_chunk_info(dataset_id, index)[:size].\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_offset","page":"Dataset","title":"HDF5.get_chunk_offset","text":"HDF5.get_chunk_offset(dataset_id, index)\n\nGet 0-based offset of chunk from 0-based index. The offsets are returned in Julia's column-major order rather than hdf5 row-major order. For a 1-based API, see HDF5.ChunkStorage.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_num_chunks","page":"Dataset","title":"HDF5.get_num_chunks","text":"HDF5.get_num_chunks(dataset_id)\n\nReturns the number of chunks in a dataset. Equivalent to API.h5d_get_num_chunks(dataset_id, HDF5.H5S_ALL).\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_num_chunks_per_dim","page":"Dataset","title":"HDF5.get_num_chunks_per_dim","text":"HDF5.get_num_chunks_per_dim(dataset_id)\n\nGet the number of chunks in each dimension in Julia's column-major order.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.read_chunk","page":"Dataset","title":"HDF5.read_chunk","text":"HDF5.read_chunk(dataset_id, offset, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())\n\nHelper method to read chunks via 0-based offsets in a Tuple.\n\nArgument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.get_chunk_length. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.\n\nThis method returns Vector{UInt8}.\n\n\n\n\n\nHDF5.read_chunk(dataset_id, index::Integer, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())\n\nHelper method to read chunks via 0-based integer index.\n\nArgument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.API.h5d_get_chunk_info. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.\n\nThis method returns Vector{UInt8}.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.write_chunk","page":"Dataset","title":"HDF5.write_chunk","text":"HDF5.write_chunk(dataset_id, offset, buf::AbstractArray; dxpl_id = HDF5.API.H5P_DEFAULT, filter_mask = 0)\n\nHelper method to write chunks via 0-based offsets offset as a Tuple.\n\n\n\n\n\nHDF5.write_chunk(dataset_id, index::Integer, buf::AbstractArray; dxpl_id = API.H5P_DEFAULT, filter_mask = 0)\n\nHelper method to write chunks via 0-based integer index.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Private-Implementation","page":"Dataset","title":"Private Implementation","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"These functions select private implementations of the public high-level API. They should be used for diagnostic purposes only.","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"_get_chunk_info_all_by_index\n_get_chunk_info_all_by_iter","category":"page"},{"location":"interface/dataset/#HDF5._get_chunk_info_all_by_index","page":"Dataset","title":"HDF5._get_chunk_info_all_by_index","text":"_get_chunk_info_all_by_index(dataset, [dxpl])\n\nImplementation of get_chunk_info_all via HDF5.API.h5d_get_chunk_info.\n\nWe expect this will be slower, O(N^2), than using h5d_chunk_iter since each call to h5d_get_chunk_info iterates through the B-tree structure.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5._get_chunk_info_all_by_iter","page":"Dataset","title":"HDF5._get_chunk_info_all_by_iter","text":"_get_chunk_info_all_by_iter(dataset, [dxpl])\n\nImplementation of get_chunk_info_all via HDF5.API.h5d_chunk_iter.\n\nWe expect this will be faster, O(N), than using h5d_get_chunk_info since this allows us to iterate through the chunks once.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Files","page":"Files","title":"Files","text":"","category":"section"},{"location":"interface/files/","page":"Files","title":"Files","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/files/","page":"Files","title":"Files","text":"h5open\nishdf5\nBase.isopen\nBase.read\nstart_swmr_write","category":"page"},{"location":"interface/files/#HDF5.h5open","page":"Files","title":"HDF5.h5open","text":"h5open(filename::AbstractString, mode::AbstractString=\"r\"; swmr=false, pv...)\n\nOpen or create an HDF5 file where mode is one of:\n\n\"r\" read only\n\"r+\" read and write\n\"cw\" read and write, create file if not existing, do not truncate\n\"w\" read and write, create a new file (destroys any existing contents)\n\nPass swmr=true to enable (Single Writer Multiple Reader) SWMR write access for \"w\" and \"r+\", or SWMR read access for \"r\".\n\nProperties can be specified as keywords for FileAccessProperties and FileCreateProperties.\n\nAlso the keywords fapl and fcpl can be used to provide default instances of these property lists. Property lists passed in via keyword will be closed. This is useful to set properties not currently defined by HDF5.jl.\n\nNote that h5open uses fclose_degree = :strong by default, but this can be overriden by the fapl keyword.\n\n\n\n\n\nfunction h5open(f::Function, args...; pv...)\n\nApply the function f to the result of h5open(args...; kwargs...) and close the resulting HDF5.File upon completion. For example with a do block:\n\nh5open(\"foo.h5\",\"w\") do h5\n h5[\"foo\"]=[1,2,3]\nend\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#HDF5.ishdf5","page":"Files","title":"HDF5.ishdf5","text":"ishdf5(name::AbstractString)\n\nReturns true if the file specified by name is in the HDF5 format, and false otherwise.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Base.isopen","page":"Files","title":"Base.isopen","text":"isopen(obj::HDF5.File)\n\nReturns true if obj has not been closed, false if it has been closed.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Base.read","page":"Files","title":"Base.read","text":"read(parent::H5DataStore)\nread(parent::H5DataStore, names...)\n\nRead a list of variables, read(parent, \"A\", \"B\", \"x\", ...). If no variables are specified, read every variable in the file.\n\n\n\n\n\nread(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString; pv...)\nread(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString => dt::HDF5.Datatype; pv...)\n\nRead a dataset or attribute from a HDF5 file of group identified by name. Optionally, specify the HDF5.Datatype to be read.\n\n\n\n\n\nread(obj::HDF5.DatasetOrAttribute}\n\nRead the data within a HDF5.Dataset or HDF5.Attribute.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#HDF5.start_swmr_write","page":"Files","title":"HDF5.start_swmr_write","text":"start_swmr_write(h5::HDF5.File)\n\nStart Single Reader Multiple Writer (SWMR) writing mode.\n\nExternal links\n\nSingle Writer Multiple Reader from the HDF5 manual.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Attributes","page":"Attributes","title":"Attributes","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/attributes/#Dictionary-interface","page":"Attributes","title":"Dictionary interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"attrs\nattributes","category":"page"},{"location":"interface/attributes/#HDF5.attrs","page":"Attributes","title":"HDF5.attrs","text":"attrs(object::Union{File,Group,Dataset,Datatype})\n\nThe attributes dictionary of object. Returns an AttributeDict, a Dict-like object for accessing the attributes of object.\n\nattrs(object)[\"name\"] = value # create/overwrite an attribute\nattr = attrs(object)[\"name\"] # read an attribute\ndelete!(attrs(object), \"name\") # delete an attribute\nkeys(attrs(object)) # list the attribute names\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.attributes","page":"Attributes","title":"HDF5.attributes","text":"attributes(object::Union{File,Object})\n\nThe attributes of a file or object: this returns an Attributes object, which is Dict-like object for accessing the attributes of object: getindex will return an Attribute object, and setindex! will call write_attribute.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Mid-level-Interface","page":"Attributes","title":"Mid-level Interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"Attribute\nopen_attribute\ncreate_attribute\nread_attribute\nwrite_attribute\ndelete_attribute\nrename_attribute","category":"page"},{"location":"interface/attributes/#HDF5.Attribute","page":"Attributes","title":"HDF5.Attribute","text":"HDF5.Attribute\n\nA HDF5 attribute: this is a piece of metadata attached to an HDF5 Group or Dataset. It acts like a Dataset, in that it has a defined datatype and dataspace, and can read and write data to it.\n\nSee also\n\nopen_attribute\ncreate_attribute\nread_attribute\nwrite_attribute\ndelete_attribute\n\n\n\n\n\n","category":"type"},{"location":"interface/attributes/#HDF5.open_attribute","page":"Attributes","title":"HDF5.open_attribute","text":"open_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)\n\nOpen the Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.create_attribute","page":"Attributes","title":"HDF5.create_attribute","text":"create_attribute(parent::Union{File,Object}, name::AbstractString, dtype::Datatype, space::Dataspace)\ncreate_attribute(parent::Union{File,Object}, name::AbstractString, data)\n\nCreate a new Attribute object named name on the object parent, either by specifying the Datatype and Dataspace of the attribute, or by providing the data. Note that no data will be written: use write_attribute to write the data.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.read_attribute","page":"Attributes","title":"HDF5.read_attribute","text":"read_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)\n\nRead the value of the named attribute on the parent object.\n\nExample\n\njulia> HDF5.read_attribute(g, \"time\")\n2.45\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.write_attribute","page":"Attributes","title":"HDF5.write_attribute","text":"write_attribute(parent::Union{File,Object}, name::AbstractString, data)\n\nWrite data as an Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.delete_attribute","page":"Attributes","title":"HDF5.delete_attribute","text":"delete_attribute(parent::Union{File,Object}, name::AbstractString)\n\nDelete the Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.rename_attribute","page":"Attributes","title":"HDF5.rename_attribute","text":"rename_attribute(parent::Union{File,Object}, oldname::AbstractString, newname::AbstractString)\n\nRename the Attribute of the object parent named oldname to newname.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Convenience-interface","page":"Attributes","title":"Convenience interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"h5readattr\nh5writeattr\nnum_attrs","category":"page"},{"location":"interface/attributes/#HDF5.h5readattr","page":"Attributes","title":"HDF5.h5readattr","text":"h5readattr(filename, name::AbstractString, data::Dict)\n\nRead the attributes of the object at name in the HDF5 file filename, returning a Dict.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.h5writeattr","page":"Attributes","title":"HDF5.h5writeattr","text":"h5writeattr(filename, name::AbstractString, data::Dict)\n\nWrite data as attributes to the object at name in the HDF5 file filename.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.num_attrs","page":"Attributes","title":"HDF5.num_attrs","text":"num_attrs()\n\nRetrieve the number of attributes from an object.\n\nSee API.h5o_get_info.\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Properties","page":"Properties","title":"Properties","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"HDF5 property lists are collections of name-value pairs which can be passed to other HDF5 functions to control features that are typically unimportant or whose default values are usually used. In HDF5.jl, these options are typically handled by keyword arguments to such functions, which will internally create the appropriate Properties objects, and so users will not usually be required to construct them manually.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"Not all properties defined by the HDF5 library are currently available in HDF5.jl. If you require additional properties, please open an issue or pull request.","category":"page"},{"location":"interface/properties/#Common-functions","page":"Properties","title":"Common functions","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"setproperties!","category":"page"},{"location":"interface/properties/#HDF5.setproperties!","page":"Properties","title":"HDF5.setproperties!","text":"setproperties!(props::Properties...; kwargs...)\n\nFor each (key, value) pair in kwargs, set the corresponding properties in each Properties object in props. Returns a Dict of any pairs which didn't match properties in props.\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Properties-types","page":"Properties","title":"Properties types","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"AttributeCreateProperties\nFileAccessProperties\nFileCreateProperties\nGroupAccessProperties\nGroupCreateProperties\nDatasetCreateProperties\nDatasetAccessProperties\nDatatypeAccessProperties\nDatasetTransferProperties\nLinkCreateProperties\nObjectCreateProperties\nStringCreateProperties\nDatatypeCreateProperties","category":"page"},{"location":"interface/properties/#HDF5.AttributeCreateProperties","page":"Properties","title":"HDF5.AttributeCreateProperties","text":"AttributeCreateProperties(;kws...)\nAttributeCreateProperties(f::Function; kws...)\n\nProperties used when creating attributes.\n\nchar_encoding: the character enconding, either :ascii or :utf8.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.FileAccessProperties","page":"Properties","title":"HDF5.FileAccessProperties","text":"FileAccessProperties(;kws...)\nFileAccessProperties(f::Function; kws...)\n\nProperties used when accessing files.\n\nalignment :: Tuple{Integer, Integer}: a (threshold, alignment) pair: any file object greater than or equal in size to threshold bytes will be aligned on an address which is a multiple of alignment. Default values are 1, implying no alignment.\ndriver: the file driver used to access the file. See Drivers.\ndriver_info (get only)\nfclose_degree: file close degree property. One of:\n:weak\n:semi\n:strong\n:default\nlibver_bounds: a (low, high) pair: low sets the earliest possible format versions that the library will use when creating objects in the file; high sets the latest format versions that the library will be allowed to use when creating objects in the file. Values can be a VersionNumber for the hdf5 library, :earliest, or :latest . See H5P_SET_LIBVER_BOUNDS\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.FileCreateProperties","page":"Properties","title":"HDF5.FileCreateProperties","text":"FileCreateProperties(;kws...)\nFileCreateProperties(f::Function; kws...)\n\nProperties used when creating a new File. Inherits from ObjectCreateProperties, with additional properties:\n\nuserblock :: Integer: user block size in bytes. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). See H5P_SET_USERBLOCK.\ntrack_order :: Bool: tracks the file creation order.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.GroupAccessProperties","page":"Properties","title":"HDF5.GroupAccessProperties","text":"GroupAccessProperties(;kws...)\n\nProperties used when accessing datatypes. None are currently defined.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.GroupCreateProperties","page":"Properties","title":"HDF5.GroupCreateProperties","text":"GroupCreateProperties(;kws...)\nGroupCreateProperties(f::Function; kws...)\n\nProperties used when creating a new Group. Inherits from ObjectCreateProperties, with additional options:\n\nlocal_heap_size_hint :: Integer: the anticipated maximum local heap size in bytes. See H5P_SET_LOCAL_HEAP_SIZE_HINT.\ntrack_order :: Bool: tracks the group creation order.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetCreateProperties","page":"Properties","title":"HDF5.DatasetCreateProperties","text":"DatasetCreateProperties(;kws...)\nDatasetCreateProperties(f::Function; kws...)\n\nProperties used when creating a new Dataset. Inherits from ObjectCreateProperties, with additional properties:\n\nalloc_time: the timing for the allocation of storage space for a dataset's raw data; one of:\n:default\n:early: allocate all space when the dataset is created\n:incremental: Allocate space incrementally, as data is written to the dataset\n:late: Allocate all space when data is first written to the dataset.\nSee H5P_SET_ALLOC_TIME.\nfill_time: the timing of when the dataset should be filled; one of:\n:alloc: Fill when allocated\n:never: Never fill\n:ifset: Fill if a value is set\nfill_value: the fill value for a dataset. See H5P_SET_FILL_VALUE.\nchunk: a tuple containing the size of the chunks to store each dimension. See H5P_SET_CHUNK (note that this uses Julia's column-major ordering).\nexternal: A tuple of (name,offset,size), See H5P_SET_EXTERNAL.\nfilters (only valid when layout=:chunked): a filter or vector of filters that are applied to applied to each chunk of a dataset, see Filters. When accessed, will return a Filters.FilterPipeline object that can be modified in-place.\nlayout: the type of storage used to store the raw data for a dataset. Can be one of:\n:compact: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data.\n:contiguous: Store raw data separately from the object header in one large chunk in the file.\n:chunked: Store raw data separately from the object header as chunks of data in separate locations in the file.\n:virtual: Draw raw data from multiple datasets in different files. See the virtual property below.\nSee H5P_SET_LAYOUT.\nno_attrs_hint: Minimize the space for dataset metadata by hinting that no attributes will be added if set to true. Attributes can still be added but may exist elsewhere within the file. See H5P_SET_DSET_NO_ATTRS_HINT.\nvirtual: when specified, creates a virtual dataset (VDS). The argument should be a \"virtuala collection of VirtualMapping objects for describing the mapping from the dataset to the source datasets. When accessed, returns a VirtualLayout object.\n\nThe following options are shortcuts for the various filters, and are set-only. They will be appended to the filter pipeline in the order in which they appear\n\nblosc = true | level: set the H5Zblosc.BloscFilter compression filter; argument can be either true, or the compression level.\ndeflate = true | level: set the Filters.Deflate compression filter; argument can be either true, or the compression level.\nfletcher32 = true: set the Filters.Fletcher32 checksum filter.\nshuffle = true: set the Filters.Shuffle filter.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetAccessProperties","page":"Properties","title":"HDF5.DatasetAccessProperties","text":"DatasetAccessProperties(;kws...)\nDatasetAccessProperties(f::Function; kws...)\n\nProperties that control access to data in external, virtual, and chunked datasets.\n\nchunk_cache: Chunk cache parameters as (nslots, nbytes, w0). Default: (521, 0x100000, 0.75)\nefile_prefix: Path prefix for reading external files. The default is the current working directory.\n:origin: alias for raw\"$ORIGIN\" will make the external file relative to the HDF5 file.\nvirtual_prefix: Path prefix for reading virtual datasets.\nvirtual_printf_gap: The maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset\nvirtual_view: Influences whether the view of the virtual dataset includes or excludes missing mapped elements\n:first_missing: includes all data before the first missing mapped data\n:last_available: includes all available mapped data\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\nSee Dataset Access Properties\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatatypeAccessProperties","page":"Properties","title":"HDF5.DatatypeAccessProperties","text":"DatatypeAccessProperties(;kws...)\n\nProperties used when accessing datatypes. None are currently defined.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetTransferProperties","page":"Properties","title":"HDF5.DatasetTransferProperties","text":"DatasetTransferProperties(;kws...)\nDatasetTransferProperties(f::Function; kws...)\n\nProperties used when transferring data to/from datasets\n\ndxpl_mpio: MPI transfer mode when using Drivers.MPIO file driver:\n:independent: use independent I/O access (default),\n:collective: use collective I/O access.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.LinkCreateProperties","page":"Properties","title":"HDF5.LinkCreateProperties","text":"LinkCreateProperties(;kws...)\nLinkCreateProperties(f::Function; kws...)\n\nProperties used when creating links.\n\nchar_encoding: the character enconding, either :ascii or :utf8.\ncreate_intermediate_group :: Bool: if true, will create missing intermediate groups.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.ObjectCreateProperties","page":"Properties","title":"HDF5.ObjectCreateProperties","text":"ObjectCreateProperties(;kws...)\nObjectCreateProperties(f::Function; kws...)\n\nProperties used when creating a new object. Available options:\n\nobj_track_times :: Bool: governs the recording of times associated with an object. If set to true, time data will be recorded. See H5P_SET_OBJ_TRACK_TIMES.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.StringCreateProperties","page":"Properties","title":"HDF5.StringCreateProperties","text":"StringCreateProperties(;kws...)\nStringCreateProperties(f::Function; kws...)\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatatypeCreateProperties","page":"Properties","title":"HDF5.DatatypeCreateProperties","text":"DatatypeCreateProperties(;kws...)\nDatatypeCreateProperties(f::Function; kws...)\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#Virtual-Datasets","page":"Properties","title":"Virtual Datasets","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"VirtualMapping\nVirtualLayout","category":"page"},{"location":"interface/properties/#HDF5.VirtualMapping","page":"Properties","title":"HDF5.VirtualMapping","text":"VirtualMapping(\n vspace::Dataspace,\n srcfile::AbstractString,\n srcdset::AbstractString,\n srcspace::Dataspace\n)\n\nSpecify a map of elements of the virtual dataset (VDS) described by vspace to the elements of the source dataset described by srcspace. The source dataset is identified by the name of the file where it is located, srcfile, and the name of the dataset, srcdset.\n\nBoth srcfile and srcdset support \"printf\"-style formats with %b being replaced by the block count of the selection.\n\nFor more details on how source file resolution works, see H5P_SET_VIRTUAL.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.VirtualLayout","page":"Properties","title":"HDF5.VirtualLayout","text":"VirtualLayout(dcpl::DatasetCreateProperties)\n\nThe collection of VirtualMappings associated with dcpl. This is an AbstractVector{VirtualMapping}, supporting length, getindex and push!.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#Drivers","page":"Properties","title":"Drivers","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"File drivers determine how the HDF5 is accessed. These can be set as the driver property in FileAccessProperties.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5.Drivers","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"Core\nPOSIX\nROS3\nMPIO","category":"page"},{"location":"interface/properties/#HDF5.Drivers.Core","page":"Properties","title":"HDF5.Drivers.Core","text":"Core([increment::Csize_t, backing_store::Cuint, [write_tracking::Cuint, page_size::Csize_t]])\nCore(; increment::Csize_t = 8192, backing_store::Cuint = true, write_tracking::Cuint = false, page_size::Csize_t = 524288)\n\nArguments\n\nincrement: specifies the increment by which allocated memory is to be increased each time more memory is required. (default: 8192)\nbacking_store: Boolean flag indicating whether to write the file contents to disk when the file is closed. (default: false)\nwrite_tracking: Boolean flag indicating whether write tracking is enabled. (default: false)\npage_size: Size, in bytes, of write aggregation pages. (default: 524288)\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.POSIX","page":"Properties","title":"HDF5.Drivers.POSIX","text":"POSIX()\n\nAlso referred to as SEC2, this driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.ROS3","page":"Properties","title":"HDF5.Drivers.ROS3","text":"ROS3()\nROS3(aws_region::String, secret_id::String, secret_key::String)\nROS3(version::Int32, authenticate::Bool, aws_region::String, secret_id::String, secret_key::String)\n\nThis is the read-only virtual driver that enables access to HDF5 objects stored in AWS S3\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.MPIO","page":"Properties","title":"HDF5.Drivers.MPIO","text":"MPIO(comm::MPI.Comm, info::MPI.Info)\nMPIO(comm::MPI.Comm; kwargs....)\n\nThe parallel MPI file driver. This requires the use of MPI.jl, and a custom HDF5 binary that has been built with MPI support.\n\ncomm is the communicator over which the file will be opened.\ninfo/kwargs are MPI-IO options, and are passed to MPI_FILE_OPEN.\n\nSee also\n\nHDF5.has_parallel\nParallel HDF5\n\nExternal links\n\nH5P_SET_FAPL_MPIO\nParallel HDF5\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Internals","page":"Properties","title":"Internals","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"The following macros are used for defining new properties and property getters/setters.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"@propertyclass\n@bool_property\n@enum_property\n@tuple_property","category":"page"},{"location":"interface/properties/#HDF5.@propertyclass","page":"Properties","title":"HDF5.@propertyclass","text":"@propertyclass P classid\n\nDefine a new subtype of P <: Properties corresponding to a HDF5 property list with class identifier classid.\n\nOnce defined, the following interfaces can be defined:\n\nsuperclass(::Type{P})\n\nThis should return the type from which P inherits. If not defined, it will inherit from GenericProperties.\n\nclass_propertynames(::Type{P})\n\nThis should return a Tuple of Symbols, being the names of the properties associated with P.\n\nclass_getproperty(::Type{P}, p::Properties, name::Symbol)\n\nIf name is an associated property of type P, this should return the value of the property, otherwise call class_getproperty(superclass(P), p, name).\n\nclass_setproperty!(::Type{P}, p::Properties, name::Symbol, val)\n\nIf name is an associated property of type P, this should set the value of the property, otherwise call class_setproperty!(superclass(P), p, name, val).\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@bool_property","page":"Properties","title":"HDF5.@bool_property","text":"@bool_property(name)\n\nWrap property getter/setter API functions that use 0/1 to use Bool values\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@enum_property","page":"Properties","title":"HDF5.@enum_property","text":"@enum_property(name, sym1 => enumvalue1, sym2 => enumvalue2, ...)\n\nWrap property getter/setter API functions that use enum values to use symbol instead.\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@tuple_property","page":"Properties","title":"HDF5.@tuple_property","text":"@tuple_property(name)\n\n\n\n\n\n","category":"macro"},{"location":"interface/datatype/#Datatypes","page":"Datatypes","title":"Datatypes","text":"","category":"section"},{"location":"interface/datatype/","page":"Datatypes","title":"Datatypes","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/datatype/","page":"Datatypes","title":"Datatypes","text":"Datatype\nopen_datatype","category":"page"},{"location":"interface/datatype/#HDF5.Datatype","page":"Datatypes","title":"HDF5.Datatype","text":"HDF5.Datatype(id, toclose = true)\n\nWrapper for a HDF5 datatype id. If toclose is true, the finalizer will close the datatype.\n\n\n\n\n\n","category":"type"},{"location":"interface/datatype/#HDF5.open_datatype","page":"Datatypes","title":"HDF5.open_datatype","text":"open_datatype(parent::Union{File,Group}, path::AbstractString; properties...)\n\nOpen an existing Datatype at path under the parent object.\n\nOptional keyword arguments include any keywords that that belong to DatatypeAccessProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#Configuration","page":"Configuration","title":"Configuration","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"has_parallel\nhas_ros3","category":"page"},{"location":"interface/configuration/#HDF5.has_parallel","page":"Configuration","title":"HDF5.has_parallel","text":"has_parallel()\n\nReturns true if the HDF5 libraries were compiled with MPI parallel support via the Drivers.MPIO driver.\n\nSee Parallel HDF5 for more details.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#HDF5.has_ros3","page":"Configuration","title":"HDF5.has_ros3","text":"has_ros3()\n\nReturns true if the HDF5 libraries were compiled with ros3 support\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#Display","page":"Configuration","title":"Display","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"SHOW_TREE_ICONS\nSHOW_TREE_MAX_CHILDREN\nSHOW_TREE_MAX_DEPTH","category":"page"},{"location":"interface/configuration/#HDF5.SHOW_TREE_ICONS","page":"Configuration","title":"HDF5.SHOW_TREE_ICONS","text":"SHOW_TREE_ICONS = Ref{Bool}(true)\n\nConfigurable option to control whether emoji icons (true) or a plain-text annotation (false) is used to indicate the object type by show_tree.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.SHOW_TREE_MAX_CHILDREN","page":"Configuration","title":"HDF5.SHOW_TREE_MAX_CHILDREN","text":"SHOW_TREE_MAX_CHILDREN = Ref{Int}(50)\n\nMaximum number of children to show at each node.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.SHOW_TREE_MAX_DEPTH","page":"Configuration","title":"HDF5.SHOW_TREE_MAX_DEPTH","text":"SHOW_TREE_MAX_DEPTH = Ref{Int}(5)\n\nMaximum recursive depth to descend during printing.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#Internals","page":"Configuration","title":"Internals","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"get_context_property\nCONTEXT\nHDF5Context","category":"page"},{"location":"interface/configuration/#HDF5.get_context_property","page":"Configuration","title":"HDF5.get_context_property","text":"get_context_property(name::Symbol)\n\nInternal API\n\nRetrieve a property list from the task local context, defaulting to HDF5.CONTEXT if task_local_storage()[:hdf5_context] does not exist.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#HDF5.CONTEXT","page":"Configuration","title":"HDF5.CONTEXT","text":"HDF5.CONTEXT\n\nInternal API\n\nDefault HDF5Context.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.HDF5Context","page":"Configuration","title":"HDF5.HDF5Context","text":"HDF5Context\n\nInternal API\n\nAn HDF5Context is a collection of HDF5 property lists. It is meant to be used as a Task local mechanism to store state and change the default property lists for new objects.\n\nUse the function get_context_property(name::Symbol) to access a property list within the local context.\n\nThe context in task_local_storage()[:hdf5_context] will be checked first. A common global HDF5Context is stored in the constant HDF5.CONTEXT and serves as the default context if the current task does not have a :hdf5_context.\n\nFields\n\nattribute_access\nattribute_create\ndataset_access\ndataset_create\ndataset_tranfer\ndatatype_access\ndatatype_create\nfile_access\nfile_create\nfile_mount\ngroup_access\ngroup_create\nlink_access\nlink_create\nobject_copy\nobject_create\nstring_create\n\n\n\n\n\n","category":"type"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"CurrentModule = HDF5.API","category":"page"},{"location":"api_bindings/#Low-level-library-bindings","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"At the lowest level, HDF5.jl operates by calling the public API of the HDF5 shared library through a set of ccall wrapper functions. This page documents the function names and nominal C argument types of the API which have bindings in this package. Note that in many cases, high-level data types are valid arguments through automatic ccall conversions. For instance, HDF5.Datatype objects will be automatically converted to their hid_t ID by Julia's cconvert+unsafe_convert ccall rules.","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"There are additional helper wrappers (often for out-argument functions) which are not documented here.","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5","page":"Low-level library bindings","title":"H5 — General Library Functions","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5_close\nh5_dont_atexit\nh5_free_memory\nh5_garbage_collect\nh5_get_libversion\nh5_is_library_threadsafe\nh5_open\nh5_set_free_list_limits","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5_close\nh5_dont_atexit\nh5_free_memory\nh5_garbage_collect\nh5_get_libversion\nh5_is_library_threadsafe\nh5_open\nh5_set_free_list_limits","category":"page"},{"location":"api_bindings/#HDF5.API.h5_close","page":"Low-level library bindings","title":"HDF5.API.h5_close","text":"h5_close()\n\nSee libhdf5 documentation for H5close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_dont_atexit","page":"Low-level library bindings","title":"HDF5.API.h5_dont_atexit","text":"h5_dont_atexit()\n\nSee libhdf5 documentation for H5dont_atexit.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_free_memory","page":"Low-level library bindings","title":"HDF5.API.h5_free_memory","text":"h5_free_memory(buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5free_memory.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_garbage_collect","page":"Low-level library bindings","title":"HDF5.API.h5_garbage_collect","text":"h5_garbage_collect()\n\nSee libhdf5 documentation for H5garbage_collect.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_get_libversion","page":"Low-level library bindings","title":"HDF5.API.h5_get_libversion","text":"h5_get_libversion(majnum::Ref{Cuint}, minnum::Ref{Cuint}, relnum::Ref{Cuint})\n\nSee libhdf5 documentation for H5get_libversion.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_is_library_threadsafe","page":"Low-level library bindings","title":"HDF5.API.h5_is_library_threadsafe","text":"h5_is_library_threadsafe(is_ts::Ref{Cuint})\n\nSee libhdf5 documentation for H5is_library_threadsafe.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_open","page":"Low-level library bindings","title":"HDF5.API.h5_open","text":"h5_open()\n\nSee libhdf5 documentation for H5open.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_set_free_list_limits","page":"Low-level library bindings","title":"HDF5.API.h5_set_free_list_limits","text":"h5_set_free_list_limits(reg_global_lim::Cint, reg_list_lim::Cint, arr_global_lim::Cint, arr_list_lim::Cint, blk_global_lim::Cint, blk_list_lim::Cint)\n\nSee libhdf5 documentation for H5set_free_list_limits.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5A","page":"Low-level library bindings","title":"H5A — Attribute Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5a_close\nh5a_create\nh5a_create_by_name\nh5a_delete\nh5a_delete_by_idx\nh5a_delete_by_name\nh5a_exists\nh5a_exists_by_name\nh5a_get_create_plist\nh5a_get_name\nh5a_get_name_by_idx\nh5a_get_space\nh5a_get_type\nh5a_iterate\nh5a_open\nh5a_open_by_idx\nh5a_read\nh5a_rename\nh5a_write","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5a_close\nh5a_create\nh5a_create_by_name\nh5a_delete\nh5a_delete_by_idx\nh5a_delete_by_name\nh5a_exists\nh5a_exists_by_name\nh5a_get_create_plist\nh5a_get_name\nh5a_get_name_by_idx\nh5a_get_space\nh5a_get_type\nh5a_iterate\nh5a_open\nh5a_open_by_idx\nh5a_read\nh5a_rename\nh5a_write","category":"page"},{"location":"api_bindings/#HDF5.API.h5a_close","page":"Low-level library bindings","title":"HDF5.API.h5a_close","text":"h5a_close(id::hid_t)\n\nSee libhdf5 documentation for H5Aclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_create","page":"Low-level library bindings","title":"HDF5.API.h5a_create","text":"h5a_create(loc_id::hid_t, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Acreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_create_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_create_by_name","text":"h5a_create_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Acreate_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete","page":"Low-level library bindings","title":"HDF5.API.h5a_delete","text":"h5a_delete(loc_id::hid_t, attr_name::Cstring)\n\nSee libhdf5 documentation for H5Adelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_delete_by_idx","text":"h5a_delete_by_idx(loc_id::hid_t, obj_name::Cstring, idx_type::Cint, order::Cint, n::hsize_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Adelete_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_delete_by_name","text":"h5a_delete_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Adelete_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_exists","page":"Low-level library bindings","title":"HDF5.API.h5a_exists","text":"h5a_exists(obj_id::hid_t, attr_name::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Aexists.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_exists_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_exists_by_name","text":"h5a_exists_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Aexists_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5a_get_create_plist","text":"h5a_get_create_plist(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_name","page":"Low-level library bindings","title":"HDF5.API.h5a_get_name","text":"h5a_get_name(attr_id::hid_t, buf_size::Csize_t, buf::Ptr{UInt8}) -> Cssize_t\n\nSee libhdf5 documentation for H5Aget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_name_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_get_name_by_idx","text":"h5a_get_name_by_idx(loc_id::hid_t, obj_name::Cstring, index_type::Cint, order::Cint, idx::hsize_t, name::Ptr{UInt8}, size::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Aget_name_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_space","page":"Low-level library bindings","title":"HDF5.API.h5a_get_space","text":"h5a_get_space(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_type","page":"Low-level library bindings","title":"HDF5.API.h5a_get_type","text":"h5a_get_type(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_iterate","page":"Low-level library bindings","title":"HDF5.API.h5a_iterate","text":"h5a_iterate(obj_id::hid_t, idx_type::Cint, order::Cint, n::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Aiterate2.\n\n\n\n\n\nh5a_iterate(f, loc_id, idx_type, order, idx = 0) -> hsize_t\n\nExecutes h5a_iterate with the user-provided callback function f, returning the index where iteration ends.\n\nThe callback function must correspond to the signature\n\nf(loc::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5A_info_t}) -> Union{Bool, Integer}\n\nwhere a negative return value halts iteration abnormally (triggering an error), a true or a positive value halts iteration successfully, and false or zero continues iteration.\n\nExamples\n\njulia> HDF5.API.h5a_iterate(obj, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do loc, name, info\n println(unsafe_string(name))\n return false\n end\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_open","page":"Low-level library bindings","title":"HDF5.API.h5a_open","text":"h5a_open(obj_id::hid_t, attr_name::Cstring, aapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_open_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_open_by_idx","text":"h5a_open_by_idx(obj_id::hid_t, pathname::Cstring, idx_type::Cint, order::Cint, n::hsize_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aopen_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_read","page":"Low-level library bindings","title":"HDF5.API.h5a_read","text":"h5a_read(attr_id::hid_t, mem_type_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Aread.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_rename","page":"Low-level library bindings","title":"HDF5.API.h5a_rename","text":"h5a_rename(loc_id::hid_t, old_attr_name::Cstring, new_attr_name::Cstring)\n\nSee libhdf5 documentation for H5Arename.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_write","page":"Low-level library bindings","title":"HDF5.API.h5a_write","text":"h5a_write(attr_hid::hid_t, mem_type_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Awrite.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5D","page":"Low-level library bindings","title":"H5D — Dataset Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5d_chunk_iter\nh5d_close\nh5d_create\nh5d_create_anon\nh5d_extend\nh5d_fill\nh5d_flush\nh5d_gather\nh5d_get_access_plist\nh5d_get_chunk_info\nh5d_get_chunk_info_by_coord\nh5d_get_chunk_storage_size\nh5d_get_create_plist\nh5d_get_num_chunks\nh5d_get_offset\nh5d_get_space\nh5d_get_space_status\nh5d_get_storage_size\nh5d_get_type\nh5d_iterate\nh5d_open\nh5d_read\nh5d_read_chunk\nh5d_refresh\nh5d_scatter\nh5d_set_extent\nh5d_vlen_get_buf_size\nh5d_vlen_reclaim\nh5d_write\nh5d_write_chunk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5d_chunk_iter\nh5d_close\nh5d_create\nh5d_create_anon\nh5d_extend\nh5d_fill\nh5d_flush\nh5d_gather\nh5d_get_access_plist\nh5d_get_chunk_info\nh5d_get_chunk_info_by_coord\nh5d_get_chunk_storage_size\nh5d_get_create_plist\nh5d_get_num_chunks\nh5d_get_offset\nh5d_get_space\nh5d_get_space_status\nh5d_get_storage_size\nh5d_get_type\nh5d_iterate\nh5d_open\nh5d_read\nh5d_read_chunk\nh5d_refresh\nh5d_scatter\nh5d_set_extent\nh5d_vlen_get_buf_size\nh5d_vlen_reclaim\nh5d_write\nh5d_write_chunk","category":"page"},{"location":"api_bindings/#HDF5.API.h5d_chunk_iter","page":"Low-level library bindings","title":"HDF5.API.h5d_chunk_iter","text":"h5d_chunk_iter(dset_id::hid_t, dxpl_id::hid_t, cb::Ptr{Nothing}, op_data::Any)\n\nSee libhdf5 documentation for H5Dchunk_iter.\n\n\n\n\n\nh5d_chunk_iter(f, dataset, [dxpl_id=H5P_DEFAULT])\n\nCall f(offset::Ptr{hsize_t}, filter_mask::Cuint, addr::haddr_t, size::hsize_t) for each chunk. dataset maybe a HDF5.Dataset or a dataset id. dxpl_id is the the dataset transfer property list and is optional.\n\nAvailable only for HDF5 1.10.x series for 1.10.9 and greater or for version HDF5 1.12.3 or greater.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_close","page":"Low-level library bindings","title":"HDF5.API.h5d_close","text":"h5d_close(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Dclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_create","page":"Low-level library bindings","title":"HDF5.API.h5d_create","text":"h5d_create(loc_id::hid_t, pathname::Cstring, dtype_id::hid_t, space_id::hid_t, lcpl_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dcreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_create_anon","page":"Low-level library bindings","title":"HDF5.API.h5d_create_anon","text":"h5d_create_anon(loc_id::hid_t, type_id::hid_t, space_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dcreate_anon.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_extend","page":"Low-level library bindings","title":"HDF5.API.h5d_extend","text":"h5d_extend(dataset_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dextend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_fill","page":"Low-level library bindings","title":"HDF5.API.h5d_fill","text":"h5d_fill(fill::Ptr{Cvoid}, fill_type_id::hid_t, buf::Ptr{Cvoid}, buf_type_id::hid_t, space_id::hid_t)\n\nSee libhdf5 documentation for H5Dfill.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_flush","page":"Low-level library bindings","title":"HDF5.API.h5d_flush","text":"h5d_flush(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Dflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_gather","page":"Low-level library bindings","title":"HDF5.API.h5d_gather","text":"h5d_gather(src_space_id::hid_t, src_buf::Ptr{Cvoid}, type_id::hid_t, dst_buf_size::Csize_t, dst_buf::Ptr{Cvoid}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Dgather.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_access_plist","page":"Low-level library bindings","title":"HDF5.API.h5d_get_access_plist","text":"h5d_get_access_plist(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_access_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_info","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_info","text":"h5d_get_chunk_info(dataset_id::hid_t, fspace_id::hid_t, index::hsize_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_info.\n\n\n\n\n\nh5d_get_chunk_info(dataset_id, fspace_id, index)\nh5d_get_chunk_info(dataset_id, index; fspace_id = HDF5.API.H5S_ALL)\n\nHelper method to retrieve chunk information.\n\nReturns a NamedTuple{(:offset, :filter_mask, :addr, :size), Tuple{HDF5.API.hsize_t, UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_info_by_coord","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_info_by_coord","text":"h5d_get_chunk_info_by_coord(dataset_id::hid_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_info_by_coord.\n\n\n\n\n\nh5d_get_chunk_info_by_coord(dataset_id, offset)\n\nHelper method to read chunk information by coordinate. Returns a NamedTuple{(:filter_mask, :addr, :size), Tuple{UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_storage_size","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_storage_size","text":"h5d_get_chunk_storage_size(dataset_id::hid_t, offset::Ptr{hsize_t}, chunk_nbytes::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_storage_size.\n\n\n\n\n\nh5d_get_chunk_storage_size(dataset_id, offset)\n\nHelper method to retrieve the chunk storage size in bytes. Returns an integer of type HDF5.API.hsize_t.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5d_get_create_plist","text":"h5d_get_create_plist(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_num_chunks","page":"Low-level library bindings","title":"HDF5.API.h5d_get_num_chunks","text":"h5d_get_num_chunks(dataset_id::hid_t, fspace_id::hid_t, nchunks::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_num_chunks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_offset","page":"Low-level library bindings","title":"HDF5.API.h5d_get_offset","text":"h5d_get_offset(dataset_id::hid_t) -> haddr_t\n\nSee libhdf5 documentation for H5Dget_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_space","page":"Low-level library bindings","title":"HDF5.API.h5d_get_space","text":"h5d_get_space(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_space_status","page":"Low-level library bindings","title":"HDF5.API.h5d_get_space_status","text":"h5d_get_space_status(dataset_id::hid_t, status::Ref{Cint})\n\nSee libhdf5 documentation for H5Dget_space_status.\n\n\n\n\n\nh5d_get_space_status(dataset_id)\n\nHelper method to retrieve the status of the dataset space. Returns a HDF5.API.H5D_space_status_t (Cint) indicating the status, see HDF5.API.H5D_SPACE_STATUS_* constants.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_storage_size","page":"Low-level library bindings","title":"HDF5.API.h5d_get_storage_size","text":"h5d_get_storage_size(dataset_id::hid_t) -> hsize_t\n\nSee libhdf5 documentation for H5Dget_storage_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_type","page":"Low-level library bindings","title":"HDF5.API.h5d_get_type","text":"h5d_get_type(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_iterate","page":"Low-level library bindings","title":"HDF5.API.h5d_iterate","text":"h5d_iterate(buf::Ptr{Cvoid}, type_id::hid_t, space_id::hid_t, operator::Ptr{Cvoid}, operator_data::Any)\n\nSee libhdf5 documentation for H5Diterate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_open","page":"Low-level library bindings","title":"HDF5.API.h5d_open","text":"h5d_open(loc_id::hid_t, pathname::Cstring, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dopen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_read","page":"Low-level library bindings","title":"HDF5.API.h5d_read","text":"h5d_read(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dread.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_read_chunk","page":"Low-level library bindings","title":"HDF5.API.h5d_read_chunk","text":"h5d_read_chunk(dset::hid_t, dxpl_id::hid_t, offset::Ptr{hsize_t}, filters::Ptr{UInt32}, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dread_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_refresh","page":"Low-level library bindings","title":"HDF5.API.h5d_refresh","text":"h5d_refresh(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Drefresh.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_scatter","page":"Low-level library bindings","title":"HDF5.API.h5d_scatter","text":"h5d_scatter(op::Ptr{Cvoid}, op_data::Any, type_id::hid_t, dst_space_id::hid_t, dst_buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dscatter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_set_extent","page":"Low-level library bindings","title":"HDF5.API.h5d_set_extent","text":"h5d_set_extent(dataset_id::hid_t, new_dims::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dset_extent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_vlen_get_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5d_vlen_get_buf_size","text":"h5d_vlen_get_buf_size(dset_id::hid_t, type_id::hid_t, space_id::hid_t, buf::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dvlen_get_buf_size.\n\n\n\n\n\nh5d_vlen_get_buf_size(dataset_id, type_id, space_id)\n\nHelper method to determines the number of bytes required to store the variable length data from the dataset. Returns a value of type HDF5.API.hsize_t.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_vlen_reclaim","page":"Low-level library bindings","title":"HDF5.API.h5d_vlen_reclaim","text":"h5d_vlen_reclaim(type_id::hid_t, space_id::hid_t, plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dvlen_reclaim.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_write","page":"Low-level library bindings","title":"HDF5.API.h5d_write","text":"h5d_write(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dwrite.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_write_chunk","page":"Low-level library bindings","title":"HDF5.API.h5d_write_chunk","text":"h5d_write_chunk(dset_id::hid_t, dxpl_id::hid_t, filter_mask::UInt32, offset::Ptr{hsize_t}, bufsize::Csize_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dwrite_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5E","page":"Low-level library bindings","title":"H5E — Error Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5e_close_stack\nh5e_get_auto\nh5e_get_current_stack\nh5e_get_msg\nh5e_get_num\nh5e_set_auto\nh5e_walk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5e_close_stack\nh5e_get_auto\nh5e_get_current_stack\nh5e_get_msg\nh5e_get_num\nh5e_set_auto\nh5e_walk","category":"page"},{"location":"api_bindings/#HDF5.API.h5e_close_stack","page":"Low-level library bindings","title":"HDF5.API.h5e_close_stack","text":"h5e_close_stack(stack_id::hid_t)\n\nSee libhdf5 documentation for H5Eclose_stack.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_auto","page":"Low-level library bindings","title":"HDF5.API.h5e_get_auto","text":"h5e_get_auto(estack_id::hid_t, func::Ref{Ptr{Cvoid}}, client_data::Ref{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Eget_auto2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_current_stack","page":"Low-level library bindings","title":"HDF5.API.h5e_get_current_stack","text":"h5e_get_current_stack() -> hid_t\n\nSee libhdf5 documentation for H5Eget_current_stack.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_msg","page":"Low-level library bindings","title":"HDF5.API.h5e_get_msg","text":"h5e_get_msg(mesg_id::hid_t, mesg_type::Ref{Cint}, mesg::Ref{UInt8}, len::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Eget_msg.\n\n\n\n\n\nmesg_type, mesg = h5e_get_msg(meshg_id)\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_num","page":"Low-level library bindings","title":"HDF5.API.h5e_get_num","text":"h5e_get_num(estack_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Eget_num.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_set_auto","page":"Low-level library bindings","title":"HDF5.API.h5e_set_auto","text":"h5e_set_auto(estack_id::hid_t, func::Ptr{Cvoid}, client_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Eset_auto2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_walk","page":"Low-level library bindings","title":"HDF5.API.h5e_walk","text":"h5e_walk(stack_id::hid_t, direction::Cint, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Ewalk2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5F","page":"Low-level library bindings","title":"H5F — File Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5f_clear_elink_file_cache\nh5f_close\nh5f_create\nh5f_delete\nh5f_flush\nh5f_format_convert\nh5f_get_access_plist\nh5f_get_create_plist\nh5f_get_dset_no_attrs_hint\nh5f_get_eoa\nh5f_get_file_image\nh5f_get_fileno\nh5f_get_filesize\nh5f_get_free_sections\nh5f_get_freespace\nh5f_get_info\nh5f_get_intent\nh5f_get_mdc_config\nh5f_get_mdc_hit_rate\nh5f_get_mdc_image_info\nh5f_get_mdc_logging_status\nh5f_get_mdc_size\nh5f_get_metadata_read_retry_info\nh5f_get_mpi_atomicity\nh5f_get_name\nh5f_get_obj_count\nh5f_get_obj_ids\nh5f_get_page_buffering_stats\nh5f_get_vfd_handle\nh5f_increment_filesize\nh5f_is_accessible\nh5f_is_hdf5\nh5f_mount\nh5f_open\nh5f_reopen\nh5f_reset_mdc_hit_rate_stats\nh5f_reset_page_buffering_stats\nh5f_set_dset_no_attrs_hint\nh5f_set_libver_bounds\nh5f_set_mdc_config\nh5f_set_mpi_atomicity\nh5f_start_mdc_logging\nh5f_start_swmr_write\nh5f_stop_mdc_logging\nh5f_unmount","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5f_clear_elink_file_cache\nh5f_close\nh5f_create\nh5f_delete\nh5f_flush\nh5f_format_convert\nh5f_get_access_plist\nh5f_get_create_plist\nh5f_get_dset_no_attrs_hint\nh5f_get_eoa\nh5f_get_file_image\nh5f_get_fileno\nh5f_get_filesize\nh5f_get_free_sections\nh5f_get_freespace\nh5f_get_info\nh5f_get_intent\nh5f_get_mdc_config\nh5f_get_mdc_hit_rate\nh5f_get_mdc_image_info\nh5f_get_mdc_logging_status\nh5f_get_mdc_size\nh5f_get_metadata_read_retry_info\nh5f_get_mpi_atomicity\nh5f_get_name\nh5f_get_obj_count\nh5f_get_obj_ids\nh5f_get_page_buffering_stats\nh5f_get_vfd_handle\nh5f_increment_filesize\nh5f_is_accessible\nh5f_is_hdf5\nh5f_mount\nh5f_open\nh5f_reopen\nh5f_reset_mdc_hit_rate_stats\nh5f_reset_page_buffering_stats\nh5f_set_dset_no_attrs_hint\nh5f_set_libver_bounds\nh5f_set_mdc_config\nh5f_set_mpi_atomicity\nh5f_start_mdc_logging\nh5f_start_swmr_write\nh5f_stop_mdc_logging\nh5f_unmount","category":"page"},{"location":"api_bindings/#HDF5.API.h5f_clear_elink_file_cache","page":"Low-level library bindings","title":"HDF5.API.h5f_clear_elink_file_cache","text":"h5f_clear_elink_file_cache(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fclear_elink_file_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_close","page":"Low-level library bindings","title":"HDF5.API.h5f_close","text":"h5f_close(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_create","page":"Low-level library bindings","title":"HDF5.API.h5f_create","text":"h5f_create(pathname::Cstring, flags::Cuint, fcpl_id::hid_t, fapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_delete","page":"Low-level library bindings","title":"HDF5.API.h5f_delete","text":"h5f_delete(filename::Cstring, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Fdelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_flush","page":"Low-level library bindings","title":"HDF5.API.h5f_flush","text":"h5f_flush(object_id::hid_t, scope::Cint)\n\nSee libhdf5 documentation for H5Fflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_format_convert","page":"Low-level library bindings","title":"HDF5.API.h5f_format_convert","text":"h5f_format_convert(fid::hid_t)\n\nSee libhdf5 documentation for H5Fformat_convert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_access_plist","page":"Low-level library bindings","title":"HDF5.API.h5f_get_access_plist","text":"h5f_get_access_plist(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fget_access_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5f_get_create_plist","text":"h5f_get_create_plist(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5f_get_dset_no_attrs_hint","text":"h5f_get_dset_no_attrs_hint(file_id::hid_t, minimize::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_eoa","page":"Low-level library bindings","title":"HDF5.API.h5f_get_eoa","text":"h5f_get_eoa(file_id::hid_t, eoa::Ptr{haddr_t})\n\nSee libhdf5 documentation for H5Fget_eoa.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_file_image","page":"Low-level library bindings","title":"HDF5.API.h5f_get_file_image","text":"h5f_get_file_image(file_id::hid_t, buf_ptr::Ptr{Cvoid}, buf_len::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_fileno","page":"Low-level library bindings","title":"HDF5.API.h5f_get_fileno","text":"h5f_get_fileno(file_id::hid_t, fileno::Ptr{Culong})\n\nSee libhdf5 documentation for H5Fget_fileno.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_filesize","page":"Low-level library bindings","title":"HDF5.API.h5f_get_filesize","text":"h5f_get_filesize(file_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Fget_filesize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_free_sections","page":"Low-level library bindings","title":"HDF5.API.h5f_get_free_sections","text":"h5f_get_free_sections(file_id::hid_t, type::H5F_mem_t, nsects::Csize_t, sect_info::Ptr{H5F_sect_info_t}) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_free_sections.\n\n\n\n\n\nh5f_get_free_sections(file_id, type, [sect_info::AbstractVector{H5F_sect_info_t}])::AbstractVector{H5F_sect_info_t}\n\nReturn an AbstractVector of the free section information. If sect_info is not provided a new Vector will be allocated and returned. If sect_info is provided, a view, a SubArray, will be returned.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_freespace","page":"Low-level library bindings","title":"HDF5.API.h5f_get_freespace","text":"h5f_get_freespace(file_id::hid_t) -> hssize_t\n\nSee libhdf5 documentation for H5Fget_freespace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_info","text":"h5f_get_info(obj_id::hid_t, file_info::Ptr{H5F_info2_t})\n\nSee libhdf5 documentation for H5Fget_info2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_intent","page":"Low-level library bindings","title":"HDF5.API.h5f_get_intent","text":"h5f_get_intent(file_id::hid_t, intent::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Fget_intent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_config","text":"h5f_get_mdc_config(file_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Fget_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_hit_rate","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_hit_rate","text":"h5f_get_mdc_hit_rate(file_id::hid_t, hit_rate_ptr::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Fget_mdc_hit_rate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_image_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_image_info","text":"h5f_get_mdc_image_info(file_id::hid_t, image_addr::Ptr{haddr_t}, image_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Fget_mdc_image_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_logging_status","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_logging_status","text":"h5f_get_mdc_logging_status(file_id::hid_t, is_enabled::Ptr{hbool_t}, is_currently_logging::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_mdc_logging_status.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_size","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_size","text":"h5f_get_mdc_size(file_id::hid_t, max_size_ptr::Ptr{Csize_t}, min_clean_size_ptr::Ptr{Csize_t}, cur_size_ptr::Ptr{Csize_t}, cur_num_entries_ptr::Ptr{Cint})\n\nSee libhdf5 documentation for H5Fget_mdc_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_metadata_read_retry_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_metadata_read_retry_info","text":"h5f_get_metadata_read_retry_info(file_id::hid_t, info::Ptr{H5F_retry_info_t})\n\nSee libhdf5 documentation for H5Fget_metadata_read_retry_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mpi_atomicity","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mpi_atomicity","text":"h5f_get_mpi_atomicity(file_id::hid_t, flag::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_mpi_atomicity.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_name","page":"Low-level library bindings","title":"HDF5.API.h5f_get_name","text":"h5f_get_name(obj_id::hid_t, buf::Ptr{UInt8}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_obj_count","page":"Low-level library bindings","title":"HDF5.API.h5f_get_obj_count","text":"h5f_get_obj_count(file_id::hid_t, types::Cuint) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_obj_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_obj_ids","page":"Low-level library bindings","title":"HDF5.API.h5f_get_obj_ids","text":"h5f_get_obj_ids(file_id::hid_t, types::Cuint, max_objs::Csize_t, obj_id_list::Ptr{hid_t}) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_obj_ids.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_page_buffering_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_get_page_buffering_stats","text":"h5f_get_page_buffering_stats(file_id::hid_t, accesses::Ptr{Cuint}, hits::Ptr{Cuint}, misses::Ptr{Cuint}, evictions::Ptr{Cuint}, bypasses::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Fget_page_buffering_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_vfd_handle","page":"Low-level library bindings","title":"HDF5.API.h5f_get_vfd_handle","text":"h5f_get_vfd_handle(file_id::hid_t, fapl_id::hid_t, file_handle::Ref{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Fget_vfd_handle.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_increment_filesize","page":"Low-level library bindings","title":"HDF5.API.h5f_increment_filesize","text":"h5f_increment_filesize(file_id::hid_t, increment::hsize_t)\n\nSee libhdf5 documentation for H5Fincrement_filesize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_is_accessible","page":"Low-level library bindings","title":"HDF5.API.h5f_is_accessible","text":"h5f_is_accessible(container_name::Cstring, fapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Fis_accessible.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_is_hdf5","page":"Low-level library bindings","title":"HDF5.API.h5f_is_hdf5","text":"h5f_is_hdf5(pathname::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Fis_hdf5.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_mount","page":"Low-level library bindings","title":"HDF5.API.h5f_mount","text":"h5f_mount(loc::hid_t, name::Cstring, child::hid_t, plist::hid_t)\n\nSee libhdf5 documentation for H5Fmount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_open","page":"Low-level library bindings","title":"HDF5.API.h5f_open","text":"h5f_open(pathname::Cstring, flags::Cuint, fapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reopen","page":"Low-level library bindings","title":"HDF5.API.h5f_reopen","text":"h5f_reopen(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Freopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reset_mdc_hit_rate_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_reset_mdc_hit_rate_stats","text":"h5f_reset_mdc_hit_rate_stats(file_id::hid_t)\n\nSee libhdf5 documentation for H5Freset_mdc_hit_rate_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reset_page_buffering_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_reset_page_buffering_stats","text":"h5f_reset_page_buffering_stats(file_id::hid_t)\n\nSee libhdf5 documentation for H5Freset_page_buffering_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5f_set_dset_no_attrs_hint","text":"h5f_set_dset_no_attrs_hint(file_id::hid_t, minimize::hbool_t)\n\nSee libhdf5 documentation for H5Fset_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5f_set_libver_bounds","text":"h5f_set_libver_bounds(file_id::hid_t, low::H5F_libver_t, high::H5F_libver_t)\n\nSee libhdf5 documentation for H5Fset_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5f_set_mdc_config","text":"h5f_set_mdc_config(file_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Fset_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_mpi_atomicity","page":"Low-level library bindings","title":"HDF5.API.h5f_set_mpi_atomicity","text":"h5f_set_mpi_atomicity(file_id::hid_t, flag::hbool_t)\n\nSee libhdf5 documentation for H5Fset_mpi_atomicity.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_start_mdc_logging","page":"Low-level library bindings","title":"HDF5.API.h5f_start_mdc_logging","text":"h5f_start_mdc_logging(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fstart_mdc_logging.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_start_swmr_write","page":"Low-level library bindings","title":"HDF5.API.h5f_start_swmr_write","text":"h5f_start_swmr_write(id::hid_t)\n\nSee libhdf5 documentation for H5Fstart_swmr_write.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_stop_mdc_logging","page":"Low-level library bindings","title":"HDF5.API.h5f_stop_mdc_logging","text":"h5f_stop_mdc_logging(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fstop_mdc_logging.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_unmount","page":"Low-level library bindings","title":"HDF5.API.h5f_unmount","text":"h5f_unmount(loc::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Funmount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5G","page":"Low-level library bindings","title":"H5G — Group Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5g_close\nh5g_create\nh5g_get_create_plist\nh5g_get_info\nh5g_get_num_objs\nh5g_get_objname_by_idx\nh5g_open","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5g_close\nh5g_create\nh5g_get_create_plist\nh5g_get_info\nh5g_get_num_objs\nh5g_get_objname_by_idx\nh5g_open","category":"page"},{"location":"api_bindings/#HDF5.API.h5g_close","page":"Low-level library bindings","title":"HDF5.API.h5g_close","text":"h5g_close(group_id::hid_t)\n\nSee libhdf5 documentation for H5Gclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_create","page":"Low-level library bindings","title":"HDF5.API.h5g_create","text":"h5g_create(loc_id::hid_t, pathname::Cstring, lcpl_id::hid_t, gcpl_id::hid_t, gapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gcreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5g_get_create_plist","text":"h5g_get_create_plist(group_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_info","page":"Low-level library bindings","title":"HDF5.API.h5g_get_info","text":"h5g_get_info(group_id::hid_t, buf::Ptr{H5G_info_t})\n\nSee libhdf5 documentation for H5Gget_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_num_objs","page":"Low-level library bindings","title":"HDF5.API.h5g_get_num_objs","text":"h5g_get_num_objs(loc_id::hid_t, num_obj::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Gget_num_objs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_objname_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5g_get_objname_by_idx","text":"h5g_get_objname_by_idx(loc_id::hid_t, idx::hsize_t, pathname::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Gget_objname_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_open","page":"Low-level library bindings","title":"HDF5.API.h5g_open","text":"h5g_open(loc_id::hid_t, pathname::Cstring, gapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gopen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5I","page":"Low-level library bindings","title":"H5I — Identifier Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5i_dec_ref\nh5i_get_file_id\nh5i_get_name\nh5i_get_ref\nh5i_get_type\nh5i_inc_ref\nh5i_is_valid","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5i_dec_ref\nh5i_get_file_id\nh5i_get_name\nh5i_get_ref\nh5i_get_type\nh5i_inc_ref\nh5i_is_valid","category":"page"},{"location":"api_bindings/#HDF5.API.h5i_dec_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_dec_ref","text":"h5i_dec_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Idec_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_file_id","page":"Low-level library bindings","title":"HDF5.API.h5i_get_file_id","text":"h5i_get_file_id(obj_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Iget_file_id.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_name","page":"Low-level library bindings","title":"HDF5.API.h5i_get_name","text":"h5i_get_name(obj_id::hid_t, buf::Ptr{UInt8}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Iget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_get_ref","text":"h5i_get_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iget_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_type","page":"Low-level library bindings","title":"HDF5.API.h5i_get_type","text":"h5i_get_type(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_inc_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_inc_ref","text":"h5i_inc_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iinc_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_is_valid","page":"Low-level library bindings","title":"HDF5.API.h5i_is_valid","text":"h5i_is_valid(obj_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Iis_valid.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5L","page":"Low-level library bindings","title":"H5L — Link Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5l_create_external\nh5l_create_hard\nh5l_create_soft\nh5l_delete\nh5l_exists\nh5l_get_info\nh5l_get_name_by_idx\nh5l_iterate\nh5l_move","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5l_create_external\nh5l_create_hard\nh5l_create_soft\nh5l_delete\nh5l_exists\nh5l_get_info\nh5l_get_name_by_idx\nh5l_iterate\nh5l_move","category":"page"},{"location":"api_bindings/#HDF5.API.h5l_create_external","page":"Low-level library bindings","title":"HDF5.API.h5l_create_external","text":"h5l_create_external(target_file_name::Cstring, target_obj_name::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_create_hard","page":"Low-level library bindings","title":"HDF5.API.h5l_create_hard","text":"h5l_create_hard(obj_loc_id::hid_t, obj_name::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_hard.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_create_soft","page":"Low-level library bindings","title":"HDF5.API.h5l_create_soft","text":"h5l_create_soft(target_path::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_soft.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_delete","page":"Low-level library bindings","title":"HDF5.API.h5l_delete","text":"h5l_delete(obj_id::hid_t, pathname::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Ldelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_exists","page":"Low-level library bindings","title":"HDF5.API.h5l_exists","text":"h5l_exists(loc_id::hid_t, pathname::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Lexists.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_get_info","page":"Low-level library bindings","title":"HDF5.API.h5l_get_info","text":"h5l_get_info(link_loc_id::hid_t, link_name::Cstring, link_buf::Ptr{H5L_info_t}, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lget_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_get_name_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5l_get_name_by_idx","text":"h5l_get_name_by_idx(loc_id::hid_t, group_name::Cstring, index_field::Cint, order::Cint, n::hsize_t, name::Ptr{UInt8}, size::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Lget_name_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_iterate","page":"Low-level library bindings","title":"HDF5.API.h5l_iterate","text":"h5l_iterate(group_id::hid_t, idx_type::Cint, order::Cint, idx::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Literate1.\n\n\n\n\n\nh5l_iterate(f, group_id, idx_type, order, idx = 0) -> hsize_t\n\nExecutes h5l_iterate with the user-provided callback function f, returning the index where iteration ends.\n\nThe callback function must correspond to the signature\n\nf(group::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5L_info_t}) -> Union{Bool, Integer}\n\nwhere a negative return value halts iteration abnormally, true or a positive value halts iteration successfully, and false or zero continues iteration.\n\nExamples\n\njulia> HDF5.API.h5l_iterate(hfile, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do group, name, info\n println(unsafe_string(name))\n return HDF5.API.herr_t(0)\n end\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_move","page":"Low-level library bindings","title":"HDF5.API.h5l_move","text":"h5l_move(src_obj_id::hid_t, src_name::Cstring, dest_obj_id::hid_t, dest_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lmove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5O","page":"Low-level library bindings","title":"H5O — Object Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5o_are_mdc_flushes_disabled\nh5o_close\nh5o_copy\nh5o_decr_refcount\nh5o_disable_mdc_flushes\nh5o_enable_mdc_flushes\nh5o_exists_by_name\nh5o_flush\nh5o_get_comment\nh5o_get_comment_by_name\nh5o_get_info\nh5o_get_info1\nh5o_get_info_by_idx\nh5o_get_info_by_name\nh5o_get_native_info\nh5o_get_native_info_by_idx\nh5o_get_native_info_by_name\nh5o_incr_refcount\nh5o_link\nh5o_open\nh5o_open_by_addr\nh5o_open_by_idx\nh5o_refresh\nh5o_set_comment\nh5o_set_comment_by_name\nh5o_token_cmp\nh5o_token_from_str\nh5o_token_to_str\nh5o_visit\nh5o_visit_by_name","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5o_are_mdc_flushes_disabled\nh5o_close\nh5o_copy\nh5o_decr_refcount\nh5o_disable_mdc_flushes\nh5o_enable_mdc_flushes\nh5o_exists_by_name\nh5o_flush\nh5o_get_comment\nh5o_get_comment_by_name\nh5o_get_info\nh5o_get_info1\nh5o_get_info_by_idx\nh5o_get_info_by_name\nh5o_get_native_info\nh5o_get_native_info_by_idx\nh5o_get_native_info_by_name\nh5o_incr_refcount\nh5o_link\nh5o_open\nh5o_open_by_addr\nh5o_open_by_idx\nh5o_refresh\nh5o_set_comment\nh5o_set_comment_by_name\nh5o_token_cmp\nh5o_token_from_str\nh5o_token_to_str\nh5o_visit\nh5o_visit_by_name","category":"page"},{"location":"api_bindings/#HDF5.API.h5o_are_mdc_flushes_disabled","page":"Low-level library bindings","title":"HDF5.API.h5o_are_mdc_flushes_disabled","text":"h5o_are_mdc_flushes_disabled(object_id::hid_t, are_disabled::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Oare_mdc_flushes_disabled.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_close","page":"Low-level library bindings","title":"HDF5.API.h5o_close","text":"h5o_close(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_copy","page":"Low-level library bindings","title":"HDF5.API.h5o_copy","text":"h5o_copy(src_loc_id::hid_t, src_name::Cstring, dst_loc_id::hid_t, dst_name::Cstring, ocpypl_id::hid_t, lcpl_id::hid_t)\n\nSee libhdf5 documentation for H5Ocopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_decr_refcount","page":"Low-level library bindings","title":"HDF5.API.h5o_decr_refcount","text":"h5o_decr_refcount(object_id::hid_t)\n\nSee libhdf5 documentation for H5Odecr_refcount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_disable_mdc_flushes","page":"Low-level library bindings","title":"HDF5.API.h5o_disable_mdc_flushes","text":"h5o_disable_mdc_flushes(object_id::hid_t)\n\nSee libhdf5 documentation for H5Odisable_mdc_flushes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_enable_mdc_flushes","page":"Low-level library bindings","title":"HDF5.API.h5o_enable_mdc_flushes","text":"h5o_enable_mdc_flushes(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oenable_mdc_flushes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_exists_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_exists_by_name","text":"h5o_exists_by_name(loc_id::hid_t, name::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Oexists_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_flush","page":"Low-level library bindings","title":"HDF5.API.h5o_flush","text":"h5o_flush(obj_id::hid_t)\n\nSee libhdf5 documentation for H5Oflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_comment","page":"Low-level library bindings","title":"HDF5.API.h5o_get_comment","text":"h5o_get_comment(obj_id::hid_t, comment::Ptr{Cchar}, bufsize::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Oget_comment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_comment_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_comment_by_name","text":"h5o_get_comment_by_name(loc_id::hid_t, name::Cstring, comment::Ptr{Cchar}, bufsize::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Oget_comment_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info","text":"h5o_get_info(loc_id::hid_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint)\n\nSee libhdf5 documentation for H5Oget_info3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info1","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info1","text":"h5o_get_info1(object_id, [buf])\n\nDeprecated HDF5 function. Use h5o_get_info or h5o_get_native_info if possible.\n\nSee libhdf5 documentation for H5Oget_info1.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info_by_idx","text":"h5o_get_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_info_by_idx3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info_by_name","text":"h5o_get_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_info_by_name3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info","text":"h5o_get_native_info(loc_id::hid_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint)\n\nSee libhdf5 documentation for H5Oget_native_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info_by_idx","text":"h5o_get_native_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_native_info_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info_by_name","text":"h5o_get_native_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_native_info_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_incr_refcount","page":"Low-level library bindings","title":"HDF5.API.h5o_incr_refcount","text":"h5o_incr_refcount(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oincr_refcount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_link","page":"Low-level library bindings","title":"HDF5.API.h5o_link","text":"h5o_link(obj_id::hid_t, new_loc_id::hid_t, new_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Olink.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open","page":"Low-level library bindings","title":"HDF5.API.h5o_open","text":"h5o_open(loc_id::hid_t, pathname::Cstring, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open_by_addr","page":"Low-level library bindings","title":"HDF5.API.h5o_open_by_addr","text":"h5o_open_by_addr(loc_id::hid_t, addr::haddr_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen_by_addr.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_open_by_idx","text":"h5o_open_by_idx(loc_id::hid_t, group_name::Cstring, index_type::Cint, order::Cint, n::hsize_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_refresh","page":"Low-level library bindings","title":"HDF5.API.h5o_refresh","text":"h5o_refresh(oid::hid_t)\n\nSee libhdf5 documentation for H5Orefresh.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_set_comment","page":"Low-level library bindings","title":"HDF5.API.h5o_set_comment","text":"h5o_set_comment(obj_id::hid_t, comment::Cstring)\n\nSee libhdf5 documentation for H5Oset_comment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_set_comment_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_set_comment_by_name","text":"h5o_set_comment_by_name(loc_id::hid_t, name::Cstring, comment::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oset_comment_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_cmp","page":"Low-level library bindings","title":"HDF5.API.h5o_token_cmp","text":"h5o_token_cmp(loc_id::hid_t, token1::Ptr{H5O_token_t}, token2::Ptr{H5O_token_t}, cmp_value::Ptr{Cint})\n\nSee libhdf5 documentation for H5Otoken_cmp.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_from_str","page":"Low-level library bindings","title":"HDF5.API.h5o_token_from_str","text":"h5o_token_from_str(loc_id::hid_t, token_str::Cstring, token::Ptr{H5O_token_t})\n\nSee libhdf5 documentation for H5Otoken_from_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_to_str","page":"Low-level library bindings","title":"HDF5.API.h5o_token_to_str","text":"h5o_token_to_str(loc_id::hid_t, token::Ptr{H5O_token_t}, token_str::Ptr{Ptr{Cchar}})\n\nSee libhdf5 documentation for H5Otoken_to_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_visit","page":"Low-level library bindings","title":"HDF5.API.h5o_visit","text":"h5o_visit(obj_id::hid_t, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint)\n\nSee libhdf5 documentation for H5Ovisit3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_visit_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_visit_by_name","text":"h5o_visit_by_name(loc_id::hid_t, obj_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Ovisit_by_name3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5PL","page":"Low-level library bindings","title":"H5PL — Plugin Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5pl_append\nh5pl_get\nh5pl_get_loading_state\nh5pl_insert\nh5pl_prepend\nh5pl_remove\nh5pl_replace\nh5pl_set_loading_state\nh5pl_size","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5pl_append\nh5pl_get\nh5pl_get_loading_state\nh5pl_insert\nh5pl_prepend\nh5pl_remove\nh5pl_replace\nh5pl_set_loading_state\nh5pl_size","category":"page"},{"location":"api_bindings/#HDF5.API.h5pl_append","page":"Low-level library bindings","title":"HDF5.API.h5pl_append","text":"h5pl_append(search_path::Cstring)\n\nSee libhdf5 documentation for H5PLappend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_get","page":"Low-level library bindings","title":"HDF5.API.h5pl_get","text":"h5pl_get(index::Cuint, path_buf::Ptr{Cchar}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5PLget.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_get_loading_state","page":"Low-level library bindings","title":"HDF5.API.h5pl_get_loading_state","text":"h5pl_get_loading_state(plugin_control_mask::Ptr{Cuint})\n\nSee libhdf5 documentation for H5PLget_loading_state.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_insert","page":"Low-level library bindings","title":"HDF5.API.h5pl_insert","text":"h5pl_insert(search_path::Cstring, index::Cuint)\n\nSee libhdf5 documentation for H5PLinsert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_prepend","page":"Low-level library bindings","title":"HDF5.API.h5pl_prepend","text":"h5pl_prepend(search_path::Cstring)\n\nSee libhdf5 documentation for H5PLprepend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_remove","page":"Low-level library bindings","title":"HDF5.API.h5pl_remove","text":"h5pl_remove(index::Cuint)\n\nSee libhdf5 documentation for H5PLremove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_replace","page":"Low-level library bindings","title":"HDF5.API.h5pl_replace","text":"h5pl_replace(search_path::Cstring, index::Cuint)\n\nSee libhdf5 documentation for H5PLreplace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_set_loading_state","page":"Low-level library bindings","title":"HDF5.API.h5pl_set_loading_state","text":"h5pl_set_loading_state(plugin_control_mask::Cuint)\n\nSee libhdf5 documentation for H5PLset_loading_state.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_size","page":"Low-level library bindings","title":"HDF5.API.h5pl_size","text":"h5pl_size(num_paths::Ptr{Cuint})\n\nSee libhdf5 documentation for H5PLsize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5P","page":"Low-level library bindings","title":"H5P — Property Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5p_add_merge_committed_dtype_path\nh5p_all_filters_avail\nh5p_close\nh5p_close_class\nh5p_copy\nh5p_copy_prop\nh5p_create\nh5p_create_class\nh5p_decode\nh5p_encode\nh5p_equal\nh5p_exist\nh5p_fill_value_defined\nh5p_free_merge_committed_dtype_paths\nh5p_get\nh5p_get_alignment\nh5p_get_alloc_time\nh5p_get_append_flush\nh5p_get_attr_creation_order\nh5p_get_attr_phase_change\nh5p_get_btree_ratios\nh5p_get_buffer\nh5p_get_cache\nh5p_get_char_encoding\nh5p_get_chunk\nh5p_get_chunk_cache\nh5p_get_chunk_opts\nh5p_get_class\nh5p_get_class_name\nh5p_get_class_parent\nh5p_get_copy_object\nh5p_get_core_write_tracking\nh5p_get_create_intermediate_group\nh5p_get_data_transform\nh5p_get_driver\nh5p_get_driver_info\nh5p_get_dset_no_attrs_hint\nh5p_get_dxpl_mpio\nh5p_get_edc_check\nh5p_get_efile_prefix\nh5p_get_elink_acc_flags\nh5p_get_elink_cb\nh5p_get_elink_fapl\nh5p_get_elink_file_cache_size\nh5p_get_elink_prefix\nh5p_get_est_link_info\nh5p_get_evict_on_close\nh5p_get_external\nh5p_get_external_count\nh5p_get_family_offset\nh5p_get_fapl_core\nh5p_get_fapl_family\nh5p_get_fapl_hdfs\nh5p_get_fapl_mpio\nh5p_get_fapl_multi\nh5p_get_fapl_ros3\nh5p_get_fapl_splitter\nh5p_get_fclose_degree\nh5p_get_file_image\nh5p_get_file_image_callbacks\nh5p_get_file_locking\nh5p_get_file_space\nh5p_get_file_space_page_size\nh5p_get_file_space_strategy\nh5p_get_fill_time\nh5p_get_fill_value\nh5p_get_filter\nh5p_get_filter_by_id\nh5p_get_gc_references\nh5p_get_hyper_vector_size\nh5p_get_istore_k\nh5p_get_layout\nh5p_get_libver_bounds\nh5p_get_link_creation_order\nh5p_get_link_phase_change\nh5p_get_local_heap_size_hint\nh5p_get_mcdt_search_cb\nh5p_get_mdc_config\nh5p_get_mdc_image_config\nh5p_get_mdc_log_options\nh5p_get_meta_block_size\nh5p_get_metadata_read_attempts\nh5p_get_multi_type\nh5p_get_nfilters\nh5p_get_nlinks\nh5p_get_nprops\nh5p_get_obj_track_times\nh5p_get_object_flush_cb\nh5p_get_page_buffer_size\nh5p_get_preserve\nh5p_get_shared_mesg_index\nh5p_get_shared_mesg_nindexes\nh5p_get_shared_mesg_phase_change\nh5p_get_sieve_buf_size\nh5p_get_size\nh5p_get_sizes\nh5p_get_small_data_block_size\nh5p_get_sym_k\nh5p_get_type_conv_cb\nh5p_get_userblock\nh5p_get_version\nh5p_get_virtual_count\nh5p_get_virtual_dsetname\nh5p_get_virtual_filename\nh5p_get_virtual_prefix\nh5p_get_virtual_printf_gap\nh5p_get_virtual_srcspace\nh5p_get_virtual_view\nh5p_get_virtual_vspace\nh5p_get_vlen_mem_manager\nh5p_get_vol_id\nh5p_get_vol_info\nh5p_insert\nh5p_isa_class\nh5p_iterate\nh5p_modify_filter\nh5p_register\nh5p_remove\nh5p_remove_filter\nh5p_set\nh5p_set_alignment\nh5p_set_alloc_time\nh5p_set_append_flush\nh5p_set_attr_creation_order\nh5p_set_attr_phase_change\nh5p_set_btree_ratios\nh5p_set_buffer\nh5p_set_cache\nh5p_set_char_encoding\nh5p_set_chunk\nh5p_set_chunk_cache\nh5p_set_chunk_opts\nh5p_set_copy_object\nh5p_set_core_write_tracking\nh5p_set_create_intermediate_group\nh5p_set_data_transform\nh5p_set_deflate\nh5p_set_driver\nh5p_set_dset_no_attrs_hint\nh5p_set_dxpl_mpio\nh5p_set_edc_check\nh5p_set_efile_prefix\nh5p_set_elink_acc_flags\nh5p_set_elink_cb\nh5p_set_elink_fapl\nh5p_set_elink_file_cache_size\nh5p_set_elink_prefix\nh5p_set_est_link_info\nh5p_set_evict_on_close\nh5p_set_external\nh5p_set_family_offset\nh5p_set_fapl_core\nh5p_set_fapl_family\nh5p_set_fapl_hdfs\nh5p_set_fapl_log\nh5p_set_fapl_mpio\nh5p_set_fapl_multi\nh5p_set_fapl_ros3\nh5p_set_fapl_sec2\nh5p_set_fapl_split\nh5p_set_fapl_splitter\nh5p_set_fapl_stdio\nh5p_set_fapl_windows\nh5p_set_fclose_degree\nh5p_set_file_image\nh5p_set_file_image_callbacks\nh5p_set_file_locking\nh5p_set_file_space\nh5p_set_file_space_page_size\nh5p_set_file_space_strategy\nh5p_set_fill_time\nh5p_set_fill_value\nh5p_set_filter\nh5p_set_filter_callback\nh5p_set_fletcher32\nh5p_set_gc_references\nh5p_set_hyper_vector_size\nh5p_set_istore_k\nh5p_set_layout\nh5p_set_libver_bounds\nh5p_set_link_creation_order\nh5p_set_link_phase_change\nh5p_set_local_heap_size_hint\nh5p_set_mcdt_search_cb\nh5p_set_mdc_config\nh5p_set_mdc_image_config\nh5p_set_mdc_log_options\nh5p_set_meta_block_size\nh5p_set_metadata_read_attempts\nh5p_set_multi_type\nh5p_set_nbit\nh5p_set_nlinks\nh5p_set_obj_track_times\nh5p_set_object_flush_cb\nh5p_set_page_buffer_size\nh5p_set_preserve\nh5p_set_scaleoffset\nh5p_set_shared_mesg_index\nh5p_set_shared_mesg_nindexes\nh5p_set_shared_mesg_phase_change\nh5p_set_shuffle\nh5p_set_sieve_buf_size\nh5p_set_sizes\nh5p_set_small_data_block_size\nh5p_set_sym_k\nh5p_set_szip\nh5p_set_type_conv_cb\nh5p_set_userblock\nh5p_set_virtual\nh5p_set_virtual_prefix\nh5p_set_virtual_printf_gap\nh5p_set_virtual_view\nh5p_set_vlen_mem_manager\nh5p_set_vol\nh5p_unregister","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5p_add_merge_committed_dtype_path\nh5p_all_filters_avail\nh5p_close\nh5p_close_class\nh5p_copy\nh5p_copy_prop\nh5p_create\nh5p_create_class\nh5p_decode\nh5p_encode\nh5p_equal\nh5p_exist\nh5p_fill_value_defined\nh5p_free_merge_committed_dtype_paths\nh5p_get\nh5p_get_alignment\nh5p_get_alloc_time\nh5p_get_append_flush\nh5p_get_attr_creation_order\nh5p_get_attr_phase_change\nh5p_get_btree_ratios\nh5p_get_buffer\nh5p_get_cache\nh5p_get_char_encoding\nh5p_get_chunk\nh5p_get_chunk_cache\nh5p_get_chunk_opts\nh5p_get_class\nh5p_get_class_name\nh5p_get_class_parent\nh5p_get_copy_object\nh5p_get_core_write_tracking\nh5p_get_create_intermediate_group\nh5p_get_data_transform\nh5p_get_driver\nh5p_get_driver_info\nh5p_get_dset_no_attrs_hint\nh5p_get_dxpl_mpio\nh5p_get_edc_check\nh5p_get_efile_prefix\nh5p_get_elink_acc_flags\nh5p_get_elink_cb\nh5p_get_elink_fapl\nh5p_get_elink_file_cache_size\nh5p_get_elink_prefix\nh5p_get_est_link_info\nh5p_get_evict_on_close\nh5p_get_external\nh5p_get_external_count\nh5p_get_family_offset\nh5p_get_fapl_core\nh5p_get_fapl_family\nh5p_get_fapl_hdfs\nh5p_get_fapl_mpio\nh5p_get_fapl_multi\nh5p_get_fapl_ros3\nh5p_get_fapl_splitter\nh5p_get_fclose_degree\nh5p_get_file_image\nh5p_get_file_image_callbacks\nh5p_get_file_locking\nh5p_get_file_space\nh5p_get_file_space_page_size\nh5p_get_file_space_strategy\nh5p_get_fill_time\nh5p_get_fill_value\nh5p_get_filter\nh5p_get_filter_by_id\nh5p_get_gc_references\nh5p_get_hyper_vector_size\nh5p_get_istore_k\nh5p_get_layout\nh5p_get_libver_bounds\nh5p_get_link_creation_order\nh5p_get_link_phase_change\nh5p_get_local_heap_size_hint\nh5p_get_mcdt_search_cb\nh5p_get_mdc_config\nh5p_get_mdc_image_config\nh5p_get_mdc_log_options\nh5p_get_meta_block_size\nh5p_get_metadata_read_attempts\nh5p_get_multi_type\nh5p_get_nfilters\nh5p_get_nlinks\nh5p_get_nprops\nh5p_get_obj_track_times\nh5p_get_object_flush_cb\nh5p_get_page_buffer_size\nh5p_get_preserve\nh5p_get_shared_mesg_index\nh5p_get_shared_mesg_nindexes\nh5p_get_shared_mesg_phase_change\nh5p_get_sieve_buf_size\nh5p_get_size\nh5p_get_sizes\nh5p_get_small_data_block_size\nh5p_get_sym_k\nh5p_get_type_conv_cb\nh5p_get_userblock\nh5p_get_version\nh5p_get_virtual_count\nh5p_get_virtual_dsetname\nh5p_get_virtual_filename\nh5p_get_virtual_prefix\nh5p_get_virtual_printf_gap\nh5p_get_virtual_srcspace\nh5p_get_virtual_view\nh5p_get_virtual_vspace\nh5p_get_vlen_mem_manager\nh5p_get_vol_id\nh5p_get_vol_info\nh5p_insert\nh5p_isa_class\nh5p_iterate\nh5p_modify_filter\nh5p_register\nh5p_remove\nh5p_remove_filter\nh5p_set\nh5p_set_alignment\nh5p_set_alloc_time\nh5p_set_append_flush\nh5p_set_attr_creation_order\nh5p_set_attr_phase_change\nh5p_set_btree_ratios\nh5p_set_buffer\nh5p_set_cache\nh5p_set_char_encoding\nh5p_set_chunk\nh5p_set_chunk_cache\nh5p_set_chunk_opts\nh5p_set_copy_object\nh5p_set_core_write_tracking\nh5p_set_create_intermediate_group\nh5p_set_data_transform\nh5p_set_deflate\nh5p_set_driver\nh5p_set_dset_no_attrs_hint\nh5p_set_dxpl_mpio\nh5p_set_edc_check\nh5p_set_efile_prefix\nh5p_set_elink_acc_flags\nh5p_set_elink_cb\nh5p_set_elink_fapl\nh5p_set_elink_file_cache_size\nh5p_set_elink_prefix\nh5p_set_est_link_info\nh5p_set_evict_on_close\nh5p_set_external\nh5p_set_family_offset\nh5p_set_fapl_core\nh5p_set_fapl_family\nh5p_set_fapl_hdfs\nh5p_set_fapl_log\nh5p_set_fapl_mpio\nh5p_set_fapl_multi\nh5p_set_fapl_ros3\nh5p_set_fapl_sec2\nh5p_set_fapl_split\nh5p_set_fapl_splitter\nh5p_set_fapl_stdio\nh5p_set_fapl_windows\nh5p_set_fclose_degree\nh5p_set_file_image\nh5p_set_file_image_callbacks\nh5p_set_file_locking\nh5p_set_file_space\nh5p_set_file_space_page_size\nh5p_set_file_space_strategy\nh5p_set_fill_time\nh5p_set_fill_value\nh5p_set_filter\nh5p_set_filter_callback\nh5p_set_fletcher32\nh5p_set_gc_references\nh5p_set_hyper_vector_size\nh5p_set_istore_k\nh5p_set_layout\nh5p_set_libver_bounds\nh5p_set_link_creation_order\nh5p_set_link_phase_change\nh5p_set_local_heap_size_hint\nh5p_set_mcdt_search_cb\nh5p_set_mdc_config\nh5p_set_mdc_image_config\nh5p_set_mdc_log_options\nh5p_set_meta_block_size\nh5p_set_metadata_read_attempts\nh5p_set_multi_type\nh5p_set_nbit\nh5p_set_nlinks\nh5p_set_obj_track_times\nh5p_set_object_flush_cb\nh5p_set_page_buffer_size\nh5p_set_preserve\nh5p_set_scaleoffset\nh5p_set_shared_mesg_index\nh5p_set_shared_mesg_nindexes\nh5p_set_shared_mesg_phase_change\nh5p_set_shuffle\nh5p_set_sieve_buf_size\nh5p_set_sizes\nh5p_set_small_data_block_size\nh5p_set_sym_k\nh5p_set_szip\nh5p_set_type_conv_cb\nh5p_set_userblock\nh5p_set_virtual\nh5p_set_virtual_prefix\nh5p_set_virtual_printf_gap\nh5p_set_virtual_view\nh5p_set_vlen_mem_manager\nh5p_set_vol\nh5p_unregister","category":"page"},{"location":"api_bindings/#HDF5.API.h5p_add_merge_committed_dtype_path","page":"Low-level library bindings","title":"HDF5.API.h5p_add_merge_committed_dtype_path","text":"h5p_add_merge_committed_dtype_path(plist_id::hid_t, path::Cstring)\n\nSee libhdf5 documentation for H5Padd_merge_committed_dtype_path.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_all_filters_avail","page":"Low-level library bindings","title":"HDF5.API.h5p_all_filters_avail","text":"h5p_all_filters_avail(plist_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pall_filters_avail.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_close","page":"Low-level library bindings","title":"HDF5.API.h5p_close","text":"h5p_close(id::hid_t)\n\nSee libhdf5 documentation for H5Pclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_close_class","page":"Low-level library bindings","title":"HDF5.API.h5p_close_class","text":"h5p_close_class(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pclose_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_copy","page":"Low-level library bindings","title":"HDF5.API.h5p_copy","text":"h5p_copy(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pcopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_copy_prop","page":"Low-level library bindings","title":"HDF5.API.h5p_copy_prop","text":"h5p_copy_prop(dst_id::hid_t, src_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Pcopy_prop.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_create","page":"Low-level library bindings","title":"HDF5.API.h5p_create","text":"h5p_create(cls_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_create_class","page":"Low-level library bindings","title":"HDF5.API.h5p_create_class","text":"h5p_create_class(parent::hid_t, name::Cstring, create::H5P_cls_create_func_t, create_data::Ptr{Cvoid}, copy::H5P_cls_copy_func_t, copy_data::Ptr{Cvoid}, close::H5P_cls_close_func_t, close_data::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Pcreate_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_decode","page":"Low-level library bindings","title":"HDF5.API.h5p_decode","text":"h5p_decode(buf::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Pdecode.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_encode","page":"Low-level library bindings","title":"HDF5.API.h5p_encode","text":"h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pencode1.\n\n\n\n\n\nh5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t}, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pencode2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_equal","page":"Low-level library bindings","title":"HDF5.API.h5p_equal","text":"h5p_equal(id1::hid_t, id2::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pequal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_exist","page":"Low-level library bindings","title":"HDF5.API.h5p_exist","text":"h5p_exist(plist_id::hid_t, name::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Pexist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_fill_value_defined","page":"Low-level library bindings","title":"HDF5.API.h5p_fill_value_defined","text":"h5p_fill_value_defined(plist::hid_t, status::Ptr{H5D_fill_value_t})\n\nSee libhdf5 documentation for H5Pfill_value_defined.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_free_merge_committed_dtype_paths","page":"Low-level library bindings","title":"HDF5.API.h5p_free_merge_committed_dtype_paths","text":"h5p_free_merge_committed_dtype_paths(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pfree_merge_committed_dtype_paths.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get","page":"Low-level library bindings","title":"HDF5.API.h5p_get","text":"h5p_get(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pget.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_alignment","page":"Low-level library bindings","title":"HDF5.API.h5p_get_alignment","text":"h5p_get_alignment(fapl_id::hid_t, threshold::Ref{hsize_t}, alignment::Ref{hsize_t})\n\nSee libhdf5 documentation for H5Pget_alignment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_alloc_time","page":"Low-level library bindings","title":"HDF5.API.h5p_get_alloc_time","text":"h5p_get_alloc_time(plist_id::hid_t, alloc_time::Ptr{Cint})\n\nSee libhdf5 documentation for H5Pget_alloc_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_append_flush","page":"Low-level library bindings","title":"HDF5.API.h5p_get_append_flush","text":"h5p_get_append_flush(dapl_id::hid_t, dims::Cuint, boundary::Ptr{hsize_t}, func::Ptr{H5D_append_cb_t}, udata::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_append_flush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_attr_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_get_attr_creation_order","text":"h5p_get_attr_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_attr_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_attr_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_attr_phase_change","text":"h5p_get_attr_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_attr_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_btree_ratios","page":"Low-level library bindings","title":"HDF5.API.h5p_get_btree_ratios","text":"h5p_get_btree_ratios(plist_id::hid_t, left::Ptr{Cdouble}, middle::Ptr{Cdouble}, right::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_btree_ratios.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_buffer","page":"Low-level library bindings","title":"HDF5.API.h5p_get_buffer","text":"h5p_get_buffer(plist_id::hid_t, tconv::Ptr{Ptr{Cvoid}}, bkg::Ptr{Ptr{Cvoid}}) -> Csize_t\n\nSee libhdf5 documentation for H5Pget_buffer.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_get_cache","text":"h5p_get_cache(plist_id::hid_t, mdc_nelmts::Ptr{Cint}, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_char_encoding","page":"Low-level library bindings","title":"HDF5.API.h5p_get_char_encoding","text":"h5p_get_char_encoding(plist_id::hid_t, encoding::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_char_encoding.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk","text":"h5p_get_chunk(plist_id::hid_t, n_dims::Cint, dims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Pget_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk_cache","text":"h5p_get_chunk_cache(dapl_id::hid_t, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_chunk_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk_opts","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk_opts","text":"h5p_get_chunk_opts(plist_id::hid_t, opts::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_chunk_opts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class","text":"h5p_get_class(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class_name","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class_name","text":"h5p_get_class_name(pcid::hid_t) -> String\n\nSee libhdf5 documentation for H5P_GET_CLASS_NAME.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class_parent","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class_parent","text":"h5p_get_class_parent(pclass_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_class_parent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_copy_object","page":"Low-level library bindings","title":"HDF5.API.h5p_get_copy_object","text":"h5p_get_copy_object(plist_id::hid_t, copy_options::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_copy_object.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_core_write_tracking","page":"Low-level library bindings","title":"HDF5.API.h5p_get_core_write_tracking","text":"h5p_get_core_write_tracking(fapl_id::hid_t, is_enabled::Ptr{hbool_t}, page_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_core_write_tracking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_create_intermediate_group","page":"Low-level library bindings","title":"HDF5.API.h5p_get_create_intermediate_group","text":"h5p_get_create_intermediate_group(lcpl_id::hid_t, crt_intermed_group::Ref{Cuint})\n\nSee libhdf5 documentation for H5Pget_create_intermediate_group.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_data_transform","page":"Low-level library bindings","title":"HDF5.API.h5p_get_data_transform","text":"h5p_get_data_transform(plist_id::hid_t, expression::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_data_transform.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_driver","page":"Low-level library bindings","title":"HDF5.API.h5p_get_driver","text":"h5p_get_driver(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_driver_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_driver_info","text":"h5p_get_driver_info(plist_id::hid_t) -> Ptr{Cvoid}\n\nSee libhdf5 documentation for H5Pget_driver_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_get_dset_no_attrs_hint","text":"h5p_get_dset_no_attrs_hint(dcpl_id::hid_t, minimize::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_dxpl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_get_dxpl_mpio","text":"h5p_get_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Ptr{Cint})\n\nSee libhdf5 documentation for H5Pget_dxpl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_edc_check","page":"Low-level library bindings","title":"HDF5.API.h5p_get_edc_check","text":"h5p_get_edc_check(plist_id::hid_t) -> H5Z_EDC_t\n\nSee libhdf5 documentation for H5Pget_edc_check.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_efile_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_efile_prefix","text":"h5p_get_efile_prefix(dapl_id::hid_t, prefix::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_efile_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_acc_flags","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_acc_flags","text":"h5p_get_elink_acc_flags(lapl_id::hid_t, flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_elink_acc_flags.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_cb","text":"h5p_get_elink_cb(lapl_id::hid_t, func::Ptr{H5L_elink_traverse_t}, op_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_elink_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_fapl","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_fapl","text":"h5p_get_elink_fapl(lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_elink_fapl.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_file_cache_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_file_cache_size","text":"h5p_get_elink_file_cache_size(plist_id::hid_t, efc_size::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_elink_file_cache_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_prefix","text":"h5p_get_elink_prefix(plist_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_elink_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_est_link_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_est_link_info","text":"h5p_get_est_link_info(plist_id::hid_t, est_num_entries::Ptr{Cuint}, est_name_len::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_est_link_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_evict_on_close","page":"Low-level library bindings","title":"HDF5.API.h5p_get_evict_on_close","text":"h5p_get_evict_on_close(fapl_id::hid_t, evict_on_close::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_evict_on_close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_external","page":"Low-level library bindings","title":"HDF5.API.h5p_get_external","text":"h5p_get_external(plist::hid_t, idx::Cuint, name_size::Csize_t, name::Ptr{Cuchar}, offset::Ptr{off_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_external_count","page":"Low-level library bindings","title":"HDF5.API.h5p_get_external_count","text":"h5p_get_external_count(plist::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_external_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_family_offset","page":"Low-level library bindings","title":"HDF5.API.h5p_get_family_offset","text":"h5p_get_family_offset(fapl_id::hid_t, offset::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_family_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_core","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_core","text":"h5p_get_fapl_core(fapl_id::hid_t, increment::Ptr{Csize_t}, backing_store::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_fapl_core.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_family","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_family","text":"h5p_get_fapl_family(fapl_id::hid_t, memb_size::Ptr{hsize_t}, memb_fapl_id::Ptr{hid_t})\n\nSee libhdf5 documentation for H5Pget_fapl_family.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_hdfs","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_hdfs","text":"h5p_get_fapl_hdfs(fapl_id::hid_t, fa_out::Ptr{H5FD_hdfs_fapl_t})\n\nSee libhdf5 documentation for H5Pget_fapl_hdfs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_mpio","text":"h5p_get_fapl_mpio(fapl_id::hid_t, comm::Ptr{MPI.MPI_Comm}, info::Ptr{MPI.MPI_Info})\n\nSee libhdf5 documentation for H5Pget_fapl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_multi","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_multi","text":"h5p_get_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Ptr{Cchar}}, memb_addr::Ptr{haddr_t}, relax::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_fapl_multi.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_ros3","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_ros3","text":"h5p_get_fapl_ros3(fapl_id::hid_t, fa_out::Ptr{H5FD_ros3_fapl_t})\n\nSee libhdf5 documentation for H5Pget_fapl_ros3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_splitter","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_splitter","text":"h5p_get_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})\n\nSee libhdf5 documentation for H5Pget_fapl_splitter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fclose_degree","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fclose_degree","text":"h5p_get_fclose_degree(fapl_id::hid_t, fc_degree::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_fclose_degree.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_image","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_image","text":"h5p_get_file_image(fapl_id::hid_t, buf_ptr_ptr::Ptr{Ptr{Cvoid}}, buf_len_ptr::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_image_callbacks","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_image_callbacks","text":"h5p_get_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})\n\nSee libhdf5 documentation for H5Pget_file_image_callbacks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_locking","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_locking","text":"h5p_get_file_locking(fapl_id::hid_t, use_file_locking::Ptr{hbool_t}, ignore_when_disabled::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_file_locking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space","text":"h5p_get_file_space(plist_id::hid_t, strategy::Ptr{H5F_file_space_type_t}, threshold::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space_page_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space_page_size","text":"h5p_get_file_space_page_size(plist_id::hid_t, fsp_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space_page_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space_strategy","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space_strategy","text":"h5p_get_file_space_strategy(plist_id::hid_t, strategy::Ptr{H5F_fspace_strategy_t}, persist::Ptr{hbool_t}, threshold::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space_strategy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fill_time","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fill_time","text":"h5p_get_fill_time(plist_id::hid_t, fill_time::Ptr{H5D_fill_time_t})\n\nSee libhdf5 documentation for H5Pget_fill_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fill_value","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fill_value","text":"h5p_get_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pget_fill_value.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_get_filter","text":"h5p_get_filter(plist_id::hid_t, idx::Cuint, flags::Ptr{Cuint}, cd_nemlts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{Cchar}, filter_config::Ptr{Cuint}) -> H5Z_filter_t\n\nSee libhdf5 documentation for H5Pget_filter2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_filter_by_id","page":"Low-level library bindings","title":"HDF5.API.h5p_get_filter_by_id","text":"h5p_get_filter_by_id(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Ref{Cuint}, cd_nelmts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{UInt8}, filter_config::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_filter_by_id2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_gc_references","page":"Low-level library bindings","title":"HDF5.API.h5p_get_gc_references","text":"h5p_get_gc_references(fapl_id::hid_t, gc_ref::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_gc_references.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_hyper_vector_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_hyper_vector_size","text":"h5p_get_hyper_vector_size(fapl_id::hid_t, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_hyper_vector_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_istore_k","page":"Low-level library bindings","title":"HDF5.API.h5p_get_istore_k","text":"h5p_get_istore_k(plist_id::hid_t, ik::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_istore_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_layout","page":"Low-level library bindings","title":"HDF5.API.h5p_get_layout","text":"h5p_get_layout(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_layout.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5p_get_libver_bounds","text":"h5p_get_libver_bounds(fapl_id::hid_t, low::Ref{Cint}, high::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_link_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_get_link_creation_order","text":"h5p_get_link_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_link_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_link_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_link_phase_change","text":"h5p_get_link_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_link_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_local_heap_size_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_get_local_heap_size_hint","text":"h5p_get_local_heap_size_hint(plist_id::hid_t, size_hint::Ref{Csize_t})\n\nSee libhdf5 documentation for H5Pget_local_heap_size_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mcdt_search_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mcdt_search_cb","text":"h5p_get_mcdt_search_cb(plist_id::hid_t, func::Ptr{H5O_mcdt_search_cb_t}, op_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_mcdt_search_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_config","text":"h5p_get_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Pget_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_image_config","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_image_config","text":"h5p_get_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})\n\nSee libhdf5 documentation for H5Pget_mdc_image_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_log_options","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_log_options","text":"h5p_get_mdc_log_options(plist_id::hid_t, is_enabled::Ptr{hbool_t}, location::Ptr{Cchar}, location_size::Ptr{Csize_t}, start_on_access::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_mdc_log_options.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_meta_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_meta_block_size","text":"h5p_get_meta_block_size(fapl_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_meta_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_metadata_read_attempts","page":"Low-level library bindings","title":"HDF5.API.h5p_get_metadata_read_attempts","text":"h5p_get_metadata_read_attempts(plist_id::hid_t, attempts::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_metadata_read_attempts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_multi_type","page":"Low-level library bindings","title":"HDF5.API.h5p_get_multi_type","text":"h5p_get_multi_type(fapl_id::hid_t, type::Ptr{H5FD_mem_t})\n\nSee libhdf5 documentation for H5Pget_multi_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nfilters","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nfilters","text":"h5p_get_nfilters(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_nfilters.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nlinks","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nlinks","text":"h5p_get_nlinks(plist_id::hid_t, nlinks::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_nlinks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nprops","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nprops","text":"h5p_get_nprops(id::hid_t, nprops::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_nprops.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_obj_track_times","page":"Low-level library bindings","title":"HDF5.API.h5p_get_obj_track_times","text":"h5p_get_obj_track_times(plist_id::hid_t, track_times::Ref{UInt8})\n\nSee libhdf5 documentation for H5Pget_obj_track_times.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_object_flush_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_object_flush_cb","text":"h5p_get_object_flush_cb(plist_id::hid_t, func::Ptr{H5F_flush_cb_t}, udata::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_object_flush_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_page_buffer_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_page_buffer_size","text":"h5p_get_page_buffer_size(plist_id::hid_t, buf_size::Ptr{Csize_t}, min_meta_perc::Ptr{Cuint}, min_raw_perc::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_page_buffer_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_preserve","page":"Low-level library bindings","title":"HDF5.API.h5p_get_preserve","text":"h5p_get_preserve(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_preserve.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_index","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_index","text":"h5p_get_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Ptr{Cuint}, min_mesg_size::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_nindexes","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_nindexes","text":"h5p_get_shared_mesg_nindexes(plist_id::hid_t, nindexes::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_nindexes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_phase_change","text":"h5p_get_shared_mesg_phase_change(plist_id::hid_t, max_list::Ptr{Cuint}, min_btree::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sieve_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sieve_buf_size","text":"h5p_get_sieve_buf_size(fapl_id::hid_t, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_sieve_buf_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_size","text":"h5p_get_size(id::hid_t, name::Ptr{Cchar}, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sizes","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sizes","text":"h5p_get_sizes(plist_id::hid_t, sizeof_addr::Ptr{Csize_t}, sizeof_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_sizes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_small_data_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_small_data_block_size","text":"h5p_get_small_data_block_size(fapl_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_small_data_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sym_k","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sym_k","text":"h5p_get_sym_k(plist_id::hid_t, ik::Ptr{Cuint}, lk::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_sym_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_type_conv_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_type_conv_cb","text":"h5p_get_type_conv_cb(dxpl_id::hid_t, op::Ptr{H5T_conv_except_func_t}, operate_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_type_conv_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_userblock","page":"Low-level library bindings","title":"HDF5.API.h5p_get_userblock","text":"h5p_get_userblock(plist_id::hid_t, len::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_userblock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_version","page":"Low-level library bindings","title":"HDF5.API.h5p_get_version","text":"h5p_get_version(plist_id::hid_t, boot::Ptr{Cuint}, freelist::Ptr{Cuint}, stab::Ptr{Cuint}, shhdr::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_version.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_count","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_count","text":"h5p_get_virtual_count(dcpl_id::hid_t, count::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_virtual_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_dsetname","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_dsetname","text":"h5p_get_virtual_dsetname(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_dsetname.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_filename","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_filename","text":"h5p_get_virtual_filename(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_filename.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_prefix","text":"h5p_get_virtual_prefix(dapl_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_printf_gap","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_printf_gap","text":"h5p_get_virtual_printf_gap(dapl_id::hid_t, gap_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_virtual_printf_gap.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_srcspace","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_srcspace","text":"h5p_get_virtual_srcspace(dcpl_id::hid_t, index::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_virtual_srcspace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_view","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_view","text":"h5p_get_virtual_view(dapl_id::hid_t, view::Ptr{H5D_vds_view_t})\n\nSee libhdf5 documentation for H5Pget_virtual_view.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_vspace","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_vspace","text":"h5p_get_virtual_vspace(dcpl_id::hid_t, index::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_virtual_vspace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vlen_mem_manager","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vlen_mem_manager","text":"h5p_get_vlen_mem_manager(plist_id::hid_t, alloc_func::Ptr{H5MM_allocate_t}, alloc_info::Ptr{Ptr{Cvoid}}, free_func::Ptr{H5MM_free_t}, free_info::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_vlen_mem_manager.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vol_id","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vol_id","text":"h5p_get_vol_id(plist_id::hid_t, vol_id::Ptr{hid_t})\n\nSee libhdf5 documentation for H5Pget_vol_id.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vol_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vol_info","text":"h5p_get_vol_info(plist_id::hid_t, vol_info::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_vol_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_insert","page":"Low-level library bindings","title":"HDF5.API.h5p_insert","text":"h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_delete::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pinsert1.\n\n\n\n\n\nh5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pinsert2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_isa_class","page":"Low-level library bindings","title":"HDF5.API.h5p_isa_class","text":"h5p_isa_class(plist_id::hid_t, pclass_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pisa_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_iterate","page":"Low-level library bindings","title":"HDF5.API.h5p_iterate","text":"h5p_iterate(id::hid_t, idx::Ptr{Cint}, iter_func::H5P_iterate_t, iter_data::Ptr{Cvoid}) -> Int\n\nSee libhdf5 documentation for H5Piterate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_modify_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_modify_filter","text":"h5p_modify_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pmodify_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_register","page":"Low-level library bindings","title":"HDF5.API.h5p_register","text":"h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, prp_create::H5P_prp_create_func_t, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pregister1.\n\n\n\n\n\nh5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, create::H5P_prp_create_func_t, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pregister2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_remove","page":"Low-level library bindings","title":"HDF5.API.h5p_remove","text":"h5p_remove(plist_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Premove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_remove_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_remove_filter","text":"h5p_remove_filter(plist_id::hid_t, filter_id::H5Z_filter_t)\n\nSee libhdf5 documentation for H5Premove_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set","page":"Low-level library bindings","title":"HDF5.API.h5p_set","text":"h5p_set(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_alignment","page":"Low-level library bindings","title":"HDF5.API.h5p_set_alignment","text":"h5p_set_alignment(plist_id::hid_t, threshold::hsize_t, alignment::hsize_t)\n\nSee libhdf5 documentation for H5Pset_alignment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_alloc_time","page":"Low-level library bindings","title":"HDF5.API.h5p_set_alloc_time","text":"h5p_set_alloc_time(plist_id::hid_t, alloc_time::Cint)\n\nSee libhdf5 documentation for H5Pset_alloc_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_append_flush","page":"Low-level library bindings","title":"HDF5.API.h5p_set_append_flush","text":"h5p_set_append_flush(dapl_id::hid_t, ndims::Cuint, boundary::Ptr{hsize_t}, func::H5D_append_cb_t, udata::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_append_flush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_attr_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_set_attr_creation_order","text":"h5p_set_attr_creation_order(plist_id::hid_t, crt_order_flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_attr_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_attr_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_attr_phase_change","text":"h5p_set_attr_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)\n\nSee libhdf5 documentation for H5Pset_attr_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_btree_ratios","page":"Low-level library bindings","title":"HDF5.API.h5p_set_btree_ratios","text":"h5p_set_btree_ratios(plist_id::hid_t, left::Cdouble, middle::Cdouble, right::Cdouble)\n\nSee libhdf5 documentation for H5Pset_btree_ratios.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_buffer","page":"Low-level library bindings","title":"HDF5.API.h5p_set_buffer","text":"h5p_set_buffer(plist_id::hid_t, size::Csize_t, tconv::Ptr{Cvoid}, bkg::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_buffer.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_set_cache","text":"h5p_set_cache(plist_id::hid_t, mdc_nelmts::Cint, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)\n\nSee libhdf5 documentation for H5Pset_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_char_encoding","page":"Low-level library bindings","title":"HDF5.API.h5p_set_char_encoding","text":"h5p_set_char_encoding(plist_id::hid_t, encoding::Cint)\n\nSee libhdf5 documentation for H5Pset_char_encoding.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk","text":"h5p_set_chunk(plist_id::hid_t, ndims::Cint, dims::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pset_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk_cache","text":"h5p_set_chunk_cache(dapl_id::hid_t, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)\n\nSee libhdf5 documentation for H5Pset_chunk_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk_opts","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk_opts","text":"h5p_set_chunk_opts(plist_id::hid_t, opts::Cuint)\n\nSee libhdf5 documentation for H5Pset_chunk_opts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_copy_object","page":"Low-level library bindings","title":"HDF5.API.h5p_set_copy_object","text":"h5p_set_copy_object(plist_id::hid_t, copy_options::Cuint)\n\nSee libhdf5 documentation for H5Pset_copy_object.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_core_write_tracking","page":"Low-level library bindings","title":"HDF5.API.h5p_set_core_write_tracking","text":"h5p_set_core_write_tracking(fapl_id::hid_t, is_enabled::hbool_t, page_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_core_write_tracking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_create_intermediate_group","page":"Low-level library bindings","title":"HDF5.API.h5p_set_create_intermediate_group","text":"h5p_set_create_intermediate_group(plist_id::hid_t, setting::Cuint)\n\nSee libhdf5 documentation for H5Pset_create_intermediate_group.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_data_transform","page":"Low-level library bindings","title":"HDF5.API.h5p_set_data_transform","text":"h5p_set_data_transform(plist_id::hid_t, expression::Cstring)\n\nSee libhdf5 documentation for H5Pset_data_transform.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_deflate","page":"Low-level library bindings","title":"HDF5.API.h5p_set_deflate","text":"h5p_set_deflate(plist_id::hid_t, setting::Cuint)\n\nSee libhdf5 documentation for H5Pset_deflate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_driver","page":"Low-level library bindings","title":"HDF5.API.h5p_set_driver","text":"h5p_set_driver(plist_id::hid_t, driver_id::hid_t, driver_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_set_dset_no_attrs_hint","text":"h5p_set_dset_no_attrs_hint(dcpl_id::hid_t, minimize::hbool_t)\n\nSee libhdf5 documentation for H5Pset_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_dxpl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_dxpl_mpio","text":"h5p_set_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Cint)\n\nSee libhdf5 documentation for H5Pset_dxpl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_edc_check","page":"Low-level library bindings","title":"HDF5.API.h5p_set_edc_check","text":"h5p_set_edc_check(plist_id::hid_t, check::H5Z_EDC_t)\n\nSee libhdf5 documentation for H5Pset_edc_check.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_efile_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_efile_prefix","text":"h5p_set_efile_prefix(plist_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_efile_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_acc_flags","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_acc_flags","text":"h5p_set_elink_acc_flags(lapl_id::hid_t, flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_elink_acc_flags.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_cb","text":"h5p_set_elink_cb(lapl_id::hid_t, func::H5L_elink_traverse_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_elink_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_fapl","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_fapl","text":"h5p_set_elink_fapl(lapl_id::hid_t, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_elink_fapl.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_file_cache_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_file_cache_size","text":"h5p_set_elink_file_cache_size(plist_id::hid_t, efc_size::Cuint)\n\nSee libhdf5 documentation for H5Pset_elink_file_cache_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_prefix","text":"h5p_set_elink_prefix(plist_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_elink_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_est_link_info","page":"Low-level library bindings","title":"HDF5.API.h5p_set_est_link_info","text":"h5p_set_est_link_info(plist_id::hid_t, est_num_entries::Cuint, est_name_len::Cuint)\n\nSee libhdf5 documentation for H5Pset_est_link_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_evict_on_close","page":"Low-level library bindings","title":"HDF5.API.h5p_set_evict_on_close","text":"h5p_set_evict_on_close(fapl_id::hid_t, evict_on_close::hbool_t)\n\nSee libhdf5 documentation for H5Pset_evict_on_close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_external","page":"Low-level library bindings","title":"HDF5.API.h5p_set_external","text":"h5p_set_external(plist_id::hid_t, name::Cstring, offset::off_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_family_offset","page":"Low-level library bindings","title":"HDF5.API.h5p_set_family_offset","text":"h5p_set_family_offset(fapl_id::hid_t, offset::hsize_t)\n\nSee libhdf5 documentation for H5Pset_family_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_core","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_core","text":"h5p_set_fapl_core(fapl_id::hid_t, increment::Csize_t, backing_store::hbool_t)\n\nSee libhdf5 documentation for H5Pset_fapl_core.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_family","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_family","text":"h5p_set_fapl_family(fapl_id::hid_t, memb_size::hsize_t, memb_fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_family.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_hdfs","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_hdfs","text":"h5p_set_fapl_hdfs(fapl_id::hid_t, fa::Ptr{H5FD_hdfs_fapl_t})\n\nSee libhdf5 documentation for H5Pset_fapl_hdfs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_log","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_log","text":"h5p_set_fapl_log(fapl_id::hid_t, logfile::Cstring, flags::Culonglong, buf_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_fapl_log.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_mpio","text":"h5p_set_fapl_mpio(fapl_id::hid_t, comm::MPI.MPI_Comm, info::MPI.MPI_Info)\n\nSee libhdf5 documentation for H5Pset_fapl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_multi","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_multi","text":"h5p_set_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Cstring}, memb_addr::Ptr{haddr_t}, relax::hbool_t)\n\nSee libhdf5 documentation for H5Pset_fapl_multi.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_ros3","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_ros3","text":"h5p_set_fapl_ros3(fapl_id::hid_t, fa::Ptr{H5FD_ros3_fapl_t})\n\nSee libhdf5 documentation for H5Pset_fapl_ros3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_sec2","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_sec2","text":"h5p_set_fapl_sec2(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_sec2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_split","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_split","text":"h5p_set_fapl_split(fapl::hid_t, meta_ext::Cstring, meta_plist_id::hid_t, raw_ext::Cstring, raw_plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_split.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_splitter","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_splitter","text":"h5p_set_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})\n\nSee libhdf5 documentation for H5Pset_fapl_splitter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_stdio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_stdio","text":"h5p_set_fapl_stdio(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_stdio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_windows","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_windows","text":"h5p_set_fapl_windows(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_windows.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fclose_degree","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fclose_degree","text":"h5p_set_fclose_degree(plist_id::hid_t, fc_degree::Cint)\n\nSee libhdf5 documentation for H5Pset_fclose_degree.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_image","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_image","text":"h5p_set_file_image(fapl_id::hid_t, buf_ptr::Ptr{Cvoid}, buf_len::Csize_t)\n\nSee libhdf5 documentation for H5Pset_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_image_callbacks","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_image_callbacks","text":"h5p_set_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})\n\nSee libhdf5 documentation for H5Pset_file_image_callbacks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_locking","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_locking","text":"h5p_set_file_locking(fapl_id::hid_t, use_file_locking::hbool_t, ignore_when_disabled::hbool_t)\n\nSee libhdf5 documentation for H5Pset_file_locking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space","text":"h5p_set_file_space(plist_id::hid_t, strategy::H5F_file_space_type_t, threshold::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space_page_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space_page_size","text":"h5p_set_file_space_page_size(plist_id::hid_t, fsp_size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space_page_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space_strategy","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space_strategy","text":"h5p_set_file_space_strategy(plist_id::hid_t, strategy::H5F_fspace_strategy_t, persist::hbool_t, threshold::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space_strategy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fill_time","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fill_time","text":"h5p_set_fill_time(plist_id::hid_t, fill_time::H5D_fill_time_t)\n\nSee libhdf5 documentation for H5Pset_fill_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fill_value","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fill_value","text":"h5p_set_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_fill_value.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_set_filter","text":"h5p_set_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pset_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_filter_callback","page":"Low-level library bindings","title":"HDF5.API.h5p_set_filter_callback","text":"h5p_set_filter_callback(plist_id::hid_t, func::H5Z_filter_func_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_filter_callback.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fletcher32","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fletcher32","text":"h5p_set_fletcher32(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fletcher32.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_gc_references","page":"Low-level library bindings","title":"HDF5.API.h5p_set_gc_references","text":"h5p_set_gc_references(fapl_id::hid_t, gc_ref::Cuint)\n\nSee libhdf5 documentation for H5Pset_gc_references.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_hyper_vector_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_hyper_vector_size","text":"h5p_set_hyper_vector_size(plist_id::hid_t, size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_hyper_vector_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_istore_k","page":"Low-level library bindings","title":"HDF5.API.h5p_set_istore_k","text":"h5p_set_istore_k(plist_id::hid_t, ik::Cuint)\n\nSee libhdf5 documentation for H5Pset_istore_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_layout","page":"Low-level library bindings","title":"HDF5.API.h5p_set_layout","text":"h5p_set_layout(plist_id::hid_t, setting::Cint)\n\nSee libhdf5 documentation for H5Pset_layout.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5p_set_libver_bounds","text":"h5p_set_libver_bounds(fapl_id::hid_t, low::Cint, high::Cint)\n\nSee libhdf5 documentation for H5Pset_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_link_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_set_link_creation_order","text":"h5p_set_link_creation_order(plist_id::hid_t, crt_order_flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_link_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_link_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_link_phase_change","text":"h5p_set_link_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)\n\nSee libhdf5 documentation for H5Pset_link_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_local_heap_size_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_set_local_heap_size_hint","text":"h5p_set_local_heap_size_hint(plist_id::hid_t, size_hint::Csize_t)\n\nSee libhdf5 documentation for H5Pset_local_heap_size_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mcdt_search_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mcdt_search_cb","text":"h5p_set_mcdt_search_cb(plist_id::hid_t, func::H5O_mcdt_search_cb_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_mcdt_search_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_config","text":"h5p_set_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Pset_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_image_config","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_image_config","text":"h5p_set_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})\n\nSee libhdf5 documentation for H5Pset_mdc_image_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_log_options","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_log_options","text":"h5p_set_mdc_log_options(plist_id::hid_t, is_enabled::hbool_t, location::Cstring, start_on_access::hbool_t)\n\nSee libhdf5 documentation for H5Pset_mdc_log_options.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_meta_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_meta_block_size","text":"h5p_set_meta_block_size(fapl_id::hid_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_meta_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_metadata_read_attempts","page":"Low-level library bindings","title":"HDF5.API.h5p_set_metadata_read_attempts","text":"h5p_set_metadata_read_attempts(plist_id::hid_t, attempts::Cuint)\n\nSee libhdf5 documentation for H5Pset_metadata_read_attempts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_multi_type","page":"Low-level library bindings","title":"HDF5.API.h5p_set_multi_type","text":"h5p_set_multi_type(fapl_id::hid_t, type::H5FD_mem_t)\n\nSee libhdf5 documentation for H5Pset_multi_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_nbit","page":"Low-level library bindings","title":"HDF5.API.h5p_set_nbit","text":"h5p_set_nbit(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_nbit.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_nlinks","page":"Low-level library bindings","title":"HDF5.API.h5p_set_nlinks","text":"h5p_set_nlinks(plist_id::hid_t, nlinks::Csize_t)\n\nSee libhdf5 documentation for H5Pset_nlinks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_obj_track_times","page":"Low-level library bindings","title":"HDF5.API.h5p_set_obj_track_times","text":"h5p_set_obj_track_times(plist_id::hid_t, track_times::UInt8)\n\nSee libhdf5 documentation for H5Pset_obj_track_times.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_object_flush_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_object_flush_cb","text":"h5p_set_object_flush_cb(plist_id::hid_t, func::H5F_flush_cb_t, udata::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_object_flush_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_page_buffer_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_page_buffer_size","text":"h5p_set_page_buffer_size(plist_id::hid_t, buf_size::Csize_t, min_meta_per::Cuint, min_raw_per::Cuint)\n\nSee libhdf5 documentation for H5Pset_page_buffer_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_preserve","page":"Low-level library bindings","title":"HDF5.API.h5p_set_preserve","text":"h5p_set_preserve(plist_id::hid_t, status::hbool_t)\n\nSee libhdf5 documentation for H5Pset_preserve.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_scaleoffset","page":"Low-level library bindings","title":"HDF5.API.h5p_set_scaleoffset","text":"h5p_set_scaleoffset(plist_id::hid_t, scale_type::Cint, scale_factor::Cint)\n\nSee libhdf5 documentation for H5Pset_scaleoffset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_index","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_index","text":"h5p_set_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Cuint, min_mesg_size::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_nindexes","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_nindexes","text":"h5p_set_shared_mesg_nindexes(plist_id::hid_t, nindexes::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_nindexes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_phase_change","text":"h5p_set_shared_mesg_phase_change(plist_id::hid_t, max_list::Cuint, min_btree::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shuffle","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shuffle","text":"h5p_set_shuffle(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_shuffle.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sieve_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sieve_buf_size","text":"h5p_set_sieve_buf_size(fapl_id::hid_t, size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_sieve_buf_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sizes","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sizes","text":"h5p_set_sizes(plist_id::hid_t, sizeof_addr::Csize_t, sizeof_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_sizes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_small_data_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_small_data_block_size","text":"h5p_set_small_data_block_size(fapl_id::hid_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_small_data_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sym_k","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sym_k","text":"h5p_set_sym_k(plist_id::hid_t, ik::Cuint, lk::Cuint)\n\nSee libhdf5 documentation for H5Pset_sym_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_szip","page":"Low-level library bindings","title":"HDF5.API.h5p_set_szip","text":"h5p_set_szip(plist_id::hid_t, options_mask::Cuint, pixels_per_block::Cuint)\n\nSee libhdf5 documentation for H5Pset_szip.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_type_conv_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_type_conv_cb","text":"h5p_set_type_conv_cb(dxpl_id::hid_t, op::H5T_conv_except_func_t, operate_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_type_conv_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_userblock","page":"Low-level library bindings","title":"HDF5.API.h5p_set_userblock","text":"h5p_set_userblock(plist_id::hid_t, len::hsize_t)\n\nSee libhdf5 documentation for H5Pset_userblock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual","text":"h5p_set_virtual(dcpl_id::hid_t, vspace_id::hid_t, src_file_name::Cstring, src_dset_name::Cstring, src_space_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_virtual.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_prefix","text":"h5p_set_virtual_prefix(dapl_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_virtual_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_printf_gap","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_printf_gap","text":"h5p_set_virtual_printf_gap(dapl_id::hid_t, gap_size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_virtual_printf_gap.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_view","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_view","text":"h5p_set_virtual_view(dapl_id::hid_t, view::H5D_vds_view_t)\n\nSee libhdf5 documentation for H5Pset_virtual_view.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_vlen_mem_manager","page":"Low-level library bindings","title":"HDF5.API.h5p_set_vlen_mem_manager","text":"h5p_set_vlen_mem_manager(plist_id::hid_t, alloc_func::H5MM_allocate_t, alloc_info::Ptr{Cvoid}, free_func::H5MM_free_t, free_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_vlen_mem_manager.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_vol","page":"Low-level library bindings","title":"HDF5.API.h5p_set_vol","text":"h5p_set_vol(plist_id::hid_t, new_vol_id::hid_t, new_vol_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_vol.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_unregister","page":"Low-level library bindings","title":"HDF5.API.h5p_unregister","text":"h5p_unregister(pclass_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Punregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5R","page":"Low-level library bindings","title":"H5R — Reference Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5r_create\nh5r_dereference\nh5r_get_obj_type\nh5r_get_region","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5r_create\nh5r_dereference\nh5r_get_obj_type\nh5r_get_region","category":"page"},{"location":"api_bindings/#HDF5.API.h5r_create","page":"Low-level library bindings","title":"HDF5.API.h5r_create","text":"h5r_create(ref::Ptr{Cvoid}, loc_id::hid_t, pathname::Cstring, ref_type::Cint, space_id::hid_t)\n\nSee libhdf5 documentation for H5Rcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_dereference","page":"Low-level library bindings","title":"HDF5.API.h5r_dereference","text":"h5r_dereference(obj_id::hid_t, oapl_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Rdereference2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_get_obj_type","page":"Low-level library bindings","title":"HDF5.API.h5r_get_obj_type","text":"h5r_get_obj_type(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}, obj_type::Ptr{Cint})\n\nSee libhdf5 documentation for H5Rget_obj_type2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_get_region","page":"Low-level library bindings","title":"HDF5.API.h5r_get_region","text":"h5r_get_region(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Rget_region.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5S","page":"Low-level library bindings","title":"H5S — Dataspace Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5s_close\nh5s_combine_select\nh5s_copy\nh5s_create\nh5s_create_simple\nh5s_extent_equal\nh5s_get_regular_hyperslab\nh5s_get_select_hyper_nblocks\nh5s_get_select_npoints\nh5s_get_select_type\nh5s_get_simple_extent_dims\nh5s_get_simple_extent_ndims\nh5s_get_simple_extent_type\nh5s_is_regular_hyperslab\nh5s_is_simple\nh5s_select_hyperslab\nh5s_set_extent_simple","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5s_close\nh5s_combine_select\nh5s_copy\nh5s_create\nh5s_create_simple\nh5s_extent_equal\nh5s_get_regular_hyperslab\nh5s_get_select_hyper_nblocks\nh5s_get_select_npoints\nh5s_get_select_type\nh5s_get_simple_extent_dims\nh5s_get_simple_extent_ndims\nh5s_get_simple_extent_type\nh5s_is_regular_hyperslab\nh5s_is_simple\nh5s_select_hyperslab\nh5s_set_extent_simple","category":"page"},{"location":"api_bindings/#HDF5.API.h5s_close","page":"Low-level library bindings","title":"HDF5.API.h5s_close","text":"h5s_close(space_id::hid_t)\n\nSee libhdf5 documentation for H5Sclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_combine_select","page":"Low-level library bindings","title":"HDF5.API.h5s_combine_select","text":"h5s_combine_select(space1_id::hid_t, op::Cint, space2_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Scombine_select.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_copy","page":"Low-level library bindings","title":"HDF5.API.h5s_copy","text":"h5s_copy(space_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Scopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_create","page":"Low-level library bindings","title":"HDF5.API.h5s_create","text":"h5s_create(class::Cint) -> hid_t\n\nSee libhdf5 documentation for H5Screate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_create_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_create_simple","text":"h5s_create_simple(rank::Cint, current_dims::Ptr{hsize_t}, maximum_dims::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Screate_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_extent_equal","page":"Low-level library bindings","title":"HDF5.API.h5s_extent_equal","text":"h5s_extent_equal(space1_id::hid_t, space2_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sextent_equal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_regular_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_get_regular_hyperslab","text":"h5s_get_regular_hyperslab(space_id::hid_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sget_regular_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_hyper_nblocks","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_hyper_nblocks","text":"h5s_get_select_hyper_nblocks(space_id::hid_t) -> hssize_t\n\nSee libhdf5 documentation for H5Sget_select_hyper_nblocks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_npoints","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_npoints","text":"h5s_get_select_npoints(space_id::hid_t) -> hsize_t\n\nSee libhdf5 documentation for H5Sget_select_npoints.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_type","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_type","text":"h5s_get_select_type(space_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Sget_select_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_dims","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_dims","text":"h5s_get_simple_extent_dims(space_id::hid_t, dims::Ptr{hsize_t}, maxdims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Sget_simple_extent_dims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_ndims","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_ndims","text":"h5s_get_simple_extent_ndims(space_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Sget_simple_extent_ndims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_type","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_type","text":"h5s_get_simple_extent_type(space_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Sget_simple_extent_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_is_regular_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_is_regular_hyperslab","text":"h5s_is_regular_hyperslab(space_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sis_regular_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_is_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_is_simple","text":"h5s_is_simple(space_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sis_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_select_hyperslab","text":"h5s_select_hyperslab(dspace_id::hid_t, seloper::Cint, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sselect_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_set_extent_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_set_extent_simple","text":"h5s_set_extent_simple(dspace_id::hid_t, rank::Cint, current_size::Ptr{hsize_t}, maximum_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sset_extent_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5T","page":"Low-level library bindings","title":"H5T — Datatype Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5t_array_create\nh5t_close\nh5t_commit\nh5t_committed\nh5t_copy\nh5t_create\nh5t_enum_insert\nh5t_equal\nh5t_get_array_dims\nh5t_get_array_ndims\nh5t_get_class\nh5t_get_cset\nh5t_get_ebias\nh5t_get_fields\nh5t_get_member_class\nh5t_get_member_index\nh5t_get_member_name\nh5t_get_member_offset\nh5t_get_member_type\nh5t_get_native_type\nh5t_get_nmembers\nh5t_get_offset\nh5t_get_order\nh5t_get_precision\nh5t_get_sign\nh5t_get_size\nh5t_get_strpad\nh5t_get_super\nh5t_get_tag\nh5t_insert\nh5t_is_variable_str\nh5t_lock\nh5t_open\nh5t_set_cset\nh5t_set_ebias\nh5t_set_fields\nh5t_set_offset\nh5t_set_order\nh5t_set_precision\nh5t_set_size\nh5t_set_strpad\nh5t_set_tag\nh5t_vlen_create","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5t_array_create\nh5t_close\nh5t_commit\nh5t_committed\nh5t_copy\nh5t_create\nh5t_enum_insert\nh5t_equal\nh5t_get_array_dims\nh5t_get_array_ndims\nh5t_get_class\nh5t_get_cset\nh5t_get_ebias\nh5t_get_fields\nh5t_get_member_class\nh5t_get_member_index\nh5t_get_member_name\nh5t_get_member_offset\nh5t_get_member_type\nh5t_get_native_type\nh5t_get_nmembers\nh5t_get_offset\nh5t_get_order\nh5t_get_precision\nh5t_get_sign\nh5t_get_size\nh5t_get_strpad\nh5t_get_super\nh5t_get_tag\nh5t_insert\nh5t_is_variable_str\nh5t_lock\nh5t_open\nh5t_set_cset\nh5t_set_ebias\nh5t_set_fields\nh5t_set_offset\nh5t_set_order\nh5t_set_precision\nh5t_set_size\nh5t_set_strpad\nh5t_set_tag\nh5t_vlen_create","category":"page"},{"location":"api_bindings/#HDF5.API.h5t_array_create","page":"Low-level library bindings","title":"HDF5.API.h5t_array_create","text":"h5t_array_create(basetype_id::hid_t, ndims::Cuint, sz::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Tarray_create2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_close","page":"Low-level library bindings","title":"HDF5.API.h5t_close","text":"h5t_close(dtype_id::hid_t)\n\nSee libhdf5 documentation for H5Tclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_commit","page":"Low-level library bindings","title":"HDF5.API.h5t_commit","text":"h5t_commit(loc_id::hid_t, name::Cstring, dtype_id::hid_t, lcpl_id::hid_t, tcpl_id::hid_t, tapl_id::hid_t)\n\nSee libhdf5 documentation for H5Tcommit2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_committed","page":"Low-level library bindings","title":"HDF5.API.h5t_committed","text":"h5t_committed(dtype_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tcommitted.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_copy","page":"Low-level library bindings","title":"HDF5.API.h5t_copy","text":"h5t_copy(dtype_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tcopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_create","page":"Low-level library bindings","title":"HDF5.API.h5t_create","text":"h5t_create(class_id::Cint, sz::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Tcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_enum_insert","page":"Low-level library bindings","title":"HDF5.API.h5t_enum_insert","text":"h5t_enum_insert(dtype_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Tenum_insert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_equal","page":"Low-level library bindings","title":"HDF5.API.h5t_equal","text":"h5t_equal(dtype_id1::hid_t, dtype_id2::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tequal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_array_dims","page":"Low-level library bindings","title":"HDF5.API.h5t_get_array_dims","text":"h5t_get_array_dims(dtype_id::hid_t, dims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Tget_array_dims2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_array_ndims","page":"Low-level library bindings","title":"HDF5.API.h5t_get_array_ndims","text":"h5t_get_array_ndims(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_array_ndims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_class","page":"Low-level library bindings","title":"HDF5.API.h5t_get_class","text":"h5t_get_class(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_cset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_cset","text":"h5t_get_cset(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_cset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_ebias","page":"Low-level library bindings","title":"HDF5.API.h5t_get_ebias","text":"h5t_get_ebias(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_ebias.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_fields","page":"Low-level library bindings","title":"HDF5.API.h5t_get_fields","text":"h5t_get_fields(dtype_id::hid_t, spos::Ref{Csize_t}, epos::Ref{Csize_t}, esize::Ref{Csize_t}, mpos::Ref{Csize_t}, msize::Ref{Csize_t})\n\nSee libhdf5 documentation for H5Tget_fields.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_class","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_class","text":"h5t_get_member_class(dtype_id::hid_t, index::Cuint) -> Int\n\nSee libhdf5 documentation for H5Tget_member_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_index","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_index","text":"h5t_get_member_index(dtype_id::hid_t, membername::Cstring) -> Int\n\nSee libhdf5 documentation for H5Tget_member_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_name","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_name","text":"h5t_get_member_name(type_id::hid_t, index::Cuint) -> String\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_offset","text":"h5t_get_member_offset(dtype_id::hid_t, index::Cuint) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_member_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_type","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_type","text":"h5t_get_member_type(dtype_id::hid_t, index::Cuint) -> hid_t\n\nSee libhdf5 documentation for H5Tget_member_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_native_type","page":"Low-level library bindings","title":"HDF5.API.h5t_get_native_type","text":"h5t_get_native_type(dtype_id::hid_t, direction::Cint) -> hid_t\n\nSee libhdf5 documentation for H5Tget_native_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_nmembers","page":"Low-level library bindings","title":"HDF5.API.h5t_get_nmembers","text":"h5t_get_nmembers(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_nmembers.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_offset","text":"h5t_get_offset(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_order","page":"Low-level library bindings","title":"HDF5.API.h5t_get_order","text":"h5t_get_order(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_precision","page":"Low-level library bindings","title":"HDF5.API.h5t_get_precision","text":"h5t_get_precision(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_precision.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_sign","page":"Low-level library bindings","title":"HDF5.API.h5t_get_sign","text":"h5t_get_sign(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_sign.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_size","page":"Low-level library bindings","title":"HDF5.API.h5t_get_size","text":"h5t_get_size(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_strpad","page":"Low-level library bindings","title":"HDF5.API.h5t_get_strpad","text":"h5t_get_strpad(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_strpad.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_super","page":"Low-level library bindings","title":"HDF5.API.h5t_get_super","text":"h5t_get_super(dtype_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tget_super.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_tag","page":"Low-level library bindings","title":"HDF5.API.h5t_get_tag","text":"h5t_get_tag(type_id::hid_t) -> String\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_insert","page":"Low-level library bindings","title":"HDF5.API.h5t_insert","text":"h5t_insert(dtype_id::hid_t, fieldname::Cstring, offset::Csize_t, field_id::hid_t)\n\nSee libhdf5 documentation for H5Tinsert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_is_variable_str","page":"Low-level library bindings","title":"HDF5.API.h5t_is_variable_str","text":"h5t_is_variable_str(type_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tis_variable_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_lock","page":"Low-level library bindings","title":"HDF5.API.h5t_lock","text":"h5t_lock(type_id::hid_t)\n\nSee libhdf5 documentation for H5Tlock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_open","page":"Low-level library bindings","title":"HDF5.API.h5t_open","text":"h5t_open(loc_id::hid_t, name::Cstring, tapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Topen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_cset","page":"Low-level library bindings","title":"HDF5.API.h5t_set_cset","text":"h5t_set_cset(dtype_id::hid_t, cset::Cint)\n\nSee libhdf5 documentation for H5Tset_cset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_ebias","page":"Low-level library bindings","title":"HDF5.API.h5t_set_ebias","text":"h5t_set_ebias(dtype_id::hid_t, ebias::Csize_t)\n\nSee libhdf5 documentation for H5Tset_ebias.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_fields","page":"Low-level library bindings","title":"HDF5.API.h5t_set_fields","text":"h5t_set_fields(dtype_id::hid_t, spos::Csize_t, epos::Csize_t, esize::Csize_t, mpos::Csize_t, msize::Csize_t)\n\nSee libhdf5 documentation for H5Tset_fields.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_set_offset","text":"h5t_set_offset(dtype_id::hid_t, offset::Csize_t)\n\nSee libhdf5 documentation for H5Tset_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_order","page":"Low-level library bindings","title":"HDF5.API.h5t_set_order","text":"h5t_set_order(dtype_id::hid_t, order::Cint)\n\nSee libhdf5 documentation for H5Tset_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_precision","page":"Low-level library bindings","title":"HDF5.API.h5t_set_precision","text":"h5t_set_precision(dtype_id::hid_t, sz::Csize_t)\n\nSee libhdf5 documentation for H5Tset_precision.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_size","page":"Low-level library bindings","title":"HDF5.API.h5t_set_size","text":"h5t_set_size(dtype_id::hid_t, sz::Csize_t)\n\nSee libhdf5 documentation for H5Tset_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_strpad","page":"Low-level library bindings","title":"HDF5.API.h5t_set_strpad","text":"h5t_set_strpad(dtype_id::hid_t, sz::Cint)\n\nSee libhdf5 documentation for H5Tset_strpad.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_tag","page":"Low-level library bindings","title":"HDF5.API.h5t_set_tag","text":"h5t_set_tag(dtype_id::hid_t, tag::Cstring)\n\nSee libhdf5 documentation for H5Tset_tag.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_vlen_create","page":"Low-level library bindings","title":"HDF5.API.h5t_vlen_create","text":"h5t_vlen_create(base_type_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tvlen_create.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5Z","page":"Low-level library bindings","title":"H5Z — Filter Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5z_filter_avail\nh5z_get_filter_info\nh5z_register\nh5z_unregister","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5z_filter_avail\nh5z_get_filter_info\nh5z_register\nh5z_unregister","category":"page"},{"location":"api_bindings/#HDF5.API.h5z_filter_avail","page":"Low-level library bindings","title":"HDF5.API.h5z_filter_avail","text":"h5z_filter_avail(id::H5Z_filter_t) -> Bool\n\nSee libhdf5 documentation for H5Zfilter_avail.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_get_filter_info","page":"Low-level library bindings","title":"HDF5.API.h5z_get_filter_info","text":"h5z_get_filter_info(filter::H5Z_filter_t, filter_config_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Zget_filter_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_register","page":"Low-level library bindings","title":"HDF5.API.h5z_register","text":"h5z_register(filter_class::Ref{H5Z_class_t})\n\nSee libhdf5 documentation for H5Zregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_unregister","page":"Low-level library bindings","title":"HDF5.API.h5z_unregister","text":"h5z_unregister(id::H5Z_filter_t)\n\nSee libhdf5 documentation for H5Zunregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5FD","page":"Low-level library bindings","title":"H5FD — File Drivers","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5fd_core_init\nh5fd_family_init\nh5fd_log_init\nh5fd_mpio_init\nh5fd_multi_init\nh5fd_sec2_init\nh5fd_stdio_init","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5fd_core_init\nh5fd_family_init\nh5fd_log_init\nh5fd_mpio_init\nh5fd_multi_init\nh5fd_sec2_init\nh5fd_stdio_init","category":"page"},{"location":"api_bindings/#HDF5.API.h5fd_core_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_core_init","text":"h5fd_core_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_CORE. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_family_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_family_init","text":"h5fd_family_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_FAMILY. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_log_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_log_init","text":"h5fd_log_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_LOG. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_mpio_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_mpio_init","text":"h5fd_mpio_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_MPIO. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_multi_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_multi_init","text":"h5fd_multi_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_MULTI. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_sec2_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_sec2_init","text":"h5fd_sec2_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_SEC2. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_stdio_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_stdio_init","text":"h5fd_stdio_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_STDIO. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5DO","page":"Low-level library bindings","title":"H5DO — Optimized Functions Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5do_append\nh5do_write_chunk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5do_append\nh5do_write_chunk","category":"page"},{"location":"api_bindings/#HDF5.API.h5do_append","page":"Low-level library bindings","title":"HDF5.API.h5do_append","text":"h5do_append(dset_id::hid_t, dxpl_id::hid_t, index::Cuint, num_elem::hsize_t, memtype::hid_t, buffer::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5DOappend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5do_write_chunk","page":"Low-level library bindings","title":"HDF5.API.h5do_write_chunk","text":"h5do_write_chunk(dset_id::hid_t, dxpl_id::hid_t, filter_mask::UInt32, offset::Ptr{hsize_t}, bufsize::Csize_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5DOwrite_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5DS","page":"Low-level library bindings","title":"H5DS — Dimension Scale Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5ds_attach_scale\nh5ds_detach_scale\nh5ds_get_label\nh5ds_get_num_scales\nh5ds_get_scale_name\nh5ds_is_attached\nh5ds_is_scale\nh5ds_set_label\nh5ds_set_scale","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5ds_attach_scale\nh5ds_detach_scale\nh5ds_get_label\nh5ds_get_num_scales\nh5ds_get_scale_name\nh5ds_is_attached\nh5ds_is_scale\nh5ds_set_label\nh5ds_set_scale","category":"page"},{"location":"api_bindings/#HDF5.API.h5ds_attach_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_attach_scale","text":"h5ds_attach_scale(did::hid_t, dsid::hid_t, idx::Cuint)\n\nSee libhdf5 documentation for H5DSattach_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_detach_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_detach_scale","text":"h5ds_detach_scale(did::hid_t, dsid::hid_t, idx::Cuint)\n\nSee libhdf5 documentation for H5DSdetach_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_label","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_label","text":"h5ds_get_label(did::hid_t, idx::Cuint, label::Ptr{UInt8}, size::hsize_t)\n\nSee libhdf5 documentation for H5DSget_label.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_num_scales","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_num_scales","text":"h5ds_get_num_scales(did::hid_t, idx::Cuint) -> Int\n\nSee libhdf5 documentation for H5DSget_num_scales.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_scale_name","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_scale_name","text":"h5ds_get_scale_name(did::hid_t, name::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5DSget_scale_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_is_attached","page":"Low-level library bindings","title":"HDF5.API.h5ds_is_attached","text":"h5ds_is_attached(did::hid_t, dsid::hid_t, idx::Cuint) -> Bool\n\nSee libhdf5 documentation for H5DSis_attached.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_is_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_is_scale","text":"h5ds_is_scale(did::hid_t) -> Bool\n\nSee libhdf5 documentation for H5DSis_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_set_label","page":"Low-level library bindings","title":"HDF5.API.h5ds_set_label","text":"h5ds_set_label(did::hid_t, idx::Cuint, label::Ref{UInt8})\n\nSee libhdf5 documentation for H5DSset_label.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_set_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_set_scale","text":"h5ds_set_scale(dsid::hid_t, dimname::Cstring)\n\nSee libhdf5 documentation for H5DSset_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5LT","page":"Low-level library bindings","title":"H5LT — Lite Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5lt_dtype_to_text","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5lt_dtype_to_text","category":"page"},{"location":"api_bindings/#HDF5.API.h5lt_dtype_to_text","page":"Low-level library bindings","title":"HDF5.API.h5lt_dtype_to_text","text":"h5lt_dtype_to_text(datatype::hid_t, str::Ptr{UInt8}, lang_type::Cint, len::Ref{Csize_t})\n\nSee libhdf5 documentation for H5LTdtype_to_text.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5TB","page":"Low-level library bindings","title":"H5TB — Table Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5tb_append_records\nh5tb_get_field_info\nh5tb_get_table_info\nh5tb_make_table\nh5tb_read_records\nh5tb_read_table\nh5tb_write_records","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5tb_append_records\nh5tb_get_field_info\nh5tb_get_table_info\nh5tb_make_table\nh5tb_read_records\nh5tb_read_table\nh5tb_write_records","category":"page"},{"location":"api_bindings/#HDF5.API.h5tb_append_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_append_records","text":"h5tb_append_records(loc_id::hid_t, dset_name::Cstring, nrecords::hsize_t, type_size::Csize_t, field_offset::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBappend_records.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_get_field_info","page":"Low-level library bindings","title":"HDF5.API.h5tb_get_field_info","text":"h5tb_get_field_info(loc_id::hid_t, table_name::Cstring, field_names::Ptr{Ptr{UInt8}}, field_sizes::Ptr{Csize_t}, field_offsets::Ptr{Csize_t}, type_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5TBget_field_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_get_table_info","page":"Low-level library bindings","title":"HDF5.API.h5tb_get_table_info","text":"h5tb_get_table_info(loc_id::hid_t, table_name::Cstring, nfields::Ptr{hsize_t}, nrecords::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5TBget_table_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_make_table","page":"Low-level library bindings","title":"HDF5.API.h5tb_make_table","text":"h5tb_make_table(table_title::Cstring, loc_id::hid_t, dset_name::Cstring, nfields::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_names::Ptr{Cstring}, field_offset::Ptr{Csize_t}, field_types::Ptr{hid_t}, chunk_size::hsize_t, fill_data::Ptr{Cvoid}, compress::Cint, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBmake_table.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_read_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_read_records","text":"h5tb_read_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBread_records.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_read_table","page":"Low-level library bindings","title":"HDF5.API.h5tb_read_table","text":"h5tb_read_table(loc_id::hid_t, table_name::Cstring, dst_size::Csize_t, dst_offset::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, dst_buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBread_table.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_write_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_write_records","text":"h5tb_write_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBwrite_records.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#Dataspaces","page":"Dataspaces","title":"Dataspaces","text":"","category":"section"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"Dataspace\ndataspace\nisnull\nget_extent_dims\nset_extent_dims","category":"page"},{"location":"interface/dataspaces/#HDF5.Dataspace","page":"Dataspaces","title":"HDF5.Dataspace","text":"HDF5.Dataspace\n\nA dataspace defines the size and the shape of a dataset or an attribute.\n\nA dataspace is typically constructed by calling dataspace.\n\nThe following functions have methods defined for Dataspace objects\n\n==\nndims\nsize\nlength\nisempty\nisnull\n\n\n\n\n\n","category":"type"},{"location":"interface/dataspaces/#HDF5.dataspace","page":"Dataspaces","title":"HDF5.dataspace","text":"dataspace(obj::Union{Attribute, Dataset, Dataspace})\n\nThe Dataspace of obj.\n\n\n\n\n\ndataspace(data)\n\nThe default Dataspace used for representing a Julia object data:\n\nstrings or numbers: a scalar Dataspace\narrays: a simple Dataspace\nstruct types: a scalar Dataspace\nnothing or an EmptyArray: a null dataspace\n\n\n\n\n\ndataspace(dims::Tuple; max_dims::Tuple=dims)\ndataspace(dims::Tuple, max_dims::Tuple)\n\nConstruct a simple Dataspace for the given dimensions dims. The maximum dimensions maxdims specifies the maximum possible size: -1 can be used to indicate unlimited dimensions.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.isnull","page":"Dataspaces","title":"HDF5.isnull","text":"isnull(dspace::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute})\n\nDetermines whether the given object has no size (consistent with the API.H5S_NULL dataspace).\n\nExamples\n\njulia> HDF5.isnull(dataspace(HDF5.EmptyArray{Float64}()))\ntrue\n\njulia> HDF5.isnull(dataspace((0,)))\nfalse\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.get_extent_dims","page":"Dataspaces","title":"HDF5.get_extent_dims","text":"HDF5.get_extent_dims(obj::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute}) -> dims, maxdims\n\nGet the array dimensions from a dataspace, dataset, or attribute and return a tuple of dims and maxdims.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.set_extent_dims","page":"Dataspaces","title":"HDF5.set_extent_dims","text":"HDF5.set_extent_dims(dset::HDF5.Dataset, new_dims::Dims)\n\nChange the current dimensions of a dataset to new_dims, limited by max_dims = get_extent_dims(dset)[2]. Reduction is possible and leads to loss of truncated data.\n\n\n\n\n\nHDF5.set_extent_dims(dspace::HDF5.Dataspace, new_dims::Dims, max_dims::Union{Dims,Nothing} = nothing)\n\nChange the dimensions of a dataspace dspace to new_dims, optionally with the maximum possible dimensions max_dims different from the active size new_dims. If not given, max_dims is set equal to new_dims.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#Hyperslab","page":"Dataspaces","title":"Hyperslab","text":"","category":"section"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"BlockRange\nselect_hyperslab!\nget_regular_hyperslab","category":"page"},{"location":"interface/dataspaces/#HDF5.BlockRange","page":"Dataspaces","title":"HDF5.BlockRange","text":"HDF5.BlockRange(;start::Integer, stride::Integer=1, count::Integer=1, block::Integer=1)\n\nA BlockRange represents a selection along a single dimension of a HDF5 hyperslab. It is similar to a Julia range object, with some extra features for selecting multiple contiguous blocks.\n\nstart: the index of the first element in the first block (1-based).\nstride: the step between the first element of each block (must be >0)\ncount: the number of blocks (can be -1 for an unlimited number of blocks)\nblock: the number of elements in each block.\n\nHDF5.BlockRange(obj::Union{Integer, OrdinalRange})\n\nConvert obj to a BlockRange object.\n\nExternal links\n\nHDF5 User Guide, section 7.4.2.1 \"Selecting Hyperslabs\"\n\n\n\n\n\n","category":"type"},{"location":"interface/dataspaces/#HDF5.select_hyperslab!","page":"Dataspaces","title":"HDF5.select_hyperslab!","text":"HDF5.select_hyperslab!(dspace::Dataspace, [op, ], idxs::Tuple)\n\nSelects a hyperslab region of the dspace. idxs should be a tuple of integers, ranges or BlockRange objects.\n\nop determines how the new selection is to be combined with the already selected dataspace:\n:select (default): replace the existing selection with the new selection.\n:or: adds the new selection to the existing selection. Aliases: |, ∪, union.\n:and: retains only the overlapping portions of the new and existing selection. Aliases: &, ∩, intersect.\n:xor: retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. Aliases: ⊻, xor\n:notb: retains only elements of the existing selection that are not in the new selection. Alias: setdiff.\n:nota: retains only elements of the new selection that are not in the existing selection.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.get_regular_hyperslab","page":"Dataspaces","title":"HDF5.get_regular_hyperslab","text":"HDF5.get_regular_hyperslab(dspace)::Tuple\n\nGet the hyperslab selection from dspace. Returns a tuple of BlockRange objects.\n\n\n\n\n\n","category":"function"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = HDF5","category":"page"},{"location":"#HDF5.jl","page":"Home","title":"HDF5.jl","text":"","category":"section"},{"location":"#Overview","page":"Home","title":"Overview","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5 stands for Hierarchical Data Format v5 and is closely modeled on file systems. In HDF5, a \"group\" is analogous to a directory, a \"dataset\" is like a file. HDF5 also uses \"attributes\" to associate metadata with a particular group or dataset. HDF5 uses ASCII names for these different objects, and objects can be accessed by Unix-like pathnames, e.g., \"/sample1/tempsensor/firsttrial\" for a top-level group \"sample1\", a subgroup \"tempsensor\", and a dataset \"firsttrial\".","category":"page"},{"location":"","page":"Home","title":"Home","text":"For simple types (scalars, strings, and arrays), HDF5 provides sufficient metadata to know how each item is to be interpreted. For example, HDF5 encodes that a given block of bytes is to be interpreted as an array of Int64, and represents them in a way that is compatible across different computing architectures.","category":"page"},{"location":"","page":"Home","title":"Home","text":"However, to preserve Julia objects, one generally needs additional type information to be supplied, which is easy to provide using attributes. This is handled for you automatically in the JLD/JLD2. These specific formats (conventions) provide \"extra\" functionality, but they are still both regular HDF5 files and are therefore compatible with any HDF5 reader or writer.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Language wrappers for HDF5 are often described as either \"low level\" or \"high level.\" This package contains both flavors: at the low level, it directly wraps HDF5's functions, thus copying their API and making them available from within Julia. At the high level, it provides a set of functions built on the low-level wrap which may make the usage of this library more convenient.","category":"page"},{"location":"#Installation","page":"Home","title":"Installation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"julia>]\npkg> add HDF5","category":"page"},{"location":"","page":"Home","title":"Home","text":"Starting from Julia 1.3, the HDF5 binaries are by default downloaded using the HDF5_jll package.","category":"page"},{"location":"#Using-custom-or-system-provided-HDF5-binaries","page":"Home","title":"Using custom or system provided HDF5 binaries","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"note: Migration from HDF5.jl v0.16 and earlier\nHow to use a system-provided HDF5 library has been changed in HDF5.jl v0.17. Previously, the library path was set by the environment variable JULIA_HDF5_PATH, which required to rebuild HDF5.jl afterwards. The environment variable has been removed and no longer has an effect (for backward compatibility it is still recommended to also set the environment variable). Instead, proceed as described below.","category":"page"},{"location":"","page":"Home","title":"Home","text":"To use system-provided HDF5 binaries instead, set the preferences libhdf5 and libhdf5_hl, see also Preferences.jl. These need to point to the local paths of the libraries libhdf5 and libhdf5_hl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For example, to use HDF5 (libhdf5-mpich-dev) with MPI using system libraries on Ubuntu 20.04, you would run","category":"page"},{"location":"","page":"Home","title":"Home","text":"$ sudo apt install mpich libhdf5-mpich-dev","category":"page"},{"location":"","page":"Home","title":"Home","text":"If your system HDF5 library is compiled with MPI, you need to tell MPI.jl to use the same locally installed MPI implementation. This can be done in Julia by running:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using MPIPreferences\nMPIPreferences.use_system_binary()","category":"page"},{"location":"","page":"Home","title":"Home","text":"to set the MPI preferences, see the documentation of MPI.jl. You can set the path to the system library using Preferences.jl by:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Preferences, UUIDs\n\nset_preferences!(\n UUID(\"f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f\"), # UUID of HDF5.jl\n \"libhdf5\" => \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5.so\",\n \"libhdf5_hl\" => \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so\", force = true)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Also see the file test/configure_packages.jl for an example.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Both, the MPI preferences and the preferences for HDF5.jl write to a file called LocalPreferences.toml in the project directory. After performing the described steps this file could look like the following:","category":"page"},{"location":"","page":"Home","title":"Home","text":"[MPIPreferences]\n_format = \"1.0\"\nabi = \"MPICH\"\nbinary = \"system\"\nlibmpi = \"/software/mpi/lib/libmpi.so\"\nmpiexec = \"/software/mpi/bin/mpiexec\"\n\n[HDF5]\nlibhdf5 = \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5.so\"\nlibhdf5_hl = \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so\"","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you want to switch to another HDF5 library or the library moved, you can call the set_preferences! commands again (or manually edit LocalPreferences.toml) to set the new paths. Using the default implementation provided by HDF5_jll can be done by simply manually deleting the LocalPreferences.toml file.","category":"page"},{"location":"#Opening-and-closing-files","page":"Home","title":"Opening and closing files","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"\"Plain\" (i.e., with no extra formatting conventions) HDF5 files are created and/or opened with the h5open command:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid = h5open(filename, mode)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The mode can be any one of the following:","category":"page"},{"location":"","page":"Home","title":"Home","text":"mode Meaning\n\"r\" read-only\n\"r+\" read-write, preserving any existing contents\n\"cw\" read-write, create file if not existing, preserve existing contents\n\"w\" read-write, destroying any existing contents (if any)","category":"page"},{"location":"","page":"Home","title":"Home","text":"For example","category":"page"},{"location":"","page":"Home","title":"Home","text":"using HDF5\nfname = tempname(); # temporary file\nfid = h5open(fname, \"w\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"This produces an object of type HDF5File, a subtype of the abstract type DataFile. This file will have no elements (groups, datasets, or attributes) that are not explicitly created by the user.","category":"page"},{"location":"","page":"Home","title":"Home","text":"When you're finished with a file, you should close it:","category":"page"},{"location":"","page":"Home","title":"Home","text":"close(fid)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Closing a file also closes any other open objects (e.g., datasets, groups) in that file. In general, you need to close an HDF5 file to \"release\" it for use by other applications.","category":"page"},{"location":"#Creating-a-group-or-dataset","page":"Home","title":"Creating a group or dataset","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Groups can be created via the function create_group","category":"page"},{"location":"","page":"Home","title":"Home","text":"create_group(fid, \"mygroup\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"We can write the \"mydataset\" by indexing into fid. This also happens to write data to the dataset.","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"mydataset\"] = rand()","category":"page"},{"location":"","page":"Home","title":"Home","text":"Alternatively, we can call create_dataset, which does not write data to the dataset. It merely creates the dataset.","category":"page"},{"location":"","page":"Home","title":"Home","text":"create_dataset(fid, \"myvector\", Int, (10,))","category":"page"},{"location":"","page":"Home","title":"Home","text":"Creating a dataset within a group is as simple as indexing into the group with the name of the dataset or calling create_dataset with the group as the first argument.","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = fid[\"mygroup\"]\ng[\"mydataset\"] = \"Hello World!\"\ncreate_dataset(g, \"myvector\", Int, (10,))","category":"page"},{"location":"","page":"Home","title":"Home","text":"The do syntax is also supported. The file, group, and dataset handles will automatically be closed after the do block terminates.","category":"page"},{"location":"","page":"Home","title":"Home","text":"h5open(\"example2.h5\", \"w\") do fid\n g = create_group(fid, \"mygroup\")\n dset = create_dataset(g, \"myvector\", Float64, (10,))\n write(dset,rand(10))\nend","category":"page"},{"location":"#Opening-and-closing-objects","page":"Home","title":"Opening and closing objects","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"If you have a file object fid, and this has a group or dataset called \"mygroup\" at the top level of a file, you can open it in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"obj = fid[\"mygroup\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"This does not read any data or attributes associated with the object, it's simply a handle for further manipulations. For example:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = fid[\"mygroup\"]\ndset = g[\"mydataset\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"or simply","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = fid[\"mygroup/mydataset\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"When you're done with an object, you can close it using close(obj). If you forget to do this, it will be closed for you anyway when the file is closed, or if obj goes out of scope and gets garbage collected.","category":"page"},{"location":"#Reading-and-writing-data","page":"Home","title":"Reading and writing data","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Suppose you have a group g which contains a dataset with path \"mydataset\", and that you've also opened this dataset as dset = g[\"mydataset\"]. You can read information in this dataset in any of the following ways:","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = read(dset)\nA = read(g, \"mydataset\")\nAsub = dset[2:3, 1:3]","category":"page"},{"location":"","page":"Home","title":"Home","text":"The last syntax reads just a subset of the data array (assuming that dset is an array of sufficient size). libhdf5 has internal mechanisms for slicing arrays, and consequently if you need only a small piece of a large array, it can be faster to read just what you need rather than reading the entire array and discarding most of it.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Datasets can be created with either","category":"page"},{"location":"","page":"Home","title":"Home","text":"g[\"mydataset\"] = rand(3,5)\nwrite(g, \"mydataset\", rand(3,5))","category":"page"},{"location":"","page":"Home","title":"Home","text":"One can use the high level interface load and save from FileIO, where an optional OrderedDict can be passed (track_order inferred). Note that using track_order=true or passing an OrderedDict is a promise that the read file has been created with the appropriate ordering flags.","category":"page"},{"location":"","page":"Home","title":"Home","text":"julia> using OrderedCollections, FileIO\njulia> save(\"track_order.h5\", OrderedDict(\"z\"=>1, \"a\"=>2, \"g/f\"=>3, \"g/b\"=>4))\njulia> load(\"track_order.h5\"; dict=OrderedDict())\nOrderedDict{Any, Any} with 4 entries:\n \"z\" => 1\n \"a\" => 2\n \"g/f\" => 3\n \"g/b\" => 4","category":"page"},{"location":"#Passing-parameters","page":"Home","title":"Passing parameters","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"It is often required to pass parameters to specific routines, which are collected in so-called property lists in HDF5. There are different property lists for different tasks, e.g. for the access/creation of files, datasets, groups. In this high level framework multiple parameters can be simply applied by appending them at the end of function calls as keyword arguments.","category":"page"},{"location":"","page":"Home","title":"Home","text":"g[\"A\"] = A # basic\ng[\"A\", chunk=(5,5)] = A # add chunks\n\nB = h5read(fn,\"mygroup/B\", # two parameters\n fapl_mpio=(ccomm,cinfo), # if parameter requires multiple args use tuples\n dxpl_mpio=HDF5.H5FD_MPIO_COLLECTIVE )","category":"page"},{"location":"","page":"Home","title":"Home","text":"This will automatically create the correct property lists, add the properties, and apply the property list while reading/writing the data. The naming of the properties generally follows that of HDF5, i.e. the key fapl_mpio returns the HDF5 functions h5pget/set_fapl_mpio and their corresponding property list type H5P_FILE_ACCESS. The complete list if routines and their interfaces is available at the H5P: Property List Interface documentation. Note that not all properties are available. When searching for a property check whether the corresponding h5pget/set functions are available.","category":"page"},{"location":"#Chunking-and-compression","page":"Home","title":"Chunking and compression","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"You can also optionally \"chunk\" and/or compress your data. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = rand(100,100)\ng[\"A\", chunk=(5,5)] = A","category":"page"},{"location":"","page":"Home","title":"Home","text":"stores the matrix A in 5-by-5 chunks. Chunking improves efficiency if you write or extract small segments or slices of an array, if these are not stored contiguously.","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = rand(100,100)\ng1[\"A\", chunk=(5,5), compress=3] = A\ng2[\"A\", chunk=(5,5), shuffle=(), deflate=3] = A\nusing H5Zblosc # load in Blosc\ng3[\"A\", chunk=(5,5), blosc=3] = A","category":"page"},{"location":"","page":"Home","title":"Home","text":"Standard compression in HDF5 (\"compress\") corresponds to (\"deflate\") and uses the deflate/zlib algorithm. The deflate algorithm is often more efficient if prefixed by a \"shuffle\" filter. Blosc is generally much faster than deflate – however, reading Blosc-compressed HDF5 files require Blosc to be installed. This is the case for Julia, but often not for vanilla HDF5 distributions that may be used outside Julia. (In this case, the structure of the HDF5 file is still accessible, but compressed datasets cannot be read.) Compression requires chunking, and heuristic chunking is automatically used if you specify compression but don't specify chunking.","category":"page"},{"location":"","page":"Home","title":"Home","text":"It is also possible to write to subsets of an on-disk HDF5 dataset. This is useful to incrementally save to very large datasets you don't want to keep in memory. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = create_dataset(g, \"B\", datatype(Float64), dataspace(1000,100,10), chunk=(100,100,1))\ndset[:,1,1] = rand(1000)","category":"page"},{"location":"","page":"Home","title":"Home","text":"creates a Float64 dataset in the file or group g, with dimensions 1000x100x10, and then writes to just the first 1000 element slice. If you know the typical size of subset reasons you'll be reading/writing, it can be beneficial to set the chunk dimensions appropriately.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For fine-grained control of filter and compression pipelines, please use the filters keyword to define a filter pipeline. For example, this can be used to include external filter packages. This enables the use of Blosc, Bzip2, LZ4, ZStandard, or custom filter plugins.","category":"page"},{"location":"#Memory-mapping","page":"Home","title":"Memory mapping","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"If you will frequently be accessing individual elements or small regions of array datasets, it can be substantially more efficient to bypass HDF5 routines and use direct memory mapping. This is possible only under particular conditions: when the dataset is an array of standard \"bits\" types (e.g., Float64 or Int32) and no chunking/compression is being used. You can use the ismmappable function to test whether this is possible; for example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = g[\"x\"]\nif HDF5.ismmappable(dset)\n dset = HDF5.readmmap(dset)\nend\nval = dset[15]","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that readmmap returns an Array rather than an HDF5 object.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note: if you use readmmap on a dataset and subsequently close the file, the array data are still available–-and file continues to be in use–-until all of the arrays are garbage-collected. This is in contrast to standard HDF5 datasets, where closing the file prevents further access to any of the datasets, but the file is also detached and can safely be rewritten immediately.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Under the default allocation-time policy, a newly added ismmappable dataset can only be memory mapped after it has been written to. The following fails:","category":"page"},{"location":"","page":"Home","title":"Home","text":"vec_dset = create_dataset(g, \"v\", datatype(Float64), dataspace(10_000,1))\nHDF5.ismmappable(vec_dset) # == true\nvec = HDF5.readmmap(vec_dset) # throws ErrorException(\"Error mmapping array\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"because although the dataset description has been added, the space within the HDF5 file has not yet actually been allocated (so the file region cannot be memory mapped by the OS). The storage can be allocated by making at least one write:","category":"page"},{"location":"","page":"Home","title":"Home","text":"vec_dset[1,1] = 0.0 # force allocation of /g/v within the file\nvec = HDF5.readmmap(vec_dset) # and now the memory mapping can succeed","category":"page"},{"location":"","page":"Home","title":"Home","text":"Alternatively, the policy can be set so that the space is allocated immediately upon creation of the data set with the alloc_time keyword:","category":"page"},{"location":"","page":"Home","title":"Home","text":"mtx_dset = create_dataset(g, \"M\", datatype(Float64), dataspace(100, 1000),\n alloc_time = HDF5.H5D_ALLOC_TIME_EARLY)\nmtx = HDF5.readmmap(mtx_dset) # succeeds immediately","category":"page"},{"location":"#Supported-data-types","page":"Home","title":"Supported data types","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5.jl knows how to store values of the following types: signed and unsigned integers of 8, 16, 32, and 64 bits, Float32, Float64; Complex versions of these numeric types; Arrays of these numeric types (including complex versions); ASCIIString and UTF8String; and Arrays of these two string types. Arrays of strings are supported using HDF5's variable-length-strings facility. By default Complex numbers are stored as compound types with r and i fields following the h5py convention. When reading data, compound types with matching field names will be loaded as the corresponding Complex Julia type. These field names are configurable with the HDF5.set_complex_field_names(real::AbstractString, imag::AbstractString) function and complex support can be completely enabled/disabled with HDF5.enable/disable_complex_support().","category":"page"},{"location":"","page":"Home","title":"Home","text":"For Arrays, note that the array dimensionality is preserved, including 0-length dimensions:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"zero_vector\"] = zeros(0)\nfid[\"zero_matrix\"] = zeros(0, 0)\nsize(fid[\"zero_vector\"]) # == (0,)\nsize(fid[\"zero_matrix\"]) # == (0, 0)","category":"page"},{"location":"","page":"Home","title":"Home","text":"An exception to this rule is Julia's 0-dimensional Array, which is stored as an HDF5 scalar because there is a value to be preserved:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"zero_dim_value\"] = fill(1.0π)\nread(fid[\"zero_dim_value\"]) # == 3.141592653589793, != [3.141592653589793]","category":"page"},{"location":"","page":"Home","title":"Home","text":"HDF5 also has the concept of a null array which contains a type but has neither size nor contents, which is represented by the type HDF5.EmptyArray:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"empty_array\"] = HDF5.EmptyArray{Float32}()\nHDF5.isnull(fid[\"empty_array\"]) # == true\nsize(fid[\"empty_array\"]) # == ()\neltype(fid[\"empty_array\"]) # == Float32","category":"page"},{"location":"","page":"Home","title":"Home","text":"This module also supports HDF5's VLEN, OPAQUE, and REFERENCE types, which can be used to encode more complex types. In general, you need to specify how you want to combine these more advanced facilities to represent more complex data types. For many of the data types in Julia, the JLD module implements support. You can likewise define your own file format if, for example, you need to interact with some external program that has explicit formatting requirements.","category":"page"},{"location":"#Creating-groups-and-attributes","page":"Home","title":"Creating groups and attributes","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Create a new group in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = create_group(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The named group will be created as a child of the parent.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Attributes can be created using","category":"page"},{"location":"","page":"Home","title":"Home","text":"attributes(parent)[name] = value","category":"page"},{"location":"","page":"Home","title":"Home","text":"where attributes simply indicates that the object referenced by name (a string) is an attribute, not another group or dataset. (Datasets cannot have child datasets, but groups can have either.) value must be a simple type: BitsKinds, strings, and arrays of either of these. The HDF5 standard recommends against storing large objects as attributes.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The value stored in an attribute can be retrieved like","category":"page"},{"location":"","page":"Home","title":"Home","text":"read_attribute(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can also access the value of an attribute by indexing, like so:","category":"page"},{"location":"","page":"Home","title":"Home","text":"julia> attr = attributes(parent)[name];\njulia> attr[]","category":"page"},{"location":"#Getting-information","page":"Home","title":"Getting information","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5.name(obj)","category":"page"},{"location":"","page":"Home","title":"Home","text":"will return the full HDF5 pathname of object obj.","category":"page"},{"location":"","page":"Home","title":"Home","text":"keys(g)","category":"page"},{"location":"","page":"Home","title":"Home","text":"returns a string array containing all objects inside group g. These relative pathnames, not absolute pathnames.","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can iterate over the objects in a group, i.e.,","category":"page"},{"location":"","page":"Home","title":"Home","text":"for obj in g\n data = read(obj)\n println(data)\nend","category":"page"},{"location":"","page":"Home","title":"Home","text":"This gives you a straightforward way of recursively exploring an entire HDF5 file.","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you need to know whether group g has a dataset named mydata, you can test that with","category":"page"},{"location":"","page":"Home","title":"Home","text":"if haskey(g, \"mydata\")\n ...\nend\ntf = haskey(g, \"mydata\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"If instead you want to know whether g has an attribute named myattribute, do it this way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"tf = haskey(attributes(g), \"myattribute\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you have an HDF5 object, and you want to know where it fits in the hierarchy of the file, the following can be useful:","category":"page"},{"location":"","page":"Home","title":"Home","text":"p = parent(obj) # p is the parent object (usually a group)\nfn = HDF5.filename(obj) # fn is a string\ng = HDF5.root(obj) # g is the group \"/\"","category":"page"},{"location":"","page":"Home","title":"Home","text":"For array objects (datasets and attributes) the following methods work:","category":"page"},{"location":"","page":"Home","title":"Home","text":"dims = size(dset)\nnd = ndims(dset)\nlen = length(dset)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Objects can be created with properties, and you can query those properties in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"p = HDF5.get_create_properties(dset)\nchunksz = HDF5.get_chunk(p)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The simpler syntax chunksz = HDF5.get_chunk(dset) is also available.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Finally, sometimes you need to be able to conveniently test whether a file is an HDF5 file:","category":"page"},{"location":"","page":"Home","title":"Home","text":"tf = HDF5.ishdf5(filename)","category":"page"},{"location":"#Mid-level-routines","page":"Home","title":"Mid-level routines","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Sometimes you might want more fine-grained control, which can be achieved using a different set of routines. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = open_group(parent, name)\ndset = open_dataset(parent, name[, apl])\nattr = open_attribute(parent, name)\nt = open_datatype(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"These open the named group, dataset, attribute, and committed datatype, respectively. For datasets, apl stands for \"access parameter list\" and provides opportunities for more sophisticated control (see the HDF5 documentation).","category":"page"},{"location":"","page":"Home","title":"Home","text":"New objects can be created in the following ways:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = create_group(parent, name[, lcpl, gcpl]; properties...)\ndset = create_dataset(parent, name, data; properties...)\nattr = create_attribute(parent, name, data)","category":"page"},{"location":"","page":"Home","title":"Home","text":"creates groups, datasets, and attributes without writing any data to them. You can then use write(obj, data) to store the data. The optional properties and property lists allow even more fine-grained control. This syntax uses data to infer the object's \"HDF5.datatype\" and \"HDF5.dataspace\"; for the most explicit control, data can be replaced with dtype, dspace, where dtype is an HDF5.Datatype and dspace is an HDF5.Dataspace.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Analogously, to create committed data types, use","category":"page"},{"location":"","page":"Home","title":"Home","text":"t = commit_datatype(parent, name, dtype[, lcpl, tcpl, tapl])","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can create and write data in one step,","category":"page"},{"location":"","page":"Home","title":"Home","text":"write_dataset(parent, name, data; properties...)\nwrite_attribute(parent, name, data)","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can use extendible dimensions,","category":"page"},{"location":"","page":"Home","title":"Home","text":"d = create_dataset(parent, name, dtype, (dims, max_dims), chunk=(chunk_dims))\nHDF5.set_extent_dims(d, new_dims)","category":"page"},{"location":"","page":"Home","title":"Home","text":"where dims is a tuple of integers. For example","category":"page"},{"location":"","page":"Home","title":"Home","text":"b = create_dataset(fid, \"b\", Int, ((1000,),(-1,)), chunk=(100,)) #-1 is equivalent to typemax(hsize_t)\nHDF5.set_extent_dims(b, (10000,))\nb[1:10000] = collect(1:10000)","category":"page"},{"location":"","page":"Home","title":"Home","text":"when dimensions are reduced, the truncated data is lost. A maximum dimension of -1 is often referred to as unlimited dimensions, though it is limited by the maximum size of an unsigned integer.","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can copy data from one file to another:","category":"page"},{"location":"","page":"Home","title":"Home","text":"copy_object(source, data_name, target, name)\ncopy_object(source[data_name], target, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Finally, it's possible to delete objects:","category":"page"},{"location":"","page":"Home","title":"Home","text":"delete_object(parent, name) # for groups, datasets, and datatypes\ndelete_attribute(parent, name) # for attributes","category":"page"},{"location":"#Low-level-routines","page":"Home","title":"Low-level routines","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Many of the most commonly-used libhdf5 functions have been wrapped in a submodule API. The library follows a consistent convention: for example, libhdf5's H5Adelete is wrapped with a Julia function called h5a_delete. The arguments are exactly as specified in the HDF5 reference manual. Note that the functions in the API submodule are not exported, so unless you import them specifically, you need to preface them with HDF5.API to use them: for example, HDF5.API.h5a_delete.","category":"page"},{"location":"","page":"Home","title":"Home","text":"HDF5 is a large library, and the low-level wrap is not complete. However, many of the most-commonly used functions are wrapped, and in general wrapping a new function takes only a single line of code. Users who need additional functionality are encouraged to contribute it.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that Julia's HDF5 directly uses the \"2\" interfaces, e.g., H5Dcreate2, so you need to have version 1.8 of the HDF5 library or later.","category":"page"},{"location":"#Language-interoperability-with-row-and-column-major-order-arrays","page":"Home","title":"Language interoperability with row- and column-major order arrays","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"There are two main methods for storing multidimensional arrays in linear storage row-major order and column-major order. Julia, like Fortran and MATLAB, stores multidimensional arrays in column-major order, while other languages, including C and Python (NumPy), use row-major order. Therefore when reading an array in Julia from row-major order language the dimensions may be inverted.","category":"page"},{"location":"","page":"Home","title":"Home","text":"To read a multidimensional array into the original shape from an HDF5 file written by Python (numpy and h5py) or C/C++/Objective-C, simply reverse the dimensions. For example, one may add the following line after reading the dataset dset:","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = permutedims(dset, reverse(1:ndims(dset)))","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that some languages or libraries use both methods, so please check the datset's description for details. For example, NumPy arrays are row-major by default, but NumPy can use either row-major or column-major ordered arrays.","category":"page"},{"location":"#Credits","page":"Home","title":"Credits","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Konrad Hinsen initiated Julia's support for HDF5\nTim Holy and Simon Kornblith (primary authors)\nTom Short contributed code and ideas to the dictionary-like interface\nBlake Johnson made several improvements, such as support for iterating over attributes\nIsaiah Norton and Elliot Saba improved installation on Windows and OSX\nSteve Johnson contributed the do syntax and Blosc compression\nMike Nolta and Jameson Nash contributed code or suggestions for improving the handling of HDF5's constants\nThanks also to the users who have reported bugs and tested fixes","category":"page"}] +[{"location":"mpi/#Parallel-HDF5","page":"Parallel HDF5","title":"Parallel HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"It is possible to read and write parallel HDF5 files using MPI. For this, the HDF5 binaries loaded by HDF5.jl must have been compiled with parallel support, and linked to the specific MPI implementation that will be used for parallel I/O.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Parallel-enabled HDF5 libraries are usually included in computing clusters and linked to the available MPI implementations. They are also available via the package manager of a number of Linux distributions.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Finally, note that the MPI.jl package is lazy-loaded by HDF5.jl using Requires. In practice, this means that in Julia code, MPI must be imported before HDF5 for parallel functionality to be available.","category":"page"},{"location":"mpi/#Setting-up-Parallel-HDF5","page":"Parallel HDF5","title":"Setting-up Parallel HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"The following step-by-step guide assumes one already has access to parallel-enabled HDF5 libraries linked to an existent MPI installation.","category":"page"},{"location":"mpi/#using_system_MPI","page":"Parallel HDF5","title":"1. Using system-provided MPI libraries","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Using a system-provided MPI library can be done with MPIPreferences.jl. After installing MPIPreferences.jl and running julia --project -e 'using MPIPreferences; MPIPreferences.use_system_binary()' MPIPreferences.jl identifies any available MPI implementation and stores the information in a file LocalPreferences.toml. See the MPI.jl docs for details.","category":"page"},{"location":"mpi/#using_parallel_HDF5","page":"Parallel HDF5","title":"2. Using parallel HDF5 libraries","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"note: Migration from HDF5.jl v0.16 and earlier\nHow to use a system-provided HDF5 library has been changed in HDF5.jl v0.17. Previously, the library path was set by the environment variable JULIA_HDF5_PATH, which required to rebuild HDF5.jl afterwards. The environment variable has been removed and no longer has an effect (for backward compatibility it is still recommended to also set the environment variable). Instead, proceed as described below.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"As detailed in Using custom or system provided HDF5 binaries, set the preferences libhdf5 and libhdf5_hl to the full path, where the parallel HDF5 binaries are located. This can be done by:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"julia> using Preferences, UUIDs\n\njulia> set_preferences!(\n UUID(\"f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f\"), # UUID of HDF5.jl\n \"libhdf5\" => \"/path/to/your/libhdf5.so\",\n \"libhdf5_hl\" => \"/path/to/your/libhdf5_hl.so\",\n force = true)","category":"page"},{"location":"mpi/#.-Loading-MPI-enabled-HDF5","page":"Parallel HDF5","title":"3. Loading MPI-enabled HDF5","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"In Julia code, MPI.jl must be loaded before HDF5.jl for MPI functionality to be available:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"using MPI\nusing HDF5\n\n@assert HDF5.has_parallel()","category":"page"},{"location":"mpi/#Notes-to-HPC-cluster-administrators","page":"Parallel HDF5","title":"Notes to HPC cluster administrators","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"More information for a setup at an HPC cluster can be found in the docs of MPI.jl. After performing the steps 1. and 2. the LocalPreferences.toml file could look something like the following:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"[MPIPreferences]\n_format = \"1.0\"\nabi = \"OpenMPI\"\nbinary = \"system\"\nlibmpi = \"/software/mpi/lib/libmpi.so\"\nmpiexec = \"/software/mpi/bin/mpiexec\"\n\n[HDF5]\nlibhdf5 = \"/path/to/your/libhdf5.so\"\nlibhdf5_hl = \"/path/to/your/libhdf5_hl.so\"","category":"page"},{"location":"mpi/#Reading-and-writing-data-in-parallel","page":"Parallel HDF5","title":"Reading and writing data in parallel","text":"","category":"section"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"A parallel HDF5 file may be opened by passing a MPI.Comm (and optionally a MPI.Info) object to h5open. For instance:","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"comm = MPI.COMM_WORLD\ninfo = MPI.Info()\nff = h5open(filename, \"w\", comm, info)","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"MPI-distributed data is typically written by first creating a dataset describing the global dimensions of the data. The following example writes a 10 × Nproc array distributed over Nproc MPI processes.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Nproc = MPI.Comm_size(comm)\nmyrank = MPI.Comm_rank(comm)\nM = 10\nA = fill(myrank, M) # local data\ndims = (M, Nproc) # dimensions of global data\n\n# Create dataset\ndset = create_dataset(ff, \"/data\", datatype(eltype(A)), dataspace(dims))\n\n# Write local data\ndset[:, myrank + 1] = A","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Note that metadata operations, such as create_dataset, must be called collectively (on all processes at the same time, with the same arguments), but the actual writing to the dataset may be done independently. See Collective Calling Requirements in Parallel HDF5 Applications for the exact requirements.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"Sometimes, it may be more efficient to write data in chunks, so that each process writes to a separate chunk of the file. This is especially the case when data is uniformly distributed among MPI processes. In this example, this can be achieved by passing chunk=(M, 1) to create_dataset.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"For better performance, it is sometimes preferable to perform collective I/O when reading and writing datasets in parallel. This is achieved by passing dxpl_mpio=:collective to create_dataset. See also the HDF5 docs.","category":"page"},{"location":"mpi/","page":"Parallel HDF5","title":"Parallel HDF5","text":"A few more examples are available in test/mpio.jl.","category":"page"},{"location":"interface/filters/#Filters","page":"Filters","title":"Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"HDF5 supports filters for compression and validation: these are applied sequentially to each chunk of a dataset when writing data, and in reverse order when reading data.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"These can be set by passing a filter or vector of filters as a filters property to DatasetCreateProperties or via the filters keyword argument of create_dataset.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/#Example","page":"Filters","title":"Example","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Filters","category":"page"},{"location":"interface/filters/#HDF5.Filters","page":"Filters","title":"HDF5.Filters","text":"HDF5.Filters\n\nThis module contains the interface for using filters in HDF5.jl.\n\nExample Usage\n\nusing HDF5\nusing HDF5.Filters\n\n# Create a new file\nfn = tempname()\n\n# Create test data\ndata = rand(1000, 1000)\n\n# Open temp file for writing\nf = h5open(fn, \"w\") \n\n# Create datasets\ndsdeflate = create_dataset(f, \"deflate\", datatype(data), dataspace(data),\n chunk=(100, 100), deflate=3)\n\ndsshufdef = create_dataset(f, \"shufdef\", datatype(data), dataspace(data),\n chunk=(100, 100), shuffle=true, deflate=3)\n\ndsfiltdef = create_dataset(f, \"filtdef\", datatype(data), dataspace(data),\n chunk=(100, 100), filters=Filters.Deflate(3))\n\ndsfiltshufdef = create_dataset(f, \"filtshufdef\", datatype(data), dataspace(data),\n chunk=(100, 100), filters=[Filters.Shuffle(), Filters.Deflate(3)])\n\n# Write data\nwrite(dsdeflate, data)\nwrite(dsshufdef, data)\nwrite(dsfiltdef, data)\nwrite(dsfiltshufdef, data)\n\nclose(f)\n\nAdditonal Examples\n\nSee test/filter.jl for further examples.\n\n\n\n\n\n","category":"module"},{"location":"interface/filters/#Built-in-Filters","page":"Filters","title":"Built-in Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Deflate\nShuffle\nFletcher32\nSzip\nNBit\nScaleOffset\nExternalFilter","category":"page"},{"location":"interface/filters/#HDF5.Filters.Deflate","page":"Filters","title":"HDF5.Filters.Deflate","text":"Deflate(level=5)\n\nDeflate/ZLIB lossless compression filter. level is an integer between 0 and 9, inclusive, denoting the compression level, with 0 being no compression, 9 being the highest compression (but slowest speed).\n\nExternal links\n\nH5P_SET_DEFLATE\nDeflate on Wikipedia\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Shuffle","page":"Filters","title":"HDF5.Filters.Shuffle","text":"Shuffle()\n\nThe shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.\n\nAs implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.\n\nExternal links\n\nH5P_SET_SHUFFLE\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Fletcher32","page":"Filters","title":"HDF5.Filters.Fletcher32","text":"Fletcher32()\n\nThe Fletcher32 checksum filter. This doesn't perform compression, but instead checks the validity of the stored data.\n\nThis should be applied after any lossy filters have been applied.\n\nExternal links\n\nH5P_SET_FLETCHER32\nFletcher's checksum on Wikipedia\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.Szip","page":"Filters","title":"HDF5.Filters.Szip","text":"Szip(coding=:nn, pixels_per_block=8)\n\nSzip compression lossless filter. Options:\n\ncoding: the coding method: either :ec (entropy coding) or :nn (nearest neighbors, default)\npixels_per_block: The number of pixels or data elements in each data block (typically 8, 10, 16, or 32)\n\nExternal links\n\nH5P_SET_SZIP\nSzip Compression in HDF Products\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.NBit","page":"Filters","title":"HDF5.Filters.NBit","text":"NBit()\n\nThe N-Bit filter.\n\nExternal links\n\nH5P_SET_NBIT\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.ScaleOffset","page":"Filters","title":"HDF5.Filters.ScaleOffset","text":"ScaleOffset(scale_type::Integer, scale_offset::Integer)\n\nThe scale-offset filter.\n\nExternal links\n\nH5P_SET_SCALEOFFSET\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.ExternalFilter","page":"Filters","title":"HDF5.Filters.ExternalFilter","text":"ExternalFilter(filter_id::API.H5Z_filter_t, flags::Cuint, data::Vector{Cuint}, name::String, config::Cuint)\nExternalFilter(filter_id, flags, data::Integer...)\nExternalFilter(filter_id, data::AbstractVector{<:Integer} = Cuint[])\n\nIntended to support arbitrary, unregistered, external filters. Allows the quick creation of filters using internal/proprietary filters without subtyping HDF5.Filters.Filter. Users are instead encouraged to define subtypes on HDF5.Filters.Filter.\n\nFields / Arguments\n\nfilter_id - (required) Integer filter identifer.\nflags - (optional) bit vector describing general properties of the filter. Defaults to API.H5Z_FLAG_MANDATORY\ndata - (optional) auxillary data for the filter. See cd_values. Defaults to Cuint[]\nname - (optional) String describing the name of the filter. Defaults to \"Unknown Filter with id [filter_id]\"\nconfig - (optional) bit vector representing information about the filter regarding whether it is able to encode data, decode data, neither, or both. Defaults to 0.\n\nSee also:\n\nAPI.h5p_set_filter\nH5Z_GET_FILTER_INFO.\nRegistered Filter Plugins\n\nflags bits\n\nAPI.H5Z_FLAG_OPTIONAL\nAPI.H5Z_FLAG_MANDATORY\n\nconfig bits \n\nAPI.H5Z_FILTER_CONFIG_ENCODE_ENABLED\nAPI.H5Z_FILTER_CONFIG_DECODE_ENABLED\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#External-Filter-Packages","page":"Filters","title":"External Filter Packages","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Several external Julia packages implement HDF5 filter plugins in Julia. As they are independent of HDF5.jl, they must be installed in order to use their plugins.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The H5Zblosc.jl, H5Zbzip2.jl, H5Zlz4.jl, and H5Zzstd.jl packages are maintained as independent subdirectory packages within the HDF5.jl repository.","category":"page"},{"location":"interface/filters/#H5Zblosc.jl","page":"Filters","title":"H5Zblosc.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zblosc","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"BloscFilter","category":"page"},{"location":"interface/filters/#H5Zblosc.BloscFilter","page":"Filters","title":"H5Zblosc.BloscFilter","text":"BloscFilter(;level=5, shuffle=true, compressor=\"blosclz\")\n\nThe Blosc compression filter, using Blosc.jl. Options:\n\nlevel: compression level\nshuffle: whether to shuffle data before compressing (this option should be used instead of the Shuffle filter)\ncompressor: the compression algorithm. Call Blosc.compressors() for the available compressors.\n\nExternal links\n\nWhat Is Blosc?\nBlosc HDF5 Filter ID 32001\nBlosc HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zbzip2.jl","page":"Filters","title":"H5Zbzip2.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zbzip2","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Bzip2Filter","category":"page"},{"location":"interface/filters/#H5Zbzip2.Bzip2Filter","page":"Filters","title":"H5Zbzip2.Bzip2Filter","text":"Bzip2Filter(blockSize100k)\n\nApply Bzip2 compression. The filter id is 307.\n\nExternal Links\n\nBZIP2 HDF5 Filter ID 307\nPyTables Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zlz4.jl","page":"Filters","title":"H5Zlz4.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zlz4","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Lz4Filter","category":"page"},{"location":"interface/filters/#H5Zlz4.Lz4Filter","page":"Filters","title":"H5Zlz4.Lz4Filter","text":"Lz4Filter(blockSize)\n\nApply LZ4 compression. blockSize is the main argument. The filter id is 32004.\n\nExternal Links\n\nLZ4 HDF5 Filter ID 32004\nLZ4 HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#H5Zzstd.jl","page":"Filters","title":"H5Zzstd.jl","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = H5Zzstd","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"ZstdFilter","category":"page"},{"location":"interface/filters/#H5Zzstd.ZstdFilter","page":"Filters","title":"H5Zzstd.ZstdFilter","text":"ZstdFilter(clevel)\n\nZstandard compression filter. clevel determines the compression level.\n\nExternal Links\n\nZstandard HDF5 Filter ID 32015\nZstandard HDF5 Plugin Repository (C code)\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#Other-External-Filters","page":"Filters","title":"Other External Filters","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Additional filters can be dynamically loaded by the HDF5 library. See External Links below for more information.","category":"page"},{"location":"interface/filters/#Using-an-ExternalFilter","page":"Filters","title":"Using an ExternalFilter","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"ExternalFilter can be used to insert a dynamically loaded filter into the FilterPipeline in an ad-hoc fashion.","category":"page"},{"location":"interface/filters/#Example-for-bitshuffle","page":"Filters","title":"Example for bitshuffle","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"If we do not have a defined subtype of Filter for the bitshuffle filter we can create an ExternalFilter. From the header file or list of registered plugins, we see that the bitshuffle filter has an id of 32008.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Furthermore, the header describes two options:","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"block_size (optional). Default is 0.\ncompression - This can be 0 or BSHUF_H5_COMPRESS_LZ4 (2 as defined in the C header)","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"using HDF5.Filters\n\nbitshuf = ExternalFilter(32008, Cuint[0, 0])\nbitshuf_comp = ExternalFilter(32008, Cuint[0, 2])\n\ndata_A = rand(0:31, 1024)\ndata_B = rand(32:63, 1024)\n\nfilename, _ = mktemp()\nh5open(filename, \"w\") do h5f\n # Indexing style\n h5f[\"ex_data_A\", chunk=(32,), filters=bitshuf] = data_A\n # Procedural style\n d, dt = create_dataset(h5f, \"ex_data_B\", data_B, chunk=(32,), filters=[bitshuf_comp])\n write(d, data_B)\nend","category":"page"},{"location":"interface/filters/#Creating-a-new-Filter-type","page":"Filters","title":"Creating a new Filter type","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Examining the bitshuffle filter source code we see that three additional data components get prepended to the options. These are","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The major version\nThe minor version\nThe element size in bytes of the type via H5Tget_size.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"import HDF5.Filters: FILTERS, Filter, FilterPipeline, filterid\nusing HDF5.API\n\nconst H5Z_BSHUF_ID = API.H5Z_filter_t(32008)\nstruct BitShuffleFilter <: HDF5.Filters.Filter\n major::Cuint\n minor::Cuint\n elem_size::Cuint\n block_size::Cuint\n compression::Cuint\n BitShuffleFilter(block_size, compression) = new(0, 0, 0, block_size, compression)\nend\n# filterid is the only required method of the filter interface\n# since we are using an externally registered filter\nfilterid(::Type{BitShuffleFilter}) = H5Z_BSHUF_ID\nFILTERS[H5Z_BSHUF_ID] = BitShuffleFilter\n\nfunction Base.push!(p::FilterPipeline, f::BitShuffleFilter)\n ref = Ref(f)\n GC.@preserve ref begin\n API.h5p_set_filter(p.plist, H5Z_BSHUF_ID, API.H5Z_FLAG_OPTIONAL, 2, pointer_from_objref(ref) + sizeof(Cuint)*3)\n end\n return p\nend","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Because the first three elements are not provided directly via h5p_set_filter, we also needed to implement a custom Base.push! into the FilterPipeline.","category":"page"},{"location":"interface/filters/#Filter-Interface","page":"Filters","title":"Filter Interface","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"CurrentModule = HDF5.Filters","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"The filter interface is used to describe filters and obtain information on them.","category":"page"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"Filter\nFilterPipeline\nUnknownFilter\nFILTERS\nEXTERNAL_FILTER_JULIA_PACKAGES\nfilterid\nisavailable\nisdecoderenabled\nisencoderenabled\ndecoder_present\nencoder_present\nensure_filters_available\nfiltername\ncan_apply_func\ncan_apply_cfunc\nset_local_func\nset_local_cfunc\nfilter_func\nfilter_cfunc\nregister_filter","category":"page"},{"location":"interface/filters/#HDF5.Filters.Filter","page":"Filters","title":"HDF5.Filters.Filter","text":"Filter\n\nAbstract type to describe HDF5 Filters. See the Extended Help for information on implementing a new filter.\n\nExtended Help\n\nFilter interface\n\nThe Filter interface is implemented upon the Filter subtype.\n\nSee API.h5z_register for details.\n\nRequired Methods to Implement\n\nfilterid - registered filter ID\nfilter_func - implement the actual filter\n\nOptional Methods to Implement\n\nfiltername - defaults to \"Unnamed Filter\"\nencoder_present - defaults to true\ndecoder_present - defaults to true\ncan_apply_func - defaults to nothing\nset_local_func - defaults to nothing\n\nAdvanced Methods to Implement\n\ncan_apply_cfunc - Defaults to wrapping @cfunction around the result of can_apply_func\nset_local_cfunc - Defaults to wrapping @cfunction around the result of set_local_func\nfilter_cfunc - Defaults to wrapping @cfunction around the result of filter_func\nregister_filter - Defaults to using the above functions to register the filter\n\nImplement the Advanced Methods to avoid @cfunction from generating a runtime closure which may not work on all systems.\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.FilterPipeline","page":"Filters","title":"HDF5.Filters.FilterPipeline","text":"FilterPipeline(plist::DatasetCreateProperties)\n\nThe filter pipeline associated with plist. Acts like a AbstractVector{Filter}, supporting the following operations:\n\nlength(pipeline): the number of filters.\npipeline[i] to return the ith filter.\npipeline[FilterType] to return a filter of type FilterType\npush!(pipline, filter) to add an extra filter to the pipeline.\nappend!(pipeline, filters) to add multiple filters to the pipeline.\ndelete!(pipeline, FilterType) to remove a filter of type FilterType from the pipeline.\nempty!(pipeline) to remove all filters from the pipeline.\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.UnknownFilter","page":"Filters","title":"HDF5.Filters.UnknownFilter","text":"UnknownFilter\n\nUnknown filter type. Alias for ExternalFilter (see related documentation).\n\n\n\n\n\n","category":"type"},{"location":"interface/filters/#HDF5.Filters.FILTERS","page":"Filters","title":"HDF5.Filters.FILTERS","text":"FILTERS\n\nMaps filter id to filter type.\n\n\n\n\n\n","category":"constant"},{"location":"interface/filters/#HDF5.Filters.EXTERNAL_FILTER_JULIA_PACKAGES","page":"Filters","title":"HDF5.Filters.EXTERNAL_FILTER_JULIA_PACKAGES","text":"EXTERNAL_FILTER_JULIA_PACKAGES\n\nMaps filter id to the Julia package name that contains the filter.\n\n\n\n\n\n","category":"constant"},{"location":"interface/filters/#HDF5.Filters.filterid","page":"Filters","title":"HDF5.Filters.filterid","text":"filterid(F) where {F <: Filter}\n\nThe internal filter id of a filter of type F.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isavailable","page":"Filters","title":"HDF5.Filters.isavailable","text":"isavailable(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter is available and false otherwise.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isdecoderenabled","page":"Filters","title":"HDF5.Filters.isdecoderenabled","text":"isdecoderenabled(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can decode or decompress data.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.isencoderenabled","page":"Filters","title":"HDF5.Filters.isencoderenabled","text":"isencoderenabled(filter_or_id)\n\nGiven a subtype of Filters.Filter or the filter ID number as an integer, return true if the filter can encode or compress data.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.decoder_present","page":"Filters","title":"HDF5.Filters.decoder_present","text":"decoder_present(::Type{F}) where {F<:Filter}\n\nCan the filter decode or decompress the data? Defaults to true. Returns a Bool. See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.encoder_present","page":"Filters","title":"HDF5.Filters.encoder_present","text":"encoder_present(::Type{F}) where {F<:Filter}\n\nCan the filter have an encode or compress the data? Defaults to true. Returns a Bool. See API.h5z_register.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.ensure_filters_available","page":"Filters","title":"HDF5.Filters.ensure_filters_available","text":"Error if all filters in a filter pipeline are not available.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filtername","page":"Filters","title":"HDF5.Filters.filtername","text":"filtername(::Type{F}) where {F<:Filter}\n\nWhat is the name of a filter? Defaults to \"Unnamed Filter\" Returns a String describing the filter. See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.can_apply_func","page":"Filters","title":"HDF5.Filters.can_apply_func","text":"can_apply_func(::Type{F}) where {F<:Filter}\n\nReturn a function indicating whether the filter can be applied or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.can_apply_cfunc","page":"Filters","title":"HDF5.Filters.can_apply_cfunc","text":"can_apply_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the can apply function. By default, this will return the result of using @cfunction on the function specified by can_apply_func(F) or C_NULL if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.set_local_func","page":"Filters","title":"HDF5.Filters.set_local_func","text":"set_local_func(::Type{F}) where {F<:Filter}\n\nReturn a function that sets dataset specific parameters or nothing if no function exists. The function signature is func(dcpl_id::API.hid_t, type_id::API.hid_t, space_id::API.hid_t). See API.h5z_register.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.set_local_cfunc","page":"Filters","title":"HDF5.Filters.set_local_cfunc","text":"set_local_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the set local function. By default, this will return the result of using @cfunction on the function specified by set_local_func(F) or C_NULL if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filter_func","page":"Filters","title":"HDF5.Filters.filter_func","text":"filter_func(::Type{F}) where {F<:Filter}\n\nReturns a function that performs the actual filtering.\n\nSee API.h5z_register\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.filter_cfunc","page":"Filters","title":"HDF5.Filters.filter_cfunc","text":"filter_cfunc(::Type{F}) where {F<:Filter}\n\nReturn a C function pointer for the filter function. By default, this will return the result of using @cfunction on the function specified by filter_func(F) or will throw an error if nothing.\n\nOverriding this will allow @cfunction to return a Ptr{Nothing} rather than a CFunction` closure which may not work on all systems.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#HDF5.Filters.register_filter","page":"Filters","title":"HDF5.Filters.register_filter","text":"register_filter(::Type{F}) where F <: Filter\n\nRegister the filter with the HDF5 library via API.h5z_register. Also add F to the FILTERS dictionary.\n\n\n\n\n\n","category":"function"},{"location":"interface/filters/#External-Links","page":"Filters","title":"External Links","text":"","category":"section"},{"location":"interface/filters/","page":"Filters","title":"Filters","text":"A list of registered filter plugins can be found on the HDF Group website.\nSee the HDF5 Documentation of HDF5 Filter Plugins for details.\nThe source code for many external plugins have been collected in the HDFGroup hdf5_plugins repository.\nCompiled binaries of dynamically downloaded plugins by downloaded from HDF5 Group.","category":"page"},{"location":"interface/groups/#Groups","page":"Groups","title":"Groups","text":"","category":"section"},{"location":"interface/groups/","page":"Groups","title":"Groups","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/groups/","page":"Groups","title":"Groups","text":"Group\ncreate_group\nopen_group\ncreate_external","category":"page"},{"location":"interface/groups/#HDF5.Group","page":"Groups","title":"HDF5.Group","text":"HDF5.Group\n\nAn object representing a HDF5 group. A group is analagous to a file system directory, in that, except for the root group, every object must be a member of at least one group.\n\nSee also\n\ncreate_group\nopen_group\n\n\n\n\n\n","category":"type"},{"location":"interface/groups/#HDF5.create_group","page":"Groups","title":"HDF5.create_group","text":"create_group(parent::Union{File,Group}, path::AbstractString; properties...)\n\nCreate a new Group at path under the parent object. Optional keyword arguments include any keywords that that belong to LinkCreateProperties or GroupCreateProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/groups/#HDF5.open_group","page":"Groups","title":"HDF5.open_group","text":"open_group(parent::Union{File,Group}, path::AbstractString; properties...)\n\nOpen an existing Group at path under the parent object.\n\nOptional keyword arguments include any keywords that that belong to GroupAccessProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/groups/#HDF5.create_external","page":"Groups","title":"HDF5.create_external","text":"create_external(source::Union{HDF5.File, HDF5.Group}, source_relpath, target_filename, target_path;\n lcpl_id=HDF5.API.H5P_DEFAULT, lapl_id=HDF5.H5P.DEFAULT)\n\nCreate an external link such that source[source_relpath] points to target_path within the file with path target_filename.\n\nSee also\n\nAPI.h5l_create_external\n\n\n\n\n\n","category":"function"},{"location":"interface/objects/#Objects","page":"Objects","title":"Objects","text":"","category":"section"},{"location":"interface/objects/","page":"Objects","title":"Objects","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/objects/","page":"Objects","title":"Objects","text":"copy_object\ndelete_object","category":"page"},{"location":"interface/objects/#HDF5.copy_object","page":"Objects","title":"HDF5.copy_object","text":"copy_object(src_parent::Union{File,Group}, src_path::AbstractString, dst_parent::Union{File,Group}, dst_path::AbstractString)\n\nCopy data from src_parent[src_path] to dst_parent[dst_path].\n\nExamples\n\nf = h5open(\"f.h5\", \"r\")\ng = h5open(\"g.h5\", \"cw\")\ncopy_object(f, \"Group1\", g, \"GroupA\")\ncopy_object(f[\"Group1\"], \"data1\", g, \"DataSet/data_1\")\n\n\n\n\n\ncopy_object(src_obj::Object, dst_parent::Union{File,Group}, dst_path::AbstractString)\n\nExamples\n\ncopy_object(f[\"Group1\"], g, \"GroupA\")\ncopy_object(f[\"Group1/data1\"], g, \"DataSet/data_1\")\n\n\n\n\n\n","category":"function"},{"location":"interface/objects/#HDF5.delete_object","page":"Objects","title":"HDF5.delete_object","text":"delete_object(parent::Union{File,Group}, path::AbstractString)\n\nDelete the object at parent[path].\n\nExamples\n\nf = h5open(\"f.h5\", \"r+\")\ndelete_object(f, \"Group1\")\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Dataset","page":"Dataset","title":"Dataset","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"Many dataset operations are available through the indexing interface, which is aliased to the functional interface. Below describes the functional interface.","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"Dataset\ncreate_dataset\nBase.copyto!\nBase.similar\ncreate_external_dataset\nget_datasets\nopen_dataset\nwrite_dataset\nread_dataset","category":"page"},{"location":"interface/dataset/#HDF5.Dataset","page":"Dataset","title":"HDF5.Dataset","text":"HDF5.Dataset\n\nA mutable wrapper for a HDF5 Dataset HDF5.API.hid_t.\n\n\n\n\n\n","category":"type"},{"location":"interface/dataset/#HDF5.create_dataset","page":"Dataset","title":"HDF5.create_dataset","text":"create_dataset(parent, path, datatype, dataspace; properties...)\n\nArguments\n\nparent - File or Group\npath - String describing the path of the dataset within the HDF5 file or nothing to create an anonymous dataset\ndatatype - Datatype or Type or the dataset\ndataspace - Dataspace or Dims of the dataset\nproperties - keyword name-value pairs set properties of the dataset\n\nKeywords\n\nThere are many keyword properties that can be set. Below are a few select keywords.\n\nchunk - Dims describing the size of a chunk. Needed to apply filters.\nfilters - AbstractVector{<: Filters.Filter} describing the order of the filters to apply to the data. See Filters\nexternal - Tuple{AbstractString, Intger, Integer} (filepath, offset, filesize) External dataset file location, data offset, and file size. See API.h5p_set_external.\n\nAdditionally, the initial create, transfer, and access properties can be provided as a keyword:\n\ndcpl - DatasetCreateProperties\ndxpl - DatasetTransferProperties\ndapl - DatasetAccessProperties\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Base.copyto!","page":"Dataset","title":"Base.copyto!","text":"copyto!(output_buffer::AbstractArray{T}, obj::Union{DatasetOrAttribute}) where T\n\nCopy [part of] a HDF5 dataset or attribute to a preallocated output buffer. The output buffer must be convertible to a pointer and have a contiguous layout.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Base.similar","page":"Dataset","title":"Base.similar","text":"similar(obj::DatasetOrAttribute, [::Type{T}], [dims::Integer...]; normalize = true)\n\nReturn a Array{T} or Matrix{UInt8} to that can contain [part of] the dataset.\n\nThe normalize keyword will normalize the buffer for string and array datatypes.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.create_external_dataset","page":"Dataset","title":"HDF5.create_external_dataset","text":"create_external_dataset(parent, name, filepath, dtype, dspace, offset = 0)\n\nCreate an external dataset with data in an external file.\n\nparent - File or Group\nname - Name of the Dataset\nfilepath - File path to where the data is tored\ndtype - Datatype, Type, or value where datatype is applicable\noffset - Offset, in bytes, from the beginning of the file to the location in the file where the data starts.\n\nSee also API.h5p_set_external to link to multiple segments.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_datasets","page":"Dataset","title":"HDF5.get_datasets","text":"get_datasets(file::HDF5.File) -> datasets::Vector{HDF5.Dataset}\n\nGet all the datasets in an hdf5 file without loading the data.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.open_dataset","page":"Dataset","title":"HDF5.open_dataset","text":"open_dataset(parent::Union{File, Group}, path::AbstractString; properties...)\n\nOpen an existing HDF5.Dataset at path under parent\n\nOptional keyword arguments include any keywords that that belong to DatasetAccessProperties or DatasetTransferProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.write_dataset","page":"Dataset","title":"HDF5.write_dataset","text":"write_dataset(parent::Union{File,Group}, name::Union{AbstractString,Nothing}, data; pv...)\n\nCreate and write a dataset with data. Keywords are forwarded to create_dataset. Providing nothing as the name will create an anonymous dataset.\n\nSee also create_dataset\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.read_dataset","page":"Dataset","title":"HDF5.read_dataset","text":"read_dataset(parent::Union{File,Group}, name::AbstractString)\n\nRead a dataset with named name from parent. This will typically return an array. The dataset will be opened, read, and closed.\n\nSee also HDF5.open_dataset, Base.read\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Chunks","page":"Dataset","title":"Chunks","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"do_read_chunk\ndo_write_chunk\nget_chunk_index\nget_chunk_info_all\nget_chunk_length\nget_chunk_offset\nget_num_chunks\nget_num_chunks_per_dim\nread_chunk\nwrite_chunk","category":"page"},{"location":"interface/dataset/#HDF5.do_read_chunk","page":"Dataset","title":"HDF5.do_read_chunk","text":"do_read_chunk(dataset::Dataset, offset)\n\nRead a raw chunk at a given offset. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.\n\n\n\n\n\ndo_read_chunk(dataset::Dataset, index::Integer)\n\nRead a raw chunk at a given index. index is 1-based and consecutive up to the number of chunks.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.do_write_chunk","page":"Dataset","title":"HDF5.do_write_chunk","text":"do_write_chunk(dataset::Dataset, offset, chunk_bytes::AbstractArray, filter_mask=0)\n\nWrite a raw chunk at a given offset. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. offset is a 1-based list of rank ndims(dataset) and must fall on a chunk boundary.\n\n\n\n\n\ndo_write_chunk(dataset::Dataset, index, chunk_bytes::AbstractArray, filter_mask=0)\n\nWrite a raw chunk at a given linear index. chunk_bytes is an AbstractArray that can be converted to a pointer, Ptr{Cvoid}. index is 1-based and consecutive up to the number of chunks.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_index","page":"Dataset","title":"HDF5.get_chunk_index","text":"HDF5.get_chunk_index(dataset_id, offset)\n\nGet 0-based index of chunk from 0-based offset returned in Julia's column-major order. For a 1-based API, see HDF5.ChunkStorage.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_info_all","page":"Dataset","title":"HDF5.get_chunk_info_all","text":"HDF5.get_chunk_info_all(dataset, [dxpl])\n\nObtain information on all the chunks in a dataset. Returns a Vector{ChunkInfo{N}}. The fields of ChunkInfo{N} are\n\noffset - NTuple{N, Int} indicating the offset of the chunk in terms of elements, reversed to F-order\nfilter_mask - Cuint, 32-bit flags indicating whether filters have been applied to the cunk\naddr - haddr_t, byte-offset of the chunk in the file\nsize - hsize_t, size of the chunk in bytes\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_length","page":"Dataset","title":"HDF5.get_chunk_length","text":"HDF5.get_chunk_length(dataset_id)\n\nRetrieves the chunk size in bytes. Equivalent to API.h5d_get_chunk_info(dataset_id, index)[:size].\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_chunk_offset","page":"Dataset","title":"HDF5.get_chunk_offset","text":"HDF5.get_chunk_offset(dataset_id, index)\n\nGet 0-based offset of chunk from 0-based index. The offsets are returned in Julia's column-major order rather than hdf5 row-major order. For a 1-based API, see HDF5.ChunkStorage.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_num_chunks","page":"Dataset","title":"HDF5.get_num_chunks","text":"HDF5.get_num_chunks(dataset_id)\n\nReturns the number of chunks in a dataset. Equivalent to API.h5d_get_num_chunks(dataset_id, HDF5.H5S_ALL).\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.get_num_chunks_per_dim","page":"Dataset","title":"HDF5.get_num_chunks_per_dim","text":"HDF5.get_num_chunks_per_dim(dataset_id)\n\nGet the number of chunks in each dimension in Julia's column-major order.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.read_chunk","page":"Dataset","title":"HDF5.read_chunk","text":"HDF5.read_chunk(dataset_id, offset, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())\n\nHelper method to read chunks via 0-based offsets in a Tuple.\n\nArgument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.get_chunk_length. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.\n\nThis method returns Vector{UInt8}.\n\n\n\n\n\nHDF5.read_chunk(dataset_id, index::Integer, [buf]; dxpl_id = HDF5.API.H5P_DEFAULT, filters = Ref{UInt32}())\n\nHelper method to read chunks via 0-based integer index.\n\nArgument buf is optional and defaults to a Vector{UInt8} of length determined by HDF5.API.h5d_get_chunk_info. Argument dxpl_id can be supplied a keyword and defaults to HDF5.API.H5P_DEFAULT. Argument filters can be retrieved by supplying a Ref{UInt32} value via a keyword argument.\n\nThis method returns Vector{UInt8}.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5.write_chunk","page":"Dataset","title":"HDF5.write_chunk","text":"HDF5.write_chunk(dataset_id, offset, buf::AbstractArray; dxpl_id = HDF5.API.H5P_DEFAULT, filter_mask = 0)\n\nHelper method to write chunks via 0-based offsets offset as a Tuple.\n\n\n\n\n\nHDF5.write_chunk(dataset_id, index::Integer, buf::AbstractArray; dxpl_id = API.H5P_DEFAULT, filter_mask = 0)\n\nHelper method to write chunks via 0-based integer index.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#Private-Implementation","page":"Dataset","title":"Private Implementation","text":"","category":"section"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"These functions select private implementations of the public high-level API. They should be used for diagnostic purposes only.","category":"page"},{"location":"interface/dataset/","page":"Dataset","title":"Dataset","text":"_get_chunk_info_all_by_index\n_get_chunk_info_all_by_iter","category":"page"},{"location":"interface/dataset/#HDF5._get_chunk_info_all_by_index","page":"Dataset","title":"HDF5._get_chunk_info_all_by_index","text":"_get_chunk_info_all_by_index(dataset, [dxpl])\n\nImplementation of get_chunk_info_all via HDF5.API.h5d_get_chunk_info.\n\nWe expect this will be slower, O(N^2), than using h5d_chunk_iter since each call to h5d_get_chunk_info iterates through the B-tree structure.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataset/#HDF5._get_chunk_info_all_by_iter","page":"Dataset","title":"HDF5._get_chunk_info_all_by_iter","text":"_get_chunk_info_all_by_iter(dataset, [dxpl])\n\nImplementation of get_chunk_info_all via HDF5.API.h5d_chunk_iter.\n\nWe expect this will be faster, O(N), than using h5d_get_chunk_info since this allows us to iterate through the chunks once.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Files","page":"Files","title":"Files","text":"","category":"section"},{"location":"interface/files/","page":"Files","title":"Files","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/files/","page":"Files","title":"Files","text":"h5open\nishdf5\nBase.isopen\nBase.read\nstart_swmr_write","category":"page"},{"location":"interface/files/#HDF5.h5open","page":"Files","title":"HDF5.h5open","text":"h5open(filename::AbstractString, mode::AbstractString=\"r\"; swmr=false, pv...)\n\nOpen or create an HDF5 file where mode is one of:\n\n\"r\" read only\n\"r+\" read and write\n\"cw\" read and write, create file if not existing, do not truncate\n\"w\" read and write, create a new file (destroys any existing contents)\n\nPass swmr=true to enable (Single Writer Multiple Reader) SWMR write access for \"w\" and \"r+\", or SWMR read access for \"r\".\n\nProperties can be specified as keywords for FileAccessProperties and FileCreateProperties.\n\nAlso the keywords fapl and fcpl can be used to provide default instances of these property lists. Property lists passed in via keyword will be closed. This is useful to set properties not currently defined by HDF5.jl.\n\nNote that h5open uses fclose_degree = :strong by default, but this can be overriden by the fapl keyword.\n\n\n\n\n\nfunction h5open(f::Function, args...; pv...)\n\nApply the function f to the result of h5open(args...; kwargs...) and close the resulting HDF5.File upon completion. For example with a do block:\n\nh5open(\"foo.h5\",\"w\") do h5\n h5[\"foo\"]=[1,2,3]\nend\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#HDF5.ishdf5","page":"Files","title":"HDF5.ishdf5","text":"ishdf5(name::AbstractString)\n\nReturns true if the file specified by name is in the HDF5 format, and false otherwise.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Base.isopen","page":"Files","title":"Base.isopen","text":"isopen(obj::HDF5.File)\n\nReturns true if obj has not been closed, false if it has been closed.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#Base.read","page":"Files","title":"Base.read","text":"read(parent::H5DataStore)\nread(parent::H5DataStore, names...)\n\nRead a list of variables, read(parent, \"A\", \"B\", \"x\", ...). If no variables are specified, read every variable in the file.\n\n\n\n\n\nread(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString; pv...)\nread(parent::Union{HDF5.File, HDF5.Group}, name::AbstractString => dt::HDF5.Datatype; pv...)\n\nRead a dataset or attribute from a HDF5 file of group identified by name. Optionally, specify the HDF5.Datatype to be read.\n\n\n\n\n\nread(obj::HDF5.DatasetOrAttribute}\n\nRead the data within a HDF5.Dataset or HDF5.Attribute.\n\n\n\n\n\n","category":"function"},{"location":"interface/files/#HDF5.start_swmr_write","page":"Files","title":"HDF5.start_swmr_write","text":"start_swmr_write(h5::HDF5.File)\n\nStart Single Reader Multiple Writer (SWMR) writing mode.\n\nExternal links\n\nSingle Writer Multiple Reader from the HDF5 manual.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Attributes","page":"Attributes","title":"Attributes","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/attributes/#Dictionary-interface","page":"Attributes","title":"Dictionary interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"attrs\nattributes","category":"page"},{"location":"interface/attributes/#HDF5.attrs","page":"Attributes","title":"HDF5.attrs","text":"attrs(object::Union{File,Group,Dataset,Datatype})\n\nThe attributes dictionary of object. Returns an AttributeDict, a Dict-like object for accessing the attributes of object.\n\nattrs(object)[\"name\"] = value # create/overwrite an attribute\nattr = attrs(object)[\"name\"] # read an attribute\ndelete!(attrs(object), \"name\") # delete an attribute\nkeys(attrs(object)) # list the attribute names\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.attributes","page":"Attributes","title":"HDF5.attributes","text":"attributes(object::Union{File,Object})\n\nThe attributes of a file or object: this returns an Attributes object, which is Dict-like object for accessing the attributes of object: getindex will return an Attribute object, and setindex! will call write_attribute.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Mid-level-Interface","page":"Attributes","title":"Mid-level Interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"Attribute\nopen_attribute\ncreate_attribute\nread_attribute\nwrite_attribute\ndelete_attribute\nrename_attribute","category":"page"},{"location":"interface/attributes/#HDF5.Attribute","page":"Attributes","title":"HDF5.Attribute","text":"HDF5.Attribute\n\nA HDF5 attribute: this is a piece of metadata attached to an HDF5 Group or Dataset. It acts like a Dataset, in that it has a defined datatype and dataspace, and can read and write data to it.\n\nSee also\n\nopen_attribute\ncreate_attribute\nread_attribute\nwrite_attribute\ndelete_attribute\n\n\n\n\n\n","category":"type"},{"location":"interface/attributes/#HDF5.open_attribute","page":"Attributes","title":"HDF5.open_attribute","text":"open_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)\n\nOpen the Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.create_attribute","page":"Attributes","title":"HDF5.create_attribute","text":"create_attribute(parent::Union{File,Object}, name::AbstractString, dtype::Datatype, space::Dataspace)\ncreate_attribute(parent::Union{File,Object}, name::AbstractString, data)\n\nCreate a new Attribute object named name on the object parent, either by specifying the Datatype and Dataspace of the attribute, or by providing the data. Note that no data will be written: use write_attribute to write the data.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.read_attribute","page":"Attributes","title":"HDF5.read_attribute","text":"read_attribute(parent::Union{File,Group,Dataset,Datatype}, name::AbstractString)\n\nRead the value of the named attribute on the parent object.\n\nExample\n\njulia> HDF5.read_attribute(g, \"time\")\n2.45\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.write_attribute","page":"Attributes","title":"HDF5.write_attribute","text":"write_attribute(parent::Union{File,Object}, name::AbstractString, data)\n\nWrite data as an Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.delete_attribute","page":"Attributes","title":"HDF5.delete_attribute","text":"delete_attribute(parent::Union{File,Object}, name::AbstractString)\n\nDelete the Attribute named name on the object parent.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.rename_attribute","page":"Attributes","title":"HDF5.rename_attribute","text":"rename_attribute(parent::Union{File,Object}, oldname::AbstractString, newname::AbstractString)\n\nRename the Attribute of the object parent named oldname to newname.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#Convenience-interface","page":"Attributes","title":"Convenience interface","text":"","category":"section"},{"location":"interface/attributes/","page":"Attributes","title":"Attributes","text":"h5readattr\nh5writeattr\nnum_attrs","category":"page"},{"location":"interface/attributes/#HDF5.h5readattr","page":"Attributes","title":"HDF5.h5readattr","text":"h5readattr(filename, name::AbstractString, data::Dict)\n\nRead the attributes of the object at name in the HDF5 file filename, returning a Dict.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.h5writeattr","page":"Attributes","title":"HDF5.h5writeattr","text":"h5writeattr(filename, name::AbstractString, data::Dict)\n\nWrite data as attributes to the object at name in the HDF5 file filename.\n\n\n\n\n\n","category":"function"},{"location":"interface/attributes/#HDF5.num_attrs","page":"Attributes","title":"HDF5.num_attrs","text":"num_attrs()\n\nRetrieve the number of attributes from an object.\n\nSee API.h5o_get_info.\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Properties","page":"Properties","title":"Properties","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"HDF5 property lists are collections of name-value pairs which can be passed to other HDF5 functions to control features that are typically unimportant or whose default values are usually used. In HDF5.jl, these options are typically handled by keyword arguments to such functions, which will internally create the appropriate Properties objects, and so users will not usually be required to construct them manually.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"Not all properties defined by the HDF5 library are currently available in HDF5.jl. If you require additional properties, please open an issue or pull request.","category":"page"},{"location":"interface/properties/#Common-functions","page":"Properties","title":"Common functions","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"setproperties!","category":"page"},{"location":"interface/properties/#HDF5.setproperties!","page":"Properties","title":"HDF5.setproperties!","text":"setproperties!(props::Properties...; kwargs...)\n\nFor each (key, value) pair in kwargs, set the corresponding properties in each Properties object in props. Returns a Dict of any pairs which didn't match properties in props.\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Properties-types","page":"Properties","title":"Properties types","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"AttributeCreateProperties\nFileAccessProperties\nFileCreateProperties\nGroupAccessProperties\nGroupCreateProperties\nDatasetCreateProperties\nDatasetAccessProperties\nDatatypeAccessProperties\nDatasetTransferProperties\nLinkCreateProperties\nObjectCreateProperties\nStringCreateProperties\nDatatypeCreateProperties","category":"page"},{"location":"interface/properties/#HDF5.AttributeCreateProperties","page":"Properties","title":"HDF5.AttributeCreateProperties","text":"AttributeCreateProperties(;kws...)\nAttributeCreateProperties(f::Function; kws...)\n\nProperties used when creating attributes.\n\nchar_encoding: the character enconding, either :ascii or :utf8.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.FileAccessProperties","page":"Properties","title":"HDF5.FileAccessProperties","text":"FileAccessProperties(;kws...)\nFileAccessProperties(f::Function; kws...)\n\nProperties used when accessing files.\n\nalignment :: Tuple{Integer, Integer}: a (threshold, alignment) pair: any file object greater than or equal in size to threshold bytes will be aligned on an address which is a multiple of alignment. Default values are 1, implying no alignment.\ndriver: the file driver used to access the file. See Drivers.\ndriver_info (get only)\nfclose_degree: file close degree property. One of:\n:weak\n:semi\n:strong\n:default\nlibver_bounds: a (low, high) pair: low sets the earliest possible format versions that the library will use when creating objects in the file; high sets the latest format versions that the library will be allowed to use when creating objects in the file. Values can be a VersionNumber for the hdf5 library, :earliest, or :latest . See H5P_SET_LIBVER_BOUNDS\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.FileCreateProperties","page":"Properties","title":"HDF5.FileCreateProperties","text":"FileCreateProperties(;kws...)\nFileCreateProperties(f::Function; kws...)\n\nProperties used when creating a new File. Inherits from ObjectCreateProperties, with additional properties:\n\nuserblock :: Integer: user block size in bytes. The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.). See H5P_SET_USERBLOCK.\ntrack_order :: Bool: tracks the file creation order.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.GroupAccessProperties","page":"Properties","title":"HDF5.GroupAccessProperties","text":"GroupAccessProperties(;kws...)\n\nProperties used when accessing datatypes. None are currently defined.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.GroupCreateProperties","page":"Properties","title":"HDF5.GroupCreateProperties","text":"GroupCreateProperties(;kws...)\nGroupCreateProperties(f::Function; kws...)\n\nProperties used when creating a new Group. Inherits from ObjectCreateProperties, with additional options:\n\nlocal_heap_size_hint :: Integer: the anticipated maximum local heap size in bytes. See H5P_SET_LOCAL_HEAP_SIZE_HINT.\ntrack_order :: Bool: tracks the group creation order.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetCreateProperties","page":"Properties","title":"HDF5.DatasetCreateProperties","text":"DatasetCreateProperties(;kws...)\nDatasetCreateProperties(f::Function; kws...)\n\nProperties used when creating a new Dataset. Inherits from ObjectCreateProperties, with additional properties:\n\nalloc_time: the timing for the allocation of storage space for a dataset's raw data; one of:\n:default\n:early: allocate all space when the dataset is created\n:incremental: Allocate space incrementally, as data is written to the dataset\n:late: Allocate all space when data is first written to the dataset.\nSee H5P_SET_ALLOC_TIME.\nfill_time: the timing of when the dataset should be filled; one of:\n:alloc: Fill when allocated\n:never: Never fill\n:ifset: Fill if a value is set\nfill_value: the fill value for a dataset. See H5P_SET_FILL_VALUE.\nchunk: a tuple containing the size of the chunks to store each dimension. See H5P_SET_CHUNK (note that this uses Julia's column-major ordering).\nexternal: A tuple of (name,offset,size), See H5P_SET_EXTERNAL.\nfilters (only valid when layout=:chunked): a filter or vector of filters that are applied to applied to each chunk of a dataset, see Filters. When accessed, will return a Filters.FilterPipeline object that can be modified in-place.\nlayout: the type of storage used to store the raw data for a dataset. Can be one of:\n:compact: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data.\n:contiguous: Store raw data separately from the object header in one large chunk in the file.\n:chunked: Store raw data separately from the object header as chunks of data in separate locations in the file.\n:virtual: Draw raw data from multiple datasets in different files. See the virtual property below.\nSee H5P_SET_LAYOUT.\nno_attrs_hint: Minimize the space for dataset metadata by hinting that no attributes will be added if set to true. Attributes can still be added but may exist elsewhere within the file. See H5P_SET_DSET_NO_ATTRS_HINT.\nvirtual: when specified, creates a virtual dataset (VDS). The argument should be a \"virtuala collection of VirtualMapping objects for describing the mapping from the dataset to the source datasets. When accessed, returns a VirtualLayout object.\n\nThe following options are shortcuts for the various filters, and are set-only. They will be appended to the filter pipeline in the order in which they appear\n\nblosc = true | level: set the H5Zblosc.BloscFilter compression filter; argument can be either true, or the compression level.\ndeflate = true | level: set the Filters.Deflate compression filter; argument can be either true, or the compression level.\nfletcher32 = true: set the Filters.Fletcher32 checksum filter.\nshuffle = true: set the Filters.Shuffle filter.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetAccessProperties","page":"Properties","title":"HDF5.DatasetAccessProperties","text":"DatasetAccessProperties(;kws...)\nDatasetAccessProperties(f::Function; kws...)\n\nProperties that control access to data in external, virtual, and chunked datasets.\n\nchunk_cache: Chunk cache parameters as (nslots, nbytes, w0). Default: (521, 0x100000, 0.75)\nefile_prefix: Path prefix for reading external files. The default is the current working directory.\n:origin: alias for raw\"$ORIGIN\" will make the external file relative to the HDF5 file.\nvirtual_prefix: Path prefix for reading virtual datasets.\nvirtual_printf_gap: The maximum number of missing source files and/or datasets with the printf-style names when getting the extent of an unlimited virtual dataset\nvirtual_view: Influences whether the view of the virtual dataset includes or excludes missing mapped elements\n:first_missing: includes all data before the first missing mapped data\n:last_available: includes all available mapped data\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\nSee Dataset Access Properties\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatatypeAccessProperties","page":"Properties","title":"HDF5.DatatypeAccessProperties","text":"DatatypeAccessProperties(;kws...)\n\nProperties used when accessing datatypes. None are currently defined.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatasetTransferProperties","page":"Properties","title":"HDF5.DatasetTransferProperties","text":"DatasetTransferProperties(;kws...)\nDatasetTransferProperties(f::Function; kws...)\n\nProperties used when transferring data to/from datasets\n\ndxpl_mpio: MPI transfer mode when using Drivers.MPIO file driver:\n:independent: use independent I/O access (default),\n:collective: use collective I/O access.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.LinkCreateProperties","page":"Properties","title":"HDF5.LinkCreateProperties","text":"LinkCreateProperties(;kws...)\nLinkCreateProperties(f::Function; kws...)\n\nProperties used when creating links.\n\nchar_encoding: the character enconding, either :ascii or :utf8.\ncreate_intermediate_group :: Bool: if true, will create missing intermediate groups.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.ObjectCreateProperties","page":"Properties","title":"HDF5.ObjectCreateProperties","text":"ObjectCreateProperties(;kws...)\nObjectCreateProperties(f::Function; kws...)\n\nProperties used when creating a new object. Available options:\n\nobj_track_times :: Bool: governs the recording of times associated with an object. If set to true, time data will be recorded. See H5P_SET_OBJ_TRACK_TIMES.\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.StringCreateProperties","page":"Properties","title":"HDF5.StringCreateProperties","text":"StringCreateProperties(;kws...)\nStringCreateProperties(f::Function; kws...)\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.DatatypeCreateProperties","page":"Properties","title":"HDF5.DatatypeCreateProperties","text":"DatatypeCreateProperties(;kws...)\nDatatypeCreateProperties(f::Function; kws...)\n\nA function argument passed via do will be given an initialized property list that will be closed.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#Virtual-Datasets","page":"Properties","title":"Virtual Datasets","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"VirtualMapping\nVirtualLayout","category":"page"},{"location":"interface/properties/#HDF5.VirtualMapping","page":"Properties","title":"HDF5.VirtualMapping","text":"VirtualMapping(\n vspace::Dataspace,\n srcfile::AbstractString,\n srcdset::AbstractString,\n srcspace::Dataspace\n)\n\nSpecify a map of elements of the virtual dataset (VDS) described by vspace to the elements of the source dataset described by srcspace. The source dataset is identified by the name of the file where it is located, srcfile, and the name of the dataset, srcdset.\n\nBoth srcfile and srcdset support \"printf\"-style formats with %b being replaced by the block count of the selection.\n\nFor more details on how source file resolution works, see H5P_SET_VIRTUAL.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.VirtualLayout","page":"Properties","title":"HDF5.VirtualLayout","text":"VirtualLayout(dcpl::DatasetCreateProperties)\n\nThe collection of VirtualMappings associated with dcpl. This is an AbstractVector{VirtualMapping}, supporting length, getindex and push!.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#Drivers","page":"Properties","title":"Drivers","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"File drivers determine how the HDF5 is accessed. These can be set as the driver property in FileAccessProperties.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5.Drivers","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"Core\nPOSIX\nROS3\nMPIO","category":"page"},{"location":"interface/properties/#HDF5.Drivers.Core","page":"Properties","title":"HDF5.Drivers.Core","text":"Core([increment::Csize_t, backing_store::Cuint, [write_tracking::Cuint, page_size::Csize_t]])\nCore(; increment::Csize_t = 8192, backing_store::Cuint = true, write_tracking::Cuint = false, page_size::Csize_t = 524288)\n\nArguments\n\nincrement: specifies the increment by which allocated memory is to be increased each time more memory is required. (default: 8192)\nbacking_store: Boolean flag indicating whether to write the file contents to disk when the file is closed. (default: false)\nwrite_tracking: Boolean flag indicating whether write tracking is enabled. (default: false)\npage_size: Size, in bytes, of write aggregation pages. (default: 524288)\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.POSIX","page":"Properties","title":"HDF5.Drivers.POSIX","text":"POSIX()\n\nAlso referred to as SEC2, this driver uses POSIX file-system functions like read and write to perform I/O to a single, permanent file on local disk with no system buffering. This driver is POSIX-compliant and is the default file driver for all systems.\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.ROS3","page":"Properties","title":"HDF5.Drivers.ROS3","text":"ROS3()\nROS3(aws_region::String, secret_id::String, secret_key::String)\nROS3(version::Int32, authenticate::Bool, aws_region::String, secret_id::String, secret_key::String)\n\nThis is the read-only virtual driver that enables access to HDF5 objects stored in AWS S3\n\n\n\n\n\n","category":"type"},{"location":"interface/properties/#HDF5.Drivers.MPIO","page":"Properties","title":"HDF5.Drivers.MPIO","text":"MPIO(comm::MPI.Comm, info::MPI.Info)\nMPIO(comm::MPI.Comm; kwargs....)\n\nThe parallel MPI file driver. This requires the use of MPI.jl, and a custom HDF5 binary that has been built with MPI support.\n\ncomm is the communicator over which the file will be opened.\ninfo/kwargs are MPI-IO options, and are passed to MPI_FILE_OPEN.\n\nSee also\n\nHDF5.has_parallel\nParallel HDF5\n\nExternal links\n\nH5P_SET_FAPL_MPIO\nParallel HDF5\n\n\n\n\n\n","category":"function"},{"location":"interface/properties/#Internals","page":"Properties","title":"Internals","text":"","category":"section"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"The following macros are used for defining new properties and property getters/setters.","category":"page"},{"location":"interface/properties/","page":"Properties","title":"Properties","text":"@propertyclass\n@bool_property\n@enum_property\n@tuple_property","category":"page"},{"location":"interface/properties/#HDF5.@propertyclass","page":"Properties","title":"HDF5.@propertyclass","text":"@propertyclass P classid\n\nDefine a new subtype of P <: Properties corresponding to a HDF5 property list with class identifier classid.\n\nOnce defined, the following interfaces can be defined:\n\nsuperclass(::Type{P})\n\nThis should return the type from which P inherits. If not defined, it will inherit from GenericProperties.\n\nclass_propertynames(::Type{P})\n\nThis should return a Tuple of Symbols, being the names of the properties associated with P.\n\nclass_getproperty(::Type{P}, p::Properties, name::Symbol)\n\nIf name is an associated property of type P, this should return the value of the property, otherwise call class_getproperty(superclass(P), p, name).\n\nclass_setproperty!(::Type{P}, p::Properties, name::Symbol, val)\n\nIf name is an associated property of type P, this should set the value of the property, otherwise call class_setproperty!(superclass(P), p, name, val).\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@bool_property","page":"Properties","title":"HDF5.@bool_property","text":"@bool_property(name)\n\nWrap property getter/setter API functions that use 0/1 to use Bool values\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@enum_property","page":"Properties","title":"HDF5.@enum_property","text":"@enum_property(name, sym1 => enumvalue1, sym2 => enumvalue2, ...)\n\nWrap property getter/setter API functions that use enum values to use symbol instead.\n\n\n\n\n\n","category":"macro"},{"location":"interface/properties/#HDF5.@tuple_property","page":"Properties","title":"HDF5.@tuple_property","text":"@tuple_property(name)\n\n\n\n\n\n","category":"macro"},{"location":"interface/datatype/#Datatypes","page":"Datatypes","title":"Datatypes","text":"","category":"section"},{"location":"interface/datatype/","page":"Datatypes","title":"Datatypes","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/datatype/","page":"Datatypes","title":"Datatypes","text":"Datatype\nopen_datatype","category":"page"},{"location":"interface/datatype/#HDF5.Datatype","page":"Datatypes","title":"HDF5.Datatype","text":"HDF5.Datatype(id, toclose = true)\n\nWrapper for a HDF5 datatype id. If toclose is true, the finalizer will close the datatype.\n\n\n\n\n\n","category":"type"},{"location":"interface/datatype/#HDF5.open_datatype","page":"Datatypes","title":"HDF5.open_datatype","text":"open_datatype(parent::Union{File,Group}, path::AbstractString; properties...)\n\nOpen an existing Datatype at path under the parent object.\n\nOptional keyword arguments include any keywords that that belong to DatatypeAccessProperties.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#Configuration","page":"Configuration","title":"Configuration","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"has_parallel\nhas_ros3","category":"page"},{"location":"interface/configuration/#HDF5.has_parallel","page":"Configuration","title":"HDF5.has_parallel","text":"has_parallel()\n\nReturns true if the HDF5 libraries were compiled with MPI parallel support via the Drivers.MPIO driver.\n\nSee Parallel HDF5 for more details.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#HDF5.has_ros3","page":"Configuration","title":"HDF5.has_ros3","text":"has_ros3()\n\nReturns true if the HDF5 libraries were compiled with ros3 support\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#Display","page":"Configuration","title":"Display","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"SHOW_TREE_ICONS\nSHOW_TREE_MAX_CHILDREN\nSHOW_TREE_MAX_DEPTH","category":"page"},{"location":"interface/configuration/#HDF5.SHOW_TREE_ICONS","page":"Configuration","title":"HDF5.SHOW_TREE_ICONS","text":"SHOW_TREE_ICONS = Ref{Bool}(true)\n\nConfigurable option to control whether emoji icons (true) or a plain-text annotation (false) is used to indicate the object type by show_tree.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.SHOW_TREE_MAX_CHILDREN","page":"Configuration","title":"HDF5.SHOW_TREE_MAX_CHILDREN","text":"SHOW_TREE_MAX_CHILDREN = Ref{Int}(50)\n\nMaximum number of children to show at each node.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.SHOW_TREE_MAX_DEPTH","page":"Configuration","title":"HDF5.SHOW_TREE_MAX_DEPTH","text":"SHOW_TREE_MAX_DEPTH = Ref{Int}(5)\n\nMaximum recursive depth to descend during printing.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#Internals","page":"Configuration","title":"Internals","text":"","category":"section"},{"location":"interface/configuration/","page":"Configuration","title":"Configuration","text":"get_context_property\nCONTEXT\nHDF5Context","category":"page"},{"location":"interface/configuration/#HDF5.get_context_property","page":"Configuration","title":"HDF5.get_context_property","text":"get_context_property(name::Symbol)\n\nInternal API\n\nRetrieve a property list from the task local context, defaulting to HDF5.CONTEXT if task_local_storage()[:hdf5_context] does not exist.\n\n\n\n\n\n","category":"function"},{"location":"interface/configuration/#HDF5.CONTEXT","page":"Configuration","title":"HDF5.CONTEXT","text":"HDF5.CONTEXT\n\nInternal API\n\nDefault HDF5Context.\n\n\n\n\n\n","category":"constant"},{"location":"interface/configuration/#HDF5.HDF5Context","page":"Configuration","title":"HDF5.HDF5Context","text":"HDF5Context\n\nInternal API\n\nAn HDF5Context is a collection of HDF5 property lists. It is meant to be used as a Task local mechanism to store state and change the default property lists for new objects.\n\nUse the function get_context_property(name::Symbol) to access a property list within the local context.\n\nThe context in task_local_storage()[:hdf5_context] will be checked first. A common global HDF5Context is stored in the constant HDF5.CONTEXT and serves as the default context if the current task does not have a :hdf5_context.\n\nFields\n\nattribute_access\nattribute_create\ndataset_access\ndataset_create\ndataset_tranfer\ndatatype_access\ndatatype_create\nfile_access\nfile_create\nfile_mount\ngroup_access\ngroup_create\nlink_access\nlink_create\nobject_copy\nobject_create\nstring_create\n\n\n\n\n\n","category":"type"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"CurrentModule = HDF5.API","category":"page"},{"location":"api_bindings/#Low-level-library-bindings","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"At the lowest level, HDF5.jl operates by calling the public API of the HDF5 shared library through a set of ccall wrapper functions. This page documents the function names and nominal C argument types of the API which have bindings in this package. Note that in many cases, high-level data types are valid arguments through automatic ccall conversions. For instance, HDF5.Datatype objects will be automatically converted to their hid_t ID by Julia's cconvert+unsafe_convert ccall rules.","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"There are additional helper wrappers (often for out-argument functions) which are not documented here.","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5","page":"Low-level library bindings","title":"H5 — General Library Functions","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5_close\nh5_dont_atexit\nh5_free_memory\nh5_garbage_collect\nh5_get_libversion\nh5_is_library_threadsafe\nh5_open\nh5_set_free_list_limits","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5_close\nh5_dont_atexit\nh5_free_memory\nh5_garbage_collect\nh5_get_libversion\nh5_is_library_threadsafe\nh5_open\nh5_set_free_list_limits","category":"page"},{"location":"api_bindings/#HDF5.API.h5_close","page":"Low-level library bindings","title":"HDF5.API.h5_close","text":"h5_close()\n\nSee libhdf5 documentation for H5close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_dont_atexit","page":"Low-level library bindings","title":"HDF5.API.h5_dont_atexit","text":"h5_dont_atexit()\n\nSee libhdf5 documentation for H5dont_atexit.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_free_memory","page":"Low-level library bindings","title":"HDF5.API.h5_free_memory","text":"h5_free_memory(buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5free_memory.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_garbage_collect","page":"Low-level library bindings","title":"HDF5.API.h5_garbage_collect","text":"h5_garbage_collect()\n\nSee libhdf5 documentation for H5garbage_collect.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_get_libversion","page":"Low-level library bindings","title":"HDF5.API.h5_get_libversion","text":"h5_get_libversion(majnum::Ref{Cuint}, minnum::Ref{Cuint}, relnum::Ref{Cuint})\n\nSee libhdf5 documentation for H5get_libversion.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_is_library_threadsafe","page":"Low-level library bindings","title":"HDF5.API.h5_is_library_threadsafe","text":"h5_is_library_threadsafe(is_ts::Ref{Cuint})\n\nSee libhdf5 documentation for H5is_library_threadsafe.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_open","page":"Low-level library bindings","title":"HDF5.API.h5_open","text":"h5_open()\n\nSee libhdf5 documentation for H5open.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5_set_free_list_limits","page":"Low-level library bindings","title":"HDF5.API.h5_set_free_list_limits","text":"h5_set_free_list_limits(reg_global_lim::Cint, reg_list_lim::Cint, arr_global_lim::Cint, arr_list_lim::Cint, blk_global_lim::Cint, blk_list_lim::Cint)\n\nSee libhdf5 documentation for H5set_free_list_limits.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5A","page":"Low-level library bindings","title":"H5A — Attribute Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5a_close\nh5a_create\nh5a_create_by_name\nh5a_delete\nh5a_delete_by_idx\nh5a_delete_by_name\nh5a_exists\nh5a_exists_by_name\nh5a_get_create_plist\nh5a_get_name\nh5a_get_name_by_idx\nh5a_get_space\nh5a_get_type\nh5a_iterate\nh5a_open\nh5a_open_by_idx\nh5a_read\nh5a_rename\nh5a_write","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5a_close\nh5a_create\nh5a_create_by_name\nh5a_delete\nh5a_delete_by_idx\nh5a_delete_by_name\nh5a_exists\nh5a_exists_by_name\nh5a_get_create_plist\nh5a_get_name\nh5a_get_name_by_idx\nh5a_get_space\nh5a_get_type\nh5a_iterate\nh5a_open\nh5a_open_by_idx\nh5a_read\nh5a_rename\nh5a_write","category":"page"},{"location":"api_bindings/#HDF5.API.h5a_close","page":"Low-level library bindings","title":"HDF5.API.h5a_close","text":"h5a_close(id::hid_t)\n\nSee libhdf5 documentation for H5Aclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_create","page":"Low-level library bindings","title":"HDF5.API.h5a_create","text":"h5a_create(loc_id::hid_t, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Acreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_create_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_create_by_name","text":"h5a_create_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, type_id::hid_t, space_id::hid_t, acpl_id::hid_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Acreate_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete","page":"Low-level library bindings","title":"HDF5.API.h5a_delete","text":"h5a_delete(loc_id::hid_t, attr_name::Cstring)\n\nSee libhdf5 documentation for H5Adelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_delete_by_idx","text":"h5a_delete_by_idx(loc_id::hid_t, obj_name::Cstring, idx_type::Cint, order::Cint, n::hsize_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Adelete_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_delete_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_delete_by_name","text":"h5a_delete_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Adelete_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_exists","page":"Low-level library bindings","title":"HDF5.API.h5a_exists","text":"h5a_exists(obj_id::hid_t, attr_name::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Aexists.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_exists_by_name","page":"Low-level library bindings","title":"HDF5.API.h5a_exists_by_name","text":"h5a_exists_by_name(loc_id::hid_t, obj_name::Cstring, attr_name::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Aexists_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5a_get_create_plist","text":"h5a_get_create_plist(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_name","page":"Low-level library bindings","title":"HDF5.API.h5a_get_name","text":"h5a_get_name(attr_id::hid_t, buf_size::Csize_t, buf::Ptr{UInt8}) -> Cssize_t\n\nSee libhdf5 documentation for H5Aget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_name_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_get_name_by_idx","text":"h5a_get_name_by_idx(loc_id::hid_t, obj_name::Cstring, index_type::Cint, order::Cint, idx::hsize_t, name::Ptr{UInt8}, size::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Aget_name_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_space","page":"Low-level library bindings","title":"HDF5.API.h5a_get_space","text":"h5a_get_space(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_get_type","page":"Low-level library bindings","title":"HDF5.API.h5a_get_type","text":"h5a_get_type(attr_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_iterate","page":"Low-level library bindings","title":"HDF5.API.h5a_iterate","text":"h5a_iterate(obj_id::hid_t, idx_type::Cint, order::Cint, n::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Aiterate2.\n\n\n\n\n\nh5a_iterate(f, loc_id, idx_type, order, idx = 0) -> hsize_t\n\nExecutes h5a_iterate with the user-provided callback function f, returning the index where iteration ends.\n\nThe callback function must correspond to the signature\n\nf(loc::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5A_info_t}) -> Union{Bool, Integer}\n\nwhere a negative return value halts iteration abnormally (triggering an error), a true or a positive value halts iteration successfully, and false or zero continues iteration.\n\nExamples\n\njulia> HDF5.API.h5a_iterate(obj, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do loc, name, info\n println(unsafe_string(name))\n return false\n end\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_open","page":"Low-level library bindings","title":"HDF5.API.h5a_open","text":"h5a_open(obj_id::hid_t, attr_name::Cstring, aapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_open_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5a_open_by_idx","text":"h5a_open_by_idx(obj_id::hid_t, pathname::Cstring, idx_type::Cint, order::Cint, n::hsize_t, aapl_id::hid_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Aopen_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_read","page":"Low-level library bindings","title":"HDF5.API.h5a_read","text":"h5a_read(attr_id::hid_t, mem_type_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Aread.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_rename","page":"Low-level library bindings","title":"HDF5.API.h5a_rename","text":"h5a_rename(loc_id::hid_t, old_attr_name::Cstring, new_attr_name::Cstring)\n\nSee libhdf5 documentation for H5Arename.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5a_write","page":"Low-level library bindings","title":"HDF5.API.h5a_write","text":"h5a_write(attr_hid::hid_t, mem_type_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Awrite.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5D","page":"Low-level library bindings","title":"H5D — Dataset Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5d_chunk_iter\nh5d_close\nh5d_create\nh5d_create_anon\nh5d_extend\nh5d_fill\nh5d_flush\nh5d_gather\nh5d_get_access_plist\nh5d_get_chunk_info\nh5d_get_chunk_info_by_coord\nh5d_get_chunk_storage_size\nh5d_get_create_plist\nh5d_get_num_chunks\nh5d_get_offset\nh5d_get_space\nh5d_get_space_status\nh5d_get_storage_size\nh5d_get_type\nh5d_iterate\nh5d_open\nh5d_read\nh5d_read_chunk\nh5d_refresh\nh5d_scatter\nh5d_set_extent\nh5d_vlen_get_buf_size\nh5d_vlen_reclaim\nh5d_write\nh5d_write_chunk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5d_chunk_iter\nh5d_close\nh5d_create\nh5d_create_anon\nh5d_extend\nh5d_fill\nh5d_flush\nh5d_gather\nh5d_get_access_plist\nh5d_get_chunk_info\nh5d_get_chunk_info_by_coord\nh5d_get_chunk_storage_size\nh5d_get_create_plist\nh5d_get_num_chunks\nh5d_get_offset\nh5d_get_space\nh5d_get_space_status\nh5d_get_storage_size\nh5d_get_type\nh5d_iterate\nh5d_open\nh5d_read\nh5d_read_chunk\nh5d_refresh\nh5d_scatter\nh5d_set_extent\nh5d_vlen_get_buf_size\nh5d_vlen_reclaim\nh5d_write\nh5d_write_chunk","category":"page"},{"location":"api_bindings/#HDF5.API.h5d_chunk_iter","page":"Low-level library bindings","title":"HDF5.API.h5d_chunk_iter","text":"h5d_chunk_iter(dset_id::hid_t, dxpl_id::hid_t, cb::Ptr{Nothing}, op_data::Any)\n\nSee libhdf5 documentation for H5Dchunk_iter.\n\n\n\n\n\nh5d_chunk_iter(f, dataset, [dxpl_id=H5P_DEFAULT])\n\nCall f(offset::Ptr{hsize_t}, filter_mask::Cuint, addr::haddr_t, size::hsize_t) for each chunk. dataset maybe a HDF5.Dataset or a dataset id. dxpl_id is the the dataset transfer property list and is optional.\n\nAvailable only for HDF5 1.10.x series for 1.10.9 and greater or for version HDF5 1.12.3 or greater.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_close","page":"Low-level library bindings","title":"HDF5.API.h5d_close","text":"h5d_close(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Dclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_create","page":"Low-level library bindings","title":"HDF5.API.h5d_create","text":"h5d_create(loc_id::hid_t, pathname::Cstring, dtype_id::hid_t, space_id::hid_t, lcpl_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dcreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_create_anon","page":"Low-level library bindings","title":"HDF5.API.h5d_create_anon","text":"h5d_create_anon(loc_id::hid_t, type_id::hid_t, space_id::hid_t, dcpl_id::hid_t, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dcreate_anon.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_extend","page":"Low-level library bindings","title":"HDF5.API.h5d_extend","text":"h5d_extend(dataset_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dextend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_fill","page":"Low-level library bindings","title":"HDF5.API.h5d_fill","text":"h5d_fill(fill::Ptr{Cvoid}, fill_type_id::hid_t, buf::Ptr{Cvoid}, buf_type_id::hid_t, space_id::hid_t)\n\nSee libhdf5 documentation for H5Dfill.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_flush","page":"Low-level library bindings","title":"HDF5.API.h5d_flush","text":"h5d_flush(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Dflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_gather","page":"Low-level library bindings","title":"HDF5.API.h5d_gather","text":"h5d_gather(src_space_id::hid_t, src_buf::Ptr{Cvoid}, type_id::hid_t, dst_buf_size::Csize_t, dst_buf::Ptr{Cvoid}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Dgather.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_access_plist","page":"Low-level library bindings","title":"HDF5.API.h5d_get_access_plist","text":"h5d_get_access_plist(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_access_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_info","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_info","text":"h5d_get_chunk_info(dataset_id::hid_t, fspace_id::hid_t, index::hsize_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_info.\n\n\n\n\n\nh5d_get_chunk_info(dataset_id, fspace_id, index)\nh5d_get_chunk_info(dataset_id, index; fspace_id = HDF5.API.H5S_ALL)\n\nHelper method to retrieve chunk information.\n\nReturns a NamedTuple{(:offset, :filter_mask, :addr, :size), Tuple{HDF5.API.hsize_t, UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_info_by_coord","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_info_by_coord","text":"h5d_get_chunk_info_by_coord(dataset_id::hid_t, offset::Ptr{hsize_t}, filter_mask::Ptr{Cuint}, addr::Ptr{haddr_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_info_by_coord.\n\n\n\n\n\nh5d_get_chunk_info_by_coord(dataset_id, offset)\n\nHelper method to read chunk information by coordinate. Returns a NamedTuple{(:filter_mask, :addr, :size), Tuple{UInt32, HDF5.API.haddr_t, HDF5.API.hsize_t}}.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_chunk_storage_size","page":"Low-level library bindings","title":"HDF5.API.h5d_get_chunk_storage_size","text":"h5d_get_chunk_storage_size(dataset_id::hid_t, offset::Ptr{hsize_t}, chunk_nbytes::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_chunk_storage_size.\n\n\n\n\n\nh5d_get_chunk_storage_size(dataset_id, offset)\n\nHelper method to retrieve the chunk storage size in bytes. Returns an integer of type HDF5.API.hsize_t.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5d_get_create_plist","text":"h5d_get_create_plist(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_num_chunks","page":"Low-level library bindings","title":"HDF5.API.h5d_get_num_chunks","text":"h5d_get_num_chunks(dataset_id::hid_t, fspace_id::hid_t, nchunks::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dget_num_chunks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_offset","page":"Low-level library bindings","title":"HDF5.API.h5d_get_offset","text":"h5d_get_offset(dataset_id::hid_t) -> haddr_t\n\nSee libhdf5 documentation for H5Dget_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_space","page":"Low-level library bindings","title":"HDF5.API.h5d_get_space","text":"h5d_get_space(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_space_status","page":"Low-level library bindings","title":"HDF5.API.h5d_get_space_status","text":"h5d_get_space_status(dataset_id::hid_t, status::Ref{Cint})\n\nSee libhdf5 documentation for H5Dget_space_status.\n\n\n\n\n\nh5d_get_space_status(dataset_id)\n\nHelper method to retrieve the status of the dataset space. Returns a HDF5.API.H5D_space_status_t (Cint) indicating the status, see HDF5.API.H5D_SPACE_STATUS_* constants.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_storage_size","page":"Low-level library bindings","title":"HDF5.API.h5d_get_storage_size","text":"h5d_get_storage_size(dataset_id::hid_t) -> hsize_t\n\nSee libhdf5 documentation for H5Dget_storage_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_get_type","page":"Low-level library bindings","title":"HDF5.API.h5d_get_type","text":"h5d_get_type(dataset_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_iterate","page":"Low-level library bindings","title":"HDF5.API.h5d_iterate","text":"h5d_iterate(buf::Ptr{Cvoid}, type_id::hid_t, space_id::hid_t, operator::Ptr{Cvoid}, operator_data::Any)\n\nSee libhdf5 documentation for H5Diterate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_open","page":"Low-level library bindings","title":"HDF5.API.h5d_open","text":"h5d_open(loc_id::hid_t, pathname::Cstring, dapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Dopen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_read","page":"Low-level library bindings","title":"HDF5.API.h5d_read","text":"h5d_read(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dread.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_read_chunk","page":"Low-level library bindings","title":"HDF5.API.h5d_read_chunk","text":"h5d_read_chunk(dset::hid_t, dxpl_id::hid_t, offset::Ptr{hsize_t}, filters::Ptr{UInt32}, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dread_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_refresh","page":"Low-level library bindings","title":"HDF5.API.h5d_refresh","text":"h5d_refresh(dataset_id::hid_t)\n\nSee libhdf5 documentation for H5Drefresh.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_scatter","page":"Low-level library bindings","title":"HDF5.API.h5d_scatter","text":"h5d_scatter(op::Ptr{Cvoid}, op_data::Any, type_id::hid_t, dst_space_id::hid_t, dst_buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dscatter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_set_extent","page":"Low-level library bindings","title":"HDF5.API.h5d_set_extent","text":"h5d_set_extent(dataset_id::hid_t, new_dims::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dset_extent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_vlen_get_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5d_vlen_get_buf_size","text":"h5d_vlen_get_buf_size(dset_id::hid_t, type_id::hid_t, space_id::hid_t, buf::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Dvlen_get_buf_size.\n\n\n\n\n\nh5d_vlen_get_buf_size(dataset_id, type_id, space_id)\n\nHelper method to determines the number of bytes required to store the variable length data from the dataset. Returns a value of type HDF5.API.hsize_t.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_vlen_reclaim","page":"Low-level library bindings","title":"HDF5.API.h5d_vlen_reclaim","text":"h5d_vlen_reclaim(type_id::hid_t, space_id::hid_t, plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dvlen_reclaim.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_write","page":"Low-level library bindings","title":"HDF5.API.h5d_write","text":"h5d_write(dataset_id::hid_t, mem_type_id::hid_t, mem_space_id::hid_t, file_space_id::hid_t, xfer_plist_id::hid_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dwrite.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5d_write_chunk","page":"Low-level library bindings","title":"HDF5.API.h5d_write_chunk","text":"h5d_write_chunk(dset_id::hid_t, dxpl_id::hid_t, filter_mask::UInt32, offset::Ptr{hsize_t}, bufsize::Csize_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Dwrite_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5E","page":"Low-level library bindings","title":"H5E — Error Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5e_close_stack\nh5e_get_auto\nh5e_get_current_stack\nh5e_get_msg\nh5e_get_num\nh5e_set_auto\nh5e_walk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5e_close_stack\nh5e_get_auto\nh5e_get_current_stack\nh5e_get_msg\nh5e_get_num\nh5e_set_auto\nh5e_walk","category":"page"},{"location":"api_bindings/#HDF5.API.h5e_close_stack","page":"Low-level library bindings","title":"HDF5.API.h5e_close_stack","text":"h5e_close_stack(stack_id::hid_t)\n\nSee libhdf5 documentation for H5Eclose_stack.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_auto","page":"Low-level library bindings","title":"HDF5.API.h5e_get_auto","text":"h5e_get_auto(estack_id::hid_t, func::Ref{Ptr{Cvoid}}, client_data::Ref{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Eget_auto2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_current_stack","page":"Low-level library bindings","title":"HDF5.API.h5e_get_current_stack","text":"h5e_get_current_stack() -> hid_t\n\nSee libhdf5 documentation for H5Eget_current_stack.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_msg","page":"Low-level library bindings","title":"HDF5.API.h5e_get_msg","text":"h5e_get_msg(mesg_id::hid_t, mesg_type::Ref{Cint}, mesg::Ref{UInt8}, len::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Eget_msg.\n\n\n\n\n\nmesg_type, mesg = h5e_get_msg(meshg_id)\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_get_num","page":"Low-level library bindings","title":"HDF5.API.h5e_get_num","text":"h5e_get_num(estack_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Eget_num.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_set_auto","page":"Low-level library bindings","title":"HDF5.API.h5e_set_auto","text":"h5e_set_auto(estack_id::hid_t, func::Ptr{Cvoid}, client_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Eset_auto2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5e_walk","page":"Low-level library bindings","title":"HDF5.API.h5e_walk","text":"h5e_walk(stack_id::hid_t, direction::Cint, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Ewalk2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5F","page":"Low-level library bindings","title":"H5F — File Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5f_clear_elink_file_cache\nh5f_close\nh5f_create\nh5f_delete\nh5f_flush\nh5f_format_convert\nh5f_get_access_plist\nh5f_get_create_plist\nh5f_get_dset_no_attrs_hint\nh5f_get_eoa\nh5f_get_file_image\nh5f_get_fileno\nh5f_get_filesize\nh5f_get_free_sections\nh5f_get_freespace\nh5f_get_info\nh5f_get_intent\nh5f_get_mdc_config\nh5f_get_mdc_hit_rate\nh5f_get_mdc_image_info\nh5f_get_mdc_logging_status\nh5f_get_mdc_size\nh5f_get_metadata_read_retry_info\nh5f_get_mpi_atomicity\nh5f_get_name\nh5f_get_obj_count\nh5f_get_obj_ids\nh5f_get_page_buffering_stats\nh5f_get_vfd_handle\nh5f_increment_filesize\nh5f_is_accessible\nh5f_is_hdf5\nh5f_mount\nh5f_open\nh5f_reopen\nh5f_reset_mdc_hit_rate_stats\nh5f_reset_page_buffering_stats\nh5f_set_dset_no_attrs_hint\nh5f_set_libver_bounds\nh5f_set_mdc_config\nh5f_set_mpi_atomicity\nh5f_start_mdc_logging\nh5f_start_swmr_write\nh5f_stop_mdc_logging\nh5f_unmount","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5f_clear_elink_file_cache\nh5f_close\nh5f_create\nh5f_delete\nh5f_flush\nh5f_format_convert\nh5f_get_access_plist\nh5f_get_create_plist\nh5f_get_dset_no_attrs_hint\nh5f_get_eoa\nh5f_get_file_image\nh5f_get_fileno\nh5f_get_filesize\nh5f_get_free_sections\nh5f_get_freespace\nh5f_get_info\nh5f_get_intent\nh5f_get_mdc_config\nh5f_get_mdc_hit_rate\nh5f_get_mdc_image_info\nh5f_get_mdc_logging_status\nh5f_get_mdc_size\nh5f_get_metadata_read_retry_info\nh5f_get_mpi_atomicity\nh5f_get_name\nh5f_get_obj_count\nh5f_get_obj_ids\nh5f_get_page_buffering_stats\nh5f_get_vfd_handle\nh5f_increment_filesize\nh5f_is_accessible\nh5f_is_hdf5\nh5f_mount\nh5f_open\nh5f_reopen\nh5f_reset_mdc_hit_rate_stats\nh5f_reset_page_buffering_stats\nh5f_set_dset_no_attrs_hint\nh5f_set_libver_bounds\nh5f_set_mdc_config\nh5f_set_mpi_atomicity\nh5f_start_mdc_logging\nh5f_start_swmr_write\nh5f_stop_mdc_logging\nh5f_unmount","category":"page"},{"location":"api_bindings/#HDF5.API.h5f_clear_elink_file_cache","page":"Low-level library bindings","title":"HDF5.API.h5f_clear_elink_file_cache","text":"h5f_clear_elink_file_cache(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fclear_elink_file_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_close","page":"Low-level library bindings","title":"HDF5.API.h5f_close","text":"h5f_close(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_create","page":"Low-level library bindings","title":"HDF5.API.h5f_create","text":"h5f_create(pathname::Cstring, flags::Cuint, fcpl_id::hid_t, fapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_delete","page":"Low-level library bindings","title":"HDF5.API.h5f_delete","text":"h5f_delete(filename::Cstring, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Fdelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_flush","page":"Low-level library bindings","title":"HDF5.API.h5f_flush","text":"h5f_flush(object_id::hid_t, scope::Cint)\n\nSee libhdf5 documentation for H5Fflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_format_convert","page":"Low-level library bindings","title":"HDF5.API.h5f_format_convert","text":"h5f_format_convert(fid::hid_t)\n\nSee libhdf5 documentation for H5Fformat_convert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_access_plist","page":"Low-level library bindings","title":"HDF5.API.h5f_get_access_plist","text":"h5f_get_access_plist(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fget_access_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5f_get_create_plist","text":"h5f_get_create_plist(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5f_get_dset_no_attrs_hint","text":"h5f_get_dset_no_attrs_hint(file_id::hid_t, minimize::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_eoa","page":"Low-level library bindings","title":"HDF5.API.h5f_get_eoa","text":"h5f_get_eoa(file_id::hid_t, eoa::Ptr{haddr_t})\n\nSee libhdf5 documentation for H5Fget_eoa.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_file_image","page":"Low-level library bindings","title":"HDF5.API.h5f_get_file_image","text":"h5f_get_file_image(file_id::hid_t, buf_ptr::Ptr{Cvoid}, buf_len::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_fileno","page":"Low-level library bindings","title":"HDF5.API.h5f_get_fileno","text":"h5f_get_fileno(file_id::hid_t, fileno::Ptr{Culong})\n\nSee libhdf5 documentation for H5Fget_fileno.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_filesize","page":"Low-level library bindings","title":"HDF5.API.h5f_get_filesize","text":"h5f_get_filesize(file_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Fget_filesize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_free_sections","page":"Low-level library bindings","title":"HDF5.API.h5f_get_free_sections","text":"h5f_get_free_sections(file_id::hid_t, type::H5F_mem_t, nsects::Csize_t, sect_info::Ptr{H5F_sect_info_t}) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_free_sections.\n\n\n\n\n\nh5f_get_free_sections(file_id, type, [sect_info::AbstractVector{H5F_sect_info_t}])::AbstractVector{H5F_sect_info_t}\n\nReturn an AbstractVector of the free section information. If sect_info is not provided a new Vector will be allocated and returned. If sect_info is provided, a view, a SubArray, will be returned.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_freespace","page":"Low-level library bindings","title":"HDF5.API.h5f_get_freespace","text":"h5f_get_freespace(file_id::hid_t) -> hssize_t\n\nSee libhdf5 documentation for H5Fget_freespace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_info","text":"h5f_get_info(obj_id::hid_t, file_info::Ptr{H5F_info2_t})\n\nSee libhdf5 documentation for H5Fget_info2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_intent","page":"Low-level library bindings","title":"HDF5.API.h5f_get_intent","text":"h5f_get_intent(file_id::hid_t, intent::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Fget_intent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_config","text":"h5f_get_mdc_config(file_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Fget_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_hit_rate","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_hit_rate","text":"h5f_get_mdc_hit_rate(file_id::hid_t, hit_rate_ptr::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Fget_mdc_hit_rate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_image_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_image_info","text":"h5f_get_mdc_image_info(file_id::hid_t, image_addr::Ptr{haddr_t}, image_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Fget_mdc_image_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_logging_status","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_logging_status","text":"h5f_get_mdc_logging_status(file_id::hid_t, is_enabled::Ptr{hbool_t}, is_currently_logging::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_mdc_logging_status.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mdc_size","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mdc_size","text":"h5f_get_mdc_size(file_id::hid_t, max_size_ptr::Ptr{Csize_t}, min_clean_size_ptr::Ptr{Csize_t}, cur_size_ptr::Ptr{Csize_t}, cur_num_entries_ptr::Ptr{Cint})\n\nSee libhdf5 documentation for H5Fget_mdc_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_metadata_read_retry_info","page":"Low-level library bindings","title":"HDF5.API.h5f_get_metadata_read_retry_info","text":"h5f_get_metadata_read_retry_info(file_id::hid_t, info::Ptr{H5F_retry_info_t})\n\nSee libhdf5 documentation for H5Fget_metadata_read_retry_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_mpi_atomicity","page":"Low-level library bindings","title":"HDF5.API.h5f_get_mpi_atomicity","text":"h5f_get_mpi_atomicity(file_id::hid_t, flag::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Fget_mpi_atomicity.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_name","page":"Low-level library bindings","title":"HDF5.API.h5f_get_name","text":"h5f_get_name(obj_id::hid_t, buf::Ptr{UInt8}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_obj_count","page":"Low-level library bindings","title":"HDF5.API.h5f_get_obj_count","text":"h5f_get_obj_count(file_id::hid_t, types::Cuint) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_obj_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_obj_ids","page":"Low-level library bindings","title":"HDF5.API.h5f_get_obj_ids","text":"h5f_get_obj_ids(file_id::hid_t, types::Cuint, max_objs::Csize_t, obj_id_list::Ptr{hid_t}) -> Cssize_t\n\nSee libhdf5 documentation for H5Fget_obj_ids.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_page_buffering_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_get_page_buffering_stats","text":"h5f_get_page_buffering_stats(file_id::hid_t, accesses::Ptr{Cuint}, hits::Ptr{Cuint}, misses::Ptr{Cuint}, evictions::Ptr{Cuint}, bypasses::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Fget_page_buffering_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_get_vfd_handle","page":"Low-level library bindings","title":"HDF5.API.h5f_get_vfd_handle","text":"h5f_get_vfd_handle(file_id::hid_t, fapl_id::hid_t, file_handle::Ref{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Fget_vfd_handle.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_increment_filesize","page":"Low-level library bindings","title":"HDF5.API.h5f_increment_filesize","text":"h5f_increment_filesize(file_id::hid_t, increment::hsize_t)\n\nSee libhdf5 documentation for H5Fincrement_filesize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_is_accessible","page":"Low-level library bindings","title":"HDF5.API.h5f_is_accessible","text":"h5f_is_accessible(container_name::Cstring, fapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Fis_accessible.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_is_hdf5","page":"Low-level library bindings","title":"HDF5.API.h5f_is_hdf5","text":"h5f_is_hdf5(pathname::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Fis_hdf5.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_mount","page":"Low-level library bindings","title":"HDF5.API.h5f_mount","text":"h5f_mount(loc::hid_t, name::Cstring, child::hid_t, plist::hid_t)\n\nSee libhdf5 documentation for H5Fmount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_open","page":"Low-level library bindings","title":"HDF5.API.h5f_open","text":"h5f_open(pathname::Cstring, flags::Cuint, fapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Fopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reopen","page":"Low-level library bindings","title":"HDF5.API.h5f_reopen","text":"h5f_reopen(file_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Freopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reset_mdc_hit_rate_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_reset_mdc_hit_rate_stats","text":"h5f_reset_mdc_hit_rate_stats(file_id::hid_t)\n\nSee libhdf5 documentation for H5Freset_mdc_hit_rate_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_reset_page_buffering_stats","page":"Low-level library bindings","title":"HDF5.API.h5f_reset_page_buffering_stats","text":"h5f_reset_page_buffering_stats(file_id::hid_t)\n\nSee libhdf5 documentation for H5Freset_page_buffering_stats.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5f_set_dset_no_attrs_hint","text":"h5f_set_dset_no_attrs_hint(file_id::hid_t, minimize::hbool_t)\n\nSee libhdf5 documentation for H5Fset_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5f_set_libver_bounds","text":"h5f_set_libver_bounds(file_id::hid_t, low::H5F_libver_t, high::H5F_libver_t)\n\nSee libhdf5 documentation for H5Fset_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5f_set_mdc_config","text":"h5f_set_mdc_config(file_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Fset_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_set_mpi_atomicity","page":"Low-level library bindings","title":"HDF5.API.h5f_set_mpi_atomicity","text":"h5f_set_mpi_atomicity(file_id::hid_t, flag::hbool_t)\n\nSee libhdf5 documentation for H5Fset_mpi_atomicity.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_start_mdc_logging","page":"Low-level library bindings","title":"HDF5.API.h5f_start_mdc_logging","text":"h5f_start_mdc_logging(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fstart_mdc_logging.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_start_swmr_write","page":"Low-level library bindings","title":"HDF5.API.h5f_start_swmr_write","text":"h5f_start_swmr_write(id::hid_t)\n\nSee libhdf5 documentation for H5Fstart_swmr_write.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_stop_mdc_logging","page":"Low-level library bindings","title":"HDF5.API.h5f_stop_mdc_logging","text":"h5f_stop_mdc_logging(file_id::hid_t)\n\nSee libhdf5 documentation for H5Fstop_mdc_logging.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5f_unmount","page":"Low-level library bindings","title":"HDF5.API.h5f_unmount","text":"h5f_unmount(loc::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Funmount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5G","page":"Low-level library bindings","title":"H5G — Group Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5g_close\nh5g_create\nh5g_get_create_plist\nh5g_get_info\nh5g_get_num_objs\nh5g_get_objname_by_idx\nh5g_open","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5g_close\nh5g_create\nh5g_get_create_plist\nh5g_get_info\nh5g_get_num_objs\nh5g_get_objname_by_idx\nh5g_open","category":"page"},{"location":"api_bindings/#HDF5.API.h5g_close","page":"Low-level library bindings","title":"HDF5.API.h5g_close","text":"h5g_close(group_id::hid_t)\n\nSee libhdf5 documentation for H5Gclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_create","page":"Low-level library bindings","title":"HDF5.API.h5g_create","text":"h5g_create(loc_id::hid_t, pathname::Cstring, lcpl_id::hid_t, gcpl_id::hid_t, gapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gcreate2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_create_plist","page":"Low-level library bindings","title":"HDF5.API.h5g_get_create_plist","text":"h5g_get_create_plist(group_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gget_create_plist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_info","page":"Low-level library bindings","title":"HDF5.API.h5g_get_info","text":"h5g_get_info(group_id::hid_t, buf::Ptr{H5G_info_t})\n\nSee libhdf5 documentation for H5Gget_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_num_objs","page":"Low-level library bindings","title":"HDF5.API.h5g_get_num_objs","text":"h5g_get_num_objs(loc_id::hid_t, num_obj::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Gget_num_objs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_get_objname_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5g_get_objname_by_idx","text":"h5g_get_objname_by_idx(loc_id::hid_t, idx::hsize_t, pathname::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Gget_objname_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5g_open","page":"Low-level library bindings","title":"HDF5.API.h5g_open","text":"h5g_open(loc_id::hid_t, pathname::Cstring, gapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Gopen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5I","page":"Low-level library bindings","title":"H5I — Identifier Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5i_dec_ref\nh5i_get_file_id\nh5i_get_name\nh5i_get_ref\nh5i_get_type\nh5i_inc_ref\nh5i_is_valid","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5i_dec_ref\nh5i_get_file_id\nh5i_get_name\nh5i_get_ref\nh5i_get_type\nh5i_inc_ref\nh5i_is_valid","category":"page"},{"location":"api_bindings/#HDF5.API.h5i_dec_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_dec_ref","text":"h5i_dec_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Idec_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_file_id","page":"Low-level library bindings","title":"HDF5.API.h5i_get_file_id","text":"h5i_get_file_id(obj_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Iget_file_id.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_name","page":"Low-level library bindings","title":"HDF5.API.h5i_get_name","text":"h5i_get_name(obj_id::hid_t, buf::Ptr{UInt8}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Iget_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_get_ref","text":"h5i_get_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iget_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_get_type","page":"Low-level library bindings","title":"HDF5.API.h5i_get_type","text":"h5i_get_type(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iget_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_inc_ref","page":"Low-level library bindings","title":"HDF5.API.h5i_inc_ref","text":"h5i_inc_ref(obj_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Iinc_ref.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5i_is_valid","page":"Low-level library bindings","title":"HDF5.API.h5i_is_valid","text":"h5i_is_valid(obj_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Iis_valid.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5L","page":"Low-level library bindings","title":"H5L — Link Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5l_create_external\nh5l_create_hard\nh5l_create_soft\nh5l_delete\nh5l_exists\nh5l_get_info\nh5l_get_name_by_idx\nh5l_iterate\nh5l_move","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5l_create_external\nh5l_create_hard\nh5l_create_soft\nh5l_delete\nh5l_exists\nh5l_get_info\nh5l_get_name_by_idx\nh5l_iterate\nh5l_move","category":"page"},{"location":"api_bindings/#HDF5.API.h5l_create_external","page":"Low-level library bindings","title":"HDF5.API.h5l_create_external","text":"h5l_create_external(target_file_name::Cstring, target_obj_name::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_create_hard","page":"Low-level library bindings","title":"HDF5.API.h5l_create_hard","text":"h5l_create_hard(obj_loc_id::hid_t, obj_name::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_hard.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_create_soft","page":"Low-level library bindings","title":"HDF5.API.h5l_create_soft","text":"h5l_create_soft(target_path::Cstring, link_loc_id::hid_t, link_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lcreate_soft.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_delete","page":"Low-level library bindings","title":"HDF5.API.h5l_delete","text":"h5l_delete(obj_id::hid_t, pathname::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Ldelete.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_exists","page":"Low-level library bindings","title":"HDF5.API.h5l_exists","text":"h5l_exists(loc_id::hid_t, pathname::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Lexists.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_get_info","page":"Low-level library bindings","title":"HDF5.API.h5l_get_info","text":"h5l_get_info(link_loc_id::hid_t, link_name::Cstring, link_buf::Ptr{H5L_info_t}, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lget_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_get_name_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5l_get_name_by_idx","text":"h5l_get_name_by_idx(loc_id::hid_t, group_name::Cstring, index_field::Cint, order::Cint, n::hsize_t, name::Ptr{UInt8}, size::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Lget_name_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_iterate","page":"Low-level library bindings","title":"HDF5.API.h5l_iterate","text":"h5l_iterate(group_id::hid_t, idx_type::Cint, order::Cint, idx::Ptr{hsize_t}, op::Ptr{Cvoid}, op_data::Any)\n\nSee libhdf5 documentation for H5Literate1.\n\n\n\n\n\nh5l_iterate(f, group_id, idx_type, order, idx = 0) -> hsize_t\n\nExecutes h5l_iterate with the user-provided callback function f, returning the index where iteration ends.\n\nThe callback function must correspond to the signature\n\nf(group::HDF5.API.hid_t, name::Ptr{Cchar}, info::Ptr{HDF5.API.H5L_info_t}) -> Union{Bool, Integer}\n\nwhere a negative return value halts iteration abnormally, true or a positive value halts iteration successfully, and false or zero continues iteration.\n\nExamples\n\njulia> HDF5.API.h5l_iterate(hfile, HDF5.API.H5_INDEX_NAME, HDF5.API.H5_ITER_INC) do group, name, info\n println(unsafe_string(name))\n return HDF5.API.herr_t(0)\n end\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5l_move","page":"Low-level library bindings","title":"HDF5.API.h5l_move","text":"h5l_move(src_obj_id::hid_t, src_name::Cstring, dest_obj_id::hid_t, dest_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Lmove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5O","page":"Low-level library bindings","title":"H5O — Object Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5o_are_mdc_flushes_disabled\nh5o_close\nh5o_copy\nh5o_decr_refcount\nh5o_disable_mdc_flushes\nh5o_enable_mdc_flushes\nh5o_exists_by_name\nh5o_flush\nh5o_get_comment\nh5o_get_comment_by_name\nh5o_get_info\nh5o_get_info1\nh5o_get_info_by_idx\nh5o_get_info_by_name\nh5o_get_native_info\nh5o_get_native_info_by_idx\nh5o_get_native_info_by_name\nh5o_incr_refcount\nh5o_link\nh5o_open\nh5o_open_by_addr\nh5o_open_by_idx\nh5o_refresh\nh5o_set_comment\nh5o_set_comment_by_name\nh5o_token_cmp\nh5o_token_from_str\nh5o_token_to_str\nh5o_visit\nh5o_visit_by_name","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5o_are_mdc_flushes_disabled\nh5o_close\nh5o_copy\nh5o_decr_refcount\nh5o_disable_mdc_flushes\nh5o_enable_mdc_flushes\nh5o_exists_by_name\nh5o_flush\nh5o_get_comment\nh5o_get_comment_by_name\nh5o_get_info\nh5o_get_info1\nh5o_get_info_by_idx\nh5o_get_info_by_name\nh5o_get_native_info\nh5o_get_native_info_by_idx\nh5o_get_native_info_by_name\nh5o_incr_refcount\nh5o_link\nh5o_open\nh5o_open_by_addr\nh5o_open_by_idx\nh5o_refresh\nh5o_set_comment\nh5o_set_comment_by_name\nh5o_token_cmp\nh5o_token_from_str\nh5o_token_to_str\nh5o_visit\nh5o_visit_by_name","category":"page"},{"location":"api_bindings/#HDF5.API.h5o_are_mdc_flushes_disabled","page":"Low-level library bindings","title":"HDF5.API.h5o_are_mdc_flushes_disabled","text":"h5o_are_mdc_flushes_disabled(object_id::hid_t, are_disabled::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Oare_mdc_flushes_disabled.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_close","page":"Low-level library bindings","title":"HDF5.API.h5o_close","text":"h5o_close(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_copy","page":"Low-level library bindings","title":"HDF5.API.h5o_copy","text":"h5o_copy(src_loc_id::hid_t, src_name::Cstring, dst_loc_id::hid_t, dst_name::Cstring, ocpypl_id::hid_t, lcpl_id::hid_t)\n\nSee libhdf5 documentation for H5Ocopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_decr_refcount","page":"Low-level library bindings","title":"HDF5.API.h5o_decr_refcount","text":"h5o_decr_refcount(object_id::hid_t)\n\nSee libhdf5 documentation for H5Odecr_refcount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_disable_mdc_flushes","page":"Low-level library bindings","title":"HDF5.API.h5o_disable_mdc_flushes","text":"h5o_disable_mdc_flushes(object_id::hid_t)\n\nSee libhdf5 documentation for H5Odisable_mdc_flushes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_enable_mdc_flushes","page":"Low-level library bindings","title":"HDF5.API.h5o_enable_mdc_flushes","text":"h5o_enable_mdc_flushes(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oenable_mdc_flushes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_exists_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_exists_by_name","text":"h5o_exists_by_name(loc_id::hid_t, name::Cstring, lapl_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Oexists_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_flush","page":"Low-level library bindings","title":"HDF5.API.h5o_flush","text":"h5o_flush(obj_id::hid_t)\n\nSee libhdf5 documentation for H5Oflush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_comment","page":"Low-level library bindings","title":"HDF5.API.h5o_get_comment","text":"h5o_get_comment(obj_id::hid_t, comment::Ptr{Cchar}, bufsize::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Oget_comment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_comment_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_comment_by_name","text":"h5o_get_comment_by_name(loc_id::hid_t, name::Cstring, comment::Ptr{Cchar}, bufsize::Csize_t, lapl_id::hid_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Oget_comment_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info","text":"h5o_get_info(loc_id::hid_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint)\n\nSee libhdf5 documentation for H5Oget_info3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info1","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info1","text":"h5o_get_info1(object_id, [buf])\n\nDeprecated HDF5 function. Use h5o_get_info or h5o_get_native_info if possible.\n\nSee libhdf5 documentation for H5Oget_info1.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info_by_idx","text":"h5o_get_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_info_by_idx3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_info_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_info_by_name","text":"h5o_get_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_info2_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_info_by_name3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info","text":"h5o_get_native_info(loc_id::hid_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint)\n\nSee libhdf5 documentation for H5Oget_native_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info_by_idx","text":"h5o_get_native_info_by_idx(loc_id::hid_t, group_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, n::hsize_t, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_native_info_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_get_native_info_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_get_native_info_by_name","text":"h5o_get_native_info_by_name(loc_id::hid_t, name::Cstring, oinfo::Ptr{H5O_native_info_t}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oget_native_info_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_incr_refcount","page":"Low-level library bindings","title":"HDF5.API.h5o_incr_refcount","text":"h5o_incr_refcount(object_id::hid_t)\n\nSee libhdf5 documentation for H5Oincr_refcount.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_link","page":"Low-level library bindings","title":"HDF5.API.h5o_link","text":"h5o_link(obj_id::hid_t, new_loc_id::hid_t, new_name::Cstring, lcpl_id::hid_t, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Olink.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open","page":"Low-level library bindings","title":"HDF5.API.h5o_open","text":"h5o_open(loc_id::hid_t, pathname::Cstring, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open_by_addr","page":"Low-level library bindings","title":"HDF5.API.h5o_open_by_addr","text":"h5o_open_by_addr(loc_id::hid_t, addr::haddr_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen_by_addr.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_open_by_idx","page":"Low-level library bindings","title":"HDF5.API.h5o_open_by_idx","text":"h5o_open_by_idx(loc_id::hid_t, group_name::Cstring, index_type::Cint, order::Cint, n::hsize_t, lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Oopen_by_idx.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_refresh","page":"Low-level library bindings","title":"HDF5.API.h5o_refresh","text":"h5o_refresh(oid::hid_t)\n\nSee libhdf5 documentation for H5Orefresh.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_set_comment","page":"Low-level library bindings","title":"HDF5.API.h5o_set_comment","text":"h5o_set_comment(obj_id::hid_t, comment::Cstring)\n\nSee libhdf5 documentation for H5Oset_comment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_set_comment_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_set_comment_by_name","text":"h5o_set_comment_by_name(loc_id::hid_t, name::Cstring, comment::Cstring, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Oset_comment_by_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_cmp","page":"Low-level library bindings","title":"HDF5.API.h5o_token_cmp","text":"h5o_token_cmp(loc_id::hid_t, token1::Ptr{H5O_token_t}, token2::Ptr{H5O_token_t}, cmp_value::Ptr{Cint})\n\nSee libhdf5 documentation for H5Otoken_cmp.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_from_str","page":"Low-level library bindings","title":"HDF5.API.h5o_token_from_str","text":"h5o_token_from_str(loc_id::hid_t, token_str::Cstring, token::Ptr{H5O_token_t})\n\nSee libhdf5 documentation for H5Otoken_from_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_token_to_str","page":"Low-level library bindings","title":"HDF5.API.h5o_token_to_str","text":"h5o_token_to_str(loc_id::hid_t, token::Ptr{H5O_token_t}, token_str::Ptr{Ptr{Cchar}})\n\nSee libhdf5 documentation for H5Otoken_to_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_visit","page":"Low-level library bindings","title":"HDF5.API.h5o_visit","text":"h5o_visit(obj_id::hid_t, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint)\n\nSee libhdf5 documentation for H5Ovisit3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5o_visit_by_name","page":"Low-level library bindings","title":"HDF5.API.h5o_visit_by_name","text":"h5o_visit_by_name(loc_id::hid_t, obj_name::Cstring, idx_type::H5_index_t, order::H5_iter_order_t, op::H5O_iterate2_t, op_data::Ptr{Cvoid}, fields::Cuint, lapl_id::hid_t)\n\nSee libhdf5 documentation for H5Ovisit_by_name3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5PL","page":"Low-level library bindings","title":"H5PL — Plugin Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5pl_append\nh5pl_get\nh5pl_get_loading_state\nh5pl_insert\nh5pl_prepend\nh5pl_remove\nh5pl_replace\nh5pl_set_loading_state\nh5pl_size","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5pl_append\nh5pl_get\nh5pl_get_loading_state\nh5pl_insert\nh5pl_prepend\nh5pl_remove\nh5pl_replace\nh5pl_set_loading_state\nh5pl_size","category":"page"},{"location":"api_bindings/#HDF5.API.h5pl_append","page":"Low-level library bindings","title":"HDF5.API.h5pl_append","text":"h5pl_append(search_path::Cstring)\n\nSee libhdf5 documentation for H5PLappend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_get","page":"Low-level library bindings","title":"HDF5.API.h5pl_get","text":"h5pl_get(index::Cuint, path_buf::Ptr{Cchar}, buf_size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5PLget.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_get_loading_state","page":"Low-level library bindings","title":"HDF5.API.h5pl_get_loading_state","text":"h5pl_get_loading_state(plugin_control_mask::Ptr{Cuint})\n\nSee libhdf5 documentation for H5PLget_loading_state.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_insert","page":"Low-level library bindings","title":"HDF5.API.h5pl_insert","text":"h5pl_insert(search_path::Cstring, index::Cuint)\n\nSee libhdf5 documentation for H5PLinsert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_prepend","page":"Low-level library bindings","title":"HDF5.API.h5pl_prepend","text":"h5pl_prepend(search_path::Cstring)\n\nSee libhdf5 documentation for H5PLprepend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_remove","page":"Low-level library bindings","title":"HDF5.API.h5pl_remove","text":"h5pl_remove(index::Cuint)\n\nSee libhdf5 documentation for H5PLremove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_replace","page":"Low-level library bindings","title":"HDF5.API.h5pl_replace","text":"h5pl_replace(search_path::Cstring, index::Cuint)\n\nSee libhdf5 documentation for H5PLreplace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_set_loading_state","page":"Low-level library bindings","title":"HDF5.API.h5pl_set_loading_state","text":"h5pl_set_loading_state(plugin_control_mask::Cuint)\n\nSee libhdf5 documentation for H5PLset_loading_state.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5pl_size","page":"Low-level library bindings","title":"HDF5.API.h5pl_size","text":"h5pl_size(num_paths::Ptr{Cuint})\n\nSee libhdf5 documentation for H5PLsize.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5P","page":"Low-level library bindings","title":"H5P — Property Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5p_add_merge_committed_dtype_path\nh5p_all_filters_avail\nh5p_close\nh5p_close_class\nh5p_copy\nh5p_copy_prop\nh5p_create\nh5p_create_class\nh5p_decode\nh5p_encode\nh5p_equal\nh5p_exist\nh5p_fill_value_defined\nh5p_free_merge_committed_dtype_paths\nh5p_get\nh5p_get_alignment\nh5p_get_alloc_time\nh5p_get_append_flush\nh5p_get_attr_creation_order\nh5p_get_attr_phase_change\nh5p_get_btree_ratios\nh5p_get_buffer\nh5p_get_cache\nh5p_get_char_encoding\nh5p_get_chunk\nh5p_get_chunk_cache\nh5p_get_chunk_opts\nh5p_get_class\nh5p_get_class_name\nh5p_get_class_parent\nh5p_get_copy_object\nh5p_get_core_write_tracking\nh5p_get_create_intermediate_group\nh5p_get_data_transform\nh5p_get_driver\nh5p_get_driver_info\nh5p_get_dset_no_attrs_hint\nh5p_get_dxpl_mpio\nh5p_get_edc_check\nh5p_get_efile_prefix\nh5p_get_elink_acc_flags\nh5p_get_elink_cb\nh5p_get_elink_fapl\nh5p_get_elink_file_cache_size\nh5p_get_elink_prefix\nh5p_get_est_link_info\nh5p_get_evict_on_close\nh5p_get_external\nh5p_get_external_count\nh5p_get_family_offset\nh5p_get_fapl_core\nh5p_get_fapl_family\nh5p_get_fapl_hdfs\nh5p_get_fapl_mpio\nh5p_get_fapl_multi\nh5p_get_fapl_ros3\nh5p_get_fapl_splitter\nh5p_get_fclose_degree\nh5p_get_file_image\nh5p_get_file_image_callbacks\nh5p_get_file_locking\nh5p_get_file_space\nh5p_get_file_space_page_size\nh5p_get_file_space_strategy\nh5p_get_fill_time\nh5p_get_fill_value\nh5p_get_filter\nh5p_get_filter_by_id\nh5p_get_gc_references\nh5p_get_hyper_vector_size\nh5p_get_istore_k\nh5p_get_layout\nh5p_get_libver_bounds\nh5p_get_link_creation_order\nh5p_get_link_phase_change\nh5p_get_local_heap_size_hint\nh5p_get_mcdt_search_cb\nh5p_get_mdc_config\nh5p_get_mdc_image_config\nh5p_get_mdc_log_options\nh5p_get_meta_block_size\nh5p_get_metadata_read_attempts\nh5p_get_multi_type\nh5p_get_nfilters\nh5p_get_nlinks\nh5p_get_nprops\nh5p_get_obj_track_times\nh5p_get_object_flush_cb\nh5p_get_page_buffer_size\nh5p_get_preserve\nh5p_get_shared_mesg_index\nh5p_get_shared_mesg_nindexes\nh5p_get_shared_mesg_phase_change\nh5p_get_sieve_buf_size\nh5p_get_size\nh5p_get_sizes\nh5p_get_small_data_block_size\nh5p_get_sym_k\nh5p_get_type_conv_cb\nh5p_get_userblock\nh5p_get_version\nh5p_get_virtual_count\nh5p_get_virtual_dsetname\nh5p_get_virtual_filename\nh5p_get_virtual_prefix\nh5p_get_virtual_printf_gap\nh5p_get_virtual_srcspace\nh5p_get_virtual_view\nh5p_get_virtual_vspace\nh5p_get_vlen_mem_manager\nh5p_get_vol_id\nh5p_get_vol_info\nh5p_insert\nh5p_isa_class\nh5p_iterate\nh5p_modify_filter\nh5p_register\nh5p_remove\nh5p_remove_filter\nh5p_set\nh5p_set_alignment\nh5p_set_alloc_time\nh5p_set_append_flush\nh5p_set_attr_creation_order\nh5p_set_attr_phase_change\nh5p_set_btree_ratios\nh5p_set_buffer\nh5p_set_cache\nh5p_set_char_encoding\nh5p_set_chunk\nh5p_set_chunk_cache\nh5p_set_chunk_opts\nh5p_set_copy_object\nh5p_set_core_write_tracking\nh5p_set_create_intermediate_group\nh5p_set_data_transform\nh5p_set_deflate\nh5p_set_driver\nh5p_set_dset_no_attrs_hint\nh5p_set_dxpl_mpio\nh5p_set_edc_check\nh5p_set_efile_prefix\nh5p_set_elink_acc_flags\nh5p_set_elink_cb\nh5p_set_elink_fapl\nh5p_set_elink_file_cache_size\nh5p_set_elink_prefix\nh5p_set_est_link_info\nh5p_set_evict_on_close\nh5p_set_external\nh5p_set_family_offset\nh5p_set_fapl_core\nh5p_set_fapl_family\nh5p_set_fapl_hdfs\nh5p_set_fapl_log\nh5p_set_fapl_mpio\nh5p_set_fapl_multi\nh5p_set_fapl_ros3\nh5p_set_fapl_sec2\nh5p_set_fapl_split\nh5p_set_fapl_splitter\nh5p_set_fapl_stdio\nh5p_set_fapl_windows\nh5p_set_fclose_degree\nh5p_set_file_image\nh5p_set_file_image_callbacks\nh5p_set_file_locking\nh5p_set_file_space\nh5p_set_file_space_page_size\nh5p_set_file_space_strategy\nh5p_set_fill_time\nh5p_set_fill_value\nh5p_set_filter\nh5p_set_filter_callback\nh5p_set_fletcher32\nh5p_set_gc_references\nh5p_set_hyper_vector_size\nh5p_set_istore_k\nh5p_set_layout\nh5p_set_libver_bounds\nh5p_set_link_creation_order\nh5p_set_link_phase_change\nh5p_set_local_heap_size_hint\nh5p_set_mcdt_search_cb\nh5p_set_mdc_config\nh5p_set_mdc_image_config\nh5p_set_mdc_log_options\nh5p_set_meta_block_size\nh5p_set_metadata_read_attempts\nh5p_set_multi_type\nh5p_set_nbit\nh5p_set_nlinks\nh5p_set_obj_track_times\nh5p_set_object_flush_cb\nh5p_set_page_buffer_size\nh5p_set_preserve\nh5p_set_scaleoffset\nh5p_set_shared_mesg_index\nh5p_set_shared_mesg_nindexes\nh5p_set_shared_mesg_phase_change\nh5p_set_shuffle\nh5p_set_sieve_buf_size\nh5p_set_sizes\nh5p_set_small_data_block_size\nh5p_set_sym_k\nh5p_set_szip\nh5p_set_type_conv_cb\nh5p_set_userblock\nh5p_set_virtual\nh5p_set_virtual_prefix\nh5p_set_virtual_printf_gap\nh5p_set_virtual_view\nh5p_set_vlen_mem_manager\nh5p_set_vol\nh5p_unregister","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5p_add_merge_committed_dtype_path\nh5p_all_filters_avail\nh5p_close\nh5p_close_class\nh5p_copy\nh5p_copy_prop\nh5p_create\nh5p_create_class\nh5p_decode\nh5p_encode\nh5p_equal\nh5p_exist\nh5p_fill_value_defined\nh5p_free_merge_committed_dtype_paths\nh5p_get\nh5p_get_alignment\nh5p_get_alloc_time\nh5p_get_append_flush\nh5p_get_attr_creation_order\nh5p_get_attr_phase_change\nh5p_get_btree_ratios\nh5p_get_buffer\nh5p_get_cache\nh5p_get_char_encoding\nh5p_get_chunk\nh5p_get_chunk_cache\nh5p_get_chunk_opts\nh5p_get_class\nh5p_get_class_name\nh5p_get_class_parent\nh5p_get_copy_object\nh5p_get_core_write_tracking\nh5p_get_create_intermediate_group\nh5p_get_data_transform\nh5p_get_driver\nh5p_get_driver_info\nh5p_get_dset_no_attrs_hint\nh5p_get_dxpl_mpio\nh5p_get_edc_check\nh5p_get_efile_prefix\nh5p_get_elink_acc_flags\nh5p_get_elink_cb\nh5p_get_elink_fapl\nh5p_get_elink_file_cache_size\nh5p_get_elink_prefix\nh5p_get_est_link_info\nh5p_get_evict_on_close\nh5p_get_external\nh5p_get_external_count\nh5p_get_family_offset\nh5p_get_fapl_core\nh5p_get_fapl_family\nh5p_get_fapl_hdfs\nh5p_get_fapl_mpio\nh5p_get_fapl_multi\nh5p_get_fapl_ros3\nh5p_get_fapl_splitter\nh5p_get_fclose_degree\nh5p_get_file_image\nh5p_get_file_image_callbacks\nh5p_get_file_locking\nh5p_get_file_space\nh5p_get_file_space_page_size\nh5p_get_file_space_strategy\nh5p_get_fill_time\nh5p_get_fill_value\nh5p_get_filter\nh5p_get_filter_by_id\nh5p_get_gc_references\nh5p_get_hyper_vector_size\nh5p_get_istore_k\nh5p_get_layout\nh5p_get_libver_bounds\nh5p_get_link_creation_order\nh5p_get_link_phase_change\nh5p_get_local_heap_size_hint\nh5p_get_mcdt_search_cb\nh5p_get_mdc_config\nh5p_get_mdc_image_config\nh5p_get_mdc_log_options\nh5p_get_meta_block_size\nh5p_get_metadata_read_attempts\nh5p_get_multi_type\nh5p_get_nfilters\nh5p_get_nlinks\nh5p_get_nprops\nh5p_get_obj_track_times\nh5p_get_object_flush_cb\nh5p_get_page_buffer_size\nh5p_get_preserve\nh5p_get_shared_mesg_index\nh5p_get_shared_mesg_nindexes\nh5p_get_shared_mesg_phase_change\nh5p_get_sieve_buf_size\nh5p_get_size\nh5p_get_sizes\nh5p_get_small_data_block_size\nh5p_get_sym_k\nh5p_get_type_conv_cb\nh5p_get_userblock\nh5p_get_version\nh5p_get_virtual_count\nh5p_get_virtual_dsetname\nh5p_get_virtual_filename\nh5p_get_virtual_prefix\nh5p_get_virtual_printf_gap\nh5p_get_virtual_srcspace\nh5p_get_virtual_view\nh5p_get_virtual_vspace\nh5p_get_vlen_mem_manager\nh5p_get_vol_id\nh5p_get_vol_info\nh5p_insert\nh5p_isa_class\nh5p_iterate\nh5p_modify_filter\nh5p_register\nh5p_remove\nh5p_remove_filter\nh5p_set\nh5p_set_alignment\nh5p_set_alloc_time\nh5p_set_append_flush\nh5p_set_attr_creation_order\nh5p_set_attr_phase_change\nh5p_set_btree_ratios\nh5p_set_buffer\nh5p_set_cache\nh5p_set_char_encoding\nh5p_set_chunk\nh5p_set_chunk_cache\nh5p_set_chunk_opts\nh5p_set_copy_object\nh5p_set_core_write_tracking\nh5p_set_create_intermediate_group\nh5p_set_data_transform\nh5p_set_deflate\nh5p_set_driver\nh5p_set_dset_no_attrs_hint\nh5p_set_dxpl_mpio\nh5p_set_edc_check\nh5p_set_efile_prefix\nh5p_set_elink_acc_flags\nh5p_set_elink_cb\nh5p_set_elink_fapl\nh5p_set_elink_file_cache_size\nh5p_set_elink_prefix\nh5p_set_est_link_info\nh5p_set_evict_on_close\nh5p_set_external\nh5p_set_family_offset\nh5p_set_fapl_core\nh5p_set_fapl_family\nh5p_set_fapl_hdfs\nh5p_set_fapl_log\nh5p_set_fapl_mpio\nh5p_set_fapl_multi\nh5p_set_fapl_ros3\nh5p_set_fapl_sec2\nh5p_set_fapl_split\nh5p_set_fapl_splitter\nh5p_set_fapl_stdio\nh5p_set_fapl_windows\nh5p_set_fclose_degree\nh5p_set_file_image\nh5p_set_file_image_callbacks\nh5p_set_file_locking\nh5p_set_file_space\nh5p_set_file_space_page_size\nh5p_set_file_space_strategy\nh5p_set_fill_time\nh5p_set_fill_value\nh5p_set_filter\nh5p_set_filter_callback\nh5p_set_fletcher32\nh5p_set_gc_references\nh5p_set_hyper_vector_size\nh5p_set_istore_k\nh5p_set_layout\nh5p_set_libver_bounds\nh5p_set_link_creation_order\nh5p_set_link_phase_change\nh5p_set_local_heap_size_hint\nh5p_set_mcdt_search_cb\nh5p_set_mdc_config\nh5p_set_mdc_image_config\nh5p_set_mdc_log_options\nh5p_set_meta_block_size\nh5p_set_metadata_read_attempts\nh5p_set_multi_type\nh5p_set_nbit\nh5p_set_nlinks\nh5p_set_obj_track_times\nh5p_set_object_flush_cb\nh5p_set_page_buffer_size\nh5p_set_preserve\nh5p_set_scaleoffset\nh5p_set_shared_mesg_index\nh5p_set_shared_mesg_nindexes\nh5p_set_shared_mesg_phase_change\nh5p_set_shuffle\nh5p_set_sieve_buf_size\nh5p_set_sizes\nh5p_set_small_data_block_size\nh5p_set_sym_k\nh5p_set_szip\nh5p_set_type_conv_cb\nh5p_set_userblock\nh5p_set_virtual\nh5p_set_virtual_prefix\nh5p_set_virtual_printf_gap\nh5p_set_virtual_view\nh5p_set_vlen_mem_manager\nh5p_set_vol\nh5p_unregister","category":"page"},{"location":"api_bindings/#HDF5.API.h5p_add_merge_committed_dtype_path","page":"Low-level library bindings","title":"HDF5.API.h5p_add_merge_committed_dtype_path","text":"h5p_add_merge_committed_dtype_path(plist_id::hid_t, path::Cstring)\n\nSee libhdf5 documentation for H5Padd_merge_committed_dtype_path.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_all_filters_avail","page":"Low-level library bindings","title":"HDF5.API.h5p_all_filters_avail","text":"h5p_all_filters_avail(plist_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pall_filters_avail.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_close","page":"Low-level library bindings","title":"HDF5.API.h5p_close","text":"h5p_close(id::hid_t)\n\nSee libhdf5 documentation for H5Pclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_close_class","page":"Low-level library bindings","title":"HDF5.API.h5p_close_class","text":"h5p_close_class(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pclose_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_copy","page":"Low-level library bindings","title":"HDF5.API.h5p_copy","text":"h5p_copy(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pcopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_copy_prop","page":"Low-level library bindings","title":"HDF5.API.h5p_copy_prop","text":"h5p_copy_prop(dst_id::hid_t, src_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Pcopy_prop.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_create","page":"Low-level library bindings","title":"HDF5.API.h5p_create","text":"h5p_create(cls_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_create_class","page":"Low-level library bindings","title":"HDF5.API.h5p_create_class","text":"h5p_create_class(parent::hid_t, name::Cstring, create::H5P_cls_create_func_t, create_data::Ptr{Cvoid}, copy::H5P_cls_copy_func_t, copy_data::Ptr{Cvoid}, close::H5P_cls_close_func_t, close_data::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Pcreate_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_decode","page":"Low-level library bindings","title":"HDF5.API.h5p_decode","text":"h5p_decode(buf::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Pdecode.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_encode","page":"Low-level library bindings","title":"HDF5.API.h5p_encode","text":"h5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pencode1.\n\n\n\n\n\nh5p_encode(plist_id::hid_t, buf::Ptr{Cvoid}, nalloc::Ptr{Csize_t}, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pencode2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_equal","page":"Low-level library bindings","title":"HDF5.API.h5p_equal","text":"h5p_equal(id1::hid_t, id2::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pequal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_exist","page":"Low-level library bindings","title":"HDF5.API.h5p_exist","text":"h5p_exist(plist_id::hid_t, name::Cstring) -> Bool\n\nSee libhdf5 documentation for H5Pexist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_fill_value_defined","page":"Low-level library bindings","title":"HDF5.API.h5p_fill_value_defined","text":"h5p_fill_value_defined(plist::hid_t, status::Ptr{H5D_fill_value_t})\n\nSee libhdf5 documentation for H5Pfill_value_defined.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_free_merge_committed_dtype_paths","page":"Low-level library bindings","title":"HDF5.API.h5p_free_merge_committed_dtype_paths","text":"h5p_free_merge_committed_dtype_paths(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pfree_merge_committed_dtype_paths.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get","page":"Low-level library bindings","title":"HDF5.API.h5p_get","text":"h5p_get(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pget.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_alignment","page":"Low-level library bindings","title":"HDF5.API.h5p_get_alignment","text":"h5p_get_alignment(fapl_id::hid_t, threshold::Ref{hsize_t}, alignment::Ref{hsize_t})\n\nSee libhdf5 documentation for H5Pget_alignment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_alloc_time","page":"Low-level library bindings","title":"HDF5.API.h5p_get_alloc_time","text":"h5p_get_alloc_time(plist_id::hid_t, alloc_time::Ptr{Cint})\n\nSee libhdf5 documentation for H5Pget_alloc_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_append_flush","page":"Low-level library bindings","title":"HDF5.API.h5p_get_append_flush","text":"h5p_get_append_flush(dapl_id::hid_t, dims::Cuint, boundary::Ptr{hsize_t}, func::Ptr{H5D_append_cb_t}, udata::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_append_flush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_attr_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_get_attr_creation_order","text":"h5p_get_attr_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_attr_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_attr_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_attr_phase_change","text":"h5p_get_attr_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_attr_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_btree_ratios","page":"Low-level library bindings","title":"HDF5.API.h5p_get_btree_ratios","text":"h5p_get_btree_ratios(plist_id::hid_t, left::Ptr{Cdouble}, middle::Ptr{Cdouble}, right::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_btree_ratios.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_buffer","page":"Low-level library bindings","title":"HDF5.API.h5p_get_buffer","text":"h5p_get_buffer(plist_id::hid_t, tconv::Ptr{Ptr{Cvoid}}, bkg::Ptr{Ptr{Cvoid}}) -> Csize_t\n\nSee libhdf5 documentation for H5Pget_buffer.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_get_cache","text":"h5p_get_cache(plist_id::hid_t, mdc_nelmts::Ptr{Cint}, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_char_encoding","page":"Low-level library bindings","title":"HDF5.API.h5p_get_char_encoding","text":"h5p_get_char_encoding(plist_id::hid_t, encoding::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_char_encoding.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk","text":"h5p_get_chunk(plist_id::hid_t, n_dims::Cint, dims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Pget_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk_cache","text":"h5p_get_chunk_cache(dapl_id::hid_t, rdcc_nslots::Ptr{Csize_t}, rdcc_nbytes::Ptr{Csize_t}, rdcc_w0::Ptr{Cdouble})\n\nSee libhdf5 documentation for H5Pget_chunk_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_chunk_opts","page":"Low-level library bindings","title":"HDF5.API.h5p_get_chunk_opts","text":"h5p_get_chunk_opts(plist_id::hid_t, opts::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_chunk_opts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class","text":"h5p_get_class(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class_name","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class_name","text":"h5p_get_class_name(pcid::hid_t) -> String\n\nSee libhdf5 documentation for H5P_GET_CLASS_NAME.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_class_parent","page":"Low-level library bindings","title":"HDF5.API.h5p_get_class_parent","text":"h5p_get_class_parent(pclass_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_class_parent.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_copy_object","page":"Low-level library bindings","title":"HDF5.API.h5p_get_copy_object","text":"h5p_get_copy_object(plist_id::hid_t, copy_options::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_copy_object.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_core_write_tracking","page":"Low-level library bindings","title":"HDF5.API.h5p_get_core_write_tracking","text":"h5p_get_core_write_tracking(fapl_id::hid_t, is_enabled::Ptr{hbool_t}, page_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_core_write_tracking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_create_intermediate_group","page":"Low-level library bindings","title":"HDF5.API.h5p_get_create_intermediate_group","text":"h5p_get_create_intermediate_group(lcpl_id::hid_t, crt_intermed_group::Ref{Cuint})\n\nSee libhdf5 documentation for H5Pget_create_intermediate_group.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_data_transform","page":"Low-level library bindings","title":"HDF5.API.h5p_get_data_transform","text":"h5p_get_data_transform(plist_id::hid_t, expression::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_data_transform.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_driver","page":"Low-level library bindings","title":"HDF5.API.h5p_get_driver","text":"h5p_get_driver(plist_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_driver_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_driver_info","text":"h5p_get_driver_info(plist_id::hid_t) -> Ptr{Cvoid}\n\nSee libhdf5 documentation for H5Pget_driver_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_get_dset_no_attrs_hint","text":"h5p_get_dset_no_attrs_hint(dcpl_id::hid_t, minimize::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_dxpl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_get_dxpl_mpio","text":"h5p_get_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Ptr{Cint})\n\nSee libhdf5 documentation for H5Pget_dxpl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_edc_check","page":"Low-level library bindings","title":"HDF5.API.h5p_get_edc_check","text":"h5p_get_edc_check(plist_id::hid_t) -> H5Z_EDC_t\n\nSee libhdf5 documentation for H5Pget_edc_check.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_efile_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_efile_prefix","text":"h5p_get_efile_prefix(dapl_id::hid_t, prefix::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_efile_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_acc_flags","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_acc_flags","text":"h5p_get_elink_acc_flags(lapl_id::hid_t, flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_elink_acc_flags.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_cb","text":"h5p_get_elink_cb(lapl_id::hid_t, func::Ptr{H5L_elink_traverse_t}, op_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_elink_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_fapl","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_fapl","text":"h5p_get_elink_fapl(lapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_elink_fapl.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_file_cache_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_file_cache_size","text":"h5p_get_elink_file_cache_size(plist_id::hid_t, efc_size::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_elink_file_cache_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_elink_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_elink_prefix","text":"h5p_get_elink_prefix(plist_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_elink_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_est_link_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_est_link_info","text":"h5p_get_est_link_info(plist_id::hid_t, est_num_entries::Ptr{Cuint}, est_name_len::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_est_link_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_evict_on_close","page":"Low-level library bindings","title":"HDF5.API.h5p_get_evict_on_close","text":"h5p_get_evict_on_close(fapl_id::hid_t, evict_on_close::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_evict_on_close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_external","page":"Low-level library bindings","title":"HDF5.API.h5p_get_external","text":"h5p_get_external(plist::hid_t, idx::Cuint, name_size::Csize_t, name::Ptr{Cuchar}, offset::Ptr{off_t}, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_external_count","page":"Low-level library bindings","title":"HDF5.API.h5p_get_external_count","text":"h5p_get_external_count(plist::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_external_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_family_offset","page":"Low-level library bindings","title":"HDF5.API.h5p_get_family_offset","text":"h5p_get_family_offset(fapl_id::hid_t, offset::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_family_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_core","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_core","text":"h5p_get_fapl_core(fapl_id::hid_t, increment::Ptr{Csize_t}, backing_store::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_fapl_core.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_family","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_family","text":"h5p_get_fapl_family(fapl_id::hid_t, memb_size::Ptr{hsize_t}, memb_fapl_id::Ptr{hid_t})\n\nSee libhdf5 documentation for H5Pget_fapl_family.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_hdfs","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_hdfs","text":"h5p_get_fapl_hdfs(fapl_id::hid_t, fa_out::Ptr{H5FD_hdfs_fapl_t})\n\nSee libhdf5 documentation for H5Pget_fapl_hdfs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_mpio","text":"h5p_get_fapl_mpio(fapl_id::hid_t, comm::Ptr{MPI.MPI_Comm}, info::Ptr{MPI.MPI_Info})\n\nSee libhdf5 documentation for H5Pget_fapl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_multi","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_multi","text":"h5p_get_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Ptr{Cchar}}, memb_addr::Ptr{haddr_t}, relax::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_fapl_multi.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_ros3","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_ros3","text":"h5p_get_fapl_ros3(fapl_id::hid_t, fa_out::Ptr{H5FD_ros3_fapl_t})\n\nSee libhdf5 documentation for H5Pget_fapl_ros3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fapl_splitter","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fapl_splitter","text":"h5p_get_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})\n\nSee libhdf5 documentation for H5Pget_fapl_splitter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fclose_degree","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fclose_degree","text":"h5p_get_fclose_degree(fapl_id::hid_t, fc_degree::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_fclose_degree.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_image","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_image","text":"h5p_get_file_image(fapl_id::hid_t, buf_ptr_ptr::Ptr{Ptr{Cvoid}}, buf_len_ptr::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_image_callbacks","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_image_callbacks","text":"h5p_get_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})\n\nSee libhdf5 documentation for H5Pget_file_image_callbacks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_locking","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_locking","text":"h5p_get_file_locking(fapl_id::hid_t, use_file_locking::Ptr{hbool_t}, ignore_when_disabled::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_file_locking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space","text":"h5p_get_file_space(plist_id::hid_t, strategy::Ptr{H5F_file_space_type_t}, threshold::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space_page_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space_page_size","text":"h5p_get_file_space_page_size(plist_id::hid_t, fsp_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space_page_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_file_space_strategy","page":"Low-level library bindings","title":"HDF5.API.h5p_get_file_space_strategy","text":"h5p_get_file_space_strategy(plist_id::hid_t, strategy::Ptr{H5F_fspace_strategy_t}, persist::Ptr{hbool_t}, threshold::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_file_space_strategy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fill_time","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fill_time","text":"h5p_get_fill_time(plist_id::hid_t, fill_time::Ptr{H5D_fill_time_t})\n\nSee libhdf5 documentation for H5Pget_fill_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_fill_value","page":"Low-level library bindings","title":"HDF5.API.h5p_get_fill_value","text":"h5p_get_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pget_fill_value.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_get_filter","text":"h5p_get_filter(plist_id::hid_t, idx::Cuint, flags::Ptr{Cuint}, cd_nemlts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{Cchar}, filter_config::Ptr{Cuint}) -> H5Z_filter_t\n\nSee libhdf5 documentation for H5Pget_filter2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_filter_by_id","page":"Low-level library bindings","title":"HDF5.API.h5p_get_filter_by_id","text":"h5p_get_filter_by_id(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Ref{Cuint}, cd_nelmts::Ref{Csize_t}, cd_values::Ptr{Cuint}, namelen::Csize_t, name::Ptr{UInt8}, filter_config::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_filter_by_id2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_gc_references","page":"Low-level library bindings","title":"HDF5.API.h5p_get_gc_references","text":"h5p_get_gc_references(fapl_id::hid_t, gc_ref::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_gc_references.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_hyper_vector_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_hyper_vector_size","text":"h5p_get_hyper_vector_size(fapl_id::hid_t, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_hyper_vector_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_istore_k","page":"Low-level library bindings","title":"HDF5.API.h5p_get_istore_k","text":"h5p_get_istore_k(plist_id::hid_t, ik::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_istore_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_layout","page":"Low-level library bindings","title":"HDF5.API.h5p_get_layout","text":"h5p_get_layout(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_layout.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5p_get_libver_bounds","text":"h5p_get_libver_bounds(fapl_id::hid_t, low::Ref{Cint}, high::Ref{Cint})\n\nSee libhdf5 documentation for H5Pget_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_link_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_get_link_creation_order","text":"h5p_get_link_creation_order(plist_id::hid_t, crt_order_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_link_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_link_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_link_phase_change","text":"h5p_get_link_phase_change(plist_id::hid_t, max_compact::Ptr{Cuint}, min_dense::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_link_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_local_heap_size_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_get_local_heap_size_hint","text":"h5p_get_local_heap_size_hint(plist_id::hid_t, size_hint::Ref{Csize_t})\n\nSee libhdf5 documentation for H5Pget_local_heap_size_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mcdt_search_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mcdt_search_cb","text":"h5p_get_mcdt_search_cb(plist_id::hid_t, func::Ptr{H5O_mcdt_search_cb_t}, op_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_mcdt_search_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_config","text":"h5p_get_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Pget_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_image_config","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_image_config","text":"h5p_get_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})\n\nSee libhdf5 documentation for H5Pget_mdc_image_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_mdc_log_options","page":"Low-level library bindings","title":"HDF5.API.h5p_get_mdc_log_options","text":"h5p_get_mdc_log_options(plist_id::hid_t, is_enabled::Ptr{hbool_t}, location::Ptr{Cchar}, location_size::Ptr{Csize_t}, start_on_access::Ptr{hbool_t})\n\nSee libhdf5 documentation for H5Pget_mdc_log_options.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_meta_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_meta_block_size","text":"h5p_get_meta_block_size(fapl_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_meta_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_metadata_read_attempts","page":"Low-level library bindings","title":"HDF5.API.h5p_get_metadata_read_attempts","text":"h5p_get_metadata_read_attempts(plist_id::hid_t, attempts::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_metadata_read_attempts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_multi_type","page":"Low-level library bindings","title":"HDF5.API.h5p_get_multi_type","text":"h5p_get_multi_type(fapl_id::hid_t, type::Ptr{H5FD_mem_t})\n\nSee libhdf5 documentation for H5Pget_multi_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nfilters","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nfilters","text":"h5p_get_nfilters(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_nfilters.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nlinks","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nlinks","text":"h5p_get_nlinks(plist_id::hid_t, nlinks::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_nlinks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_nprops","page":"Low-level library bindings","title":"HDF5.API.h5p_get_nprops","text":"h5p_get_nprops(id::hid_t, nprops::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_nprops.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_obj_track_times","page":"Low-level library bindings","title":"HDF5.API.h5p_get_obj_track_times","text":"h5p_get_obj_track_times(plist_id::hid_t, track_times::Ref{UInt8})\n\nSee libhdf5 documentation for H5Pget_obj_track_times.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_object_flush_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_object_flush_cb","text":"h5p_get_object_flush_cb(plist_id::hid_t, func::Ptr{H5F_flush_cb_t}, udata::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_object_flush_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_page_buffer_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_page_buffer_size","text":"h5p_get_page_buffer_size(plist_id::hid_t, buf_size::Ptr{Csize_t}, min_meta_perc::Ptr{Cuint}, min_raw_perc::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_page_buffer_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_preserve","page":"Low-level library bindings","title":"HDF5.API.h5p_get_preserve","text":"h5p_get_preserve(plist_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Pget_preserve.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_index","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_index","text":"h5p_get_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Ptr{Cuint}, min_mesg_size::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_nindexes","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_nindexes","text":"h5p_get_shared_mesg_nindexes(plist_id::hid_t, nindexes::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_nindexes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_shared_mesg_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_get_shared_mesg_phase_change","text":"h5p_get_shared_mesg_phase_change(plist_id::hid_t, max_list::Ptr{Cuint}, min_btree::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_shared_mesg_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sieve_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sieve_buf_size","text":"h5p_get_sieve_buf_size(fapl_id::hid_t, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_sieve_buf_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_size","text":"h5p_get_size(id::hid_t, name::Ptr{Cchar}, size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sizes","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sizes","text":"h5p_get_sizes(plist_id::hid_t, sizeof_addr::Ptr{Csize_t}, sizeof_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_sizes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_small_data_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_get_small_data_block_size","text":"h5p_get_small_data_block_size(fapl_id::hid_t, size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_small_data_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_sym_k","page":"Low-level library bindings","title":"HDF5.API.h5p_get_sym_k","text":"h5p_get_sym_k(plist_id::hid_t, ik::Ptr{Cuint}, lk::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_sym_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_type_conv_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_get_type_conv_cb","text":"h5p_get_type_conv_cb(dxpl_id::hid_t, op::Ptr{H5T_conv_except_func_t}, operate_data::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_type_conv_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_userblock","page":"Low-level library bindings","title":"HDF5.API.h5p_get_userblock","text":"h5p_get_userblock(plist_id::hid_t, len::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_userblock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_version","page":"Low-level library bindings","title":"HDF5.API.h5p_get_version","text":"h5p_get_version(plist_id::hid_t, boot::Ptr{Cuint}, freelist::Ptr{Cuint}, stab::Ptr{Cuint}, shhdr::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pget_version.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_count","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_count","text":"h5p_get_virtual_count(dcpl_id::hid_t, count::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5Pget_virtual_count.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_dsetname","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_dsetname","text":"h5p_get_virtual_dsetname(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_dsetname.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_filename","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_filename","text":"h5p_get_virtual_filename(dcpl_id::hid_t, index::Csize_t, name::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_filename.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_prefix","text":"h5p_get_virtual_prefix(dapl_id::hid_t, prefix::Ptr{Cchar}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5Pget_virtual_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_printf_gap","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_printf_gap","text":"h5p_get_virtual_printf_gap(dapl_id::hid_t, gap_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pget_virtual_printf_gap.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_srcspace","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_srcspace","text":"h5p_get_virtual_srcspace(dcpl_id::hid_t, index::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_virtual_srcspace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_view","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_view","text":"h5p_get_virtual_view(dapl_id::hid_t, view::Ptr{H5D_vds_view_t})\n\nSee libhdf5 documentation for H5Pget_virtual_view.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_virtual_vspace","page":"Low-level library bindings","title":"HDF5.API.h5p_get_virtual_vspace","text":"h5p_get_virtual_vspace(dcpl_id::hid_t, index::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Pget_virtual_vspace.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vlen_mem_manager","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vlen_mem_manager","text":"h5p_get_vlen_mem_manager(plist_id::hid_t, alloc_func::Ptr{H5MM_allocate_t}, alloc_info::Ptr{Ptr{Cvoid}}, free_func::Ptr{H5MM_free_t}, free_info::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_vlen_mem_manager.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vol_id","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vol_id","text":"h5p_get_vol_id(plist_id::hid_t, vol_id::Ptr{hid_t})\n\nSee libhdf5 documentation for H5Pget_vol_id.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_get_vol_info","page":"Low-level library bindings","title":"HDF5.API.h5p_get_vol_info","text":"h5p_get_vol_info(plist_id::hid_t, vol_info::Ptr{Ptr{Cvoid}})\n\nSee libhdf5 documentation for H5Pget_vol_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_insert","page":"Low-level library bindings","title":"HDF5.API.h5p_insert","text":"h5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_delete::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pinsert1.\n\n\n\n\n\nh5p_insert(plist_id::hid_t, name::Cstring, size::Csize_t, value::Ptr{Cvoid}, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pinsert2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_isa_class","page":"Low-level library bindings","title":"HDF5.API.h5p_isa_class","text":"h5p_isa_class(plist_id::hid_t, pclass_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Pisa_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_iterate","page":"Low-level library bindings","title":"HDF5.API.h5p_iterate","text":"h5p_iterate(id::hid_t, idx::Ptr{Cint}, iter_func::H5P_iterate_t, iter_data::Ptr{Cvoid}) -> Int\n\nSee libhdf5 documentation for H5Piterate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_modify_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_modify_filter","text":"h5p_modify_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pmodify_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_register","page":"Low-level library bindings","title":"HDF5.API.h5p_register","text":"h5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, prp_create::H5P_prp_create_func_t, prp_set::H5P_prp_set_func_t, prp_get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, prp_copy::H5P_prp_copy_func_t, prp_close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pregister1.\n\n\n\n\n\nh5p_register(cls_id::hid_t, name::Cstring, size::Csize_t, def_value::Ptr{Cvoid}, create::H5P_prp_create_func_t, set::H5P_prp_set_func_t, get::H5P_prp_get_func_t, prp_del::H5P_prp_delete_func_t, copy::H5P_prp_copy_func_t, compare::H5P_prp_compare_func_t, close::H5P_prp_close_func_t)\n\nSee libhdf5 documentation for H5Pregister2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_remove","page":"Low-level library bindings","title":"HDF5.API.h5p_remove","text":"h5p_remove(plist_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Premove.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_remove_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_remove_filter","text":"h5p_remove_filter(plist_id::hid_t, filter_id::H5Z_filter_t)\n\nSee libhdf5 documentation for H5Premove_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set","page":"Low-level library bindings","title":"HDF5.API.h5p_set","text":"h5p_set(plist_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_alignment","page":"Low-level library bindings","title":"HDF5.API.h5p_set_alignment","text":"h5p_set_alignment(plist_id::hid_t, threshold::hsize_t, alignment::hsize_t)\n\nSee libhdf5 documentation for H5Pset_alignment.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_alloc_time","page":"Low-level library bindings","title":"HDF5.API.h5p_set_alloc_time","text":"h5p_set_alloc_time(plist_id::hid_t, alloc_time::Cint)\n\nSee libhdf5 documentation for H5Pset_alloc_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_append_flush","page":"Low-level library bindings","title":"HDF5.API.h5p_set_append_flush","text":"h5p_set_append_flush(dapl_id::hid_t, ndims::Cuint, boundary::Ptr{hsize_t}, func::H5D_append_cb_t, udata::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_append_flush.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_attr_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_set_attr_creation_order","text":"h5p_set_attr_creation_order(plist_id::hid_t, crt_order_flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_attr_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_attr_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_attr_phase_change","text":"h5p_set_attr_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)\n\nSee libhdf5 documentation for H5Pset_attr_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_btree_ratios","page":"Low-level library bindings","title":"HDF5.API.h5p_set_btree_ratios","text":"h5p_set_btree_ratios(plist_id::hid_t, left::Cdouble, middle::Cdouble, right::Cdouble)\n\nSee libhdf5 documentation for H5Pset_btree_ratios.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_buffer","page":"Low-level library bindings","title":"HDF5.API.h5p_set_buffer","text":"h5p_set_buffer(plist_id::hid_t, size::Csize_t, tconv::Ptr{Cvoid}, bkg::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_buffer.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_set_cache","text":"h5p_set_cache(plist_id::hid_t, mdc_nelmts::Cint, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)\n\nSee libhdf5 documentation for H5Pset_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_char_encoding","page":"Low-level library bindings","title":"HDF5.API.h5p_set_char_encoding","text":"h5p_set_char_encoding(plist_id::hid_t, encoding::Cint)\n\nSee libhdf5 documentation for H5Pset_char_encoding.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk","text":"h5p_set_chunk(plist_id::hid_t, ndims::Cint, dims::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Pset_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk_cache","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk_cache","text":"h5p_set_chunk_cache(dapl_id::hid_t, rdcc_nslots::Csize_t, rdcc_nbytes::Csize_t, rdcc_w0::Cdouble)\n\nSee libhdf5 documentation for H5Pset_chunk_cache.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_chunk_opts","page":"Low-level library bindings","title":"HDF5.API.h5p_set_chunk_opts","text":"h5p_set_chunk_opts(plist_id::hid_t, opts::Cuint)\n\nSee libhdf5 documentation for H5Pset_chunk_opts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_copy_object","page":"Low-level library bindings","title":"HDF5.API.h5p_set_copy_object","text":"h5p_set_copy_object(plist_id::hid_t, copy_options::Cuint)\n\nSee libhdf5 documentation for H5Pset_copy_object.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_core_write_tracking","page":"Low-level library bindings","title":"HDF5.API.h5p_set_core_write_tracking","text":"h5p_set_core_write_tracking(fapl_id::hid_t, is_enabled::hbool_t, page_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_core_write_tracking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_create_intermediate_group","page":"Low-level library bindings","title":"HDF5.API.h5p_set_create_intermediate_group","text":"h5p_set_create_intermediate_group(plist_id::hid_t, setting::Cuint)\n\nSee libhdf5 documentation for H5Pset_create_intermediate_group.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_data_transform","page":"Low-level library bindings","title":"HDF5.API.h5p_set_data_transform","text":"h5p_set_data_transform(plist_id::hid_t, expression::Cstring)\n\nSee libhdf5 documentation for H5Pset_data_transform.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_deflate","page":"Low-level library bindings","title":"HDF5.API.h5p_set_deflate","text":"h5p_set_deflate(plist_id::hid_t, setting::Cuint)\n\nSee libhdf5 documentation for H5Pset_deflate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_driver","page":"Low-level library bindings","title":"HDF5.API.h5p_set_driver","text":"h5p_set_driver(plist_id::hid_t, driver_id::hid_t, driver_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_dset_no_attrs_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_set_dset_no_attrs_hint","text":"h5p_set_dset_no_attrs_hint(dcpl_id::hid_t, minimize::hbool_t)\n\nSee libhdf5 documentation for H5Pset_dset_no_attrs_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_dxpl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_dxpl_mpio","text":"h5p_set_dxpl_mpio(dxpl_id::hid_t, xfer_mode::Cint)\n\nSee libhdf5 documentation for H5Pset_dxpl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_edc_check","page":"Low-level library bindings","title":"HDF5.API.h5p_set_edc_check","text":"h5p_set_edc_check(plist_id::hid_t, check::H5Z_EDC_t)\n\nSee libhdf5 documentation for H5Pset_edc_check.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_efile_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_efile_prefix","text":"h5p_set_efile_prefix(plist_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_efile_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_acc_flags","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_acc_flags","text":"h5p_set_elink_acc_flags(lapl_id::hid_t, flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_elink_acc_flags.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_cb","text":"h5p_set_elink_cb(lapl_id::hid_t, func::H5L_elink_traverse_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_elink_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_fapl","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_fapl","text":"h5p_set_elink_fapl(lapl_id::hid_t, fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_elink_fapl.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_file_cache_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_file_cache_size","text":"h5p_set_elink_file_cache_size(plist_id::hid_t, efc_size::Cuint)\n\nSee libhdf5 documentation for H5Pset_elink_file_cache_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_elink_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_elink_prefix","text":"h5p_set_elink_prefix(plist_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_elink_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_est_link_info","page":"Low-level library bindings","title":"HDF5.API.h5p_set_est_link_info","text":"h5p_set_est_link_info(plist_id::hid_t, est_num_entries::Cuint, est_name_len::Cuint)\n\nSee libhdf5 documentation for H5Pset_est_link_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_evict_on_close","page":"Low-level library bindings","title":"HDF5.API.h5p_set_evict_on_close","text":"h5p_set_evict_on_close(fapl_id::hid_t, evict_on_close::hbool_t)\n\nSee libhdf5 documentation for H5Pset_evict_on_close.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_external","page":"Low-level library bindings","title":"HDF5.API.h5p_set_external","text":"h5p_set_external(plist_id::hid_t, name::Cstring, offset::off_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_external.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_family_offset","page":"Low-level library bindings","title":"HDF5.API.h5p_set_family_offset","text":"h5p_set_family_offset(fapl_id::hid_t, offset::hsize_t)\n\nSee libhdf5 documentation for H5Pset_family_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_core","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_core","text":"h5p_set_fapl_core(fapl_id::hid_t, increment::Csize_t, backing_store::hbool_t)\n\nSee libhdf5 documentation for H5Pset_fapl_core.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_family","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_family","text":"h5p_set_fapl_family(fapl_id::hid_t, memb_size::hsize_t, memb_fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_family.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_hdfs","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_hdfs","text":"h5p_set_fapl_hdfs(fapl_id::hid_t, fa::Ptr{H5FD_hdfs_fapl_t})\n\nSee libhdf5 documentation for H5Pset_fapl_hdfs.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_log","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_log","text":"h5p_set_fapl_log(fapl_id::hid_t, logfile::Cstring, flags::Culonglong, buf_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_fapl_log.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_mpio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_mpio","text":"h5p_set_fapl_mpio(fapl_id::hid_t, comm::MPI.MPI_Comm, info::MPI.MPI_Info)\n\nSee libhdf5 documentation for H5Pset_fapl_mpio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_multi","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_multi","text":"h5p_set_fapl_multi(fapl_id::hid_t, memb_map::Ptr{H5FD_mem_t}, memb_fapl::Ptr{hid_t}, memb_name::Ptr{Cstring}, memb_addr::Ptr{haddr_t}, relax::hbool_t)\n\nSee libhdf5 documentation for H5Pset_fapl_multi.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_ros3","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_ros3","text":"h5p_set_fapl_ros3(fapl_id::hid_t, fa::Ptr{H5FD_ros3_fapl_t})\n\nSee libhdf5 documentation for H5Pset_fapl_ros3.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_sec2","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_sec2","text":"h5p_set_fapl_sec2(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_sec2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_split","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_split","text":"h5p_set_fapl_split(fapl::hid_t, meta_ext::Cstring, meta_plist_id::hid_t, raw_ext::Cstring, raw_plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_split.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_splitter","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_splitter","text":"h5p_set_fapl_splitter(fapl_id::hid_t, config_ptr::Ptr{H5FD_splitter_vfd_config_t})\n\nSee libhdf5 documentation for H5Pset_fapl_splitter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_stdio","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_stdio","text":"h5p_set_fapl_stdio(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_stdio.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fapl_windows","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fapl_windows","text":"h5p_set_fapl_windows(fapl_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fapl_windows.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fclose_degree","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fclose_degree","text":"h5p_set_fclose_degree(plist_id::hid_t, fc_degree::Cint)\n\nSee libhdf5 documentation for H5Pset_fclose_degree.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_image","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_image","text":"h5p_set_file_image(fapl_id::hid_t, buf_ptr::Ptr{Cvoid}, buf_len::Csize_t)\n\nSee libhdf5 documentation for H5Pset_file_image.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_image_callbacks","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_image_callbacks","text":"h5p_set_file_image_callbacks(fapl_id::hid_t, callbacks_ptr::Ptr{H5FD_file_image_callbacks_t})\n\nSee libhdf5 documentation for H5Pset_file_image_callbacks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_locking","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_locking","text":"h5p_set_file_locking(fapl_id::hid_t, use_file_locking::hbool_t, ignore_when_disabled::hbool_t)\n\nSee libhdf5 documentation for H5Pset_file_locking.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space","text":"h5p_set_file_space(plist_id::hid_t, strategy::H5F_file_space_type_t, threshold::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space_page_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space_page_size","text":"h5p_set_file_space_page_size(plist_id::hid_t, fsp_size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space_page_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_file_space_strategy","page":"Low-level library bindings","title":"HDF5.API.h5p_set_file_space_strategy","text":"h5p_set_file_space_strategy(plist_id::hid_t, strategy::H5F_fspace_strategy_t, persist::hbool_t, threshold::hsize_t)\n\nSee libhdf5 documentation for H5Pset_file_space_strategy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fill_time","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fill_time","text":"h5p_set_fill_time(plist_id::hid_t, fill_time::H5D_fill_time_t)\n\nSee libhdf5 documentation for H5Pset_fill_time.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fill_value","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fill_value","text":"h5p_set_fill_value(plist_id::hid_t, type_id::hid_t, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_fill_value.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_filter","page":"Low-level library bindings","title":"HDF5.API.h5p_set_filter","text":"h5p_set_filter(plist_id::hid_t, filter_id::H5Z_filter_t, flags::Cuint, cd_nelmts::Csize_t, cd_values::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Pset_filter.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_filter_callback","page":"Low-level library bindings","title":"HDF5.API.h5p_set_filter_callback","text":"h5p_set_filter_callback(plist_id::hid_t, func::H5Z_filter_func_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_filter_callback.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_fletcher32","page":"Low-level library bindings","title":"HDF5.API.h5p_set_fletcher32","text":"h5p_set_fletcher32(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_fletcher32.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_gc_references","page":"Low-level library bindings","title":"HDF5.API.h5p_set_gc_references","text":"h5p_set_gc_references(fapl_id::hid_t, gc_ref::Cuint)\n\nSee libhdf5 documentation for H5Pset_gc_references.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_hyper_vector_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_hyper_vector_size","text":"h5p_set_hyper_vector_size(plist_id::hid_t, size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_hyper_vector_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_istore_k","page":"Low-level library bindings","title":"HDF5.API.h5p_set_istore_k","text":"h5p_set_istore_k(plist_id::hid_t, ik::Cuint)\n\nSee libhdf5 documentation for H5Pset_istore_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_layout","page":"Low-level library bindings","title":"HDF5.API.h5p_set_layout","text":"h5p_set_layout(plist_id::hid_t, setting::Cint)\n\nSee libhdf5 documentation for H5Pset_layout.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_libver_bounds","page":"Low-level library bindings","title":"HDF5.API.h5p_set_libver_bounds","text":"h5p_set_libver_bounds(fapl_id::hid_t, low::Cint, high::Cint)\n\nSee libhdf5 documentation for H5Pset_libver_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_link_creation_order","page":"Low-level library bindings","title":"HDF5.API.h5p_set_link_creation_order","text":"h5p_set_link_creation_order(plist_id::hid_t, crt_order_flags::Cuint)\n\nSee libhdf5 documentation for H5Pset_link_creation_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_link_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_link_phase_change","text":"h5p_set_link_phase_change(plist_id::hid_t, max_compact::Cuint, min_dense::Cuint)\n\nSee libhdf5 documentation for H5Pset_link_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_local_heap_size_hint","page":"Low-level library bindings","title":"HDF5.API.h5p_set_local_heap_size_hint","text":"h5p_set_local_heap_size_hint(plist_id::hid_t, size_hint::Csize_t)\n\nSee libhdf5 documentation for H5Pset_local_heap_size_hint.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mcdt_search_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mcdt_search_cb","text":"h5p_set_mcdt_search_cb(plist_id::hid_t, func::H5O_mcdt_search_cb_t, op_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_mcdt_search_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_config","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_config","text":"h5p_set_mdc_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_config_t})\n\nSee libhdf5 documentation for H5Pset_mdc_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_image_config","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_image_config","text":"h5p_set_mdc_image_config(plist_id::hid_t, config_ptr::Ptr{H5AC_cache_image_config_t})\n\nSee libhdf5 documentation for H5Pset_mdc_image_config.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_mdc_log_options","page":"Low-level library bindings","title":"HDF5.API.h5p_set_mdc_log_options","text":"h5p_set_mdc_log_options(plist_id::hid_t, is_enabled::hbool_t, location::Cstring, start_on_access::hbool_t)\n\nSee libhdf5 documentation for H5Pset_mdc_log_options.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_meta_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_meta_block_size","text":"h5p_set_meta_block_size(fapl_id::hid_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_meta_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_metadata_read_attempts","page":"Low-level library bindings","title":"HDF5.API.h5p_set_metadata_read_attempts","text":"h5p_set_metadata_read_attempts(plist_id::hid_t, attempts::Cuint)\n\nSee libhdf5 documentation for H5Pset_metadata_read_attempts.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_multi_type","page":"Low-level library bindings","title":"HDF5.API.h5p_set_multi_type","text":"h5p_set_multi_type(fapl_id::hid_t, type::H5FD_mem_t)\n\nSee libhdf5 documentation for H5Pset_multi_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_nbit","page":"Low-level library bindings","title":"HDF5.API.h5p_set_nbit","text":"h5p_set_nbit(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_nbit.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_nlinks","page":"Low-level library bindings","title":"HDF5.API.h5p_set_nlinks","text":"h5p_set_nlinks(plist_id::hid_t, nlinks::Csize_t)\n\nSee libhdf5 documentation for H5Pset_nlinks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_obj_track_times","page":"Low-level library bindings","title":"HDF5.API.h5p_set_obj_track_times","text":"h5p_set_obj_track_times(plist_id::hid_t, track_times::UInt8)\n\nSee libhdf5 documentation for H5Pset_obj_track_times.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_object_flush_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_object_flush_cb","text":"h5p_set_object_flush_cb(plist_id::hid_t, func::H5F_flush_cb_t, udata::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_object_flush_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_page_buffer_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_page_buffer_size","text":"h5p_set_page_buffer_size(plist_id::hid_t, buf_size::Csize_t, min_meta_per::Cuint, min_raw_per::Cuint)\n\nSee libhdf5 documentation for H5Pset_page_buffer_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_preserve","page":"Low-level library bindings","title":"HDF5.API.h5p_set_preserve","text":"h5p_set_preserve(plist_id::hid_t, status::hbool_t)\n\nSee libhdf5 documentation for H5Pset_preserve.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_scaleoffset","page":"Low-level library bindings","title":"HDF5.API.h5p_set_scaleoffset","text":"h5p_set_scaleoffset(plist_id::hid_t, scale_type::Cint, scale_factor::Cint)\n\nSee libhdf5 documentation for H5Pset_scaleoffset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_index","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_index","text":"h5p_set_shared_mesg_index(plist_id::hid_t, index_num::Cuint, mesg_type_flags::Cuint, min_mesg_size::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_nindexes","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_nindexes","text":"h5p_set_shared_mesg_nindexes(plist_id::hid_t, nindexes::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_nindexes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shared_mesg_phase_change","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shared_mesg_phase_change","text":"h5p_set_shared_mesg_phase_change(plist_id::hid_t, max_list::Cuint, min_btree::Cuint)\n\nSee libhdf5 documentation for H5Pset_shared_mesg_phase_change.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_shuffle","page":"Low-level library bindings","title":"HDF5.API.h5p_set_shuffle","text":"h5p_set_shuffle(plist_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_shuffle.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sieve_buf_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sieve_buf_size","text":"h5p_set_sieve_buf_size(fapl_id::hid_t, size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_sieve_buf_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sizes","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sizes","text":"h5p_set_sizes(plist_id::hid_t, sizeof_addr::Csize_t, sizeof_size::Csize_t)\n\nSee libhdf5 documentation for H5Pset_sizes.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_small_data_block_size","page":"Low-level library bindings","title":"HDF5.API.h5p_set_small_data_block_size","text":"h5p_set_small_data_block_size(fapl_id::hid_t, size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_small_data_block_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_sym_k","page":"Low-level library bindings","title":"HDF5.API.h5p_set_sym_k","text":"h5p_set_sym_k(plist_id::hid_t, ik::Cuint, lk::Cuint)\n\nSee libhdf5 documentation for H5Pset_sym_k.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_szip","page":"Low-level library bindings","title":"HDF5.API.h5p_set_szip","text":"h5p_set_szip(plist_id::hid_t, options_mask::Cuint, pixels_per_block::Cuint)\n\nSee libhdf5 documentation for H5Pset_szip.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_type_conv_cb","page":"Low-level library bindings","title":"HDF5.API.h5p_set_type_conv_cb","text":"h5p_set_type_conv_cb(dxpl_id::hid_t, op::H5T_conv_except_func_t, operate_data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_type_conv_cb.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_userblock","page":"Low-level library bindings","title":"HDF5.API.h5p_set_userblock","text":"h5p_set_userblock(plist_id::hid_t, len::hsize_t)\n\nSee libhdf5 documentation for H5Pset_userblock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual","text":"h5p_set_virtual(dcpl_id::hid_t, vspace_id::hid_t, src_file_name::Cstring, src_dset_name::Cstring, src_space_id::hid_t)\n\nSee libhdf5 documentation for H5Pset_virtual.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_prefix","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_prefix","text":"h5p_set_virtual_prefix(dapl_id::hid_t, prefix::Cstring)\n\nSee libhdf5 documentation for H5Pset_virtual_prefix.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_printf_gap","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_printf_gap","text":"h5p_set_virtual_printf_gap(dapl_id::hid_t, gap_size::hsize_t)\n\nSee libhdf5 documentation for H5Pset_virtual_printf_gap.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_virtual_view","page":"Low-level library bindings","title":"HDF5.API.h5p_set_virtual_view","text":"h5p_set_virtual_view(dapl_id::hid_t, view::H5D_vds_view_t)\n\nSee libhdf5 documentation for H5Pset_virtual_view.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_vlen_mem_manager","page":"Low-level library bindings","title":"HDF5.API.h5p_set_vlen_mem_manager","text":"h5p_set_vlen_mem_manager(plist_id::hid_t, alloc_func::H5MM_allocate_t, alloc_info::Ptr{Cvoid}, free_func::H5MM_free_t, free_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_vlen_mem_manager.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_set_vol","page":"Low-level library bindings","title":"HDF5.API.h5p_set_vol","text":"h5p_set_vol(plist_id::hid_t, new_vol_id::hid_t, new_vol_info::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Pset_vol.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5p_unregister","page":"Low-level library bindings","title":"HDF5.API.h5p_unregister","text":"h5p_unregister(pclass_id::hid_t, name::Cstring)\n\nSee libhdf5 documentation for H5Punregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5R","page":"Low-level library bindings","title":"H5R — Reference Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5r_create\nh5r_dereference\nh5r_get_obj_type\nh5r_get_region","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5r_create\nh5r_dereference\nh5r_get_obj_type\nh5r_get_region","category":"page"},{"location":"api_bindings/#HDF5.API.h5r_create","page":"Low-level library bindings","title":"HDF5.API.h5r_create","text":"h5r_create(ref::Ptr{Cvoid}, loc_id::hid_t, pathname::Cstring, ref_type::Cint, space_id::hid_t)\n\nSee libhdf5 documentation for H5Rcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_dereference","page":"Low-level library bindings","title":"HDF5.API.h5r_dereference","text":"h5r_dereference(obj_id::hid_t, oapl_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Rdereference2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_get_obj_type","page":"Low-level library bindings","title":"HDF5.API.h5r_get_obj_type","text":"h5r_get_obj_type(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}, obj_type::Ptr{Cint})\n\nSee libhdf5 documentation for H5Rget_obj_type2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5r_get_region","page":"Low-level library bindings","title":"HDF5.API.h5r_get_region","text":"h5r_get_region(loc_id::hid_t, ref_type::Cint, ref::Ptr{Cvoid}) -> hid_t\n\nSee libhdf5 documentation for H5Rget_region.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5S","page":"Low-level library bindings","title":"H5S — Dataspace Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5s_close\nh5s_combine_hyperslab\nh5s_combine_select\nh5s_copy\nh5s_create\nh5s_create_simple\nh5s_extent_copy\nh5s_extent_equal\nh5s_get_regular_hyperslab\nh5s_get_select_bounds\nh5s_get_select_elem_npoints\nh5s_get_select_elem_pointlist\nh5s_get_select_hyper_blocklist\nh5s_get_select_hyper_nblocks\nh5s_get_select_npoints\nh5s_get_select_type\nh5s_get_simple_extent_dims\nh5s_get_simple_extent_ndims\nh5s_get_simple_extent_type\nh5s_is_regular_hyperslab\nh5s_is_simple\nh5s_modify_select\nh5s_offset_simple\nh5s_select_adjust\nh5s_select_all\nh5s_select_copy\nh5s_select_elements\nh5s_select_hyperslab\nh5s_select_intersect_block\nh5s_select_shape_same\nh5s_select_valid\nh5s_set_extent_none\nh5s_set_extent_simple","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5s_close\nh5s_combine_hyperslab\nh5s_combine_select\nh5s_copy\nh5s_create\nh5s_create_simple\nh5s_extent_copy\nh5s_extent_equal\nh5s_get_regular_hyperslab\nh5s_get_select_bounds\nh5s_get_select_elem_npoints\nh5s_get_select_elem_pointlist\nh5s_get_select_hyper_blocklist\nh5s_get_select_hyper_nblocks\nh5s_get_select_npoints\nh5s_get_select_type\nh5s_get_simple_extent_dims\nh5s_get_simple_extent_ndims\nh5s_get_simple_extent_type\nh5s_is_regular_hyperslab\nh5s_is_simple\nh5s_modify_select\nh5s_offset_simple\nh5s_select_adjust\nh5s_select_all\nh5s_select_copy\nh5s_select_elements\nh5s_select_hyperslab\nh5s_select_intersect_block\nh5s_select_shape_same\nh5s_select_valid\nh5s_set_extent_none\nh5s_set_extent_simple","category":"page"},{"location":"api_bindings/#HDF5.API.h5s_close","page":"Low-level library bindings","title":"HDF5.API.h5s_close","text":"h5s_close(space_id::hid_t)\n\nSee libhdf5 documentation for H5Sclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_combine_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_combine_hyperslab","text":"h5s_combine_hyperslab(dspace_id::hid_t, seloper::H5S_seloper_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Scombine_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_combine_select","page":"Low-level library bindings","title":"HDF5.API.h5s_combine_select","text":"h5s_combine_select(space1_id::hid_t, op::H5S_seloper_t, space2_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Scombine_select.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_copy","page":"Low-level library bindings","title":"HDF5.API.h5s_copy","text":"h5s_copy(space_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Scopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_create","page":"Low-level library bindings","title":"HDF5.API.h5s_create","text":"h5s_create(class::Cint) -> hid_t\n\nSee libhdf5 documentation for H5Screate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_create_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_create_simple","text":"h5s_create_simple(rank::Cint, current_dims::Ptr{hsize_t}, maximum_dims::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Screate_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_extent_copy","page":"Low-level library bindings","title":"HDF5.API.h5s_extent_copy","text":"h5s_extent_copy(dst::hid_t, src::hid_t)\n\nSee libhdf5 documentation for H5Sextent_copy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_extent_equal","page":"Low-level library bindings","title":"HDF5.API.h5s_extent_equal","text":"h5s_extent_equal(space1_id::hid_t, space2_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sextent_equal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_regular_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_get_regular_hyperslab","text":"h5s_get_regular_hyperslab(space_id::hid_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sget_regular_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_bounds","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_bounds","text":"h5s_get_select_bounds(space_id::hid_t, starts::Ptr{hsize_t}, ends::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sget_select_bounds.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_elem_npoints","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_elem_npoints","text":"h5s_get_select_elem_npoints(space_id::hid_t) -> hssize_t\n\nSee libhdf5 documentation for H5Sget_select_elem_npoints.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_elem_pointlist","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_elem_pointlist","text":"h5s_get_select_elem_pointlist(space_id::hid_t, startpoint::hsize_t, numpoints::hsize_t, buf::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sget_select_elem_pointlist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_hyper_blocklist","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_hyper_blocklist","text":"h5s_get_select_hyper_blocklist(space_id::hid_t, startblock::hsize_t, numblocks::hsize_t, buf::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sget_select_hyper_blocklist.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_hyper_nblocks","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_hyper_nblocks","text":"h5s_get_select_hyper_nblocks(space_id::hid_t) -> hssize_t\n\nSee libhdf5 documentation for H5Sget_select_hyper_nblocks.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_npoints","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_npoints","text":"h5s_get_select_npoints(space_id::hid_t) -> hsize_t\n\nSee libhdf5 documentation for H5Sget_select_npoints.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_select_type","page":"Low-level library bindings","title":"HDF5.API.h5s_get_select_type","text":"h5s_get_select_type(space_id::hid_t) -> H5S_sel_type\n\nSee libhdf5 documentation for H5Sget_select_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_dims","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_dims","text":"h5s_get_simple_extent_dims(space_id::hid_t, dims::Ptr{hsize_t}, maxdims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Sget_simple_extent_dims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_ndims","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_ndims","text":"h5s_get_simple_extent_ndims(space_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Sget_simple_extent_ndims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_get_simple_extent_type","page":"Low-level library bindings","title":"HDF5.API.h5s_get_simple_extent_type","text":"h5s_get_simple_extent_type(space_id::hid_t) -> H5S_class_t\n\nSee libhdf5 documentation for H5Sget_simple_extent_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_is_regular_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_is_regular_hyperslab","text":"h5s_is_regular_hyperslab(space_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sis_regular_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_is_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_is_simple","text":"h5s_is_simple(space_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sis_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_modify_select","page":"Low-level library bindings","title":"HDF5.API.h5s_modify_select","text":"h5s_modify_select(space_id::hid_t, op::H5S_seloper_t, space2_id::hid_t)\n\nSee libhdf5 documentation for H5Smodify_select.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_offset_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_offset_simple","text":"h5s_offset_simple(space_id::hid_t, offset::Ptr{hssize_t})\n\nSee libhdf5 documentation for H5Soffset_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_adjust","page":"Low-level library bindings","title":"HDF5.API.h5s_select_adjust","text":"h5s_select_adjust(space_id::hid_t, offset::Ptr{hssize_t})\n\nSee libhdf5 documentation for H5Sselect_adjust.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_all","page":"Low-level library bindings","title":"HDF5.API.h5s_select_all","text":"h5s_select_all(space_id::hid_t)\n\nSee libhdf5 documentation for H5Sselect_all.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_copy","page":"Low-level library bindings","title":"HDF5.API.h5s_select_copy","text":"h5s_select_copy(dst::hid_t, src::hid_t)\n\nSee libhdf5 documentation for H5Sselect_copy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_elements","page":"Low-level library bindings","title":"HDF5.API.h5s_select_elements","text":"h5s_select_elements(space_id::hid_t, op::H5S_seloper_t, num_elem::Csize_t, coord::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sselect_elements.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_hyperslab","page":"Low-level library bindings","title":"HDF5.API.h5s_select_hyperslab","text":"h5s_select_hyperslab(dspace_id::hid_t, seloper::H5S_seloper_t, start::Ptr{hsize_t}, stride::Ptr{hsize_t}, count::Ptr{hsize_t}, block::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sselect_hyperslab.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_intersect_block","page":"Low-level library bindings","title":"HDF5.API.h5s_select_intersect_block","text":"h5s_select_intersect_block(space_id::hid_t, starts::Ptr{hsize_t}, ends::Ptr{hsize_t}) -> Bool\n\nSee libhdf5 documentation for H5Sselect_intersect_block.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_shape_same","page":"Low-level library bindings","title":"HDF5.API.h5s_select_shape_same","text":"h5s_select_shape_same(space1_id::hid_t, space2_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sselect_shape_same.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_select_valid","page":"Low-level library bindings","title":"HDF5.API.h5s_select_valid","text":"h5s_select_valid(spaceid::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Sselect_valid.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_set_extent_none","page":"Low-level library bindings","title":"HDF5.API.h5s_set_extent_none","text":"h5s_set_extent_none(space_id::hid_t)\n\nSee libhdf5 documentation for H5Sset_extent_none.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5s_set_extent_simple","page":"Low-level library bindings","title":"HDF5.API.h5s_set_extent_simple","text":"h5s_set_extent_simple(dspace_id::hid_t, rank::Cint, current_size::Ptr{hsize_t}, maximum_size::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5Sset_extent_simple.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5T","page":"Low-level library bindings","title":"H5T — Datatype Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5t_array_create\nh5t_close\nh5t_commit\nh5t_committed\nh5t_copy\nh5t_create\nh5t_enum_insert\nh5t_equal\nh5t_get_array_dims\nh5t_get_array_ndims\nh5t_get_class\nh5t_get_cset\nh5t_get_ebias\nh5t_get_fields\nh5t_get_member_class\nh5t_get_member_index\nh5t_get_member_name\nh5t_get_member_offset\nh5t_get_member_type\nh5t_get_native_type\nh5t_get_nmembers\nh5t_get_offset\nh5t_get_order\nh5t_get_precision\nh5t_get_sign\nh5t_get_size\nh5t_get_strpad\nh5t_get_super\nh5t_get_tag\nh5t_insert\nh5t_is_variable_str\nh5t_lock\nh5t_open\nh5t_set_cset\nh5t_set_ebias\nh5t_set_fields\nh5t_set_offset\nh5t_set_order\nh5t_set_precision\nh5t_set_size\nh5t_set_strpad\nh5t_set_tag\nh5t_vlen_create","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5t_array_create\nh5t_close\nh5t_commit\nh5t_committed\nh5t_copy\nh5t_create\nh5t_enum_insert\nh5t_equal\nh5t_get_array_dims\nh5t_get_array_ndims\nh5t_get_class\nh5t_get_cset\nh5t_get_ebias\nh5t_get_fields\nh5t_get_member_class\nh5t_get_member_index\nh5t_get_member_name\nh5t_get_member_offset\nh5t_get_member_type\nh5t_get_native_type\nh5t_get_nmembers\nh5t_get_offset\nh5t_get_order\nh5t_get_precision\nh5t_get_sign\nh5t_get_size\nh5t_get_strpad\nh5t_get_super\nh5t_get_tag\nh5t_insert\nh5t_is_variable_str\nh5t_lock\nh5t_open\nh5t_set_cset\nh5t_set_ebias\nh5t_set_fields\nh5t_set_offset\nh5t_set_order\nh5t_set_precision\nh5t_set_size\nh5t_set_strpad\nh5t_set_tag\nh5t_vlen_create","category":"page"},{"location":"api_bindings/#HDF5.API.h5t_array_create","page":"Low-level library bindings","title":"HDF5.API.h5t_array_create","text":"h5t_array_create(basetype_id::hid_t, ndims::Cuint, sz::Ptr{hsize_t}) -> hid_t\n\nSee libhdf5 documentation for H5Tarray_create2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_close","page":"Low-level library bindings","title":"HDF5.API.h5t_close","text":"h5t_close(dtype_id::hid_t)\n\nSee libhdf5 documentation for H5Tclose.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_commit","page":"Low-level library bindings","title":"HDF5.API.h5t_commit","text":"h5t_commit(loc_id::hid_t, name::Cstring, dtype_id::hid_t, lcpl_id::hid_t, tcpl_id::hid_t, tapl_id::hid_t)\n\nSee libhdf5 documentation for H5Tcommit2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_committed","page":"Low-level library bindings","title":"HDF5.API.h5t_committed","text":"h5t_committed(dtype_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tcommitted.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_copy","page":"Low-level library bindings","title":"HDF5.API.h5t_copy","text":"h5t_copy(dtype_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tcopy.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_create","page":"Low-level library bindings","title":"HDF5.API.h5t_create","text":"h5t_create(class_id::Cint, sz::Csize_t) -> hid_t\n\nSee libhdf5 documentation for H5Tcreate.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_enum_insert","page":"Low-level library bindings","title":"HDF5.API.h5t_enum_insert","text":"h5t_enum_insert(dtype_id::hid_t, name::Cstring, value::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5Tenum_insert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_equal","page":"Low-level library bindings","title":"HDF5.API.h5t_equal","text":"h5t_equal(dtype_id1::hid_t, dtype_id2::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tequal.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_array_dims","page":"Low-level library bindings","title":"HDF5.API.h5t_get_array_dims","text":"h5t_get_array_dims(dtype_id::hid_t, dims::Ptr{hsize_t}) -> Int\n\nSee libhdf5 documentation for H5Tget_array_dims2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_array_ndims","page":"Low-level library bindings","title":"HDF5.API.h5t_get_array_ndims","text":"h5t_get_array_ndims(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_array_ndims.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_class","page":"Low-level library bindings","title":"HDF5.API.h5t_get_class","text":"h5t_get_class(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_cset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_cset","text":"h5t_get_cset(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_cset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_ebias","page":"Low-level library bindings","title":"HDF5.API.h5t_get_ebias","text":"h5t_get_ebias(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_ebias.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_fields","page":"Low-level library bindings","title":"HDF5.API.h5t_get_fields","text":"h5t_get_fields(dtype_id::hid_t, spos::Ref{Csize_t}, epos::Ref{Csize_t}, esize::Ref{Csize_t}, mpos::Ref{Csize_t}, msize::Ref{Csize_t})\n\nSee libhdf5 documentation for H5Tget_fields.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_class","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_class","text":"h5t_get_member_class(dtype_id::hid_t, index::Cuint) -> Int\n\nSee libhdf5 documentation for H5Tget_member_class.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_index","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_index","text":"h5t_get_member_index(dtype_id::hid_t, membername::Cstring) -> Int\n\nSee libhdf5 documentation for H5Tget_member_index.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_name","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_name","text":"h5t_get_member_name(type_id::hid_t, index::Cuint) -> String\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_offset","text":"h5t_get_member_offset(dtype_id::hid_t, index::Cuint) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_member_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_member_type","page":"Low-level library bindings","title":"HDF5.API.h5t_get_member_type","text":"h5t_get_member_type(dtype_id::hid_t, index::Cuint) -> hid_t\n\nSee libhdf5 documentation for H5Tget_member_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_native_type","page":"Low-level library bindings","title":"HDF5.API.h5t_get_native_type","text":"h5t_get_native_type(dtype_id::hid_t, direction::Cint) -> hid_t\n\nSee libhdf5 documentation for H5Tget_native_type.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_nmembers","page":"Low-level library bindings","title":"HDF5.API.h5t_get_nmembers","text":"h5t_get_nmembers(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_nmembers.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_get_offset","text":"h5t_get_offset(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_order","page":"Low-level library bindings","title":"HDF5.API.h5t_get_order","text":"h5t_get_order(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_precision","page":"Low-level library bindings","title":"HDF5.API.h5t_get_precision","text":"h5t_get_precision(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_precision.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_sign","page":"Low-level library bindings","title":"HDF5.API.h5t_get_sign","text":"h5t_get_sign(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_sign.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_size","page":"Low-level library bindings","title":"HDF5.API.h5t_get_size","text":"h5t_get_size(dtype_id::hid_t) -> Csize_t\n\nSee libhdf5 documentation for H5Tget_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_strpad","page":"Low-level library bindings","title":"HDF5.API.h5t_get_strpad","text":"h5t_get_strpad(dtype_id::hid_t) -> Int\n\nSee libhdf5 documentation for H5Tget_strpad.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_super","page":"Low-level library bindings","title":"HDF5.API.h5t_get_super","text":"h5t_get_super(dtype_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tget_super.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_get_tag","page":"Low-level library bindings","title":"HDF5.API.h5t_get_tag","text":"h5t_get_tag(type_id::hid_t) -> String\n\nSee libhdf5 documentation for H5Oopen.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_insert","page":"Low-level library bindings","title":"HDF5.API.h5t_insert","text":"h5t_insert(dtype_id::hid_t, fieldname::Cstring, offset::Csize_t, field_id::hid_t)\n\nSee libhdf5 documentation for H5Tinsert.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_is_variable_str","page":"Low-level library bindings","title":"HDF5.API.h5t_is_variable_str","text":"h5t_is_variable_str(type_id::hid_t) -> Bool\n\nSee libhdf5 documentation for H5Tis_variable_str.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_lock","page":"Low-level library bindings","title":"HDF5.API.h5t_lock","text":"h5t_lock(type_id::hid_t)\n\nSee libhdf5 documentation for H5Tlock.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_open","page":"Low-level library bindings","title":"HDF5.API.h5t_open","text":"h5t_open(loc_id::hid_t, name::Cstring, tapl_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Topen2.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_cset","page":"Low-level library bindings","title":"HDF5.API.h5t_set_cset","text":"h5t_set_cset(dtype_id::hid_t, cset::Cint)\n\nSee libhdf5 documentation for H5Tset_cset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_ebias","page":"Low-level library bindings","title":"HDF5.API.h5t_set_ebias","text":"h5t_set_ebias(dtype_id::hid_t, ebias::Csize_t)\n\nSee libhdf5 documentation for H5Tset_ebias.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_fields","page":"Low-level library bindings","title":"HDF5.API.h5t_set_fields","text":"h5t_set_fields(dtype_id::hid_t, spos::Csize_t, epos::Csize_t, esize::Csize_t, mpos::Csize_t, msize::Csize_t)\n\nSee libhdf5 documentation for H5Tset_fields.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_offset","page":"Low-level library bindings","title":"HDF5.API.h5t_set_offset","text":"h5t_set_offset(dtype_id::hid_t, offset::Csize_t)\n\nSee libhdf5 documentation for H5Tset_offset.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_order","page":"Low-level library bindings","title":"HDF5.API.h5t_set_order","text":"h5t_set_order(dtype_id::hid_t, order::Cint)\n\nSee libhdf5 documentation for H5Tset_order.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_precision","page":"Low-level library bindings","title":"HDF5.API.h5t_set_precision","text":"h5t_set_precision(dtype_id::hid_t, sz::Csize_t)\n\nSee libhdf5 documentation for H5Tset_precision.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_size","page":"Low-level library bindings","title":"HDF5.API.h5t_set_size","text":"h5t_set_size(dtype_id::hid_t, sz::Csize_t)\n\nSee libhdf5 documentation for H5Tset_size.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_strpad","page":"Low-level library bindings","title":"HDF5.API.h5t_set_strpad","text":"h5t_set_strpad(dtype_id::hid_t, sz::Cint)\n\nSee libhdf5 documentation for H5Tset_strpad.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_set_tag","page":"Low-level library bindings","title":"HDF5.API.h5t_set_tag","text":"h5t_set_tag(dtype_id::hid_t, tag::Cstring)\n\nSee libhdf5 documentation for H5Tset_tag.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5t_vlen_create","page":"Low-level library bindings","title":"HDF5.API.h5t_vlen_create","text":"h5t_vlen_create(base_type_id::hid_t) -> hid_t\n\nSee libhdf5 documentation for H5Tvlen_create.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5Z","page":"Low-level library bindings","title":"H5Z — Filter Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5z_filter_avail\nh5z_get_filter_info\nh5z_register\nh5z_unregister","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5z_filter_avail\nh5z_get_filter_info\nh5z_register\nh5z_unregister","category":"page"},{"location":"api_bindings/#HDF5.API.h5z_filter_avail","page":"Low-level library bindings","title":"HDF5.API.h5z_filter_avail","text":"h5z_filter_avail(id::H5Z_filter_t) -> Bool\n\nSee libhdf5 documentation for H5Zfilter_avail.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_get_filter_info","page":"Low-level library bindings","title":"HDF5.API.h5z_get_filter_info","text":"h5z_get_filter_info(filter::H5Z_filter_t, filter_config_flags::Ptr{Cuint})\n\nSee libhdf5 documentation for H5Zget_filter_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_register","page":"Low-level library bindings","title":"HDF5.API.h5z_register","text":"h5z_register(filter_class::Ref{H5Z_class_t})\n\nSee libhdf5 documentation for H5Zregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5z_unregister","page":"Low-level library bindings","title":"HDF5.API.h5z_unregister","text":"h5z_unregister(id::H5Z_filter_t)\n\nSee libhdf5 documentation for H5Zunregister.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5FD","page":"Low-level library bindings","title":"H5FD — File Drivers","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5fd_core_init\nh5fd_family_init\nh5fd_log_init\nh5fd_mpio_init\nh5fd_multi_init\nh5fd_sec2_init\nh5fd_stdio_init","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5fd_core_init\nh5fd_family_init\nh5fd_log_init\nh5fd_mpio_init\nh5fd_multi_init\nh5fd_sec2_init\nh5fd_stdio_init","category":"page"},{"location":"api_bindings/#HDF5.API.h5fd_core_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_core_init","text":"h5fd_core_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_CORE. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_family_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_family_init","text":"h5fd_family_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_FAMILY. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_log_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_log_init","text":"h5fd_log_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_LOG. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_mpio_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_mpio_init","text":"h5fd_mpio_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_MPIO. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_multi_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_multi_init","text":"h5fd_multi_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_MULTI. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_sec2_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_sec2_init","text":"h5fd_sec2_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_SEC2. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5fd_stdio_init","page":"Low-level library bindings","title":"HDF5.API.h5fd_stdio_init","text":"h5fd_stdio_init() -> hid_t\n\nThis function is exposed in libhdf5 as the macro H5FD_STDIO. See libhdf5 documentation for H5Pget_driver.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5DO","page":"Low-level library bindings","title":"H5DO — Optimized Functions Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5do_append\nh5do_write_chunk","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5do_append\nh5do_write_chunk","category":"page"},{"location":"api_bindings/#HDF5.API.h5do_append","page":"Low-level library bindings","title":"HDF5.API.h5do_append","text":"h5do_append(dset_id::hid_t, dxpl_id::hid_t, index::Cuint, num_elem::hsize_t, memtype::hid_t, buffer::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5DOappend.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5do_write_chunk","page":"Low-level library bindings","title":"HDF5.API.h5do_write_chunk","text":"h5do_write_chunk(dset_id::hid_t, dxpl_id::hid_t, filter_mask::UInt32, offset::Ptr{hsize_t}, bufsize::Csize_t, buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5DOwrite_chunk.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5DS","page":"Low-level library bindings","title":"H5DS — Dimension Scale Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5ds_attach_scale\nh5ds_detach_scale\nh5ds_get_label\nh5ds_get_num_scales\nh5ds_get_scale_name\nh5ds_is_attached\nh5ds_is_scale\nh5ds_set_label\nh5ds_set_scale","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5ds_attach_scale\nh5ds_detach_scale\nh5ds_get_label\nh5ds_get_num_scales\nh5ds_get_scale_name\nh5ds_is_attached\nh5ds_is_scale\nh5ds_set_label\nh5ds_set_scale","category":"page"},{"location":"api_bindings/#HDF5.API.h5ds_attach_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_attach_scale","text":"h5ds_attach_scale(did::hid_t, dsid::hid_t, idx::Cuint)\n\nSee libhdf5 documentation for H5DSattach_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_detach_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_detach_scale","text":"h5ds_detach_scale(did::hid_t, dsid::hid_t, idx::Cuint)\n\nSee libhdf5 documentation for H5DSdetach_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_label","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_label","text":"h5ds_get_label(did::hid_t, idx::Cuint, label::Ptr{UInt8}, size::hsize_t)\n\nSee libhdf5 documentation for H5DSget_label.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_num_scales","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_num_scales","text":"h5ds_get_num_scales(did::hid_t, idx::Cuint) -> Int\n\nSee libhdf5 documentation for H5DSget_num_scales.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_get_scale_name","page":"Low-level library bindings","title":"HDF5.API.h5ds_get_scale_name","text":"h5ds_get_scale_name(did::hid_t, name::Ptr{UInt8}, size::Csize_t) -> Cssize_t\n\nSee libhdf5 documentation for H5DSget_scale_name.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_is_attached","page":"Low-level library bindings","title":"HDF5.API.h5ds_is_attached","text":"h5ds_is_attached(did::hid_t, dsid::hid_t, idx::Cuint) -> Bool\n\nSee libhdf5 documentation for H5DSis_attached.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_is_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_is_scale","text":"h5ds_is_scale(did::hid_t) -> Bool\n\nSee libhdf5 documentation for H5DSis_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_set_label","page":"Low-level library bindings","title":"HDF5.API.h5ds_set_label","text":"h5ds_set_label(did::hid_t, idx::Cuint, label::Ref{UInt8})\n\nSee libhdf5 documentation for H5DSset_label.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5ds_set_scale","page":"Low-level library bindings","title":"HDF5.API.h5ds_set_scale","text":"h5ds_set_scale(dsid::hid_t, dimname::Cstring)\n\nSee libhdf5 documentation for H5DSset_scale.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5LT","page":"Low-level library bindings","title":"H5LT — Lite Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5lt_dtype_to_text","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5lt_dtype_to_text","category":"page"},{"location":"api_bindings/#HDF5.API.h5lt_dtype_to_text","page":"Low-level library bindings","title":"HDF5.API.h5lt_dtype_to_text","text":"h5lt_dtype_to_text(datatype::hid_t, str::Ptr{UInt8}, lang_type::Cint, len::Ref{Csize_t})\n\nSee libhdf5 documentation for H5LTdtype_to_text.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"","category":"page"},{"location":"api_bindings/#H5TB","page":"Low-level library bindings","title":"H5TB — Table Interface","text":"","category":"section"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5tb_append_records\nh5tb_get_field_info\nh5tb_get_table_info\nh5tb_make_table\nh5tb_read_records\nh5tb_read_table\nh5tb_write_records","category":"page"},{"location":"api_bindings/","page":"Low-level library bindings","title":"Low-level library bindings","text":"h5tb_append_records\nh5tb_get_field_info\nh5tb_get_table_info\nh5tb_make_table\nh5tb_read_records\nh5tb_read_table\nh5tb_write_records","category":"page"},{"location":"api_bindings/#HDF5.API.h5tb_append_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_append_records","text":"h5tb_append_records(loc_id::hid_t, dset_name::Cstring, nrecords::hsize_t, type_size::Csize_t, field_offset::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBappend_records.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_get_field_info","page":"Low-level library bindings","title":"HDF5.API.h5tb_get_field_info","text":"h5tb_get_field_info(loc_id::hid_t, table_name::Cstring, field_names::Ptr{Ptr{UInt8}}, field_sizes::Ptr{Csize_t}, field_offsets::Ptr{Csize_t}, type_size::Ptr{Csize_t})\n\nSee libhdf5 documentation for H5TBget_field_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_get_table_info","page":"Low-level library bindings","title":"HDF5.API.h5tb_get_table_info","text":"h5tb_get_table_info(loc_id::hid_t, table_name::Cstring, nfields::Ptr{hsize_t}, nrecords::Ptr{hsize_t})\n\nSee libhdf5 documentation for H5TBget_table_info.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_make_table","page":"Low-level library bindings","title":"HDF5.API.h5tb_make_table","text":"h5tb_make_table(table_title::Cstring, loc_id::hid_t, dset_name::Cstring, nfields::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_names::Ptr{Cstring}, field_offset::Ptr{Csize_t}, field_types::Ptr{hid_t}, chunk_size::hsize_t, fill_data::Ptr{Cvoid}, compress::Cint, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBmake_table.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_read_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_read_records","text":"h5tb_read_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBread_records.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_read_table","page":"Low-level library bindings","title":"HDF5.API.h5tb_read_table","text":"h5tb_read_table(loc_id::hid_t, table_name::Cstring, dst_size::Csize_t, dst_offset::Ptr{Csize_t}, dst_sizes::Ptr{Csize_t}, dst_buf::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBread_table.\n\n\n\n\n\n","category":"function"},{"location":"api_bindings/#HDF5.API.h5tb_write_records","page":"Low-level library bindings","title":"HDF5.API.h5tb_write_records","text":"h5tb_write_records(loc_id::hid_t, table_name::Cstring, start::hsize_t, nrecords::hsize_t, type_size::Csize_t, field_offsets::Ptr{Csize_t}, field_sizes::Ptr{Csize_t}, data::Ptr{Cvoid})\n\nSee libhdf5 documentation for H5TBwrite_records.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#Dataspaces","page":"Dataspaces","title":"Dataspaces","text":"","category":"section"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"CurrentModule = HDF5","category":"page"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"Dataspace\ndataspace\nisnull\nget_extent_dims\nset_extent_dims","category":"page"},{"location":"interface/dataspaces/#HDF5.Dataspace","page":"Dataspaces","title":"HDF5.Dataspace","text":"HDF5.Dataspace\n\nA dataspace defines the size and the shape of a dataset or an attribute.\n\nA dataspace is typically constructed by calling dataspace.\n\nThe following functions have methods defined for Dataspace objects\n\n==\nndims\nsize\nlength\nisempty\nisnull\n\n\n\n\n\n","category":"type"},{"location":"interface/dataspaces/#HDF5.dataspace","page":"Dataspaces","title":"HDF5.dataspace","text":"dataspace(obj::Union{Attribute, Dataset, Dataspace})\n\nThe Dataspace of obj.\n\n\n\n\n\ndataspace(data)\n\nThe default Dataspace used for representing a Julia object data:\n\nstrings or numbers: a scalar Dataspace\narrays: a simple Dataspace\nstruct types: a scalar Dataspace\nnothing or an EmptyArray: a null dataspace\n\n\n\n\n\ndataspace(dims::Tuple; max_dims::Tuple=dims)\ndataspace(dims::Tuple, max_dims::Tuple)\n\nConstruct a simple Dataspace for the given dimensions dims. The maximum dimensions maxdims specifies the maximum possible size: -1 can be used to indicate unlimited dimensions.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.isnull","page":"Dataspaces","title":"HDF5.isnull","text":"isnull(dspace::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute})\n\nDetermines whether the given object has no size (consistent with the API.H5S_NULL dataspace).\n\nExamples\n\njulia> HDF5.isnull(dataspace(HDF5.EmptyArray{Float64}()))\ntrue\n\njulia> HDF5.isnull(dataspace((0,)))\nfalse\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.get_extent_dims","page":"Dataspaces","title":"HDF5.get_extent_dims","text":"HDF5.get_extent_dims(obj::Union{HDF5.Dataspace, HDF5.Dataset, HDF5.Attribute}) -> dims, maxdims\n\nGet the array dimensions from a dataspace, dataset, or attribute and return a tuple of dims and maxdims.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.set_extent_dims","page":"Dataspaces","title":"HDF5.set_extent_dims","text":"HDF5.set_extent_dims(dset::HDF5.Dataset, new_dims::Dims)\n\nChange the current dimensions of a dataset to new_dims, limited by max_dims = get_extent_dims(dset)[2]. Reduction is possible and leads to loss of truncated data.\n\n\n\n\n\nHDF5.set_extent_dims(dspace::HDF5.Dataspace, new_dims::Dims, max_dims::Union{Dims,Nothing} = nothing)\n\nChange the dimensions of a dataspace dspace to new_dims, optionally with the maximum possible dimensions max_dims different from the active size new_dims. If not given, max_dims is set equal to new_dims.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#Hyperslab","page":"Dataspaces","title":"Hyperslab","text":"","category":"section"},{"location":"interface/dataspaces/","page":"Dataspaces","title":"Dataspaces","text":"BlockRange\nselect_hyperslab!\nget_regular_hyperslab","category":"page"},{"location":"interface/dataspaces/#HDF5.BlockRange","page":"Dataspaces","title":"HDF5.BlockRange","text":"HDF5.BlockRange(;start::Integer, stride::Integer=1, count::Integer=1, block::Integer=1)\n\nA BlockRange represents a selection along a single dimension of a HDF5 hyperslab. It is similar to a Julia range object, with some extra features for selecting multiple contiguous blocks.\n\nstart: the index of the first element in the first block (1-based).\nstride: the step between the first element of each block (must be >0)\ncount: the number of blocks (can be -1 for an unlimited number of blocks)\nblock: the number of elements in each block.\n\nHDF5.BlockRange(obj::Union{Integer, OrdinalRange})\n\nConvert obj to a BlockRange object.\n\nExternal links\n\nHDF5 User Guide, section 7.4.2.1 \"Selecting Hyperslabs\"\n\n\n\n\n\n","category":"type"},{"location":"interface/dataspaces/#HDF5.select_hyperslab!","page":"Dataspaces","title":"HDF5.select_hyperslab!","text":"HDF5.select_hyperslab!(dspace::Dataspace, [op, ], idxs::Tuple)\n\nSelects a hyperslab region of the dspace. idxs should be a tuple of integers, ranges or BlockRange objects.\n\nop determines how the new selection is to be combined with the already selected dataspace:\n:select (default): replace the existing selection with the new selection.\n:or: adds the new selection to the existing selection. Aliases: |, ∪, union.\n:and: retains only the overlapping portions of the new and existing selection. Aliases: &, ∩, intersect.\n:xor: retains only the elements that are members of the new selection or the existing selection, excluding elements that are members of both selections. Aliases: ⊻, xor\n:notb: retains only elements of the existing selection that are not in the new selection. Alias: setdiff.\n:nota: retains only elements of the new selection that are not in the existing selection.\n\n\n\n\n\n","category":"function"},{"location":"interface/dataspaces/#HDF5.get_regular_hyperslab","page":"Dataspaces","title":"HDF5.get_regular_hyperslab","text":"HDF5.get_regular_hyperslab(dspace)::Tuple\n\nGet the hyperslab selection from dspace. Returns a tuple of BlockRange objects.\n\n\n\n\n\n","category":"function"},{"location":"","page":"Home","title":"Home","text":"CurrentModule = HDF5","category":"page"},{"location":"#HDF5.jl","page":"Home","title":"HDF5.jl","text":"","category":"section"},{"location":"#Overview","page":"Home","title":"Overview","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5 stands for Hierarchical Data Format v5 and is closely modeled on file systems. In HDF5, a \"group\" is analogous to a directory, a \"dataset\" is like a file. HDF5 also uses \"attributes\" to associate metadata with a particular group or dataset. HDF5 uses ASCII names for these different objects, and objects can be accessed by Unix-like pathnames, e.g., \"/sample1/tempsensor/firsttrial\" for a top-level group \"sample1\", a subgroup \"tempsensor\", and a dataset \"firsttrial\".","category":"page"},{"location":"","page":"Home","title":"Home","text":"For simple types (scalars, strings, and arrays), HDF5 provides sufficient metadata to know how each item is to be interpreted. For example, HDF5 encodes that a given block of bytes is to be interpreted as an array of Int64, and represents them in a way that is compatible across different computing architectures.","category":"page"},{"location":"","page":"Home","title":"Home","text":"However, to preserve Julia objects, one generally needs additional type information to be supplied, which is easy to provide using attributes. This is handled for you automatically in the JLD/JLD2. These specific formats (conventions) provide \"extra\" functionality, but they are still both regular HDF5 files and are therefore compatible with any HDF5 reader or writer.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Language wrappers for HDF5 are often described as either \"low level\" or \"high level.\" This package contains both flavors: at the low level, it directly wraps HDF5's functions, thus copying their API and making them available from within Julia. At the high level, it provides a set of functions built on the low-level wrap which may make the usage of this library more convenient.","category":"page"},{"location":"#Installation","page":"Home","title":"Installation","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"julia>]\npkg> add HDF5","category":"page"},{"location":"","page":"Home","title":"Home","text":"Starting from Julia 1.3, the HDF5 binaries are by default downloaded using the HDF5_jll package.","category":"page"},{"location":"#Using-custom-or-system-provided-HDF5-binaries","page":"Home","title":"Using custom or system provided HDF5 binaries","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"note: Migration from HDF5.jl v0.16 and earlier\nHow to use a system-provided HDF5 library has been changed in HDF5.jl v0.17. Previously, the library path was set by the environment variable JULIA_HDF5_PATH, which required to rebuild HDF5.jl afterwards. The environment variable has been removed and no longer has an effect (for backward compatibility it is still recommended to also set the environment variable). Instead, proceed as described below.","category":"page"},{"location":"","page":"Home","title":"Home","text":"To use system-provided HDF5 binaries instead, set the preferences libhdf5 and libhdf5_hl, see also Preferences.jl. These need to point to the local paths of the libraries libhdf5 and libhdf5_hl.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For example, to use HDF5 (libhdf5-mpich-dev) with MPI using system libraries on Ubuntu 20.04, you would run","category":"page"},{"location":"","page":"Home","title":"Home","text":"$ sudo apt install mpich libhdf5-mpich-dev","category":"page"},{"location":"","page":"Home","title":"Home","text":"If your system HDF5 library is compiled with MPI, you need to tell MPI.jl to use the same locally installed MPI implementation. This can be done in Julia by running:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using MPIPreferences\nMPIPreferences.use_system_binary()","category":"page"},{"location":"","page":"Home","title":"Home","text":"to set the MPI preferences, see the documentation of MPI.jl. You can set the path to the system library using Preferences.jl by:","category":"page"},{"location":"","page":"Home","title":"Home","text":"using Preferences, UUIDs\n\nset_preferences!(\n UUID(\"f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f\"), # UUID of HDF5.jl\n \"libhdf5\" => \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5.so\",\n \"libhdf5_hl\" => \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so\", force = true)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Also see the file test/configure_packages.jl for an example.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Both, the MPI preferences and the preferences for HDF5.jl write to a file called LocalPreferences.toml in the project directory. After performing the described steps this file could look like the following:","category":"page"},{"location":"","page":"Home","title":"Home","text":"[MPIPreferences]\n_format = \"1.0\"\nabi = \"MPICH\"\nbinary = \"system\"\nlibmpi = \"/software/mpi/lib/libmpi.so\"\nmpiexec = \"/software/mpi/bin/mpiexec\"\n\n[HDF5]\nlibhdf5 = \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5.so\"\nlibhdf5_hl = \"/usr/lib/x86_64-linux-gnu/hdf5/mpich/libhdf5_hl.so\"","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you want to switch to another HDF5 library or the library moved, you can call the set_preferences! commands again (or manually edit LocalPreferences.toml) to set the new paths. Using the default implementation provided by HDF5_jll can be done by simply manually deleting the LocalPreferences.toml file.","category":"page"},{"location":"#Opening-and-closing-files","page":"Home","title":"Opening and closing files","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"\"Plain\" (i.e., with no extra formatting conventions) HDF5 files are created and/or opened with the h5open command:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid = h5open(filename, mode)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The mode can be any one of the following:","category":"page"},{"location":"","page":"Home","title":"Home","text":"mode Meaning\n\"r\" read-only\n\"r+\" read-write, preserving any existing contents\n\"cw\" read-write, create file if not existing, preserve existing contents\n\"w\" read-write, destroying any existing contents (if any)","category":"page"},{"location":"","page":"Home","title":"Home","text":"For example","category":"page"},{"location":"","page":"Home","title":"Home","text":"using HDF5\nfname = tempname(); # temporary file\nfid = h5open(fname, \"w\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"This produces an object of type HDF5File, a subtype of the abstract type DataFile. This file will have no elements (groups, datasets, or attributes) that are not explicitly created by the user.","category":"page"},{"location":"","page":"Home","title":"Home","text":"When you're finished with a file, you should close it:","category":"page"},{"location":"","page":"Home","title":"Home","text":"close(fid)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Closing a file also closes any other open objects (e.g., datasets, groups) in that file. In general, you need to close an HDF5 file to \"release\" it for use by other applications.","category":"page"},{"location":"#Creating-a-group-or-dataset","page":"Home","title":"Creating a group or dataset","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Groups can be created via the function create_group","category":"page"},{"location":"","page":"Home","title":"Home","text":"create_group(fid, \"mygroup\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"We can write the \"mydataset\" by indexing into fid. This also happens to write data to the dataset.","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"mydataset\"] = rand()","category":"page"},{"location":"","page":"Home","title":"Home","text":"Alternatively, we can call create_dataset, which does not write data to the dataset. It merely creates the dataset.","category":"page"},{"location":"","page":"Home","title":"Home","text":"create_dataset(fid, \"myvector\", Int, (10,))","category":"page"},{"location":"","page":"Home","title":"Home","text":"Creating a dataset within a group is as simple as indexing into the group with the name of the dataset or calling create_dataset with the group as the first argument.","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = fid[\"mygroup\"]\ng[\"mydataset\"] = \"Hello World!\"\ncreate_dataset(g, \"myvector\", Int, (10,))","category":"page"},{"location":"","page":"Home","title":"Home","text":"The do syntax is also supported. The file, group, and dataset handles will automatically be closed after the do block terminates.","category":"page"},{"location":"","page":"Home","title":"Home","text":"h5open(\"example2.h5\", \"w\") do fid\n g = create_group(fid, \"mygroup\")\n dset = create_dataset(g, \"myvector\", Float64, (10,))\n write(dset,rand(10))\nend","category":"page"},{"location":"#Opening-and-closing-objects","page":"Home","title":"Opening and closing objects","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"If you have a file object fid, and this has a group or dataset called \"mygroup\" at the top level of a file, you can open it in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"obj = fid[\"mygroup\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"This does not read any data or attributes associated with the object, it's simply a handle for further manipulations. For example:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = fid[\"mygroup\"]\ndset = g[\"mydataset\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"or simply","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = fid[\"mygroup/mydataset\"]","category":"page"},{"location":"","page":"Home","title":"Home","text":"When you're done with an object, you can close it using close(obj). If you forget to do this, it will be closed for you anyway when the file is closed, or if obj goes out of scope and gets garbage collected.","category":"page"},{"location":"#Reading-and-writing-data","page":"Home","title":"Reading and writing data","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Suppose you have a group g which contains a dataset with path \"mydataset\", and that you've also opened this dataset as dset = g[\"mydataset\"]. You can read information in this dataset in any of the following ways:","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = read(dset)\nA = read(g, \"mydataset\")\nAsub = dset[2:3, 1:3]","category":"page"},{"location":"","page":"Home","title":"Home","text":"The last syntax reads just a subset of the data array (assuming that dset is an array of sufficient size). libhdf5 has internal mechanisms for slicing arrays, and consequently if you need only a small piece of a large array, it can be faster to read just what you need rather than reading the entire array and discarding most of it.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Datasets can be created with either","category":"page"},{"location":"","page":"Home","title":"Home","text":"g[\"mydataset\"] = rand(3,5)\nwrite(g, \"mydataset\", rand(3,5))","category":"page"},{"location":"","page":"Home","title":"Home","text":"One can use the high level interface load and save from FileIO, where an optional OrderedDict can be passed (track_order inferred). Note that using track_order=true or passing an OrderedDict is a promise that the read file has been created with the appropriate ordering flags.","category":"page"},{"location":"","page":"Home","title":"Home","text":"julia> using OrderedCollections, FileIO\njulia> save(\"track_order.h5\", OrderedDict(\"z\"=>1, \"a\"=>2, \"g/f\"=>3, \"g/b\"=>4))\njulia> load(\"track_order.h5\"; dict=OrderedDict())\nOrderedDict{Any, Any} with 4 entries:\n \"z\" => 1\n \"a\" => 2\n \"g/f\" => 3\n \"g/b\" => 4","category":"page"},{"location":"#Passing-parameters","page":"Home","title":"Passing parameters","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"It is often required to pass parameters to specific routines, which are collected in so-called property lists in HDF5. There are different property lists for different tasks, e.g. for the access/creation of files, datasets, groups. In this high level framework multiple parameters can be simply applied by appending them at the end of function calls as keyword arguments.","category":"page"},{"location":"","page":"Home","title":"Home","text":"g[\"A\"] = A # basic\ng[\"A\", chunk=(5,5)] = A # add chunks\n\nB = h5read(fn,\"mygroup/B\", # two parameters\n fapl_mpio=(ccomm,cinfo), # if parameter requires multiple args use tuples\n dxpl_mpio=HDF5.H5FD_MPIO_COLLECTIVE )","category":"page"},{"location":"","page":"Home","title":"Home","text":"This will automatically create the correct property lists, add the properties, and apply the property list while reading/writing the data. The naming of the properties generally follows that of HDF5, i.e. the key fapl_mpio returns the HDF5 functions h5pget/set_fapl_mpio and their corresponding property list type H5P_FILE_ACCESS. The complete list if routines and their interfaces is available at the H5P: Property List Interface documentation. Note that not all properties are available. When searching for a property check whether the corresponding h5pget/set functions are available.","category":"page"},{"location":"#Chunking-and-compression","page":"Home","title":"Chunking and compression","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"You can also optionally \"chunk\" and/or compress your data. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = rand(100,100)\ng[\"A\", chunk=(5,5)] = A","category":"page"},{"location":"","page":"Home","title":"Home","text":"stores the matrix A in 5-by-5 chunks. Chunking improves efficiency if you write or extract small segments or slices of an array, if these are not stored contiguously.","category":"page"},{"location":"","page":"Home","title":"Home","text":"A = rand(100,100)\ng1[\"A\", chunk=(5,5), compress=3] = A\ng2[\"A\", chunk=(5,5), shuffle=(), deflate=3] = A\nusing H5Zblosc # load in Blosc\ng3[\"A\", chunk=(5,5), blosc=3] = A","category":"page"},{"location":"","page":"Home","title":"Home","text":"Standard compression in HDF5 (\"compress\") corresponds to (\"deflate\") and uses the deflate/zlib algorithm. The deflate algorithm is often more efficient if prefixed by a \"shuffle\" filter. Blosc is generally much faster than deflate – however, reading Blosc-compressed HDF5 files require Blosc to be installed. This is the case for Julia, but often not for vanilla HDF5 distributions that may be used outside Julia. (In this case, the structure of the HDF5 file is still accessible, but compressed datasets cannot be read.) Compression requires chunking, and heuristic chunking is automatically used if you specify compression but don't specify chunking.","category":"page"},{"location":"","page":"Home","title":"Home","text":"It is also possible to write to subsets of an on-disk HDF5 dataset. This is useful to incrementally save to very large datasets you don't want to keep in memory. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = create_dataset(g, \"B\", datatype(Float64), dataspace(1000,100,10), chunk=(100,100,1))\ndset[:,1,1] = rand(1000)","category":"page"},{"location":"","page":"Home","title":"Home","text":"creates a Float64 dataset in the file or group g, with dimensions 1000x100x10, and then writes to just the first 1000 element slice. If you know the typical size of subset reasons you'll be reading/writing, it can be beneficial to set the chunk dimensions appropriately.","category":"page"},{"location":"","page":"Home","title":"Home","text":"For fine-grained control of filter and compression pipelines, please use the filters keyword to define a filter pipeline. For example, this can be used to include external filter packages. This enables the use of Blosc, Bzip2, LZ4, ZStandard, or custom filter plugins.","category":"page"},{"location":"#Memory-mapping","page":"Home","title":"Memory mapping","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"If you will frequently be accessing individual elements or small regions of array datasets, it can be substantially more efficient to bypass HDF5 routines and use direct memory mapping. This is possible only under particular conditions: when the dataset is an array of standard \"bits\" types (e.g., Float64 or Int32) and no chunking/compression is being used. You can use the ismmappable function to test whether this is possible; for example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = g[\"x\"]\nif HDF5.ismmappable(dset)\n dset = HDF5.readmmap(dset)\nend\nval = dset[15]","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that readmmap returns an Array rather than an HDF5 object.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note: if you use readmmap on a dataset and subsequently close the file, the array data are still available–-and file continues to be in use–-until all of the arrays are garbage-collected. This is in contrast to standard HDF5 datasets, where closing the file prevents further access to any of the datasets, but the file is also detached and can safely be rewritten immediately.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Under the default allocation-time policy, a newly added ismmappable dataset can only be memory mapped after it has been written to. The following fails:","category":"page"},{"location":"","page":"Home","title":"Home","text":"vec_dset = create_dataset(g, \"v\", datatype(Float64), dataspace(10_000,1))\nHDF5.ismmappable(vec_dset) # == true\nvec = HDF5.readmmap(vec_dset) # throws ErrorException(\"Error mmapping array\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"because although the dataset description has been added, the space within the HDF5 file has not yet actually been allocated (so the file region cannot be memory mapped by the OS). The storage can be allocated by making at least one write:","category":"page"},{"location":"","page":"Home","title":"Home","text":"vec_dset[1,1] = 0.0 # force allocation of /g/v within the file\nvec = HDF5.readmmap(vec_dset) # and now the memory mapping can succeed","category":"page"},{"location":"","page":"Home","title":"Home","text":"Alternatively, the policy can be set so that the space is allocated immediately upon creation of the data set with the alloc_time keyword:","category":"page"},{"location":"","page":"Home","title":"Home","text":"mtx_dset = create_dataset(g, \"M\", datatype(Float64), dataspace(100, 1000),\n alloc_time = HDF5.H5D_ALLOC_TIME_EARLY)\nmtx = HDF5.readmmap(mtx_dset) # succeeds immediately","category":"page"},{"location":"#Supported-data-types","page":"Home","title":"Supported data types","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5.jl knows how to store values of the following types: signed and unsigned integers of 8, 16, 32, and 64 bits, Float32, Float64; Complex versions of these numeric types; Arrays of these numeric types (including complex versions); ASCIIString and UTF8String; and Arrays of these two string types. Arrays of strings are supported using HDF5's variable-length-strings facility. By default Complex numbers are stored as compound types with r and i fields following the h5py convention. When reading data, compound types with matching field names will be loaded as the corresponding Complex Julia type. These field names are configurable with the HDF5.set_complex_field_names(real::AbstractString, imag::AbstractString) function and complex support can be completely enabled/disabled with HDF5.enable/disable_complex_support().","category":"page"},{"location":"","page":"Home","title":"Home","text":"For Arrays, note that the array dimensionality is preserved, including 0-length dimensions:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"zero_vector\"] = zeros(0)\nfid[\"zero_matrix\"] = zeros(0, 0)\nsize(fid[\"zero_vector\"]) # == (0,)\nsize(fid[\"zero_matrix\"]) # == (0, 0)","category":"page"},{"location":"","page":"Home","title":"Home","text":"An exception to this rule is Julia's 0-dimensional Array, which is stored as an HDF5 scalar because there is a value to be preserved:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"zero_dim_value\"] = fill(1.0π)\nread(fid[\"zero_dim_value\"]) # == 3.141592653589793, != [3.141592653589793]","category":"page"},{"location":"","page":"Home","title":"Home","text":"HDF5 also has the concept of a null array which contains a type but has neither size nor contents, which is represented by the type HDF5.EmptyArray:","category":"page"},{"location":"","page":"Home","title":"Home","text":"fid[\"empty_array\"] = HDF5.EmptyArray{Float32}()\nHDF5.isnull(fid[\"empty_array\"]) # == true\nsize(fid[\"empty_array\"]) # == ()\neltype(fid[\"empty_array\"]) # == Float32","category":"page"},{"location":"","page":"Home","title":"Home","text":"This module also supports HDF5's VLEN, OPAQUE, and REFERENCE types, which can be used to encode more complex types. In general, you need to specify how you want to combine these more advanced facilities to represent more complex data types. For many of the data types in Julia, the JLD module implements support. You can likewise define your own file format if, for example, you need to interact with some external program that has explicit formatting requirements.","category":"page"},{"location":"#Creating-groups-and-attributes","page":"Home","title":"Creating groups and attributes","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Create a new group in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = create_group(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The named group will be created as a child of the parent.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Attributes can be created using","category":"page"},{"location":"","page":"Home","title":"Home","text":"attributes(parent)[name] = value","category":"page"},{"location":"","page":"Home","title":"Home","text":"where attributes simply indicates that the object referenced by name (a string) is an attribute, not another group or dataset. (Datasets cannot have child datasets, but groups can have either.) value must be a simple type: BitsKinds, strings, and arrays of either of these. The HDF5 standard recommends against storing large objects as attributes.","category":"page"},{"location":"","page":"Home","title":"Home","text":"The value stored in an attribute can be retrieved like","category":"page"},{"location":"","page":"Home","title":"Home","text":"read_attribute(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can also access the value of an attribute by indexing, like so:","category":"page"},{"location":"","page":"Home","title":"Home","text":"julia> attr = attributes(parent)[name];\njulia> attr[]","category":"page"},{"location":"#Getting-information","page":"Home","title":"Getting information","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"HDF5.name(obj)","category":"page"},{"location":"","page":"Home","title":"Home","text":"will return the full HDF5 pathname of object obj.","category":"page"},{"location":"","page":"Home","title":"Home","text":"keys(g)","category":"page"},{"location":"","page":"Home","title":"Home","text":"returns a string array containing all objects inside group g. These relative pathnames, not absolute pathnames.","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can iterate over the objects in a group, i.e.,","category":"page"},{"location":"","page":"Home","title":"Home","text":"for obj in g\n data = read(obj)\n println(data)\nend","category":"page"},{"location":"","page":"Home","title":"Home","text":"This gives you a straightforward way of recursively exploring an entire HDF5 file.","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you need to know whether group g has a dataset named mydata, you can test that with","category":"page"},{"location":"","page":"Home","title":"Home","text":"if haskey(g, \"mydata\")\n ...\nend\ntf = haskey(g, \"mydata\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"If instead you want to know whether g has an attribute named myattribute, do it this way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"tf = haskey(attributes(g), \"myattribute\")","category":"page"},{"location":"","page":"Home","title":"Home","text":"If you have an HDF5 object, and you want to know where it fits in the hierarchy of the file, the following can be useful:","category":"page"},{"location":"","page":"Home","title":"Home","text":"p = parent(obj) # p is the parent object (usually a group)\nfn = HDF5.filename(obj) # fn is a string\ng = HDF5.root(obj) # g is the group \"/\"","category":"page"},{"location":"","page":"Home","title":"Home","text":"For array objects (datasets and attributes) the following methods work:","category":"page"},{"location":"","page":"Home","title":"Home","text":"dims = size(dset)\nnd = ndims(dset)\nlen = length(dset)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Objects can be created with properties, and you can query those properties in the following way:","category":"page"},{"location":"","page":"Home","title":"Home","text":"p = HDF5.get_create_properties(dset)\nchunksz = HDF5.get_chunk(p)","category":"page"},{"location":"","page":"Home","title":"Home","text":"The simpler syntax chunksz = HDF5.get_chunk(dset) is also available.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Finally, sometimes you need to be able to conveniently test whether a file is an HDF5 file:","category":"page"},{"location":"","page":"Home","title":"Home","text":"tf = HDF5.ishdf5(filename)","category":"page"},{"location":"#Mid-level-routines","page":"Home","title":"Mid-level routines","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Sometimes you might want more fine-grained control, which can be achieved using a different set of routines. For example,","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = open_group(parent, name)\ndset = open_dataset(parent, name[, apl])\nattr = open_attribute(parent, name)\nt = open_datatype(parent, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"These open the named group, dataset, attribute, and committed datatype, respectively. For datasets, apl stands for \"access parameter list\" and provides opportunities for more sophisticated control (see the HDF5 documentation).","category":"page"},{"location":"","page":"Home","title":"Home","text":"New objects can be created in the following ways:","category":"page"},{"location":"","page":"Home","title":"Home","text":"g = create_group(parent, name[, lcpl, gcpl]; properties...)\ndset = create_dataset(parent, name, data; properties...)\nattr = create_attribute(parent, name, data)","category":"page"},{"location":"","page":"Home","title":"Home","text":"creates groups, datasets, and attributes without writing any data to them. You can then use write(obj, data) to store the data. The optional properties and property lists allow even more fine-grained control. This syntax uses data to infer the object's \"HDF5.datatype\" and \"HDF5.dataspace\"; for the most explicit control, data can be replaced with dtype, dspace, where dtype is an HDF5.Datatype and dspace is an HDF5.Dataspace.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Analogously, to create committed data types, use","category":"page"},{"location":"","page":"Home","title":"Home","text":"t = commit_datatype(parent, name, dtype[, lcpl, tcpl, tapl])","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can create and write data in one step,","category":"page"},{"location":"","page":"Home","title":"Home","text":"write_dataset(parent, name, data; properties...)\nwrite_attribute(parent, name, data)","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can use extendible dimensions,","category":"page"},{"location":"","page":"Home","title":"Home","text":"d = create_dataset(parent, name, dtype, (dims, max_dims), chunk=(chunk_dims))\nHDF5.set_extent_dims(d, new_dims)","category":"page"},{"location":"","page":"Home","title":"Home","text":"where dims is a tuple of integers. For example","category":"page"},{"location":"","page":"Home","title":"Home","text":"b = create_dataset(fid, \"b\", Int, ((1000,),(-1,)), chunk=(100,)) #-1 is equivalent to typemax(hsize_t)\nHDF5.set_extent_dims(b, (10000,))\nb[1:10000] = collect(1:10000)","category":"page"},{"location":"","page":"Home","title":"Home","text":"when dimensions are reduced, the truncated data is lost. A maximum dimension of -1 is often referred to as unlimited dimensions, though it is limited by the maximum size of an unsigned integer.","category":"page"},{"location":"","page":"Home","title":"Home","text":"You can copy data from one file to another:","category":"page"},{"location":"","page":"Home","title":"Home","text":"copy_object(source, data_name, target, name)\ncopy_object(source[data_name], target, name)","category":"page"},{"location":"","page":"Home","title":"Home","text":"Finally, it's possible to delete objects:","category":"page"},{"location":"","page":"Home","title":"Home","text":"delete_object(parent, name) # for groups, datasets, and datatypes\ndelete_attribute(parent, name) # for attributes","category":"page"},{"location":"#Low-level-routines","page":"Home","title":"Low-level routines","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Many of the most commonly-used libhdf5 functions have been wrapped in a submodule API. The library follows a consistent convention: for example, libhdf5's H5Adelete is wrapped with a Julia function called h5a_delete. The arguments are exactly as specified in the HDF5 reference manual. Note that the functions in the API submodule are not exported, so unless you import them specifically, you need to preface them with HDF5.API to use them: for example, HDF5.API.h5a_delete.","category":"page"},{"location":"","page":"Home","title":"Home","text":"HDF5 is a large library, and the low-level wrap is not complete. However, many of the most-commonly used functions are wrapped, and in general wrapping a new function takes only a single line of code. Users who need additional functionality are encouraged to contribute it.","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that Julia's HDF5 directly uses the \"2\" interfaces, e.g., H5Dcreate2, so you need to have version 1.8 of the HDF5 library or later.","category":"page"},{"location":"#Language-interoperability-with-row-and-column-major-order-arrays","page":"Home","title":"Language interoperability with row- and column-major order arrays","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"There are two main methods for storing multidimensional arrays in linear storage row-major order and column-major order. Julia, like Fortran and MATLAB, stores multidimensional arrays in column-major order, while other languages, including C and Python (NumPy), use row-major order. Therefore when reading an array in Julia from row-major order language the dimensions may be inverted.","category":"page"},{"location":"","page":"Home","title":"Home","text":"To read a multidimensional array into the original shape from an HDF5 file written by Python (numpy and h5py) or C/C++/Objective-C, simply reverse the dimensions. For example, one may add the following line after reading the dataset dset:","category":"page"},{"location":"","page":"Home","title":"Home","text":"dset = permutedims(dset, reverse(1:ndims(dset)))","category":"page"},{"location":"","page":"Home","title":"Home","text":"Note that some languages or libraries use both methods, so please check the datset's description for details. For example, NumPy arrays are row-major by default, but NumPy can use either row-major or column-major ordered arrays.","category":"page"},{"location":"#Credits","page":"Home","title":"Credits","text":"","category":"section"},{"location":"","page":"Home","title":"Home","text":"Konrad Hinsen initiated Julia's support for HDF5\nTim Holy and Simon Kornblith (primary authors)\nTom Short contributed code and ideas to the dictionary-like interface\nBlake Johnson made several improvements, such as support for iterating over attributes\nIsaiah Norton and Elliot Saba improved installation on Windows and OSX\nSteve Johnson contributed the do syntax and Blosc compression\nMike Nolta and Jameson Nash contributed code or suggestions for improving the handling of HDF5's constants\nThanks also to the users who have reported bugs and tested fixes","category":"page"}] }