Commit Graph

54 Commits

Author SHA1 Message Date
Quincey Koziol
feaa5bb9d5 [svn-r8038] Purpose:
Bug fix

Description:
    When two property lists are compared, the H5Pequal routine was just
comparing the raw information for the property values.  This causes problems
when the raw information contains pointers to other information.

Solution:
    Allow a 'compare' callback to be registered for properties, so that a user
application get perform the comparison itself, allowing for "deep" compares of
the property value.
    This was exported to the H5Pregister & H5Pinsert routines in the development
branch, but not the release branch.

Platforms tested:
    FreeBSD 4.9 (sleipnir)
    h5committest
2004-01-08 09:55:11 -05:00
Frank Baker
cec846b3d0 [svn-r7758]
Purpose:
    Updated footers to "Describes HDF5 Release 1.7, the unreleased
    development branch; working toward HDF5 Release 1.8.0"

Platforms tested:
    IE 5, Safari
2003-10-27 16:55:13 -05:00
Frank Baker
433313e267 [svn-r7731]
Description:
    Integrate Fortran90 function descriptions
        Remove "Non-C APIs" sections; add "Fortran90 Interface" sections
        Remove note that Fortran APIs are described in a separate window
    Add h5pset/get_fapl_mpiposix_f
    Reinstate H5Pget_hyper_vector_size (previously removed in error)
    Remove H5Pget_hyper_cache (function deprecated in 1.6, removed in 1.8)
    Minor copy edits and formatting

Platforms tested:
    IE 5, Safari
2003-10-24 17:51:15 -05:00
Frank Baker
c1afffec45 [svn-r7571]
Purpose:
    Alphabetic sort of RM function entries
    Additional and modified HTML coding to accomodate HTMLdoc and
        automated PDF generation
    Minor copy edits

Platforms tested:
    Safari, IE 5
2003-10-07 17:17:58 -05:00
Quincey Koziol
0bcd59f9b8 [svn-r7217] Purpose:
Correct information

Description:
    Correct a some information about file creation properties.
2003-07-14 11:51:24 -05:00
Quincey Koziol
4e23c80758 [svn-r7181] Purpose:
Version update

Description:
    Removed 1.4 compatibility code in the library.

Platforms tested:
    FreeBSD 4.8 (sleipnir)
    h5committest
2003-07-07 14:02:46 -05:00
Frank Baker
4146d79af1 [svn-r7159]
Purpose:
    Changed "HDF5 User's Guide" links (in navigation bars, primarily)
    to point to new user's guide, which will reside for a while yet on
    the HDF server.
    The old user's guide will still go out with the distribution under
    the label "HDF5 User's Guide, Release 1.4.5."

Platforms tested:
    IE 5
2003-07-03 14:40:03 -05:00
Frank Baker
bc5a1e0312 [svn-r7157]
Purpose:
    Linking in additional Fortran90 functions

Description:
    Add links to
    In RM_H5T.html
        h5tarray_create_f, h5tget_array_ndims_f, h5tget_array_dims_f
    In RM_H5P.html
        h5pmodify_filter_f, h5pget_filter_by_id_f, h5pset_family_offset_f
        h5pset(get)_fapl_core_f, h5pset(get)_fapl_family_f
        h5pset(get)_fapl_multi_f, h5pset_fapl_sec2_f, h5pset_fapl_sdio_f
        h5pset_fapl_split_f, h5pget_driver_f, h5pset_szip_f
        h5pget_nfilters_f, h5pset(get)_preserve_f

Platforms tested:
    IE 5
2003-07-03 13:52:44 -05:00
Frank Baker
79c7463f35 [svn-r7152]
Description:
    H5Pset_szip -- Added link to further SZIP information at
        http://hdf.ncsa.uiuc.edu/HDF5/doc_resource/SZIP/

Platforms tested:
    IE 5
2003-07-03 12:56:26 -05:00
Frank Baker
1091cab2e6 [svn-r7140]
Purpose:
    Add short copyright notice.
    Update release tag line.

Description:
    Added short copyright notice as comment in source files;
        does not display in browser.
    Updated release tag line in footers to read as follows:
        Describes HDF5 Release 1.6.0, July 2003

Platforms tested:
    IE 5
2003-07-02 16:28:11 -05:00
Frank Baker
64e2fe1774 [svn-r7138]
Purpose:
    H5Pset/get_hyper_cache are deprecated in R 1..6.0.

Description:
    Added notation that H5Pset/get_hyper_cache are deprecated functions
    in R1.6.0 and are available only if library is configured for
    1.4 compatibility.

Platforms tested:
    IE 5
2003-07-02 15:10:58 -05:00
Frank Baker
cd46d0a7da [svn-r7127]
Purpose:
    Bugfix

Description:
    H5Pget_filter_by_id: Changed last parameter
    from "char *name[]" to "char name[]".

Platforms tested:
    IE 5
2003-06-30 16:24:11 -05:00
Frank Baker
82a89d2c18 [svn-r7125]
Purpose:
    H5Pset_shuffle -- Add note regarding intended use.
    H5Pset_szip -- Correct options mask list.  Copy edits.

Description:
    H5Pset_shuffle -- Added note that the shuffle filter is designed to be
        used with in combination a compression filter.
    H5Pset_szip -- Changed 'szip' to 'SZIP' in running text.
        Removed RAW_OPTIONS_MASK, LSB_OPTIONS_MASK, and MSB-OPTIONS_MASK
            from options maks list as they are not available for user control.
        Added 'H5_SZIP_' prefix to all remaining option tags.
        Made corresponding changes to running text, removing or revising
            mentions of deleted option tags.

Platforms tested:
    IE 5
2003-06-30 13:52:18 -05:00
Frank Baker
331d3d504d [svn-r7111]
Purpose:
    Primarily edits from technical review.

Description:
    H5Pget_fill_value -- Corrected 'value' parameter type.
    H5Pget_fill_time -- Added H5D_FILL_TIME_IFSET.
    H5Pset_filter --Add that filters are applied to chunks in order
            in which they were created.
        Correct H5Z_FLAG_OPTIONAL description.
        Add references to related functions.
        Add H5Z_FILTER_SZIP to list of valid filters.
    H5Pget_filter -- Add H5Z_FILTER_SZIP to list of possible filters.
    H5Pset_szip -- Remove list of publications references.
    H5Pset_edc_check -- Reverse notation of default setting.
    Copy edits.

Platforms tested:
    IE 5, Safari
2003-06-26 11:50:00 -05:00
Frank Baker
5a6bfd1ae3 [svn-r7087]
Purpose:
    Review feedback.
    Change "Development notes" to user notes.
    New fill_time value (H5D_FILL_TIME_IFSET).
    Formatting fix and copy edits.

Description:
    (Based primarily on review feedback and developer consultations)
    H5Pset_hyper_vector_size -- Clarification on timing.
    H5Pmodify_filter -- dapl .vs. dcpl clarification.
    H5Pset_filter_by_id -- dapl .vs. dcpl clarification.
    H5Pset_szip -- Copy edits.
    5Pset_fill_time -- Added new fill_time value, H5D_FILL_TIME_IFSET.

    H5Pset_fill_value, H5Pfill_value_defined,
    H5Pset_fill_time, H5Pset_alloc_time
         -- Added H5Dcreate x-ref to "Notes."

    H5Pcreate_class, H5Pregister, H5Pinsert
        -- Convert some "development notes" to user notes; delete others.
        -- Formatting rework in H5Pregister "Parameters."

Platforms tested:
    IE 5, Safari
2003-06-23 16:06:40 -05:00
Frank Baker
ca33a5498c [svn-r7014]
Purpose:
    To facilitate finding functions, particularly in long Reference Manual
    sections.

Solution:
    Added alphabetized function listings.  (NOTE: Aside from the H5I and H5Z
    sections, this is not necessarily the final implementation; there will
    likely be another revision in the presentation of this listing before it
    is released.)

Platforms tested:
    Safari, IE 5
2003-06-10 10:38:46 -05:00
Frank Baker
f4bd46fed6 [svn-r6814]
Purpose:
    New and modified functions.

Description:
    Added 11 new functions:
        H5Pall_filters_avail
        H5Pget_filter_by_id
        H5Pmodify_filter
        H5Pset_hyper_vector_size / H5Pget_hyper_vector_size
        H5Pset_family_offset / H5Pget_family_offset
        H5Pset_fapl_mpiposix / H5Pget_fapl_mpiposix
        H5Pset_multi_type / H5Pget_multi_type
    H5Pset_shuffle -- Correct parameter list; copy edits.
    Some minor copy edits elsewhere.

Platforms tested:
    Safari, IE 5
2003-05-06 17:16:12 -05:00
Frank Baker
ea7491e8eb [svn-r6696]
Purpose:
    Add new function

Description:
    Added H5Pset_szip

Platforms tested:
    Safari, IE 5
2003-04-17 14:56:08 -05:00
Frank Baker
4c6122a53c [svn-r6600]
Purpose:
    Link in additional Fortran90 functions.

Description:
    Linked 68 new Fortran90 functions to the discussions of the corresponding
        C functions.  Made the corresponding Fortran index changes in the
        function listings at the tops of the RM pages.
    Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html.

Platforms tested:
    Safari and IE 5
2003-04-08 16:33:50 -05:00
Frank Baker
6e2071f7ed [svn-r6570]
Purpose:
    New feature: Fill value and storage space allocation changes

Description:
    Modified the following functions:
        H5Pset_fill_value          H5Pget_fill_value
    Added the following functions:
        H5Pfill_value_defined
        H5Pset_fill_time           H5Pget_fill_time
        H5Pset_alloc_time          H5Pget_alloc_time

Platforms tested:
    Safari, IE 5
2003-04-02 16:24:47 -05:00
Frank Baker
32be22e793 [svn-r6520]
Purpose:
    Adding descriptions of  new library features to the RM

Description:
    H5Pset_fapl_log: Added new 'buf_size' parameter.
                     New 'flags' parameter replaced 'verbosity' parameter,
                         requiring new table describing 20 available flags.
    H5Pset_filter: Added valid 'filter' parameter values.
                   Modified for Fletcher32 EDC filter.
    H5Pget_filter: Added return value descriptions.
    H5Pset_layout & H5Pget_layout:  Modified for compact datasets.
    Added the following new functions:
        H5Pset_fletcher32
        H5Pset_edc_check & H5Pget_edc_check
        H5Pset_filter_callback
        H5Pset_shuffle

Platforms tested:
    Safari
    IE 6
2003-03-24 16:09:42 -05:00
Frank Baker
d586a1adb9 [svn-r6478]
Purpose:
    DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of
        stylesheets and DW libraries.
    Stylesheets -- for consistent format management.
    DW libraries -- for managing common elements across documents.
Platforms tested:
    IE 5 and 6
    Netscape
2003-03-14 14:12:34 -05:00
Frank Baker
26cd535ff2 [svn-r5957] Purpose:
Added 19 Generic Properties functions.
    Development branch only.
Description:
    Added Generic Properties functions as follows:
	H5Pcreate_class         H5Pset
	H5Pcreate_list          H5Pexist
	H5Pclose_list           H5Pisa_class
	H5Pclose_class          H5Pequal
	H5Pregister
	H5Punregister           H5Pget_size
	H5Pinsert               H5Pget_nprops
	H5Premove               H5Pget_class_parent
	H5Piterate              H5Pget_class_name
	H5Pcopy_prop            H5Pget
Platforms tested:
    IE 5.1
2002-10-01 17:30:04 -05:00
Frank Baker
c84a46f49b [svn-r5766]
Purpose:
    Two new functions and a few copy-edits.
Description:
    Added H5Pset/get_small_data_block_size.
    Copy edits -- several typographic (spelling) corrections.
Platforms tested:
    IE 5
2002-07-05 14:58:24 -05:00
Frank Baker
2997ad4c45 [svn-r5343]
Purpose:
    Bugfixes -- Fixes #657.
                Addresses #720 (but does not complete it).
Description:
    H5Pset_fapl_split:  Added note re checking on use of this driver,
        i.e., that H5Pget_driver returns H5FD_MULTI.
        Fixes Bug #657.
    Minor copy edits, including some addressed in Bug #720.
Platforms tested:
    IE 5
2002-05-02 16:46:52 -05:00
Frank Baker
3745338005 [svn-r4833]
Purpose:
    Bugfix.  Clarification & extension.  Removed old function.
Description:
    h5pset/get_fapl_mpio_f  &  h5pset/get_dxpl_mpio_f:
        Corrected function names (mpi --> mpio)
    H5Pset_fapl_dpss:
        Removed function from RM.
    H5Pget_driver:
        Corrected return type.
        Added list of valid driver identifiers and note re custom drivers.
    H5Pcreate:
	Added note, per user complaint, that the property must eventually
	be closed with H5Pclose, else errors are likely to occur.
Platforms tested:
    IE 5
2002-01-16 13:35:33 -05:00
Albert Cheng
c54fa7409f [svn-r4446] Description:
The caution statement in H5Pset_fapl_split was no longer valid.
    Removed it.
Platforms tested:
    IE 5.
2001-09-17 16:39:49 -05:00
Albert Cheng
04ed08e223 [svn-r4445] Purpose:
Feature
Description:
    Updated with the added feature of H5Pset_fapl_split.  Added
    two examples too.
Platforms tested:
    IE 5 plus eyeball.
2001-09-17 16:36:23 -05:00
Frank Baker
cfa3658931 [svn-r4126] Purpose:
Bugfixes and editing.
Description:
    RM_H5T.html
       H5Tget_class -- Added H5T_ARRAY to list of valid datatype class IDs.
                       Closes bug #611.
                    -- Minor formatting issue in same command.
    RM_H5F.html
       H5Fflush -- Added "Note:" re H5 vs OS buffers.
       H5Fclose -- Corrected mentions of H5close to read H5Fclose.
    RM_H5P.html
       Removed () from several H5* function names in running text.
Platforms tested:
    IE 5
2001-07-05 21:32:06 -05:00
Frank Baker
ad81c8163e [svn-r3823]
Purpose:
    Update "Describes HDF5 Release..." footer from R1.4 to
    "Release 1.5, Unreleased Development Branch"
Platforms tested:
    IE 5
2001-04-18 17:03:09 -05:00
Frank Baker
8dd2c0ad9e [svn-r3822]
Purpose:
    Update "Describes HDF5 Release..." footer from R1.4 to
    "Release 1.5, Unreleased Development Branch"
Platforms tested:
    IE 5
2001-04-18 16:50:43 -05:00
Frank Baker
365b06f606 [svn-r3803]
Purpose:
    Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-11 17:45:26 -05:00
Frank Baker
fd05f98e9e [svn-r3387]
Purpose:
    Marking files for "Release 1.4, February 2001."
Description:
    Across doc files
        Updating "Describes HDF5 Release..." entry to "Describes
        HDF5 Release 1.4, February 2001."
    Copyright.html:  Added 2001 to years copyrighted.
    index.html:  Changed header to Release 1.4 (from 1.4 Beta)
Platforms tested:
    IE 5
2001-02-09 13:02:16 -05:00
Frank Baker
cefabf3224 [svn-r3311]
Purpose, Description, and Solution:
    Removed cross-links to Ragged Array doc files (above).
Platforms tested:
    IE 5
2001-01-19 16:51:53 -05:00
Frank Baker
9ae87ca1a6 [svn-r3254]
Purpose:
    Correcting docs to match code bugfixes.
Solution:
    Changed per recent bugfix in code:
        H5Tconvert 'nelmts' parameter type
        H5Pset_buffer 'size' parameter type
        H5Pget_buffer return type
2001-01-09 17:13:08 -05:00
Frank Baker
c6b677dde6 [svn-r3253]
Purpose:
    Clarifications in H5Pset_fapl_core.
Platforms tested:
    IE 5
2001-01-09 16:55:07 -05:00
Frank Baker
4acce97e47 [svn-r3246]
Description:
    Updated "Last modified" dates (correcting an oversight)
Platforms tested:
    IE 5
2001-01-09 10:05:04 -05:00
Frank Baker
6ca7ae026e [svn-r3244]
Purpose:
    Bug fix (unreported bug)
Description:
    H5Pset_fapl_core, H5Pget_fapl_core
        Completed entries for these two functions.  (They had
        been added structurally, but details had been omitted.)
Platforms tested:
    IE 5
2001-01-08 16:49:38 -05:00
Frank Baker
7fa2bc6700 [svn-r3117]
Purpose:
    Linking the new "Predefined Dataypes" document into the RM.
Description:
    Added PredefDTypes.html link into all RM files.
Platforms tested:
    IE 5
2000-12-12 17:43:02 -05:00
Frank Baker
243c60e8b5 [svn-r3105]
Purpose:
	Thoughout doc set (UG, RM, Intro, FormatSpec, and index/TOC pages):
	    Added/updated "Describes HDF5 Release ..." entry.
	    In many cases, verified/updated "Last modified ..." entry.
Platforms tested:
	IE 5
2000-12-08 17:12:36 -05:00
Frank Baker
15df4a2679 [svn-r3104]
Purpose:
	Finalize new API function descriptions
Description:
	Edits to recently-added APIs:
		H5Pset_sieve_buf_size     H5Pset_fapl_log
		H5P[sg]et_fapl_mpio       H5Pset_fapl_multi
		H5P[sg]et_dxpl_multi      H5Pset_fapl_split
		H5P[sg]et_fapl_gass       H5Pset_fapl_dpss
                H5P[sg]et_fapl_srb
	Added H5P[sg]et_fapl_core.
	Addition of new APIs for R1.4 is now complete.
	Moved H5Pset_driver and H5Pget_driver_info to TechNotes.
Platforms tested:
	IE 5
2000-12-08 14:50:33 -05:00
Frank Baker
cfe6744d58 [svn-r2881] Purpose:
Clean up formatting and delete two functions.
Description:
    Minor reformatting at the head of each file (in the functions list).
    Delete 2 functions from HM_H5T.html -- H5Tget_member_dims, H5Tinsert_array.
Platforms tested:
    IE 5.
2000-11-13 12:56:47 -05:00
Frank Baker
b527d73dda [svn-r2873]
Purpose:
    Adding all functions new to Release 1.4.
Solution:
    Adding first cut of all new API functions.
    H5Dvlen_get_buf_size
    H5Epush
    H5Pset_fapl_family       H5Pget_fapl_family
    H5Pset_fapl_mpio         H5Pget_fapl_mpio
    H5Pset_dxpl_mpio         H5Pget_dxpl_mpio
    H5Pset_fapl_multi        H5Pget_fapl_multi
    H5Pset_dxpl_multi        H5Pget_dxpl_multi
    H5Pset_fapl_split        H5Pset_fapl_sec2          H5Pset_fapl_stdio
    H5Pset_fapl_stream       H5Pget_fapl_stream
    H5Pset_fapl_log
    H5Pset_driver            H5Pget_driver             H5Pget_driver_info
    H5Pset_meta_block_size   H5Pget_meta_block_size
    H5Pset_sieve_buf_size    H5Pget_sieve_buf_size
    H5Pset_fapl_dpss
    H5Pset_fapl_gass         H5Pget_fapl_gass
    H5Pset_fapl_srb          H5Pget_fapl_srb
    H5Tarray_create          H5Tget_array_ndims        H5Tget_array_dims
Platforms tested:
    IE 5.
2000-11-13 11:35:49 -05:00
Frank Baker
f3dc4efd5f [svn-r2760]
Purpose:
    Removing functions that have been removed from library.
Solution:
    Removed H5Pget_driver, H5P[gs]et_stdio,  H5P[gs]et_sec2,
        H5P[gs]et_core, H5P[gs]et_split, H5P[gs]et_family,
        H5P[gs]et_mpi, and H5P[gs]et_xfer.
Platforms tested:
    IE5
2000-10-31 11:04:29 -05:00
Frank Baker
32c4a3e515 [svn-r2525] RM_H5P.html
RM_H5Z.html
	Corrected compression cross-reference.
2000-09-08 10:35:39 -05:00
Frank Baker
315e9c17f4 [svn-r2435] RM_H5[EIPRT].html
RM_H5Front.html
	Added new Fortran90 functions and links.  Related edits.
	Added "Describes HDF5 Release..." line in page footers.
	Minor editorial corrections.
2000-07-17 14:14:30 -05:00
Frank Baker
031768b5e2 [svn-r2426] RM_H5P.html: Minor copy-editing and formatting fixes.
H5Pget_chunk: Changed max_ndims parameter description to IN.
	H5Pget/set_gc_references: Corrected signature errors,
	    added missing parameter description and values.
	H5Pget/set_family:  Removed.  These are not implemented.
	H5Pget/set_hyper_cache: Corrected signature and parameter
	    expressions, added missing parameter description.
	H5Pset_buffer:  Added units for parameter 'size'.RM_H5P.html
	H5Pget/set_split:  Corrected misnamed parameters.
	H5Pset_alignment and H5_set_core:
	    Edited for clarity.
	    Added statement regarding "special case" effect of
	    setting 'threshold' to 0 (zero).
	    Stated clearly that 'threshold' is non-negative and
	    'alignment' and 'increment' are both positive.
	H5Pget/set_vlen_mem_manager:
	    Corrected cross-ref to H5Dvlen_reclaim.
	    Minor clarification regarding circumstances under which
	    contents of a parameter are ignored.
	H5Pget_cache: Removed redundant material.
2000-07-06 11:28:38 -05:00
Frank Baker
fbd9b7f5ad [svn-r2002] Changed 'boot block' to 'super block'. 2000-03-08 17:03:11 -05:00
Frank Baker
654dfafca6 [svn-r1886] RM_H5P.html
H5Pset/get_cache: Added missing rdcc_nelmts parameter.
	    Corrected inconsistent references to rdcc_wo parameter.
	    Clarified Purpose and Description sections.
 	H5Pget_sec2:  Corrected return type from 'returntype' to 'herr_t'.
1999-12-17 10:34:35 -05:00
Frank Baker
658fdbfb98 [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html)
	This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-13 15:39:48 -05:00