/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright by The HDF Group. * * Copyright by the Board of Trustees of the University of Illinois. * * All rights reserved. * * * * This file is part of HDF5. The full HDF5 copyright notice, including * * terms governing use, modification, and redistribution, is contained in * * the files COPYING and Copyright.html. COPYING can be found at the root * * of the source code distribution tree; Copyright.html can be found at the * * root level of an installed copy of the electronic HDF5 document set and * * is linked from the top-level documents page. It can also be found at * * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have * * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ #define H5S_PACKAGE /*suppress error about including H5Spkg */ /* Interface initialization */ #define H5_INTERFACE_INIT_FUNC H5S_init_interface #include "H5private.h" /* Generic Functions */ #include "H5Eprivate.h" /* Error handling */ #include "H5Fprivate.h" /* Files */ #include "H5FLprivate.h" /* Free lists */ #include "H5Iprivate.h" /* IDs */ #include "H5MMprivate.h" /* Memory management */ #include "H5Oprivate.h" /* Object headers */ #include "H5Spkg.h" /* Dataspaces */ /* Local macro definitions */ /* Number of reserved IDs in ID group */ #define H5S_RESERVED_ATOMS 2 /* Version of datatype encoding */ #define H5S_ENCODE_VERSION 0 /* Local static function prototypes */ static herr_t H5S_set_extent_simple (H5S_t *space, unsigned rank, const hsize_t *dims, const hsize_t *max); static htri_t H5S_is_simple(const H5S_t *sdim); static herr_t H5S_encode(H5S_t *obj, unsigned char *buf, size_t *nalloc); static H5S_t *H5S_decode(const unsigned char *buf); #ifdef H5_HAVE_PARALLEL /* Global vars whose value can be set from environment variable also */ hbool_t H5S_mpi_opt_types_g = TRUE; #endif /* H5_HAVE_PARALLEL */ /* Declare a free list to manage the H5S_extent_t struct */ H5FL_DEFINE(H5S_extent_t); /* Declare a free list to manage the H5S_t struct */ H5FL_DEFINE(H5S_t); /* Declare a free list to manage the array's of hsize_t's */ H5FL_ARR_DEFINE(hsize_t,H5S_MAX_RANK); /*-------------------------------------------------------------------------- NAME H5S_init_interface -- Initialize interface-specific information USAGE herr_t H5S_init_interface() RETURNS Non-negative on success/Negative on failure DESCRIPTION Initializes any interface-specific data or routines. --------------------------------------------------------------------------*/ static herr_t H5S_init_interface(void) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI_NOINIT(H5S_init_interface) /* Initialize the atom group for the file IDs */ if(H5I_register_type(H5I_DATASPACE, (size_t)H5I_DATASPACEID_HASHSIZE, H5S_RESERVED_ATOMS, (H5I_free_t)H5S_close) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize interface") #ifdef H5_HAVE_PARALLEL { /* Allow MPI buf-and-file-type optimizations? */ const char *s = HDgetenv ("HDF5_MPI_OPT_TYPES"); if (s && HDisdigit(*s)) H5S_mpi_opt_types_g = (int)HDstrtol (s, NULL, 0); } #endif /* H5_HAVE_PARALLEL */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_init_interface() */ /*-------------------------------------------------------------------------- NAME H5S_term_interface PURPOSE Terminate various H5S objects USAGE void H5S_term_interface() RETURNS Non-negative on success/Negative on failure DESCRIPTION Release the atom group and any other resources allocated. GLOBAL VARIABLES COMMENTS, BUGS, ASSUMPTIONS Can't report errors... EXAMPLES REVISION LOG --------------------------------------------------------------------------*/ int H5S_term_interface(void) { int n = 0; FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_term_interface) if(H5_interface_initialize_g) { if((n = H5I_nmembers(H5I_DATASPACE))) { H5I_clear_type(H5I_DATASPACE, FALSE, FALSE); } /* end if */ else { /* Free data types */ H5I_dec_type_ref(H5I_DATASPACE); /* Shut down interface */ H5_interface_initialize_g = 0; n = 1; /*H5I*/ } /* end else */ } /* end if */ FUNC_LEAVE_NOAPI(n) } /* end H5S_term_interface() */ /*-------------------------------------------------------------------------- NAME H5S_create PURPOSE Create empty, typed dataspace USAGE H5S_t *H5S_create(type) H5S_type_t type; IN: Dataspace type to create RETURNS Pointer to dataspace on success, NULL on failure DESCRIPTION Creates a new dataspace of a given type. The extent is undefined and the selection is set to the "all" selection. GLOBAL VARIABLES COMMENTS, BUGS, ASSUMPTIONS EXAMPLES REVISION LOG --------------------------------------------------------------------------*/ H5S_t * H5S_create(H5S_class_t type) { H5S_t *new_ds = NULL; /* New dataspace created */ H5S_t *ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_create, NULL) /* Create a new dataspace */ if(NULL == (new_ds = H5FL_MALLOC(H5S_t))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed") /* Initialize default dataspace state */ new_ds->extent.type = type; if(type == H5S_NULL) new_ds->extent.version = H5O_SDSPACE_VERSION_2; else new_ds->extent.version = H5O_SDSPACE_VERSION_1; new_ds->extent.rank = 0; new_ds->extent.size = new_ds->extent.max = NULL; switch(type) { case H5S_SCALAR: new_ds->extent.nelem = 1; break; case H5S_SIMPLE: case H5S_NULL: new_ds->extent.nelem = 0; break; default: HDassert("unknown dataspace (extent) type" && 0); break; } /* end switch */ /* Start with "all" selection */ if(H5S_select_all(new_ds, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTSET, NULL, "unable to set all selection") /* Reset common selection info pointer */ new_ds->select.sel_info.hslab = NULL; /* Reset "shared" info on extent */ if(H5O_msg_reset_share(H5O_SDSPACE_ID, &(new_ds->extent.sh_loc)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTRESET, NULL, "unable to reset shared component info") /* Set return value */ ret_value = new_ds; done: if(ret_value == NULL) { if(new_ds && H5S_close(new_ds) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, NULL, "unable to release dataspace") } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_create() */ /*-------------------------------------------------------------------------- NAME H5Screate PURPOSE Create empty, typed dataspace USAGE hid_t H5Screate(type) H5S_type_t type; IN: Dataspace type to create RETURNS Valid dataspace ID on success, negative on failure DESCRIPTION Creates a new dataspace of a given type. The extent & selection are undefined GLOBAL VARIABLES COMMENTS, BUGS, ASSUMPTIONS EXAMPLES REVISION LOG --------------------------------------------------------------------------*/ hid_t H5Screate(H5S_class_t type) { H5S_t *new_ds=NULL; /* New dataspace structure */ hid_t ret_value; /* Return value */ FUNC_ENTER_API(H5Screate, FAIL) H5TRACE1("i", "Sc", type); /* Check args */ if(type <= H5S_NO_CLASS || type > H5S_NULL) /* don't allow complex dataspace yet */ HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid dataspace type") if(NULL == (new_ds = H5S_create(type))) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCREATE, FAIL, "unable to create dataspace") /* Atomize */ if((ret_value = H5I_register (H5I_DATASPACE, new_ds, TRUE)) < 0) HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to register dataspace atom") done: if(ret_value < 0) { if(new_ds && H5S_close(new_ds) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release dataspace") } /* end if */ FUNC_LEAVE_API(ret_value) } /* end H5Screate() */ /*------------------------------------------------------------------------- * Function: H5S_extent_release * * Purpose: Releases all memory associated with a dataspace extent. * * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, July 23, 1998 * * Modifications: * *------------------------------------------------------------------------- */ herr_t H5S_extent_release(H5S_extent_t *extent) { herr_t ret_value=SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_extent_release, FAIL) assert(extent); /* Release extent */ if(extent->type == H5S_SIMPLE) { if(extent->size) extent->size = H5FL_ARR_FREE(hsize_t, extent->size); if(extent->max) extent->max = H5FL_ARR_FREE(hsize_t, extent->max); } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_extent_release() */ /*------------------------------------------------------------------------- * Function: H5S_close * * Purpose: Releases all memory associated with a dataspace. * * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * *------------------------------------------------------------------------- */ herr_t H5S_close(H5S_t *ds) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_close, FAIL) HDassert(ds); /* Release selection (this should come before the extent release) */ if(H5S_SELECT_RELEASE(ds) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release dataspace selection") /* Release extent */ if(H5S_extent_release(&ds->extent) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release dataspace extent") /* Release the main structure */ ds = H5FL_FREE(H5S_t, ds); done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_close() */ /*------------------------------------------------------------------------- * Function: H5Sclose * * Purpose: Release access to a dataspace object. * * Return: Non-negative on success/Negative on failure * * Errors: * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * * Modifications: * *------------------------------------------------------------------------- */ herr_t H5Sclose(hid_t space_id) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_API(H5Sclose, FAIL) H5TRACE1("e", "i", space_id); /* Check args */ if (NULL == H5I_object_verify(space_id,H5I_DATASPACE)) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") /* When the reference count reaches zero the resources are freed */ if(H5I_dec_app_ref(space_id) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDEC, FAIL, "problem freeing id") done: FUNC_LEAVE_API(ret_value) } /* end H5Sclose() */ /*------------------------------------------------------------------------- * Function: H5Scopy * * Purpose: Copies a dataspace. * * Return: Success: ID of the new dataspace * * Failure: Negative * * Programmer: Robb Matzke * Friday, January 30, 1998 * * Modifications: * *------------------------------------------------------------------------- */ hid_t H5Scopy(hid_t space_id) { H5S_t *src; H5S_t *dst = NULL; hid_t ret_value; FUNC_ENTER_API(H5Scopy, FAIL) H5TRACE1("i", "i", space_id); /* Check args */ if(NULL == (src = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") /* Copy */ if(NULL == (dst = H5S_copy(src, FALSE, TRUE))) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to copy dataspace") /* Atomize */ if((ret_value = H5I_register (H5I_DATASPACE, dst, TRUE)) < 0) HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to register dataspace atom") done: if(ret_value < 0) { if(dst && H5S_close(dst) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release dataspace") } /* end if */ FUNC_LEAVE_API(ret_value) } /* end H5Scopy() */ /*------------------------------------------------------------------------- * Function: H5Sextent_copy * * Purpose: Copies a dataspace extent. * * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Thursday, July 23, 1998 * * Modifications: * *------------------------------------------------------------------------- */ herr_t H5Sextent_copy(hid_t dst_id,hid_t src_id) { H5S_t *src; H5S_t *dst; hid_t ret_value = SUCCEED; FUNC_ENTER_API(H5Sextent_copy, FAIL) H5TRACE2("e", "ii", dst_id, src_id); /* Check args */ if(NULL == (src = (H5S_t *)H5I_object_verify(src_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") if(NULL == (dst = (H5S_t *)H5I_object_verify(dst_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") /* Copy */ if(H5S_extent_copy(&(dst->extent), &(src->extent), TRUE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOPY, FAIL, "can't copy extent") done: FUNC_LEAVE_API(ret_value) } /* end H5Sextent_copy() */ /*------------------------------------------------------------------------- * Function: H5S_extent_copy * * Purpose: Copies a dataspace extent * * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Wednesday, June 3, 1998 * * Modifications: * *------------------------------------------------------------------------- */ herr_t H5S_extent_copy(H5S_extent_t *dst, const H5S_extent_t *src, hbool_t copy_max) { unsigned u; herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_extent_copy, FAIL) /* Copy the regular fields */ dst->type = src->type; dst->version = src->version; dst->nelem = src->nelem; dst->rank = src->rank; switch (src->type) { case H5S_NULL: case H5S_SCALAR: dst->size = NULL; dst->max = NULL; break; case H5S_SIMPLE: if(src->size) { dst->size = (hsize_t *)H5FL_ARR_MALLOC(hsize_t, (size_t)src->rank); for(u = 0; u < src->rank; u++) dst->size[u] = src->size[u]; } /* end if */ else dst->size = NULL; if(copy_max && src->max) { dst->max = (hsize_t *)H5FL_ARR_MALLOC(hsize_t, (size_t)src->rank); for(u = 0; u < src->rank; u++) dst->max[u] = src->max[u]; } /* end if */ else dst->max = NULL; break; default: HDassert("unknown dataspace type" && 0); break; } /* end switch */ /* Copy the shared object info */ if(H5O_set_shared(&(dst->sh_loc), &(src->sh_loc)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOPY, FAIL, "can't copy shared information") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_extent_copy() */ /*------------------------------------------------------------------------- * Function: H5S_copy * * Purpose: Copies a dataspace, by copying the extent and selection through * H5S_extent_copy and H5S_select_copy. If the SHARE_SELECTION flag * is set, then the selection can be shared between the source and * destination dataspaces. (This should only occur in situations * where the destination dataspace will immediately change to a new * selection) * * Return: Success: A pointer to a new copy of SRC * * Failure: NULL * * Programmer: Robb Matzke * Thursday, December 4, 1997 * * Modifications: * *------------------------------------------------------------------------- */ H5S_t * H5S_copy(const H5S_t *src, hbool_t share_selection, hbool_t copy_max) { H5S_t *dst = NULL; H5S_t *ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_copy, NULL) if(NULL == (dst = H5FL_MALLOC(H5S_t))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed") /* Copy the source dataspace's extent */ if(H5S_extent_copy(&(dst->extent), &(src->extent), copy_max) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOPY, NULL, "can't copy extent") /* Copy the source dataspace's selection */ if(H5S_select_copy(dst, src, share_selection) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOPY, NULL, "can't copy select") /* Set the return value */ ret_value = dst; done: if(NULL == ret_value) if(dst) dst = H5FL_FREE(H5S_t, dst); FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_copy() */ /*------------------------------------------------------------------------- * Function: H5S_get_simple_extent_npoints * * Purpose: Determines how many data points a dataset extent has. * * Return: Success: Number of data points in the dataset extent. * * Failure: negative * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * * Note: This routine participates in the "Inlining C function pointers" * pattern, don't call it directly, use the appropriate macro * defined in H5Sprivate.h. * * Modifications: * Changed Name - QAK 7/7/98 * *------------------------------------------------------------------------- */ hssize_t H5S_get_simple_extent_npoints(const H5S_t *ds) { hssize_t ret_value; FUNC_ENTER_NOAPI(H5S_get_simple_extent_npoints, -1) /* check args */ HDassert(ds); /* Get the number of elements in extent */ ret_value = (hssize_t)ds->extent.nelem; done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_get_simple_extent_npoints() */ /*------------------------------------------------------------------------- * Function: H5Sget_simple_extent_npoints * * Purpose: Determines how many data points a dataset extent has. * * Return: Success: Number of data points in the dataset. * * Failure: negative * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * * Modifications: * Changed Name - QAK 7/7/98 * *------------------------------------------------------------------------- */ hssize_t H5Sget_simple_extent_npoints(hid_t space_id) { H5S_t *ds; hssize_t ret_value; FUNC_ENTER_API(H5Sget_simple_extent_npoints, FAIL) H5TRACE1("Hs", "i", space_id); /* Check args */ if(NULL == (ds = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") ret_value = (hssize_t)H5S_GET_EXTENT_NPOINTS(ds); done: FUNC_LEAVE_API(ret_value) } /* end H5Sget_simple_extent_npoints() */ /*------------------------------------------------------------------------- * Function: H5S_get_npoints_max * * Purpose: Determines the maximum number of data points a dataspace may * have. If the `max' array is null then the maximum number of * data points is the same as the current number of data points * without regard to the hyperslab. If any element of the `max' * array is zero then the maximum possible size is returned. * * Return: Success: Maximum number of data points the dataspace * may have. * * Failure: 0 * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * * Modifications: * *------------------------------------------------------------------------- */ hsize_t H5S_get_npoints_max(const H5S_t *ds) { hsize_t ret_value; unsigned u; FUNC_ENTER_NOAPI(H5S_get_npoints_max, 0) /* check args */ assert(ds); switch (H5S_GET_EXTENT_TYPE(ds)) { case H5S_NULL: ret_value = 0; break; case H5S_SCALAR: ret_value = 1; break; case H5S_SIMPLE: if (ds->extent.max) { for (ret_value=1, u=0; uextent.rank; u++) { if (H5S_UNLIMITED==ds->extent.max[u]) { ret_value = HSIZET_MAX; break; } else ret_value *= ds->extent.max[u]; } } else { for (ret_value=1, u=0; uextent.rank; u++) ret_value *= ds->extent.size[u]; } break; default: assert("unknown dataspace class" && 0); HGOTO_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, 0, "internal error (unknown dataspace class)") } done: FUNC_LEAVE_NOAPI(ret_value) } /*------------------------------------------------------------------------- * Function: H5Sget_simple_extent_ndims * * Purpose: Determines the dimensionality of a dataspace. * * Return: Success: The number of dimensions in a dataspace. * * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 * * Modifications: * *------------------------------------------------------------------------- */ int H5Sget_simple_extent_ndims(hid_t space_id) { H5S_t *ds; int ret_value; FUNC_ENTER_API(H5Sget_simple_extent_ndims, FAIL) H5TRACE1("Is", "i", space_id); /* Check args */ if(NULL == (ds = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") ret_value = (int)H5S_GET_EXTENT_NDIMS(ds); done: FUNC_LEAVE_API(ret_value) } /* end H5Sget_simple_extent_ndims() */ /*------------------------------------------------------------------------- * Function: H5S_get_simple_extent_ndims * * Purpose: Returns the number of dimensions in a dataspace. * * Return: Success: Non-negative number of dimensions. Zero * implies a scalar. * * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 * * Note: This routine participates in the "Inlining C function pointers" * pattern, don't call it directly, use the appropriate macro * defined in H5Sprivate.h. * * Modifications: * *------------------------------------------------------------------------- */ int H5S_get_simple_extent_ndims(const H5S_t *ds) { int ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_get_simple_extent_ndims, FAIL) /* check args */ HDassert(ds); switch(H5S_GET_EXTENT_TYPE(ds)) { case H5S_NULL: case H5S_SCALAR: case H5S_SIMPLE: ret_value = (int)ds->extent.rank; break; default: HDassert("unknown dataspace class" && 0); HGOTO_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL, "internal error (unknown dataspace class)") } /* end switch */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_get_simple_extent_ndims() */ /*------------------------------------------------------------------------- * Function: H5Sget_simple_extent_dims * * Purpose: Returns the size and maximum sizes in each dimension of * a dataspace DS through the DIMS and MAXDIMS arguments. * * Return: Success: Number of dimensions, the same value as * returned by H5Sget_simple_extent_ndims(). * * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 * * Modifications: * June 18, 1998 Albert Cheng * Added maxdims argument. Removed dims argument check * since it can still return ndims even if both dims and * maxdims are NULLs. * *------------------------------------------------------------------------- */ int H5Sget_simple_extent_dims(hid_t space_id, hsize_t dims[]/*out*/, hsize_t maxdims[]/*out*/) { H5S_t *ds; int ret_value; FUNC_ENTER_API(H5Sget_simple_extent_dims, FAIL) H5TRACE3("Is", "ixx", space_id, dims, maxdims); /* Check args */ if (NULL == (ds = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") ret_value = H5S_get_simple_extent_dims(ds, dims, maxdims); done: FUNC_LEAVE_API(ret_value) } /*------------------------------------------------------------------------- * Function: H5S_extent_get_dims * * Purpose: Returns the size in each dimension of a dataspace. This * function may not be meaningful for all types of dataspaces. * * Return: Success: Number of dimensions. Zero implies scalar. * Failure: Negative * * Programmer: Quincey Koziol * Tuesday, June 30, 2009 * *------------------------------------------------------------------------- */ int H5S_extent_get_dims(const H5S_extent_t *ext, hsize_t dims[], hsize_t max_dims[]) { int i; /* Local index variable */ int ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_extent_get_dims, FAIL) /* check args */ HDassert(ext); switch(ext->type) { case H5S_NULL: case H5S_SCALAR: ret_value = 0; break; case H5S_SIMPLE: ret_value = (int)ext->rank; for(i = 0; i < ret_value; i++) { if(dims) dims[i] = ext->size[i]; if(max_dims) { if(ext->max) max_dims[i] = ext->max[i]; else max_dims[i] = ext->size[i]; } /* end if */ } /* end for */ break; default: HDassert("unknown dataspace class" && 0); HGOTO_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL, "internal error (unknown dataspace class)") } /* end switch */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_extent_get_dims() */ /*------------------------------------------------------------------------- * Function: H5S_get_simple_extent_dims * * Purpose: Returns the size in each dimension of a dataspace. This * function may not be meaningful for all types of dataspaces. * * Return: Success: Number of dimensions. Zero implies scalar. * * Failure: Negative * * Programmer: Robb Matzke * Thursday, December 11, 1997 * * Modifications: * *------------------------------------------------------------------------- */ int H5S_get_simple_extent_dims(const H5S_t *ds, hsize_t dims[], hsize_t max_dims[]) { int ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_get_simple_extent_dims, FAIL) /* check args */ HDassert(ds); /* Get dims for extent */ if((ret_value = H5S_extent_get_dims(&ds->extent, dims, max_dims)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTGET, FAIL, "can't retrieve dataspace extent dims") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_get_simple_extent_dims() */ /*------------------------------------------------------------------------- * Function: H5S_write * * Purpose: Updates a dataspace by writing a message to an object * header. * * Return: Non-negative on success/Negative on failure * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * *------------------------------------------------------------------------- */ herr_t H5S_write(H5F_t *f, hid_t dxpl_id, H5O_t *oh, unsigned update_flags, H5S_t *ds) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_write, FAIL) HDassert(f); HDassert(oh); HDassert(ds); HDassert(H5S_GET_EXTENT_TYPE(ds) >= 0); /* Write the current dataspace extent to the dataspace message */ if(H5O_msg_write_oh(f, dxpl_id, oh, H5O_SDSPACE_ID, 0, update_flags, &(ds->extent)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "can't update simple dataspace message") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_write() */ /*------------------------------------------------------------------------- * Function: H5S_append * * Purpose: Updates a dataspace by adding a message to an object * header. * * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Tuesday, December 31, 2002 * * Modifications: * * John Mainzer, 6/6/05 * Updated function to use the new dirtied parameter of * H5AC_unprotect() instead of manipulating the is_dirty * field of the cache info. * *------------------------------------------------------------------------- */ herr_t H5S_append(H5F_t *f, hid_t dxpl_id, H5O_t *oh, H5S_t *ds) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_append, FAIL) HDassert(f); HDassert(oh); HDassert(ds); HDassert(H5S_GET_EXTENT_TYPE(ds) >= 0); /* Add the dataspace message to the object header */ if(H5O_msg_append_oh(f, dxpl_id, oh, H5O_SDSPACE_ID, 0, 0, &(ds->extent)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "can't add simple dataspace message") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_append() */ /*------------------------------------------------------------------------- * Function: H5S_read * * Purpose: Reads the dataspace from an object header. * * Return: Success: Pointer to a new dataspace. * * Failure: NULL * * Programmer: Robb Matzke * Tuesday, December 9, 1997 * *------------------------------------------------------------------------- */ H5S_t * H5S_read(const H5O_loc_t *loc, hid_t dxpl_id) { H5S_t *ds = NULL; /* Dataspace to return */ H5S_t *ret_value; /* Return value */ FUNC_ENTER_NOAPI(H5S_read, NULL) /* check args */ HDassert(loc); if(NULL == (ds = H5FL_CALLOC(H5S_t))) HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed") if(H5O_msg_read(loc, H5O_SDSPACE_ID, &(ds->extent), dxpl_id) == NULL) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, NULL, "unable to load dataspace info from dataset header") /* Default to entire dataspace being selected */ if(H5S_select_all(ds, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTSET, NULL, "unable to set all selection") /* Set the value for successful return */ ret_value = ds; done: if(ret_value == NULL) { if(ds != NULL) ds = H5FL_FREE(H5S_t, ds); } /* end if */ FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_read() */ /*-------------------------------------------------------------------------- NAME H5S_is_simple PURPOSE Check if a dataspace is simple (internal) USAGE htri_t H5S_is_simple(sdim) H5S_t *sdim; IN: Pointer to dataspace object to query RETURNS TRUE/FALSE/FAIL DESCRIPTION This function determines the if a dataspace is "simple". ie. if it has orthogonal, evenly spaced dimensions. --------------------------------------------------------------------------*/ static htri_t H5S_is_simple(const H5S_t *sdim) { htri_t ret_value; FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_is_simple) /* Check args and all the boring stuff. */ HDassert(sdim); /* H5S_NULL shouldn't be simple dataspace */ ret_value = (H5S_GET_EXTENT_TYPE(sdim) == H5S_SIMPLE || H5S_GET_EXTENT_TYPE(sdim) == H5S_SCALAR) ? TRUE : FALSE; FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_is_simple() */ /*-------------------------------------------------------------------------- NAME H5Sis_simple PURPOSE Check if a dataspace is simple USAGE htri_t H5Sis_simple(space_id) hid_t space_id; IN: ID of dataspace object to query RETURNS TRUE/FALSE/FAIL DESCRIPTION This function determines the if a dataspace is "simple". ie. if it has orthogonal, evenly spaced dimensions. --------------------------------------------------------------------------*/ htri_t H5Sis_simple(hid_t space_id) { H5S_t *space; /* dataspace to modify */ htri_t ret_value; FUNC_ENTER_API(H5Sis_simple, FAIL) H5TRACE1("t", "i", space_id); /* Check args and all the boring stuff. */ if ((space = (H5S_t *)H5I_object_verify(space_id,H5I_DATASPACE)) == NULL) HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a dataspace") ret_value = H5S_is_simple(space); done: FUNC_LEAVE_API(ret_value) } /*-------------------------------------------------------------------------- NAME H5Sset_extent_simple PURPOSE Sets the size of a simple dataspace USAGE herr_t H5Sset_extent_simple(space_id, rank, dims, max) hid_t space_id; IN: Dataspace object to query int rank; IN: # of dimensions for the dataspace const size_t *dims; IN: Size of each dimension for the dataspace const size_t *max; IN: Maximum size of each dimension for the dataspace RETURNS Non-negative on success/Negative on failure DESCRIPTION This function sets the number and size of each dimension in the dataspace. Setting RANK to a value of zero converts the dataspace to a scalar dataspace. Dimensions are specified from slowest to fastest changing in the DIMS array (i.e. 'C' order). Setting the size of a dimension in the MAX array to zero indicates that the dimension is of unlimited size and should be allowed to expand. If MAX is NULL, the dimensions in the DIMS array are used as the maximum dimensions. Currently, only the first dimension in the array (the slowest) may be unlimited in size. MODIFICATION A null dataspace cannot be created from simple space with this function. Christian Chilan 01/17/2007 Verifies that each element of DIMS is not equal to H5S_UNLIMITED. Raymond Lu 03/30/2011 We allow 0-dimension for non-unlimited dimension starting from 1.8.7 release. Raymond Lu 04/11/2011 I added a condition check to make sure the new size won't exceed the current maximal size when this function is called to change the dimension size of an existent dataspace. --------------------------------------------------------------------------*/ herr_t H5Sset_extent_simple(hid_t space_id, int rank, const hsize_t dims[/*rank*/], const hsize_t max[/*rank*/]) { H5S_t *space; /* dataspace to modify */ int u; /* local counting variable */ herr_t ret_value=SUCCEED; /* Return value */ FUNC_ENTER_API(H5Sset_extent_simple, FAIL) H5TRACE4("e", "iIs*[a1]h*[a1]h", space_id, rank, dims, max); /* Check args */ if ((space = (H5S_t *)H5I_object_verify(space_id,H5I_DATASPACE)) == NULL) HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a dataspace") if (rank > 0 && dims == NULL) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no dimensions specified") if (rank<0 || rank>H5S_MAX_RANK) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid rank") if (dims) { for (u=0; uextent.rank; u++) { if(space->extent.max && H5S_UNLIMITED!=space->extent.max[u] && (space->extent.max[u]extent.max[u]extent) < 0) HGOTO_ERROR(H5E_RESOURCE, H5E_CANTFREE, FAIL, "failed to release previous dataspace extent") if(rank == 0) { /* scalar variable */ space->extent.type = H5S_SCALAR; space->extent.nelem = 1; space->extent.rank = 0; /* set to scalar rank */ } /* end if */ else { hsize_t nelem; /* Number of elements in extent */ space->extent.type = H5S_SIMPLE; /* Set the rank and allocate space for the dims */ space->extent.rank = rank; space->extent.size = (hsize_t *)H5FL_ARR_MALLOC(hsize_t, (size_t)rank); /* Copy the dimensions & compute the number of elements in the extent */ for(u = 0, nelem = 1; u < space->extent.rank; u++) { space->extent.size[u] = dims[u]; nelem *= dims[u]; } /* end for */ space->extent.nelem = nelem; /* Copy the maximum dimensions if specified. Otherwise, the maximal dimensions are the * same as the dimension */ space->extent.max = (hsize_t *)H5FL_ARR_MALLOC(hsize_t, (size_t)rank); if(max != NULL) { HDmemcpy(space->extent.max, max, sizeof(hsize_t) * rank); } else { for(u = 0; u < space->extent.rank; u++) space->extent.max[u] = dims[u]; } } /* end else */ /* Selection related cleanup */ /* Set offset to zeros */ for(u = 0; u < space->extent.rank; u++) space->select.offset[u] = 0; space->select.offset_changed = FALSE; /* If the selection is 'all', update the number of elements selected */ if(H5S_GET_SELECT_TYPE(space) == H5S_SEL_ALL) if(H5S_select_all(space, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection") done: FUNC_LEAVE_NOAPI(ret_value) } /* H5S_set_extent_simple() */ /*------------------------------------------------------------------------- * Function: H5Screate_simple * * Purpose: Creates a new simple dataspace object and opens it for * access. The DIMS argument is the size of the simple dataset * and the MAXDIMS argument is the upper limit on the size of * the dataset. MAXDIMS may be the null pointer in which case * the upper limit is the same as DIMS. If an element of * MAXDIMS is H5S_UNLIMITED then the corresponding dimension is * unlimited, otherwise no element of MAXDIMS should be smaller * than the corresponding element of DIMS. * * Return: Success: The ID for the new simple dataspace object. * * Failure: Negative * * Programmer: Quincey Koziol * Tuesday, January 27, 1998 * * Modification: * Raymond Lu 03/30/2011 * We allow 0-dimension for non-unlimited dimension starting * from 1.8.7 release. * *------------------------------------------------------------------------- */ hid_t H5Screate_simple(int rank, const hsize_t dims[/*rank*/], const hsize_t maxdims[/*rank*/]) { H5S_t *space = NULL; int i; hid_t ret_value; FUNC_ENTER_API(H5Screate_simple, FAIL) H5TRACE3("i", "Is*[a0]h*[a0]h", rank, dims, maxdims); /* Check arguments */ if(rank < 0) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "dimensionality cannot be negative") if(rank > H5S_MAX_RANK) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "dimensionality is too large") /* We allow users to use this function to create scalar or null dataspace. * Check DIMS isn't set when the RANK is 0. */ if(!dims && rank != 0) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid dataspace information") /* Check whether the current dimensions are valid */ for(i = 0; i < rank; i++) { if(H5S_UNLIMITED == dims[i]) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "current dimension must have a specific size, not H5S_UNLIMITED") if(maxdims && H5S_UNLIMITED != maxdims[i] && maxdims[i]extent)) == NULL) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOPY, NULL, "can't copy object") if(H5S_extent_release(extent) < 0) HGOTO_ERROR(H5E_RESOURCE, H5E_CANTDELETE, NULL, "can't release previous dataspace") extent = H5FL_FREE(H5S_extent_t, extent); /* Initialize to "all" selection. Deserialization relies on valid existing selection. */ if(H5S_select_all(ds, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTSET, NULL, "unable to set all selection") /* Decode the select part of dataspace. I believe this part always exists. */ if(H5S_SELECT_DESERIALIZE(ds, buf) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDECODE, NULL, "can't decode space selection") /* Set return value */ ret_value = ds; done: /* Release fake file structure */ if(f && H5F_fake_free(f) < 0) HDONE_ERROR(H5E_DATASPACE, H5E_CANTRELEASE, NULL, "unable to release fake file struct") FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_decode() */ /*------------------------------------------------------------------------- * Function: H5S_get_simple_extent_type * * Purpose: Internal function for retrieving the type of extent for a dataspace object * * Return: Success: The class of the dataspace object * * Failure: N5S_NO_CLASS * * Errors: * * Programmer: Quincey Koziol * Thursday, September 28, 2000 * * Note: This routine participates in the "Inlining C function pointers" * pattern, don't call it directly, use the appropriate macro * defined in H5Sprivate.h. * * Modifications: * *------------------------------------------------------------------------- */ H5S_class_t H5S_get_simple_extent_type(const H5S_t *space) { H5S_class_t ret_value; FUNC_ENTER_NOAPI(H5S_get_simple_extent_type, H5S_NO_CLASS) assert(space); ret_value=H5S_GET_EXTENT_TYPE(space); done: FUNC_LEAVE_NOAPI(ret_value) } /*------------------------------------------------------------------------- * Function: H5Sget_simple_extent_type * * Purpose: Retrieves the type of extent for a dataspace object * * Return: Success: The class of the dataspace object * * Failure: N5S_NO_CLASS * * Errors: * * Programmer: Quincey Koziol * Thursday, July 23, 1998 * * Modifications: * *------------------------------------------------------------------------- */ H5S_class_t H5Sget_simple_extent_type(hid_t sid) { H5S_t *space; H5S_class_t ret_value; FUNC_ENTER_API(H5Sget_simple_extent_type, H5S_NO_CLASS) H5TRACE1("Sc", "i", sid); /* Check arguments */ if (NULL == (space = (H5S_t *)H5I_object_verify(sid, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, H5S_NO_CLASS, "not a dataspace") ret_value=H5S_GET_EXTENT_TYPE(space); done: FUNC_LEAVE_API(ret_value) } /*-------------------------------------------------------------------------- NAME H5Sset_extent_none PURPOSE Resets the extent of a dataspace back to "none" USAGE herr_t H5Sset_extent_none(space_id) hid_t space_id; IN: Dataspace object to reset RETURNS Non-negative on success/Negative on failure DESCRIPTION This function resets the type of a dataspace back to "none" with no extent information stored for the dataspace. --------------------------------------------------------------------------*/ herr_t H5Sset_extent_none(hid_t space_id) { H5S_t *space; /* dataspace to modify */ herr_t ret_value=SUCCEED; /* Return value */ FUNC_ENTER_API(H5Sset_extent_none, FAIL) H5TRACE1("e", "i", space_id); /* Check args */ if (NULL == (space = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a dataspace") /* Clear the previous extent from the dataspace */ if(H5S_extent_release(&space->extent)<0) HGOTO_ERROR(H5E_RESOURCE, H5E_CANTDELETE, FAIL, "can't release previous dataspace") space->extent.type=H5S_NO_CLASS; done: FUNC_LEAVE_API(ret_value) } /* end H5Sset_extent_none() */ /*-------------------------------------------------------------------------- NAME H5Soffset_simple PURPOSE Changes the offset of a selection within a simple dataspace extent USAGE herr_t H5Soffset_simple(space_id, offset) hid_t space_id; IN: Dataspace object to reset const hssize_t *offset; IN: Offset to position the selection at RETURNS Non-negative on success/Negative on failure DESCRIPTION This function creates an offset for the selection within an extent, allowing the same shaped selection to be moved to different locations within a dataspace without requiring it to be re-defined. --------------------------------------------------------------------------*/ herr_t H5Soffset_simple(hid_t space_id, const hssize_t *offset) { H5S_t *space; /* dataspace to modify */ herr_t ret_value=SUCCEED; /* Return value */ FUNC_ENTER_API(H5Soffset_simple, FAIL) H5TRACE2("e", "i*Hs", space_id, offset); /* Check args */ if (NULL == (space = (H5S_t *)H5I_object_verify(space_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a dataspace") if (space->extent.rank==0 || (H5S_GET_EXTENT_TYPE(space)==H5S_SCALAR || H5S_GET_EXTENT_TYPE(space)==H5S_NULL)) HGOTO_ERROR(H5E_ATOM, H5E_UNSUPPORTED, FAIL, "can't set offset on scalar or null dataspace") if (offset == NULL) HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no offset specified") /* Set the selection offset */ if(H5S_select_offset(space,offset)<0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "can't set offset") done: FUNC_LEAVE_API(ret_value) } /* end H5Soffset_simple() */ /*------------------------------------------------------------------------- * Function: H5S_set_extent * * Purpose: Modify the dimensions of a dataspace. Based on H5S_extend * * Return: Success: Non-negative * Failure: Negative * * Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu * March 13, 2002 * *------------------------------------------------------------------------- */ htri_t H5S_set_extent(H5S_t *space, const hsize_t *size) { unsigned u; /* Local index variable */ htri_t ret_value = FALSE; /* Return value */ FUNC_ENTER_NOAPI(H5S_set_extent, FAIL) /* Check args */ HDassert(space && H5S_SIMPLE == H5S_GET_EXTENT_TYPE(space)); HDassert(size); /* Verify that the dimensions being changed are allowed to change */ for(u = 0; u < space->extent.rank; u++) { if(space->extent.size[u] != size[u]) { /* Check for invalid dimension size modification */ if(space->extent.max && H5S_UNLIMITED != space->extent.max[u] && space->extent.max[u] < size[u]) HGOTO_ERROR(H5E_DATASPACE, H5E_BADVALUE, FAIL, "dimension cannot be modified") /* Indicate that dimension size can be modified */ ret_value = TRUE; } /* end if */ } /* end for */ /* Update dimension size(s) */ if(ret_value) if(H5S_set_extent_real(space, size) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTSET, FAIL, "failed to change dimension size(s)") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_set_extent() */ /*------------------------------------------------------------------------- * Function: H5S_has_extent * * Purpose: Determines if a simple dataspace's extent has been set (e.g., * by H5Sset_extent_simple() ). Helps avoid write errors. * * Return: TRUE if dataspace has extent set * FALSE if dataspace's extent is uninitialized * * Programmer: James Laird * * Date: July 23, 2004 * *------------------------------------------------------------------------- */ hbool_t H5S_has_extent(const H5S_t *ds) { hbool_t ret_value; FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_has_extent) HDassert(ds); if(0 == ds->extent.rank && 0 == ds->extent.nelem && H5S_NULL != ds->extent.type) ret_value = FALSE; else ret_value = TRUE; FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_has_extent() */ /*------------------------------------------------------------------------- * Function: H5S_set_extent_real * * Purpose: Modify the dimensions of a dataspace. Based on H5S_extend * * Return: Success: Non-negative * Failure: Negative * * Programmer: Pedro Vicente, pvn@ncsa.uiuc.edu * March 13, 2002 * *------------------------------------------------------------------------- */ herr_t H5S_set_extent_real(H5S_t *space, const hsize_t *size) { hsize_t nelem; /* Number of elements in extent */ unsigned u; /* Local index variable */ herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_set_extent_real, FAIL) /* Check args */ HDassert(space && H5S_SIMPLE == H5S_GET_EXTENT_TYPE(space)); HDassert(size); /* Change the dataspace size & re-compute the number of elements in the extent */ for(u = 0, nelem = 1; u < space->extent.rank; u++ ) { space->extent.size[u] = size[u]; nelem *= size[u]; } /* end for */ space->extent.nelem = nelem; /* If the selection is 'all', update the number of elements selected */ if(H5S_SEL_ALL == H5S_GET_SELECT_TYPE(space)) if(H5S_select_all(space, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection") /* Mark the dataspace as no longer shared if it was before */ if(H5O_msg_reset_share(H5O_SDSPACE_ID, space) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTRESET, FAIL, "can't stop sharing dataspace") done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_set_extent_real() */ /*------------------------------------------------------------------------- * Function: H5Sextent_equal * * Purpose: Determines if two dataspace extents are equal. * * Return: Success: TRUE if equal, FALSE if unequal * * Failure: Negative * * Programmer: Quincey Koziol * Monday, October 24, 2005 * *------------------------------------------------------------------------- */ htri_t H5Sextent_equal(hid_t space1_id, hid_t space2_id) { const H5S_t *ds1, *ds2; /* Dataspaces to compare */ htri_t ret_value; FUNC_ENTER_API(H5Sextent_equal, FAIL) H5TRACE2("t", "ii", space1_id, space2_id); /* check args */ if(NULL == (ds1 = (const H5S_t *)H5I_object_verify(space1_id, H5I_DATASPACE)) || NULL == (ds2 = (const H5S_t *)H5I_object_verify(space2_id, H5I_DATASPACE))) HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace") /* Check dataspaces for extent's equality */ if((ret_value = H5S_extent_equal(ds1, ds2)) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTCOMPARE, FAIL, "dataspace comparison failed") done: FUNC_LEAVE_API(ret_value) } /* end H5Sextent_equal() */ /*-------------------------------------------------------------------------- NAME H5S_extent_equal PURPOSE Check if two dataspaces have equal extents USAGE htri_t H5S_extent_equal(ds1, ds2) H5S_t *ds1, *ds2; IN: Dataspace objects to compare RETURNS TRUE if equal, FALSE if unequal on succeess/Negative on failure DESCRIPTION Compare two dataspaces if their extents are identical. --------------------------------------------------------------------------*/ htri_t H5S_extent_equal(const H5S_t *ds1, const H5S_t *ds2) { unsigned u; /* Local index variable */ htri_t ret_value = TRUE; /* Return value */ FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_extent_equal) /* Check args */ HDassert(ds1); HDassert(ds2); /* Make certain the dataspaces are the same type */ if(ds1->extent.type != ds2->extent.type) HGOTO_DONE(FALSE) /* Make certain the dataspaces are the same rank */ if(ds1->extent.rank != ds2->extent.rank) HGOTO_DONE(FALSE) /* Make certain the dataspaces' current dimensions are the same size */ if(ds1->extent.rank > 0) { HDassert(ds1->extent.size); HDassert(ds2->extent.size); for(u = 0; u < ds1->extent.rank; u++) if(ds1->extent.size[u] != ds2->extent.size[u]) HGOTO_DONE(FALSE) } /* end if */ /* Make certain the dataspaces' maximum dimensions are the same size */ if(ds1->extent.rank > 0) { /* Check for no maximum dimensions on dataspaces */ if(ds1->extent.max != NULL && ds2->extent.max != NULL) { for(u = 0; u < ds1->extent.rank; u++) if(ds1->extent.max[u] != ds2->extent.max[u]) HGOTO_DONE(FALSE) } /* end if */ else if((ds1->extent.max == NULL && ds2->extent.max != NULL) || (ds1->extent.max != NULL && ds2->extent.max == NULL)) HGOTO_DONE(FALSE) } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_extent_equal() */ /*------------------------------------------------------------------------- * Function: H5S_extent_nelem * * Purpose: Determines how many elements a dataset extent describes. * * Return: Success: Number of data points in the dataset extent. * Failure: negative * * Programmer: Quincey Koziol * Thursday, November 30, 2006 * *------------------------------------------------------------------------- */ hsize_t H5S_extent_nelem(const H5S_extent_t *ext) { FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_extent_nelem) /* check args */ HDassert(ext); /* Return the number of elements in extent */ FUNC_LEAVE_NOAPI(ext->nelem) } /* end H5S_extent_nelem() */ /*------------------------------------------------------------------------- * Function: H5S_set_latest_version * * Purpose: Set the encoding for a dataspace to the latest version. * * Return: Non-negative on success/Negative on failure * * Programmer: Quincey Koziol * Tuesday, July 24, 2007 * *------------------------------------------------------------------------- */ herr_t H5S_set_latest_version(H5S_t *ds) { herr_t ret_value = SUCCEED; /* Return value */ FUNC_ENTER_NOAPI(H5S_set_latest_version, FAIL) /* Sanity check */ HDassert(ds); /* Set encoding of extent to latest version */ ds->extent.version = H5O_SDSPACE_VERSION_LATEST; done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_set_latest_version() */ #ifndef H5_NO_DEPRECATED_SYMBOLS /*------------------------------------------------------------------------- * Function: H5S_extend * * Purpose: Extend the dimensions of a dataspace. * * Return: Success: Number of dimensions whose size increased. * * Failure: Negative * * Programmer: Robb Matzke * Friday, January 30, 1998 * *------------------------------------------------------------------------- */ int H5S_extend(H5S_t *space, const hsize_t *size) { unsigned u; int ret_value = 0; FUNC_ENTER_NOAPI(H5S_extend, FAIL) /* Check args */ HDassert(space && H5S_SIMPLE == H5S_GET_EXTENT_TYPE(space)); HDassert(size); /* Check through all the dimensions to see if modifying the dataspace is allowed */ for(u = 0; u < space->extent.rank; u++) { if(space->extent.size[u]extent.max && H5S_UNLIMITED!=space->extent.max[u] && space->extent.max[u]extent.rank; u++) { if(space->extent.size[u] < size[u]) space->extent.size[u] = size[u]; nelem *= space->extent.size[u]; } /* end for */ space->extent.nelem = nelem; /* If the selection is 'all', update the number of elements selected */ if(H5S_GET_SELECT_TYPE(space) == H5S_SEL_ALL) if(H5S_select_all(space, FALSE) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection") /* Mark the dataspace as no longer shared if it was before */ if(H5O_msg_reset_share(H5O_SDSPACE_ID, space) < 0) HGOTO_ERROR(H5E_DATASPACE, H5E_CANTRESET, FAIL, "can't stop sharing dataspace") } /* end if */ done: FUNC_LEAVE_NOAPI(ret_value) } /* end H5S_extend() */ #endif /* H5_NO_DEPRECATED_SYMBOLS */