mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-01-12 15:04:59 +08:00
6b45f5172c
Code cleanup Description: Trim trailing whitespace, which is making 'diff'ing the two branches difficult. Solution: Ran this script in each directory: foreach f (*.[ch] *.cpp) sed 's/[[:blank:]]*$//' $f > sed.out && mv sed.out $f end Platforms tested: FreeBSD 4.11 (sleipnir) Too minor to require h5committest
786 lines
24 KiB
C
786 lines
24 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||
* 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
|
||
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
|
||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||
|
||
/*
|
||
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
|
||
* Tuesday, November 10, 1998
|
||
*
|
||
* Purpose: "None" selection data space I/O functions.
|
||
*/
|
||
|
||
#define H5S_PACKAGE /*suppress error about including H5Spkg */
|
||
|
||
|
||
#include "H5private.h"
|
||
#include "H5Eprivate.h"
|
||
#include "H5Iprivate.h"
|
||
#include "H5Spkg.h"
|
||
#include "H5Vprivate.h"
|
||
#include "H5Dprivate.h"
|
||
|
||
/* Static function prototypes */
|
||
|
||
/* Selection callbacks */
|
||
static herr_t H5S_none_copy(H5S_t *dst, const H5S_t *src, hbool_t share_selection);
|
||
static herr_t H5S_none_get_seq_list(const H5S_t *space, unsigned flags,
|
||
H5S_sel_iter_t *iter, size_t maxseq, size_t maxbytes,
|
||
size_t *nseq, size_t *nbytes, hsize_t *off, size_t *len);
|
||
static herr_t H5S_none_release(H5S_t *space);
|
||
static htri_t H5S_none_is_valid(const H5S_t *space);
|
||
static hssize_t H5S_none_serial_size(const H5S_t *space);
|
||
static herr_t H5S_none_serialize(const H5S_t *space, uint8_t *buf);
|
||
static herr_t H5S_none_deserialize(H5S_t *space, const uint8_t *buf);
|
||
static herr_t H5S_none_bounds(const H5S_t *space, hsize_t *start, hsize_t *end);
|
||
static htri_t H5S_none_is_contiguous(const H5S_t *space);
|
||
static htri_t H5S_none_is_single(const H5S_t *space);
|
||
static htri_t H5S_none_is_regular(const H5S_t *space);
|
||
static herr_t H5S_none_iter_init(H5S_sel_iter_t *iter, const H5S_t *space);
|
||
|
||
/* Selection iteration callbacks */
|
||
static herr_t H5S_none_iter_coords(const H5S_sel_iter_t *iter, hsize_t *coords);
|
||
static herr_t H5S_none_iter_block(const H5S_sel_iter_t *iter, hsize_t *start, hsize_t *end);
|
||
static hsize_t H5S_none_iter_nelmts(const H5S_sel_iter_t *iter);
|
||
static htri_t H5S_none_iter_has_next_block(const H5S_sel_iter_t *iter);
|
||
static herr_t H5S_none_iter_next(H5S_sel_iter_t *sel_iter, size_t nelem);
|
||
static herr_t H5S_none_iter_next_block(H5S_sel_iter_t *sel_iter);
|
||
static herr_t H5S_none_iter_release(H5S_sel_iter_t *sel_iter);
|
||
|
||
/* Selection properties for "none" selections */
|
||
const H5S_select_class_t H5S_sel_none[1] = {{
|
||
H5S_SEL_NONE,
|
||
|
||
/* Methods on selection */
|
||
H5S_none_copy,
|
||
H5S_none_get_seq_list,
|
||
H5S_none_release,
|
||
H5S_none_is_valid,
|
||
H5S_none_serial_size,
|
||
H5S_none_serialize,
|
||
H5S_none_deserialize,
|
||
H5S_none_bounds,
|
||
H5S_none_is_contiguous,
|
||
H5S_none_is_single,
|
||
H5S_none_is_regular,
|
||
H5S_none_iter_init,
|
||
}};
|
||
|
||
/* Iteration properties for "none" selections */
|
||
static const H5S_sel_iter_class_t H5S_sel_iter_none[1] = {{
|
||
H5S_SEL_NONE,
|
||
|
||
/* Methods on selection iterator */
|
||
H5S_none_iter_coords,
|
||
H5S_none_iter_block,
|
||
H5S_none_iter_nelmts,
|
||
H5S_none_iter_has_next_block,
|
||
H5S_none_iter_next,
|
||
H5S_none_iter_next_block,
|
||
H5S_none_iter_release,
|
||
}};
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5S_none_iter_init
|
||
*
|
||
* Purpose: Initializes iteration information for "none" selection.
|
||
*
|
||
* Return: non-negative on success, negative on failure.
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Tuesday, June 16, 1998
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5S_none_iter_init (H5S_sel_iter_t *iter, const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOFUNC(H5S_none_iter_init);
|
||
|
||
/* Check args */
|
||
assert (space && H5S_SEL_NONE==H5S_GET_SELECT_TYPE(space));
|
||
assert (iter);
|
||
|
||
/* Initialize type of selection iterator */
|
||
iter->type=H5S_sel_iter_none;
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* H5S_none_iter_init() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5S_none_iter_coords
|
||
*
|
||
* Purpose: Retrieve the current coordinates of iterator for current
|
||
* selection
|
||
*
|
||
* Return: non-negative on success, negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Tuesday, April 22, 2003
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5S_none_iter_coords (const H5S_sel_iter_t UNUSED *iter, hsize_t UNUSED *coords)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_coords);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
assert (coords);
|
||
|
||
FUNC_LEAVE_NOAPI(FAIL);
|
||
} /* H5S_none_iter_coords() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5S_none_iter_block
|
||
*
|
||
* Purpose: Retrieve the current block of iterator for current
|
||
* selection
|
||
*
|
||
* Return: non-negative on success, negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Monday, June 2, 2003
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5S_none_iter_block (const H5S_sel_iter_t UNUSED *iter, hsize_t UNUSED *start, hsize_t UNUSED *end)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_block);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
assert (start);
|
||
assert (end);
|
||
|
||
FUNC_LEAVE_NOAPI(FAIL);
|
||
} /* H5S_none_iter_block() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5S_none_iter_nelmts
|
||
*
|
||
* Purpose: Return number of elements left to process in iterator
|
||
*
|
||
* Return: non-negative number of elements on success, zero on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Tuesday, June 16, 1998
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static hsize_t
|
||
H5S_none_iter_nelmts (const H5S_sel_iter_t UNUSED *iter)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_nelmts);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
|
||
FUNC_LEAVE_NOAPI(0);
|
||
} /* H5S_none_iter_nelmts() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_iter_has_next_block
|
||
PURPOSE
|
||
Check if there is another block left in the current iterator
|
||
USAGE
|
||
htri_t H5S_none_iter_has_next_block(iter)
|
||
const H5S_sel_iter_t *iter; IN: Pointer to selection iterator
|
||
RETURNS
|
||
Non-negative (TRUE/FALSE) on success/Negative on failure
|
||
DESCRIPTION
|
||
Check if there is another block available in the selection iterator.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static htri_t
|
||
H5S_none_iter_has_next_block(const H5S_sel_iter_t UNUSED *iter)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_has_next_block);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
|
||
FUNC_LEAVE_NOAPI(FAIL);
|
||
} /* H5S_none_iter_has_next_block() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_iter_next
|
||
PURPOSE
|
||
Increment selection iterator
|
||
USAGE
|
||
herr_t H5S_none_iter_next(iter, nelem)
|
||
H5S_sel_iter_t *iter; IN: Pointer to selection iterator
|
||
size_t nelem; IN: Number of elements to advance by
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Advance selection iterator to the NELEM'th next element in the selection.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_iter_next(H5S_sel_iter_t UNUSED *iter, size_t UNUSED nelem)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_next);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
assert (nelem>0);
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* H5S_none_iter_next() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_iter_next_block
|
||
PURPOSE
|
||
Increment selection iterator to next block
|
||
USAGE
|
||
herr_t H5S_none_iter_next(iter)
|
||
H5S_sel_iter_t *iter; IN: Pointer to selection iterator
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Advance selection iterator to the next block in the selection.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_iter_next_block(H5S_sel_iter_t UNUSED *iter)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_next);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
|
||
FUNC_LEAVE_NOAPI(FAIL);
|
||
} /* H5S_none_iter_next_block() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_iter_release
|
||
PURPOSE
|
||
Release "none" selection iterator information for a dataspace
|
||
USAGE
|
||
herr_t H5S_none_iter_release(iter)
|
||
H5S_sel_iter_t *iter; IN: Pointer to selection iterator
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Releases all information for a dataspace "none" selection iterator
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_iter_release (H5S_sel_iter_t UNUSED * iter)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_iter_release);
|
||
|
||
/* Check args */
|
||
assert (iter);
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* H5S_none_iter_release() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_release
|
||
PURPOSE
|
||
Release none selection information for a dataspace
|
||
USAGE
|
||
herr_t H5S_none_release(space)
|
||
H5S_t *space; IN: Pointer to dataspace
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Releases "none" selection information for a dataspace
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_release (H5S_t UNUSED * space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_release);
|
||
|
||
/* Check args */
|
||
assert (space);
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* H5S_none_release() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_copy
|
||
PURPOSE
|
||
Copy a selection from one dataspace to another
|
||
USAGE
|
||
herr_t H5S_none_copy(dst, src)
|
||
H5S_t *dst; OUT: Pointer to the destination dataspace
|
||
H5S_t *src; IN: Pointer to the source dataspace
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Copies the 'none' selection information from the source
|
||
dataspace to the destination dataspace.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_copy(H5S_t *dst, const H5S_t UNUSED *src, hbool_t UNUSED share_selection)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_copy);
|
||
|
||
assert(src);
|
||
assert(dst);
|
||
|
||
/* Set number of elements in selection */
|
||
dst->select.num_elem=0;
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* end H5S_none_copy() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_is_valid
|
||
PURPOSE
|
||
Check whether the selection fits within the extent, with the current
|
||
offset defined.
|
||
USAGE
|
||
htri_t H5S_none_is_valid(space);
|
||
H5S_t *space; IN: Dataspace pointer to query
|
||
RETURNS
|
||
TRUE if the selection fits within the extent, FALSE if it does not and
|
||
Negative on an error.
|
||
DESCRIPTION
|
||
Determines if the current selection at the current offet fits within the
|
||
extent for the dataspace. Offset is irrelevant for this type of selection.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static htri_t
|
||
H5S_none_is_valid (const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_is_valid);
|
||
|
||
assert(space);
|
||
|
||
FUNC_LEAVE_NOAPI(TRUE);
|
||
} /* end H5S_none_is_valid() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_serial_size
|
||
PURPOSE
|
||
Determine the number of bytes needed to store the serialized "none"
|
||
selection information.
|
||
USAGE
|
||
hssize_t H5S_none_serial_size(space)
|
||
H5S_t *space; IN: Dataspace pointer to query
|
||
RETURNS
|
||
The number of bytes required on success, negative on an error.
|
||
DESCRIPTION
|
||
Determines the number of bytes required to serialize an "none"
|
||
selection for storage on disk.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static hssize_t
|
||
H5S_none_serial_size (const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_serial_size);
|
||
|
||
assert(space);
|
||
|
||
/* Basic number of bytes required to serialize point selection:
|
||
* <type (4 bytes)> + <version (4 bytes)> + <padding (4 bytes)> +
|
||
* <length (4 bytes)> = 16 bytes
|
||
*/
|
||
FUNC_LEAVE_NOAPI(16);
|
||
} /* end H5S_none_serial_size() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_serialize
|
||
PURPOSE
|
||
Serialize the current selection into a user-provided buffer.
|
||
USAGE
|
||
herr_t H5S_none_serialize(space, buf)
|
||
H5S_t *space; IN: Dataspace pointer of selection to serialize
|
||
uint8 *buf; OUT: Buffer to put serialized selection into
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Serializes the current element selection into a buffer. (Primarily for
|
||
storing on disk).
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_serialize (const H5S_t *space, uint8_t *buf)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_serialize);
|
||
|
||
assert(space);
|
||
|
||
/* Store the preamble information */
|
||
UINT32ENCODE(buf, (uint32_t)H5S_GET_SELECT_TYPE(space)); /* Store the type of selection */
|
||
UINT32ENCODE(buf, (uint32_t)1); /* Store the version number */
|
||
UINT32ENCODE(buf, (uint32_t)0); /* Store the un-used padding */
|
||
UINT32ENCODE(buf, (uint32_t)0); /* Store the additional information length */
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* H5S_none_serialize() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_deserialize
|
||
PURPOSE
|
||
Deserialize the current selection from a user-provided buffer.
|
||
USAGE
|
||
herr_t H5S_none_deserialize(space, buf)
|
||
H5S_t *space; IN/OUT: Dataspace pointer to place selection into
|
||
uint8 *buf; IN: Buffer to retrieve serialized selection from
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Deserializes the current selection into a buffer. (Primarily for retrieving
|
||
from disk).
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_deserialize (H5S_t *space, const uint8_t UNUSED *buf)
|
||
{
|
||
herr_t ret_value; /* return value */
|
||
|
||
FUNC_ENTER_NOAPI_NOINIT(H5S_none_deserialize);
|
||
|
||
assert(space);
|
||
|
||
/* Change to "none" selection */
|
||
if((ret_value=H5S_select_none(space))<0)
|
||
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection");
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
} /* H5S_none_deserialize() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_bounds
|
||
PURPOSE
|
||
Gets the bounding box containing the selection.
|
||
USAGE
|
||
herr_t H5S_none_bounds(space, start, end)
|
||
H5S_t *space; IN: Dataspace pointer of selection to query
|
||
hsize_t *start; OUT: Starting coordinate of bounding box
|
||
hsize_t *end; OUT: Opposite coordinate of bounding box
|
||
RETURNS
|
||
Non-negative on success, negative on failure
|
||
DESCRIPTION
|
||
Retrieves the bounding box containing the current selection and places
|
||
it into the user's buffers. The start and end buffers must be large
|
||
enough to hold the dataspace rank number of coordinates. The bounding box
|
||
exactly contains the selection, ie. if a 2-D element selection is currently
|
||
defined with the following points: (4,5), (6,8) (10,7), the bounding box
|
||
with be (4, 5), (10, 8). Calling this function on a "none" selection
|
||
returns fail.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_bounds(const H5S_t UNUSED *space, hsize_t UNUSED *start, hsize_t UNUSED *end)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_bounds);
|
||
|
||
assert(space);
|
||
assert(start);
|
||
assert(end);
|
||
|
||
FUNC_LEAVE_NOAPI(FAIL);
|
||
} /* H5Sget_none_bounds() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_is_contiguous
|
||
PURPOSE
|
||
Check if a "none" selection is contiguous within the dataspace extent.
|
||
USAGE
|
||
htri_t H5S_all_is_contiguous(space)
|
||
H5S_t *space; IN: Dataspace pointer to check
|
||
RETURNS
|
||
TRUE/FALSE/FAIL
|
||
DESCRIPTION
|
||
Checks to see if the current selection in the dataspace is contiguous.
|
||
This is primarily used for reading the entire selection in one swoop.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static htri_t
|
||
H5S_none_is_contiguous(const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_is_contiguous);
|
||
|
||
assert(space);
|
||
|
||
FUNC_LEAVE_NOAPI(FALSE);
|
||
} /* H5S_none_is_contiguous() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_is_single
|
||
PURPOSE
|
||
Check if a "none" selection is a single block within the dataspace extent.
|
||
USAGE
|
||
htri_t H5S_none_is_single(space)
|
||
H5S_t *space; IN: Dataspace pointer to check
|
||
RETURNS
|
||
TRUE/FALSE/FAIL
|
||
DESCRIPTION
|
||
Checks to see if the current selection in the dataspace is a single block.
|
||
This is primarily used for reading the entire selection in one swoop.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static htri_t
|
||
H5S_none_is_single(const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_is_single);
|
||
|
||
assert(space);
|
||
|
||
FUNC_LEAVE_NOAPI(FALSE);
|
||
} /* H5S_none_is_single() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_is_regular
|
||
PURPOSE
|
||
Check if a "none" selection is "regular"
|
||
USAGE
|
||
htri_t H5S_none_is_regular(space)
|
||
const H5S_t *space; IN: Dataspace pointer to check
|
||
RETURNS
|
||
TRUE/FALSE/FAIL
|
||
DESCRIPTION
|
||
Checks to see if the current selection in a dataspace is the a regular
|
||
pattern.
|
||
This is primarily used for reading the entire selection in one swoop.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static htri_t
|
||
H5S_none_is_regular(const H5S_t UNUSED *space)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_is_regular);
|
||
|
||
/* Check args */
|
||
assert(space);
|
||
|
||
FUNC_LEAVE_NOAPI(TRUE);
|
||
} /* H5S_none_is_regular() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_select_none
|
||
PURPOSE
|
||
Specify that nothing is selected in the extent
|
||
USAGE
|
||
herr_t H5S_select_none(dsid)
|
||
hid_t dsid; IN: Dataspace ID of selection to modify
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
This function de-selects the entire extent for a dataspace.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
herr_t H5S_select_none (H5S_t *space)
|
||
{
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_NOAPI(H5S_select_none, FAIL);
|
||
|
||
/* Check args */
|
||
assert(space);
|
||
|
||
/* Remove current selection first */
|
||
if(H5S_SELECT_RELEASE(space)<0)
|
||
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't release hyperslab");
|
||
|
||
/* Set number of elements in selection */
|
||
space->select.num_elem=0;
|
||
|
||
/* Set selection type */
|
||
space->select.type=H5S_sel_none;
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
} /* H5S_select_none() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5Sselect_none
|
||
PURPOSE
|
||
Specify that nothing is selected in the extent
|
||
USAGE
|
||
herr_t H5Sselect_none(dsid)
|
||
hid_t dsid; IN: Dataspace ID of selection to modify
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
This function de-selects the entire extent for a dataspace.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
herr_t H5Sselect_none (hid_t spaceid)
|
||
{
|
||
H5S_t *space = NULL; /* Dataspace to modify selection of */
|
||
herr_t ret_value; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Sselect_none, FAIL);
|
||
|
||
/* Check args */
|
||
if (NULL == (space=H5I_object_verify(spaceid, H5I_DATASPACE)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
|
||
|
||
/* Change to "none" selection */
|
||
if((ret_value=H5S_select_none(space))<0)
|
||
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* H5Sselect_none() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5S_none_get_seq_list
|
||
PURPOSE
|
||
Create a list of offsets & lengths for a selection
|
||
USAGE
|
||
herr_t H5S_all_get_seq_list(space,flags,iter,maxseq,maxelem,nseq,nelem,off,len)
|
||
H5S_t *space; IN: Dataspace containing selection to use.
|
||
unsigned flags; IN: Flags for extra information about operation
|
||
H5S_sel_iter_t *iter; IN/OUT: Selection iterator describing last
|
||
position of interest in selection.
|
||
size_t maxseq; IN: Maximum number of sequences to generate
|
||
size_t maxelem; IN: Maximum number of elements to include in the
|
||
generated sequences
|
||
size_t *nseq; OUT: Actual number of sequences generated
|
||
size_t *nelem; OUT: Actual number of elements in sequences generated
|
||
hsize_t *off; OUT: Array of offsets
|
||
size_t *len; OUT: Array of lengths
|
||
RETURNS
|
||
Non-negative on success/Negative on failure.
|
||
DESCRIPTION
|
||
Use the selection in the dataspace to generate a list of byte offsets and
|
||
lengths for the region(s) selected. Start/Restart from the position in the
|
||
ITER parameter. The number of sequences generated is limited by the MAXSEQ
|
||
parameter and the number of sequences actually generated is stored in the
|
||
NSEQ parameter.
|
||
GLOBAL VARIABLES
|
||
COMMENTS, BUGS, ASSUMPTIONS
|
||
EXAMPLES
|
||
REVISION LOG
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5S_none_get_seq_list(const H5S_t UNUSED *space, unsigned UNUSED flags, H5S_sel_iter_t UNUSED *iter,
|
||
size_t UNUSED maxseq, size_t UNUSED maxelem, size_t *nseq, size_t *nelem,
|
||
hsize_t UNUSED *off, size_t UNUSED *len)
|
||
{
|
||
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5S_none_get_seq_list);
|
||
|
||
/* Check args */
|
||
assert(space);
|
||
assert(iter);
|
||
assert(maxseq>0);
|
||
assert(maxelem>0);
|
||
assert(nseq);
|
||
assert(nelem);
|
||
assert(off);
|
||
assert(len);
|
||
|
||
/* "none" selections don't generate sequences of bytes */
|
||
*nseq=0;
|
||
|
||
/* They don't use any elements, either */
|
||
*nelem=0;
|
||
|
||
FUNC_LEAVE_NOAPI(SUCCEED);
|
||
} /* end H5S_all_get_seq_list() */
|