diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-07-05 16:08:56 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-05 16:08:56 (GMT) |
commit | 5e3017f31cf220852b37c6aad5daf6597cbc2da8 (patch) | |
tree | f4c9d9b541fc0d7eefb2ee2eaa35961b80feeff7 /java | |
parent | 4fa879ab4140df94e0edccc258b3d4025dc8616a (diff) | |
download | hdf5-5e3017f31cf220852b37c6aad5daf6597cbc2da8.zip hdf5-5e3017f31cf220852b37c6aad5daf6597cbc2da8.tar.gz hdf5-5e3017f31cf220852b37c6aad5daf6597cbc2da8.tar.bz2 |
Add datasets UG chapter, plus fix doxygen refs (#1841)
* Add datasets UG chapter, plus fix doxygen refs
* Remove duplicates
Diffstat (limited to 'java')
-rw-r--r-- | java/src/hdf/hdf5lib/HDF5Constants.java | 66 | ||||
-rw-r--r-- | java/src/hdf/hdf5lib/HDF5GroupInfo.java | 2 |
2 files changed, 45 insertions, 23 deletions
diff --git a/java/src/hdf/hdf5lib/HDF5Constants.java b/java/src/hdf/hdf5lib/HDF5Constants.java index e409cfb..7c02af9 100644 --- a/java/src/hdf/hdf5lib/HDF5Constants.java +++ b/java/src/hdf/hdf5lib/HDF5Constants.java @@ -14,7 +14,7 @@ package hdf.hdf5lib; /** - * /** This class contains C constants and enumerated types of HDF5 library. The + * This class contains C constants and enumerated types of HDF5 library. The * values of these constants are obtained from the library by calling J2C(int * jconstant), where jconstant is any of the private constants which start their * name with "JH5" need to be converted. @@ -30,9 +30,6 @@ public class HDF5Constants { // Get the HDF5 constants from the library // // ///////////////////////////////////////////////////////////////////////// - /** */ - public static final long H5_QUARTER_HADDR_MAX = H5_QUARTER_HADDR_MAX(); - /** Special parameters for szip compression */ public static final int H5_SZIP_MAX_PIXELS_PER_BLOCK = H5_SZIP_MAX_PIXELS_PER_BLOCK(); /** Special parameters for szip compression */ @@ -61,31 +58,58 @@ public class HDF5Constants { public static final int H5_ITER_NATIVE = H5_ITER_NATIVE(); /** Common iteration orders, Number of iteration orders */ public static final int H5_ITER_N = H5_ITER_N(); - /** */ + /** The version of the H5AC_cache_config_t in use */ public static final int H5AC_CURR_CACHE_CONFIG_VERSION = H5AC_CURR_CACHE_CONFIG_VERSION(); - /** */ + /** The maximum length of the trace file path */ public static final int H5AC_MAX_TRACE_FILE_NAME_LEN = H5AC_MAX_TRACE_FILE_NAME_LEN(); - /** */ + /** + * When metadata_write_strategy is set to this value, only process + * zero is allowed to write dirty metadata to disk. All other + * processes must retain dirty metadata until they are informed at + * a sync point that the dirty metadata in question has been written + * to disk. + */ public static final int H5AC_METADATA_WRITE_STRATEGY_PROCESS_ZERO_ONLY = H5AC_METADATA_WRITE_STRATEGY_PROCESS_ZERO_ONLY(); - /** */ + /** + * In the distributed metadata write strategy, process zero still makes + * the decisions as to what entries should be flushed, but the actual + * flushes are distributed across the processes in the computation to + * the extent possible. + */ public static final int H5AC_METADATA_WRITE_STRATEGY_DISTRIBUTED = H5AC_METADATA_WRITE_STRATEGY_DISTRIBUTED(); - /** */ + /** Don't attempt to increase the size of the cache automatically */ public static final int H5C_incr_off = H5C_incr_off(); - /** */ + /** Attempt to increase the size of the cache + * whenever the average hit rate over the last epoch drops + * below the value supplied in the lower_hr_threshold + * field + */ public static final int H5C_incr_threshold = H5C_incr_threshold(); - /** */ + /** Don't perform flash increases in the size of the cache */ public static final int H5C_flash_incr_off = H5C_flash_incr_off(); - /** */ + /** increase the current maximum cache size by x * flash_multiple less any free space in the cache */ public static final int H5C_flash_incr_add_space = H5C_flash_incr_add_space(); - /** */ + /** Don't attempt to decrease the size of the cache automatically */ public static final int H5C_decr_off = H5C_decr_off(); - /** */ + /** Attempt to decrease the size of the cache + * whenever the average hit rate over the last epoch rises + * above the value supplied in the upper_hr_threshold + * field + */ public static final int H5C_decr_threshold = H5C_decr_threshold(); - /** */ + /** At the end of each epoch, search the cache for + * entries that have not been accessed for at least the number + * of epochs specified in the epochs_before_eviction field, and + * evict these entries + */ public static final int H5C_decr_age_out = H5C_decr_age_out(); - /** */ + /** Same as age_out, but we only + * attempt to reduce the cache size when the hit rate observed + * over the last epoch exceeds the value provided in the + * upper_hr_threshold field + */ public static final int H5C_decr_age_out_with_threshold = H5C_decr_age_out_with_threshold(); /** */ public static final int H5D_CHUNK_IDX_BTREE = H5D_CHUNK_IDX_BTREE(); @@ -874,10 +898,10 @@ public class HDF5Constants { /** */ public static final int H5R_MAXTYPE = H5R_MAXTYPE(); /** */ - public static final int H5R_OBJ_REF_BUF_SIZE = H5R_OBJ_REF_BUF_SIZE(); - /** */ public static final int H5R_DSET_REG_REF_BUF_SIZE = H5R_DSET_REG_REF_BUF_SIZE(); /** */ + public static final int H5R_OBJ_REF_BUF_SIZE = H5R_OBJ_REF_BUF_SIZE(); + /** */ public static final int H5R_OBJECT = H5R_OBJECT(); /** Define atomic datatypes */ @@ -1446,8 +1470,6 @@ public class HDF5Constants { // DO NOT EDIT THE LIST UNLESS YOU KNOW WHAT YOU DO!!! // // ///////////////////////////////////////////////////////////////////////// - private static native final long H5_QUARTER_HADDR_MAX(); - private static native final int H5_SZIP_MAX_PIXELS_PER_BLOCK(); private static native final int H5_SZIP_NN_OPTION_MASK(); @@ -2300,10 +2322,10 @@ public class HDF5Constants { private static native final int H5R_MAXTYPE(); - private static native final int H5R_OBJ_REF_BUF_SIZE(); - private static native final int H5R_DSET_REG_REF_BUF_SIZE(); + private static native final int H5R_OBJ_REF_BUF_SIZE(); + private static native final int H5R_OBJECT(); private static native final int H5S_ALL(); diff --git a/java/src/hdf/hdf5lib/HDF5GroupInfo.java b/java/src/hdf/hdf5lib/HDF5GroupInfo.java index 220cfb6..880f003 100644 --- a/java/src/hdf/hdf5lib/HDF5GroupInfo.java +++ b/java/src/hdf/hdf5lib/HDF5GroupInfo.java @@ -158,7 +158,7 @@ public class HDF5GroupInfo { public long getOID() { return objno[0]; } /** - * /** Converts this object to a String representation. + * Converts this object to a String representation. * * @return a string representation of this object */ |