Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Sets estimated number of links and length of link names in a group

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5P_SET_EST_LINK_INFO ( gcpl_id,  est_num_entries, est_name_len )

Hdf rm anchor
AnchorNamesignature

HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Pset_est_link_info(
        hid_t gcpl_id,
        unsigned est_num_entries,
        unsigned est_name_len
    )
  </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran90 Interface: h5pset_est_link_info_f 
    
SUBROUTINE h5pset_est_link_info_f(gcpl_id, est_num_entries, est_name_len, &
                                  hdferr)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: gcpl_id 
                                    ! Group creation property list identifier
  INTEGER, INTENT(IN) :: est_num_entries 
                                    ! Estimated number of links to be  
                                    ! inserted into group
  INTEGER, INTENT(IN) :: est_name_len    
                                    ! Estimated average length of link names
  INTEGER, INTENT(OUT) :: hdferr    ! Error code
                                    ! 0 on success and -1 on failure
END SUBROUTINE H5Pset_est_link_info_f
    </code></pre>

Hdf rm anchor
AnchorNameparameters

HTML Wrap
classhdf-rm-section
hid_t gcpl_idIN: Group creation property list identifier
unsigned est_num_entries    IN: Estimated number of links to be inserted into group
unsigned est_name_lenIN: Estimated average length of link names

Hdf rm anchor
AnchorNamedescription

HTML Wrap
classhdf-rm-section

H5P_SET_EST_LINK_INFO inserts two settings into the group creation property list gcpl_id: the estimated number of links that are expected to be inserted into a group created with the property list and the estimated average length of those link names.

The estimated number of links is passed in est_num_entries.

The estimated average length of the anticipated link names is passed in est_name_len.

The values for these two settings are multiplied to compute the initial local heap size (for old-style groups, if the local heap size hint is not set) or the initial object header size for (new-style compact groups; see Group implementations in HDF5). Accurately setting these parameters will help reduce wasted file space.

If a group is expected to have many links and to be stored in dense format, set est_num_entries to 0 (zero) for maximum efficiency. This will prevent the group from being created in the compact format.

See Group implementations in HDF5 in the H5G API introduction for a discussion of the available types of HDF5 group structures.

Hdf rm anchor
AnchorNamereturns

HTML Wrap
classhdf-rm-section

Returns a non-negative value if successful; otherwise returns a negative value.

Hdf rm anchor
AnchorNameexample

HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

HTML Wrap
classhdf-rm-section
Release    Change
1.8.0Function introduced in this release.