philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r1584] RM_H5D.html

Browse Source 
Added H5DGet_storage_size and H5Diterate.
RM_H5F.html
	Rearranged TOC.
RM_H5P.html
	Added H5Pset/get_hyper_cache, H5Pset/get_btree_ratios, H5Pset/get_gc_references,
	and H5Pget_vlen_mem_manager.
RM_H5R.html
	Added H5Rget_object_type.
RM_H5Front.html
	As functions were added to the Reference Manual (above), they were
	removed from "functions missing in the RM" list in this document.
This commit is contained in:
Frank Baker
1999-08-23 15:31:25 -05:00
parent 088a7b9c52
commit 8cffd507bf
5 changed files with 379 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

207
doc/html/RM_H5Front.html
View File

@@ -117,20 +117,6 @@ Manual that accompanies this Beta release; they will be documented in
the final Release 1.2. Brief descriptions, as extracted from comments
in the source code, are appended below.
H5Dget_storage_size
H5Diterate
H5Ddebug
H5Pset_hyper_cache
H5Pget_hyper_cache
H5Pset_btree_ratios
H5Pget_btree_ratios
H5Pset_gc_references
H5Pget_gc_reference
H5Pget_vlen_mem_manager
H5Rget_object_type
H5Sget_select_hyper_nblocks
H5Sget_select_elem_npoints
H5Sget_select_hyper_blocklist
@@ -148,199 +134,6 @@ in the source code, are appended below.
H5Tregister
/*-------------------------------------------------------------------------
* Function: H5Dget_storage_size
*
* Purpose: Returns the amount of storage that is required for the
* dataset. For chunked datasets this is the number of allocated
* chunks times the chunk size.
*
* Return: Success: The amount of storage space allocated for the
* dataset, not counting meta data. The return
* value may be zero if no data has been stored.
*
* Failure: Zero
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Diterate
*
* Purpose: This routine iterates over all the elements selected in a memory
* buffer. The callback function is called once for each element selected
* in the dataspace. The selection in the dataspace is modified so
* that any elements already iterated over are removed from the selection
* if the iteration is interrupted (by the H5D_operator_t function
* returning non-zero) in the "middle" of the iteration and may be
* re-started by the user where it left off.
*
* NOTE: Until "subtracting" elements from a selection is implemented,
* the selection is not modified.
*
* Parameters:
* void *buf; IN/OUT: Pointer to the buffer in memory containing
* the elements to iterate over.
* hid_t type_id; IN: Datatype ID for the elements stored in BUF.
* hid_t space_id; IN: Dataspace ID for BUF, also contains the
* selection to iterate over.
* H5D_operator_t operator; IN: Function pointer to the routine to be
* called for each element in BUF iterated over.
* void *operator_data; IN/OUT: Pointer to any user-defined data
* associated with the operation.
*
* Operation information:
* H5D_operator_t is defined as:
* typedef herr_t (*H5D_operator_t)(void *elem, hid_t type_id,
* hsize_t ndim, hssize_t *point, void *operator_data);
*
* H5D_operator_t parameters:
* void *elem; IN/OUT: Pointer to the element in memory containing
* the current point.
* hid_t type_id; IN: Datatype ID for the elements stored in ELEM.
* hsize_t ndim; IN: Number of dimensions for POINT array
* hssize_t *point; IN: Array containing the location of the element
* within the original dataspace.
* void *operator_data; IN/OUT: Pointer to any user-defined data
* associated with the operation.
*
* The return values from an operator are:
* Zero causes the iterator to continue, returning zero when all
* elements have been processed.
* Positive causes the iterator to immediately return that positive
* value, indicating short-circuit success. The iterator can be
* restarted at the next element.
* Negative causes the iterator to immediately return that value,
* indicating failure. The iterator can be restarted at the next
* element.
*
* Return: Returns the return value of the last operator if it was non-zero,
* or zero if all elements were processed. Otherwise returns a
* negative value.
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Ddebug
*
* Purpose: Prints various information about a dataset. This function is
* not to be documented in the API at this time.
*
* Return: Success: Non-negative
* Failure: Negative
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pset_hyper_cache
*
* Purpose: Given a dataset transfer property list, indicate whether to
* cache the hyperslab blocks during the I/O (which speeds
* things up) and the maximum size of the hyperslab block to
* cache. If a block is smaller than to limit, it may still not
* be cached if no memory is available. Setting the limit to 0
* indicates no limitation on the size of block to attempt to
* cache.
*
* The default is to cache blocks with no limit on block size
* for serial I/O and to not cache blocks for parallel I/O
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pget_hyper_cache
*
* Purpose: Reads values previously set with H5Pset_hyper_cache().
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pset_btree_ratios
*
* Purpose: Sets B-tree split ratios for a dataset transfer property
* list. The split ratios determine what percent of children go
* in the first node when a node splits. The LEFT ratio is
* used when the splitting node is the left-most node at its
* level in the tree; the RIGHT ratio is when the splitting node
* is the right-most node at its level; and the MIDDLE ratio for
* all other cases. A node which is the only node at its level
* in the tree uses the RIGHT ratio when it splits. All ratios
* are real numbers between 0 and 1, inclusive.
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pget_btree_ratios
*
* Purpose: Queries B-tree split ratios. See H5Pset_btree_ratios().
*
* Return: Success: Non-negative with split ratios returned through
* the non-null arguments.
* Failure: Negative
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pset_gc_references
*
* Purpose: Sets the flag for garbage collecting references for the file.
* Dataset region references (and other reference types probably) use
* space in the file heap. If garbage collection is on and the user
* passes in an uninitialized value in a reference structure, the heap
* might get corrupted. When garbage collection is off however and the
* user re-uses a reference, the previous heap block will be orphaned and
* not returned to the free heap space. When garbage collection is on,
* the user must initialize the reference structures to 0 or risk heap
* corruption.
*
* Default value for garbage collecting references is off, just to be
* on the safe side.
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pget_gc_refernces
*
* Purpose: Returns the current setting for the garbage collection refernces
* property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5Pget_vlen_mem_manager
*
* Purpose: The inverse of H5Pset_vlen_mem_manager()
*
* Return: Non-negative on success/Negative on failure
*-------------------------------------------------------------------------
*/
/*--------------------------------------------------------------------------
NAME
H5Rget_object_type
PURPOSE
Retrieves the type of object that an object reference points to
USAGE
intn H5Rget_object_type(id, ref)
hid_t id; IN: Dataset reference object is in or location ID of
object that the dataset is located within.
void *ref; IN: Reference to query.
RETURNS
Success: An object type defined in H5Gpublic.h
Failure: H5G_UNKNOWN
DESCRIPTION
Given a reference to some object, this function returns the type of object
pointed to.
--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------
NAME