mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-12-09 07:32:32 +08:00
Code Issues Packages Projects Releases Wiki Activity
17275779d0
hdf5/src/H5Spoint.c
Quincey Koziol 17275779d0 [svn-r5839] Purpose: 
Code cleanup

Description:
    Move operations on each type of selection into the source code file for
    each selection type (all->H5Sall.c, hyperslab->H5Shyper.c, etc.)

    Remove central H5S_select_<foo> operations, instead calling the operations
    through function pointers in each selection (a much more object-oriented
    approach).

Platforms tested:
    FreeBSD 4.6 (sleipnir)
2002-07-31 10:27:07 -05:00

1233 lines
42 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright (C) 1998-2001 NCSA
* All rights reserved.
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* Tuesday, June 16, 1998
*
* Purpose: Point selection data space I/O functions.
*/
#define H5S_PACKAGE /*suppress error about including H5Spkg */
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5FLprivate.h" /* Free Lists */
#include "H5Iprivate.h" /* ID Functions */
#include "H5MMprivate.h" /* Memory Management functions */
#include "H5Spkg.h" /* Dataspace functions */
#include "H5Vprivate.h" /* Vector functions */
/* Interface initialization */
#define PABLO_MASK H5Spoint_mask
#define INTERFACE_INIT NULL
static int interface_initialize_g = 0;
/* Declare a free list to manage the H5S_pnt_node_t struct */
H5FL_DEFINE_STATIC(H5S_pnt_node_t);
/* Declare a free list to manage the H5S_pnt_list_t struct */
H5FL_DEFINE_STATIC(H5S_pnt_list_t);
/*-------------------------------------------------------------------------
* Function: H5S_point_iter_init
*
* Purpose: Initializes iteration information for point selection.
*
* Return: non-negative on success, negative on failure.
*
* Programmer: Quincey Koziol
* Tuesday, June 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5S_point_iter_init(const H5S_t *space, size_t UNUSED elmt_size, H5S_sel_iter_t *sel_iter)
{
FUNC_ENTER_NOAPI(H5S_point_iter_init, FAIL);
/* Check args */
assert (space && H5S_SEL_POINTS==space->select.type);
assert (sel_iter);
/* Initialize the number of points to iterate over */
sel_iter->pnt.elmt_left=space->select.num_elem;
/* Start at the head of the list of points */
sel_iter->pnt.curr=space->select.sel_info.pnt_lst->head;
FUNC_LEAVE (SUCCEED);
} /* H5S_point_iter_init() */
/*-------------------------------------------------------------------------
* Function: H5S_point_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:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5S_point_iter_nelmts (const H5S_sel_iter_t *sel_iter)
{
FUNC_ENTER_NOAPI(H5S_point_iter_nelmts, 0);
/* Check args */
assert (sel_iter);
FUNC_LEAVE (sel_iter->pnt.elmt_left);
} /* H5S_point_iter_nelmts() */
/*--------------------------------------------------------------------------
NAME
H5S_point_iter_release
PURPOSE
Release point selection iterator information for a dataspace
USAGE
herr_t H5S_point_iter_release(sel_iter)
H5S_sel_iter_t *sel_iter; IN: Pointer to selection iterator
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Releases all information for a dataspace point selection iterator
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_point_iter_release (H5S_sel_iter_t * UNUSED sel_iter)
{
FUNC_ENTER_NOAPI(H5S_point_iter_release, FAIL);
/* Check args */
assert (sel_iter);
FUNC_LEAVE (SUCCEED);
} /* H5S_point_iter_release() */
/*--------------------------------------------------------------------------
NAME
H5S_point_add
PURPOSE
Add a series of elements to a point selection
USAGE
herr_t H5S_point_add(space, num_elem, coord)
H5S_t *space; IN: Dataspace of selection to modify
size_t num_elem; IN: Number of elements in COORD array.
const hssize_t *coord[]; IN: The location of each element selected
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function adds elements to the current point selection for a dataspace
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_point_add (H5S_t *space, H5S_seloper_t op, size_t num_elem, const hssize_t **_coord)
{
H5S_pnt_node_t *top, *curr, *new_node; /* Point selection nodes */
const hssize_t *coord=(const hssize_t *)_coord; /* Pointer to the actual coordinates */
unsigned i; /* Counter */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_add, FAIL);
assert(space);
assert(num_elem>0);
assert(coord);
assert(op==H5S_SELECT_SET || op==H5S_SELECT_APPEND || op==H5S_SELECT_PREPEND);
top=curr=NULL;
for(i=0; i<num_elem; i++) {
/* Allocate space for the new node */
if((new_node = H5FL_ALLOC(H5S_pnt_node_t,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"can't allocate point node");
if((new_node->pnt = H5MM_malloc(space->extent.u.simple.rank*sizeof(hssize_t)))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"can't allocate coordinate information");
/* Copy over the coordinates */
HDmemcpy(new_node->pnt,coord+(i*space->extent.u.simple.rank),(space->extent.u.simple.rank*sizeof(hssize_t)));
/* Link into list */
new_node->next=NULL;
if(top==NULL)
top=new_node;
else
curr->next=new_node;
curr=new_node;
} /* end for */
/* Insert the list of points selected in the proper place */
if(op==H5S_SELECT_SET || op==H5S_SELECT_PREPEND) {
/* Append current list, if there is one */
if(space->select.sel_info.pnt_lst->head!=NULL)
curr->next=space->select.sel_info.pnt_lst->head;
/* Put new list in point selection */
space->select.sel_info.pnt_lst->head=top;
} /* end if */
else { /* op==H5S_SELECT_APPEND */
new_node=space->select.sel_info.pnt_lst->head;
if(new_node!=NULL) {
while(new_node->next!=NULL)
new_node=new_node->next;
/* Append new list to point selection */
new_node->next=top;
} /* end if */
else
space->select.sel_info.pnt_lst->head=top;
} /* end else */
/* Add the number of elements in the new selection */
space->select.num_elem+=num_elem;
ret_value=SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5S_point_add() */
/*--------------------------------------------------------------------------
NAME
H5S_point_release
PURPOSE
Release point selection information for a dataspace
USAGE
herr_t H5S_point_release(space)
H5S_t *space; IN: Pointer to dataspace
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Releases all point selection information for a dataspace
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_point_release (H5S_t *space)
{
H5S_pnt_node_t *curr, *next; /* Point selection nodes */
FUNC_ENTER_NOAPI(H5S_point_release, FAIL);
/* Check args */
assert (space);
/* Delete all the nodes from the list */
curr=space->select.sel_info.pnt_lst->head;
while(curr!=NULL) {
next=curr->next;
H5MM_xfree(curr->pnt);
H5FL_FREE(H5S_pnt_node_t,curr);
curr=next;
} /* end while */
/* Free & reset the point list header */
H5FL_FREE(H5S_pnt_list_t,space->select.sel_info.pnt_lst);
space->select.sel_info.pnt_lst=NULL;
/* Reset the number of elements in the selection */
space->select.num_elem=0;
FUNC_LEAVE (SUCCEED);
} /* H5S_point_release() */
/*--------------------------------------------------------------------------
NAME
H5S_point_npoints
PURPOSE
Compute number of elements in current selection
USAGE
hsize_t H5S_point_npoints(space)
H5S_t *space; IN: Pointer to dataspace
RETURNS
The number of elements in selection on success, 0 on failure
DESCRIPTION
Compute number of elements in current selection.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hsize_t
H5S_point_npoints (const H5S_t *space)
{
FUNC_ENTER_NOAPI(H5S_point_npoints, 0);
/* Check args */
assert (space);
FUNC_LEAVE (space->select.num_elem);
} /* H5S_point_npoints() */
/*--------------------------------------------------------------------------
NAME
H5S_select_elements
PURPOSE
Specify a series of elements in the dataspace to select
USAGE
herr_t H5S_select_elements(dsid, op, num_elem, coord)
hid_t dsid; IN: Dataspace ID of selection to modify
H5S_seloper_t op; IN: Operation to perform on current selection
size_t num_elem; IN: Number of elements in COORD array.
const hssize_t **coord; IN: The location of each element selected
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function selects array elements to be included in the selection for
the dataspace. The COORD array is a 2-D array of size <dataspace rank>
by NUM_ELEM (ie. a list of coordinates in the dataspace). The order of
the element coordinates in the COORD array specifies the order that the
array elements are iterated through when I/O is performed. Duplicate
coordinates are not checked for. The selection operator, OP, determines
how the new selection is to be combined with the existing selection for
the dataspace. Currently, only H5S_SELECT_SET is supported, which replaces
the existing selection with the one defined in this call. When operators
other than H5S_SELECT_SET are used to combine a new selection with an
existing selection, the selection ordering is reset to 'C' array ordering.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_select_elements (H5S_t *space, H5S_seloper_t op, size_t num_elem,
const hssize_t **coord)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOINIT(H5S_select_elements);
/* Check args */
assert(space);
assert(num_elem);
assert(coord);
assert(op==H5S_SELECT_SET || op==H5S_SELECT_APPEND || op==H5S_SELECT_PREPEND);
/* If we are setting a new selection, remove current selection first */
if(op==H5S_SELECT_SET) {
if((*space->select.release)(space)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't release point selection");
} /* end if */
/* Allocate space for the point selection information if necessary */
if(space->select.type!=H5S_SEL_POINTS || space->select.sel_info.pnt_lst==NULL) {
if((space->select.sel_info.pnt_lst = H5FL_ALLOC(H5S_pnt_list_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate element information");
} /* end if */
/* Add points to selection */
if(H5S_point_add(space,op,num_elem,coord)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINSERT, FAIL, "can't insert elements");
/* Set selection type */
space->select.type=H5S_SEL_POINTS;
/* Set selection methods */
space->select.get_seq_list=H5S_point_get_seq_list;
space->select.get_npoints=H5S_point_npoints;
space->select.release=H5S_point_release;
space->select.iter_init=H5S_point_iter_init;
space->select.iter_nelmts=H5S_point_iter_nelmts;
space->select.iter_release=H5S_point_iter_release;
space->select.is_valid=H5S_point_is_valid;
space->select.serial_size=H5S_point_serial_size;
space->select.serialize=H5S_point_serialize;
space->select.bounds=H5S_point_bounds;
space->select.is_contiguous=H5S_point_is_contiguous;
space->select.is_single=H5S_point_is_single;
space->select.is_regular=H5S_point_is_regular;
done:
FUNC_LEAVE (ret_value);
} /* H5S_select_elements() */
/*--------------------------------------------------------------------------
NAME
H5S_point_copy
PURPOSE
Copy a selection from one dataspace to another
USAGE
herr_t H5S_point_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 all the point selection information from the source
dataspace to the destination dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_point_copy (H5S_t *dst, const H5S_t *src)
{
H5S_pnt_node_t *curr, *new_node, *new_head; /* Point information nodes */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI(H5S_point_copy, FAIL);
assert(src);
assert(dst);
/* Allocate room for the head of the point list */
if((dst->select.sel_info.pnt_lst=H5FL_ALLOC(H5S_pnt_list_t,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"can't allocate point node");
curr=src->select.sel_info.pnt_lst->head;
new_head=NULL;
while(curr!=NULL) {
/* Create each point */
if((new_node=H5FL_ALLOC(H5S_pnt_node_t,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"can't allocate point node");
if((new_node->pnt = H5MM_malloc(src->extent.u.simple.rank*sizeof(hssize_t)))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"can't allocate coordinate information");
HDmemcpy(new_node->pnt,curr->pnt,(src->extent.u.simple.rank*sizeof(hssize_t)));
new_node->next=NULL;
/* Keep the order the same when copying */
if(new_head==NULL)
new_head=dst->select.sel_info.pnt_lst->head=new_node;
else {
new_head->next=new_node;
new_head=new_node;
} /* end else */
curr=curr->next;
} /* end while */
done:
FUNC_LEAVE (ret_value);
} /* end H5S_point_copy() */
/*--------------------------------------------------------------------------
NAME
H5S_point_is_valid
PURPOSE
Check whether the selection fits within the extent, with the current
offset defined.
USAGE
htri_t H5S_point_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.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_point_is_valid (const H5S_t *space)
{
H5S_pnt_node_t *curr; /* Point information nodes */
unsigned u; /* Counter */
htri_t ret_value=TRUE; /* return value */
FUNC_ENTER_NOAPI(H5S_point_is_valid, FAIL);
assert(space);
/* Check each point to determine whether selection+offset is within extent */
curr=space->select.sel_info.pnt_lst->head;
while(curr!=NULL) {
/* Check each dimension */
for(u=0; u<space->extent.u.simple.rank; u++) {
/* Check if an offset has been defined */
/* Bounds check the selected point + offset against the extent */
if(((curr->pnt[u]+space->select.offset[u])>(hssize_t)space->extent.u.simple.size[u])
|| ((curr->pnt[u]+space->select.offset[u])<0)) {
ret_value=FALSE;
break;
} /* end if */
} /* end for */
curr=curr->next;
} /* end while */
FUNC_LEAVE (ret_value);
} /* end H5S_point_is_valid() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_elem_npoints
PURPOSE
Get the number of points in current element selection
USAGE
hssize_t H5S_get_select_elem_npoints(space)
H5S_t *space; IN: Dataspace ptr of selection to query
RETURNS
The number of element points in selection on success, negative on failure
DESCRIPTION
Returns the number of element points in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static hssize_t
H5S_get_select_elem_npoints(H5S_t *space)
{
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_elem_npoints);
assert(space);
ret_value = space->select.num_elem;
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_npoints() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_elem_npoints
PURPOSE
Get the number of points in current element selection
USAGE
hssize_t H5Sget_select_elem_npoints(dsid)
hid_t dsid; IN: Dataspace ID of selection to query
RETURNS
The number of element points in selection on success, negative on failure
DESCRIPTION
Returns the number of element points in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5Sget_select_elem_npoints(hid_t spaceid)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_elem_npoints, FAIL);
H5TRACE1("Hs","i",spaceid);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) || NULL == (space=H5I_object(spaceid)))
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
if(space->select.type!=H5S_SEL_POINTS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not an element selection");
ret_value = H5S_get_select_elem_npoints(space);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_npoints() */
/*--------------------------------------------------------------------------
NAME
H5S_point_serial_size
PURPOSE
Determine the number of bytes needed to store the serialized point selection
information.
USAGE
hssize_t H5S_point_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 the current point
selection information for storage on disk.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5S_point_serial_size (const H5S_t *space)
{
H5S_pnt_node_t *curr; /* Point information nodes */
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_serial_size, FAIL);
assert(space);
/* Basic number of bytes required to serialize point selection:
* <type (4 bytes)> + <version (4 bytes)> + <padding (4 bytes)> +
* <length (4 bytes)> + <rank (4 bytes)> + <# of points (4 bytes)> = 24 bytes
*/
ret_value=24;
/* Count points in selection */
curr=space->select.sel_info.pnt_lst->head;
while(curr!=NULL) {
/* Add 4 bytes times the rank for each element selected */
ret_value+=4*space->extent.u.simple.rank;
curr=curr->next;
} /* end while */
FUNC_LEAVE (ret_value);
} /* end H5S_point_serial_size() */
/*--------------------------------------------------------------------------
NAME
H5S_point_serialize
PURPOSE
Serialize the current selection into a user-provided buffer.
USAGE
herr_t H5S_point_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
--------------------------------------------------------------------------*/
herr_t
H5S_point_serialize (const H5S_t *space, uint8_t *buf)
{
H5S_pnt_node_t *curr; /* Point information nodes */
uint8_t *lenp; /* pointer to length location for later storage */
uint32_t len=0; /* number of bytes used */
unsigned u; /* local counting variable */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_serialize, FAIL);
assert(space);
/* Store the preamble information */
UINT32ENCODE(buf, (uint32_t)space->select.type); /* Store the type of selection */
UINT32ENCODE(buf, (uint32_t)1); /* Store the version number */
UINT32ENCODE(buf, (uint32_t)0); /* Store the un-used padding */
lenp=buf; /* keep the pointer to the length location for later */
buf+=4; /* skip over space for length */
/* Encode number of dimensions */
UINT32ENCODE(buf, (uint32_t)space->extent.u.simple.rank);
len+=4;
/* Encode number of elements */
UINT32ENCODE(buf, (uint32_t)space->select.num_elem);
len+=4;
/* Encode each point in selection */
curr=space->select.sel_info.pnt_lst->head;
while(curr!=NULL) {
/* Add 4 bytes times the rank for each element selected */
len+=4*space->extent.u.simple.rank;
/* Encode each point */
for(u=0; u<space->extent.u.simple.rank; u++)
UINT32ENCODE(buf, (uint32_t)curr->pnt[u]);
curr=curr->next;
} /* end while */
/* Encode length */
UINT32ENCODE(lenp, (uint32_t)len); /* Store the length of the extra information */
/* Set success */
ret_value=SUCCEED;
FUNC_LEAVE (ret_value);
} /* H5S_point_serialize() */
/*--------------------------------------------------------------------------
NAME
H5S_point_deserialize
PURPOSE
Deserialize the current selection from a user-provided buffer.
USAGE
herr_t H5S_point_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
--------------------------------------------------------------------------*/
herr_t
H5S_point_deserialize (H5S_t *space, const uint8_t *buf)
{
H5S_seloper_t op=H5S_SELECT_SET; /* Selection operation */
uint32_t rank; /* Rank of points */
size_t num_elem=0; /* Number of elements in selection */
hssize_t *coord=NULL, *tcoord; /* Pointer to array of elements */
unsigned i,j; /* local counting variables */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_deserialize, FAIL);
/* Check args */
assert(space);
assert(buf);
/* Deserialize points to select */
buf+=16; /* Skip over selection header */
UINT32DECODE(buf,rank); /* decode the rank of the point selection */
if(rank!=space->extent.u.simple.rank)
HGOTO_ERROR(H5E_DATASPACE, H5E_BADRANGE, FAIL, "rank of pointer does not match dataspace");
UINT32DECODE(buf,num_elem); /* decode the number of points */
/* Allocate space for the coordinates */
if((coord = H5MM_malloc(num_elem*rank*sizeof(hssize_t)))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate coordinate information");
/* Retrieve the coordinates from the buffer */
for(tcoord=coord,i=0; i<num_elem; i++)
for(j=0; j<(unsigned)rank; j++,tcoord++)
UINT32DECODE(buf, *tcoord);
/* Select points */
if((ret_value=H5S_select_elements(space,op,num_elem,(const hssize_t **)coord))<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't change selection");
done:
/* Free the coordinate array if necessary */
if(coord!=NULL)
H5MM_xfree(coord);
FUNC_LEAVE (ret_value);
} /* H5S_point_deserialize() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_elem_pointlist
PURPOSE
Get the list of element points currently selected
USAGE
herr_t H5S_get_select_elem_pointlist(space, hsize_t *buf)
H5S_t *space; IN: Dataspace pointer of selection to query
hsize_t startpoint; IN: Element point to start with
hsize_t numpoints; IN: Number of element points to get
hsize_t *buf; OUT: List of element points selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the element points into the user's buffer. The points
start with the 'startpoint'th block in the list of points and put
'numpoints' number of points into the user's buffer (or until the end of
the list of points, whichever happen first)
The point coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of points is formatted as
follows: <coordinate> followed by the next coordinate, etc. until all the
point information in the selection have been put into the user's buffer.
The points are returned in the order they will be interated through
when a selection is read/written from/to disk.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_get_select_elem_pointlist(H5S_t *space, hsize_t startpoint, hsize_t numpoints, hsize_t *buf)
{
H5S_pnt_node_t *node; /* Point node */
int rank; /* Dataspace rank */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_elem_pointlist);
assert(space);
assert(buf);
/* Get the dataspace extent rank */
rank=space->extent.u.simple.rank;
/* Get the head of the point list */
node=space->select.sel_info.pnt_lst->head;
/* Iterate to the first point to return */
while(node!=NULL && startpoint>0) {
startpoint--;
node=node->next;
} /* end while */
/* Iterate through the node, copying each hyperslab's information */
while(node!=NULL && numpoints>0) {
HDmemcpy(buf,node->pnt,sizeof(hsize_t)*rank);
buf+=rank;
numpoints--;
node=node->next;
} /* end while */
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_pointlist() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_elem_pointlist
PURPOSE
Get the list of element points currently selected
USAGE
herr_t H5Sget_select_elem_pointlist(dsid, hsize_t *buf)
hid_t dsid; IN: Dataspace ID of selection to query
hsize_t startpoint; IN: Element point to start with
hsize_t numpoints; IN: Number of element points to get
hsize_t *buf; OUT: List of element points selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the element points into the user's buffer. The points
start with the 'startpoint'th block in the list of points and put
'numpoints' number of points into the user's buffer (or until the end of
the list of points, whichever happen first)
The point coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of points is formatted as
follows: <coordinate> followed by the next coordinate, etc. until all the
point information in the selection have been put into the user's buffer.
The points are returned in the order they will be interated through
when a selection is read/written from/to disk.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Sget_select_elem_pointlist(hid_t spaceid, hsize_t startpoint, hsize_t numpoints, hsize_t *buf)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_elem_pointlist, FAIL);
H5TRACE4("e","ihh*h",spaceid,startpoint,numpoints,buf);
/* Check args */
if(buf==NULL)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid pointer");
if (H5I_DATASPACE != H5I_get_type(spaceid) || NULL == (space=H5I_object(spaceid)))
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
if(space->select.type!=H5S_SEL_POINTS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a point selection");
ret_value = H5S_get_select_elem_pointlist(space,startpoint,numpoints,buf);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_pointlist() */
/*--------------------------------------------------------------------------
NAME
H5S_point_bounds
PURPOSE
Gets the bounding box containing the selection.
USAGE
herr_t H5S_point_bounds(space, hsize_t *start, hsize_t *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).
The bounding box calculations _does_ include the current offset of the
selection within the dataspace extent.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_point_bounds(const H5S_t *space, hsize_t *start, hsize_t *end)
{
H5S_pnt_node_t *node; /* Point node */
int rank; /* Dataspace rank */
int i; /* index variable */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI(H5S_point_bounds, FAIL);
assert(space);
assert(start);
assert(end);
/* Get the dataspace extent rank */
rank=space->extent.u.simple.rank;
/* Set the start and end arrays up */
for(i=0; i<rank; i++) {
start[i]=UINT_MAX;
end[i]=0;
} /* end for */
/* Iterate through the node, checking the bounds on each element */
node=space->select.sel_info.pnt_lst->head;
while(node!=NULL) {
for(i=0; i<rank; i++) {
if(start[i]>(hsize_t)(node->pnt[i]+space->select.offset[i]))
start[i]=node->pnt[i]+space->select.offset[i];
if(end[i]<(hsize_t)(node->pnt[i]+space->select.offset[i]))
end[i]=node->pnt[i]+space->select.offset[i];
} /* end for */
node=node->next;
} /* end while */
FUNC_LEAVE (ret_value);
} /* H5Sget_point_bounds() */
/*--------------------------------------------------------------------------
NAME
H5S_point_is_contiguous
PURPOSE
Check if a point selection is contiguous within the dataspace extent.
USAGE
htri_t H5S_point_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.
This code currently doesn't properly check for contiguousness when there is
more than one point, as that would take a lot of extra coding that we
don't need now.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_point_is_contiguous(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_is_contiguous, FAIL);
assert(space);
/* One point is definitely contiguous */
if(space->select.num_elem==1)
ret_value=TRUE;
else /* More than one point might be contiguous, but it's complex to check and we don't need it right now */
ret_value=FALSE;
FUNC_LEAVE (ret_value);
} /* H5S_point_is_contiguous() */
/*--------------------------------------------------------------------------
NAME
H5S_point_is_single
PURPOSE
Check if a point selection is single within the dataspace extent.
USAGE
htri_t H5S_point_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
--------------------------------------------------------------------------*/
htri_t
H5S_point_is_single(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_is_single, FAIL);
assert(space);
/* One point is definitely 'single' :-) */
if(space->select.num_elem==1)
ret_value=TRUE;
else
ret_value=FALSE;
FUNC_LEAVE (ret_value);
} /* H5S_point_is_single() */
/*--------------------------------------------------------------------------
NAME
H5S_point_is_regular
PURPOSE
Check if a point selection is "regular"
USAGE
htri_t H5S_point_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
Doesn't check for points selected to be next to one another in a regular
pattern yet.
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_point_is_regular(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_point_is_regular, FAIL);
/* Check args */
assert(space);
/* Only simple check for regular points for now... */
if(space->select.num_elem==1)
ret_value=TRUE;
else
ret_value=FALSE;
FUNC_LEAVE (ret_value);
} /* H5S_point_is_regular() */
/*--------------------------------------------------------------------------
NAME
H5Sselect_elements
PURPOSE
Specify a series of elements in the dataspace to select
USAGE
herr_t H5Sselect_elements(dsid, op, num_elem, coord)
hid_t dsid; IN: Dataspace ID of selection to modify
H5S_seloper_t op; IN: Operation to perform on current selection
size_t num_elem; IN: Number of elements in COORD array.
const hssize_t **coord; IN: The location of each element selected
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function selects array elements to be included in the selection for
the dataspace. The COORD array is a 2-D array of size <dataspace rank>
by NUM_ELEM (ie. a list of coordinates in the dataspace). The order of
the element coordinates in the COORD array specifies the order that the
array elements are iterated through when I/O is performed. Duplicate
coordinates are not checked for. The selection operator, OP, determines
how the new selection is to be combined with the existing selection for
the dataspace. Currently, only H5S_SELECT_SET is supported, which replaces
the existing selection with the one defined in this call. When operators
other than H5S_SELECT_SET are used to combine a new selection with an
existing selection, the selection ordering is reset to 'C' array ordering.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Sselect_elements (hid_t spaceid, H5S_seloper_t op, size_t num_elem,
const hssize_t **coord)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_API(H5Sselect_elements, FAIL);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) || NULL == (space=H5I_object(spaceid)))
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
if(coord==NULL || num_elem==0)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "elements not specified");
if(!(op==H5S_SELECT_SET || op==H5S_SELECT_APPEND || op==H5S_SELECT_PREPEND))
HRETURN_ERROR(H5E_ARGS, H5E_UNSUPPORTED, FAIL, "operations other than H5S_SELECT_SET not supported currently");
/* Call the real element selection routine */
if((ret_value=H5S_select_elements(space,op,num_elem,coord))<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTDELETE, FAIL, "can't select elements");
done:
FUNC_LEAVE (ret_value);
} /* H5Sselect_elements() */
/*--------------------------------------------------------------------------
NAME
H5S_point_get_seq_list
PURPOSE
Create a list of offsets & lengths for a selection
USAGE
herr_t H5S_point_get_seq_list(space,flags,iter,elem_size,maxseq,maxbytes,nseq,nbytes,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 elem_size; IN: Size of an element
size_t maxseq; IN: Maximum number of sequences to generate
size_t maxbytes; IN: Maximum number of bytes to include in the
generated sequences
size_t *nseq; OUT: Actual number of sequences generated
size_t *nbytes; OUT: Actual number of bytes 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
--------------------------------------------------------------------------*/
herr_t
H5S_point_get_seq_list(const H5S_t *space, unsigned flags, H5S_sel_iter_t *iter,
size_t elem_size, size_t maxseq, size_t maxbytes, size_t *nseq, size_t *nbytes,
hsize_t *off, size_t *len)
{
hsize_t bytes_left; /* The number of bytes left in the selection */
hsize_t start_bytes_left; /* The initial number of bytes left in the selection */
H5S_pnt_node_t *node; /* Point node */
hsize_t dims[H5O_LAYOUT_NDIMS]; /* Total size of memory buf */
int ndims; /* Dimensionality of space*/
hsize_t acc; /* Coordinate accumulator */
hsize_t loc; /* Coordinate offset */
size_t curr_seq; /* Current sequence being operated on */
int i; /* Local index variable */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI (H5S_point_get_seq_list, FAIL);
/* Check args */
assert(space);
assert(iter);
assert(elem_size>0);
assert(maxseq>0);
assert(maxbytes>0);
assert(nseq);
assert(nbytes);
assert(off);
assert(len);
/* "round" off the maxbytes allowed to a multiple of the element size */
maxbytes=(maxbytes/elem_size)*elem_size;
/* Choose the minimum number of bytes to sequence through */
start_bytes_left=bytes_left=MIN(iter->pnt.elmt_left*elem_size,maxbytes);
/* Get the dataspace dimensions */
if ((ndims=H5S_get_simple_extent_dims (space, dims, NULL))<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to retrieve data space dimensions");
/* Walk through the points in the selection, starting at the current */
/* location in the iterator */
node=iter->pnt.curr;
curr_seq=0;
while(node!=NULL) {
/* Compute the offset of each selected point in the buffer */
for(i=ndims-1,acc=elem_size,loc=0; i>=0; i--) {
loc+=(node->pnt[i]+space->select.offset[i])*acc;
acc*=dims[i];
} /* end for */
/* Check if this is a later point in the selection */
if(curr_seq>0) {
/* If a sorted sequence is requested, make certain we don't go backwards in the offset */
if((flags&H5S_GET_SEQ_LIST_SORTED) && loc<off[curr_seq-1])
break;
/* Check if this point extends the previous sequence */
/* (Unlikely, but possible) */
if(loc==(off[curr_seq-1]+len[curr_seq-1])) {
/* Extend the previous sequence */
len[curr_seq-1]+=elem_size;
} /* end if */
else {
/* Add a new sequence */
off[curr_seq]=loc;
len[curr_seq]=elem_size;
/* Increment sequence count */
curr_seq++;
} /* end else */
} /* end if */
else {
/* Add a new sequence */
off[curr_seq]=loc;
len[curr_seq]=elem_size;
/* Increment sequence count */
curr_seq++;
} /* end else */
/* Decrement number of bytes left to process */
bytes_left-=elem_size;
/* Move the iterator */
iter->pnt.curr=node->next;
iter->pnt.elmt_left--;
/* Check if we're finished with all sequences */
if(curr_seq==maxseq)
break;
/* Check if we're finished with all the bytes available */
if(bytes_left==0)
break;
/* Advance to the next point */
node=node->next;
} /* end while */
/* Set the number of sequences generated */
*nseq=curr_seq;
/* Set the number of bytes used */
*nbytes=(start_bytes_left-bytes_left);
done:
FUNC_LEAVE (ret_value);
} /* end H5S_point_get_seq_list() */
Reference in New Issue View Git Blame Copy Permalink