hdf5/hl/test/test_ds.c

/****************************************************************************
 * NCSA HDF                                                                 *
 * Scientific Data Technologies                                             *
 * National Center for Supercomputing Applications                          *
 * University of Illinois at Urbana-Champaign                               *
 * 605 E. Springfield, Champaign IL 61820                                   *
 *                                                                          *
 * For conditions of distribution and use, see the accompanying             *
 * hdf/COPYING f.                                                           *
 *                                                                          *
 ****************************************************************************/



#include "H5DS.h"
#include "H5LT.h"
#include <stdlib.h>

/* operator functions */
static herr_t verifiy_scale(hid_t dset, unsigned dim, hid_t scale, void *visitor_data);
static herr_t read_scale(hid_t dset, unsigned dim, hid_t scale, void *visitor_data);
/* prototypes */
static int test_simple();
static int test_errors();


#define RANK      2
#define DIM_DATA  12
#define DIM1_SIZE 3
#define DIM2_SIZE 4

/*-------------------------------------------------------------------------
 * the main program
 *-------------------------------------------------------------------------
 */

int main(void)
{
 int	nerrors=0;

 nerrors += test_simple()<0 	?1:0;
 nerrors += test_errors()<0 	?1:0;

 if (nerrors) goto error;
 printf("All dimension scales tests passed.\n");
 return 0;
 
error:
 printf("***** %d DIMENSION SCALES TEST%s FAILED! *****\n",nerrors, 1 == nerrors ? "" : "S");
 return 1;
}


/*-------------------------------------------------------------------------
 * DS API test
 *
 * Functions tested:
 *
 * H5DSattach_scale
 * H5DSdetach_scale
 * H5DSset_label
 * H5DSget_label
 * H5DSset_scale
 * H5DSget_scale_name
 * H5DSis_scale
 *
 *-------------------------------------------------------------------------
 */


static int test_simple()
{
 hid_t   fid;                                              /* file ID */
 hid_t   did;                                              /* dataset ID */
 hid_t   dsid;                                             /* DS dataset ID */
 int     rank     = RANK;                                  /* rank of data dataset */
 int     rankds   = 1;                                     /* rank of DS dataset */
 hsize_t dims[RANK]  = {DIM1_SIZE,DIM2_SIZE};              /* size of data dataset */
 int     buf[DIM_DATA] = {1,2,3,4,5,6,7,8,9,10,11,12};     /* data of data dataset */
 hsize_t s1_dim[1]  = {DIM1_SIZE};                         /* size of DS 1 dataset */
 hsize_t s2_dim[1]  = {DIM2_SIZE};                         /* size of DS 2 dataset */
 char    sname[30];                                        /* scale name */
 int     s1_wbuf[DIM1_SIZE] = {10,20,30};                  /* data of DS 1 dataset */
 int     s2_wbuf[DIM2_SIZE] = {100,200,300,400};           /* data of DS 2 dataset */
 char    s1_label[16];                                     /* read label for DS 1 */
 char    s2_label[16];                                     /* read label for DS 2 */
 unsigned int dim;                                         /* dataset dimension index */
 int     scale_idx;     
 
  
 printf("Testing API functions\n");
 	
/*-------------------------------------------------------------------------
 * create a file for the test
 *-------------------------------------------------------------------------
 */  

 /* create a file using default properties */
 if ((fid=H5Fcreate("test_ds1.h5",H5F_ACC_TRUNC,H5P_DEFAULT,H5P_DEFAULT))<0)
  goto out;
	
/*-------------------------------------------------------------------------
 * create 6 datasets: two "data" datasets and 4 dimension scales
 *-------------------------------------------------------------------------
 */  

 /* make a dataset */
 if (H5LTmake_dataset_int(fid,"dset_a",rank,dims,buf)<0)
  goto out;

 /* make a dataset */
 if (H5LTmake_dataset_int(fid,"dset_b",rank,dims,buf)<0)
  goto out;

 /* make a DS dataset for the first dimension */
 if (H5LTmake_dataset_int(fid,"ds1",rankds,s1_dim,s1_wbuf)<0)
  goto out;

 /* make a DS dataset for the second dimension */
 if (H5LTmake_dataset_int(fid,"ds2",rankds,s2_dim,s2_wbuf)<0)
  goto out;

 /* make a DS dataset with an alternate scale for the 2nd dimension  */
 if (H5LTmake_dataset_int(fid,"ds21",rankds,s2_dim,s2_wbuf)<0)
  goto out;

 /* make a DS dataset with an alternate scale for the 2nd dimension  */
 if (H5LTmake_dataset_int(fid,"ds22",rankds,s2_dim,s2_wbuf)<0)
  goto out;

	
/*-------------------------------------------------------------------------
 * test 1: attach scale
 *-------------------------------------------------------------------------
 */  

 TESTING2("attach scales");

 /* get the dataset id for "dset_a" */
 if ((did = H5Dopen(fid,"dset_a"))<0)
  goto out;

/*-------------------------------------------------------------------------
 * attach the "ds1" dimension scale to "dset_a"
 *-------------------------------------------------------------------------
 */  

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds1"))<0)
  goto out;

 /* attach the "ds1" dimension scale to "dset_a" as the 1st dimension  */
 if (H5DSattach_scale(did,dsid,0)<0)
  goto out;

 /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;

/*-------------------------------------------------------------------------
 * attach the "ds2" dimension scale to "dset_a"
 *-------------------------------------------------------------------------
 */  

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds2"))<0)
  goto out;

 /* attach the "ds2" dimension scale to "dset_a" as the 2nd dimension  */
 if (H5DSattach_scale(did,dsid,1)<0)
  goto out;

 /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;
 
/*-------------------------------------------------------------------------
 *  attach the "ds21" dimension scale to "dset_a"
 *-------------------------------------------------------------------------
 */ 

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds21"))<0)
  goto out;

 /* attach the "ds21" dimension scale to "dset_a" as the 2nd dimension  */
 if (H5DSattach_scale(did,dsid,1)<0)
  goto out;

  /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;

/*-------------------------------------------------------------------------
 *  attach the "ds22" dimension scale to "dset_a"
 *-------------------------------------------------------------------------
 */ 

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds22"))<0)
  goto out;

  /* attach the "ds22" dimension scale to "dset_a" as the 2nd dimension  */
 if (H5DSattach_scale(did,dsid,1)<0)
  goto out;

  /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;

 /* close dataset ID of "dset_a" */
 if (H5Dclose(did)<0)
  goto out;
 
/*-------------------------------------------------------------------------
 *  attach the "ds1" dimension scale to "dset_b"
 *-------------------------------------------------------------------------
 */ 

 /* get the dataset id for "dset_b" */
 if ((did = H5Dopen(fid,"dset_b"))<0)
  goto out;

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds1"))<0)
  goto out;

 /* attach the "ds1" dimension scale to "dset_b" as the 1st dimension  */
 if (H5DSattach_scale(did,dsid,0)<0)
  goto out;

 /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;

 /* close dataset ID of "dset_b" */
 if (H5Dclose(did)<0)
  goto out;
 
/*-------------------------------------------------------------------------
 *  verify if the dimension scales are valid 
 *-------------------------------------------------------------------------
 */  

 if ((did = H5Dopen(fid,"ds1"))<0)
  goto out;
 if ((H5DSis_scale(did))<=0)
  goto out;
 if (H5Dclose(did))
  goto out;

 if ((did = H5Dopen(fid,"ds2"))<0)
  goto out;
 if ((H5DSis_scale(did))<=0)
  goto out;
 if (H5Dclose(did))
  goto out;

 if ((did = H5Dopen(fid,"ds21"))<0)
  goto out;
 if ((H5DSis_scale(did))<=0)
  goto out;
 if (H5Dclose(did))
  goto out;

 if ((did = H5Dopen(fid,"ds22"))<0)
  goto out;
 if ((H5DSis_scale(did))<=0)
  goto out;
 if (H5Dclose(did))
  goto out;


 PASSED();



/*-------------------------------------------------------------------------
 * test 2: has scales
 *-------------------------------------------------------------------------
 */  

 TESTING2("has scales");

/*-------------------------------------------------------------------------
 * verify that "dset_a" has dimension scales
 *-------------------------------------------------------------------------
 */  
  
 /* get the dataset id for "dset_a" */
 if ((did = H5Dopen(fid,"dset_a"))<0)
  goto out;

 /* verify that "dset_a" has dimension scales   */
 if ((H5DShas_scale(did))==0)
  goto out;

 /* close dataset ID of "dset_a" */
 if (H5Dclose(did)<0)
  goto out;

 
/*-------------------------------------------------------------------------
 * verify if "dset_b" has dimension scales
 *-------------------------------------------------------------------------
 */  

 /* get the dataset id for "dset_b" */
 if ((did = H5Dopen(fid,"dset_b"))<0)
  goto out;

 /* verify that "dset_b" does not have a complete definition of dimension scales   */
 if ((H5DShas_scale(did))==1)
  goto out;

 /* close dataset ID of "dset_b" */
 if (H5Dclose(did)<0)
  goto out;

 PASSED();



/*-------------------------------------------------------------------------
 * test 3: detach scales
 *-------------------------------------------------------------------------
 */ 

 TESTING2("detach scales ");


/*-------------------------------------------------------------------------
 * create 3 datasets: one "data" dataset and 2 dimension scales
 *-------------------------------------------------------------------------
 */  

 /* make a dataset */
 if (H5LTmake_dataset_int(fid,"dset_c",rank,dims,buf)<0)
  goto out;

 /* make a DS dataset for the first dimension */
 if (H5LTmake_dataset_int(fid,"ds3",rankds,s1_dim,s1_wbuf)<0)
  goto out;

 /* make a DS dataset for the second dimension */
 if (H5LTmake_dataset_int(fid,"ds4",rankds,s2_dim,s2_wbuf)<0)
  goto out;

/*-------------------------------------------------------------------------
 *  attach "ds3" and "ds4" to "dset_c"
 *-------------------------------------------------------------------------
 */ 

 if ((did = H5Dopen(fid,"dset_c"))<0)
  goto out;
 if ((dsid = H5Dopen(fid,"ds3"))<0)
  goto out;
 if (H5DSattach_scale(did,dsid,0)<0)
  goto out;
 if (H5Dclose(dsid)<0)
  goto out;
 if ((dsid = H5Dopen(fid,"ds4"))<0)
  goto out;
 if (H5DSattach_scale(did,dsid,1)<0)
  goto out;
 if (H5Dclose(dsid)<0)
  goto out;
 if (H5Dclose(did)<0)
  goto out;

/*-------------------------------------------------------------------------
 * verify if "dset_c" has dimension scales
 *-------------------------------------------------------------------------
 */  

 if ((did = H5Dopen(fid,"dset_c"))<0)
  goto out;
 if ((H5DShas_scale(did))==0)
  goto out;
 if (H5Dclose(did)<0)
  goto out;
  
/*-------------------------------------------------------------------------
 * detach the "ds3" dimension scale to "dset_c"
 *-------------------------------------------------------------------------
 */ 

 /* get the dataset id for "dset_c" */
 if ((did = H5Dopen(fid,"dset_c"))<0)
  goto out;

 /* get the DS dataset id */
 if ((dsid = H5Dopen(fid,"ds3"))<0)
  goto out;

 /* detach the "ds3" dimension scale to "dset_c" at index 0  */
 if (H5DSdetach_scale(did,dsid,0)<0) 
  goto out;

 /* close DS id */
 if (H5Dclose(dsid)<0)
  goto out;

 /* close dataset ID of "dset_c" */
 if (H5Dclose(did)<0)
  goto out;

/*-------------------------------------------------------------------------
 * verify that "dset_c" has NOT dimension scales
 *-------------------------------------------------------------------------
 */  

 if ((did = H5Dopen(fid,"dset_c"))<0)
  goto out;
 if ((H5DShas_scale(did))==1)
  goto out;
 if (H5Dclose(did)<0)
  goto out;

 PASSED();

/*-------------------------------------------------------------------------
 * test 4: set/get label
 *-------------------------------------------------------------------------
 */ 
 
 TESTING2("set/get label");

 if ((did = H5Dopen(fid,"dset_a"))<0)
  goto out;

 if (H5DSset_label(did,"DY",0)<0)
  goto out;

 if (H5DSset_label(did,"DX",1)<0)
  goto out;

 if (H5DSget_label(did,s1_label,0)<0)
  goto out;

 if (H5DSget_label(did,s2_label,1)<0)
  goto out;

 if (strcmp("DY",s1_label)!=0)
  goto out;
 if (strcmp("DX",s2_label)!=0)
  goto out;

 if (H5Dclose(did))
  goto out;

 PASSED();
 
/*-------------------------------------------------------------------------
 * test 5: set scale/get scale name
 *-------------------------------------------------------------------------
 */ 
 

 TESTING2("set scale/get scale name");

/*-------------------------------------------------------------------------
 * make a dataset named "ds5" and convert it to a DS dataset
 *-------------------------------------------------------------------------
 */ 
 if (H5LTmake_dataset_int(fid,"ds5",rankds,s1_dim,s1_wbuf)<0)
  goto out;

 if ((did = H5Dopen(fid,"ds5"))<0)
  goto out;

 if (H5DSset_scale(did,"scale 1")<0)
  goto out;

 /* verify that "ds5" is a dimension scale dataset  */
 if ((H5DSis_scale(did))==0)
  goto out;

/*-------------------------------------------------------------------------
 * get its scale name
 *-------------------------------------------------------------------------
 */ 

 if (H5DSget_scale_name(did,sname)<0)
  goto out;

 if (H5Dclose(did))
  goto out;

 if (strcmp("scale 1",sname)!=0)
  goto out;

 PASSED();

/*-------------------------------------------------------------------------
 * test 6: test iterate scales with a function verifiy_scale
 *-------------------------------------------------------------------------
 */ 
 TESTING2("iterate scales");

 /* get the dataset id for "dset_a" */
 if ((did = H5Dopen(fid,"dset_a"))<0)
  goto out;

 dim = 0;

 /* iterate trough the 1st dimension of "dset_a" and verify that its DS is valid  */
 if (H5DSiterate_scales(did,dim,NULL,verifiy_scale,NULL)<0)
  goto out;

 /* iterate trough the 2nd dimension of "dset_a" and verify that its DS is valid
    start at DS index 2 */
 dim = 1;
 scale_idx = 2;

 if (H5DSiterate_scales(did,dim,&scale_idx,verifiy_scale,NULL)<0)
  goto out;

 /* close dataset ID of "dset_a" */
 if (H5Dclose(did)<0)
  goto out;

 PASSED();


/*-------------------------------------------------------------------------
 * test 6: test iterate scales with a function read_scale
 *-------------------------------------------------------------------------
 */ 
 TESTING2("read scale values with iterate scales");

 /* get the dataset id for "dset_a" */
 if ((did = H5Dopen(fid,"dset_a"))<0)
  goto out;

 dim = 0;

 /* iterate trough the 1st dimension of "dset_a" and read the DS  */
 if (H5DSiterate_scales(did,dim,NULL,read_scale,s1_wbuf)<0)
  goto out;

 /* iterate trough the 2nd dimension of "dset_a" and read the DS
    start at DS index 2 */
 dim = 1;
 scale_idx = 2;

 if (H5DSiterate_scales(did,dim,&scale_idx,read_scale,s2_wbuf)<0)
  goto out;

 /* close dataset ID of "dset_a" */
 if (H5Dclose(did)<0)
  goto out;

 PASSED();

/*-------------------------------------------------------------------------
 * end
 *-------------------------------------------------------------------------
 */  

 /* close */
 H5Fclose(fid);

 return 0;
  
 /* error zone, gracefully close */
out:
 H5E_BEGIN_TRY {
  H5Dclose(did);
  H5Fclose(fid);
 } H5E_END_TRY;
 H5_FAILED();
 return FAIL;
}


/*-------------------------------------------------------------------------
 * test error conditions
 *-------------------------------------------------------------------------
 */

static int test_errors()
{
 hid_t   fid;                                              /* file ID */
 int     rank     = RANK;                                  /* rank of data dataset */
 int     rankds   = 1;                                     /* rank of DS dataset */
 hsize_t dims[RANK]  = {DIM1_SIZE,DIM2_SIZE};              /* size of data dataset */
 int     buf[DIM_DATA] = {1,2,3,4,5,6,7,8,9,10,11,12};     /* data of data dataset */
 hsize_t s1_dim[1]  = {DIM1_SIZE};                         /* size of DS 1 dataset */
 hsize_t s2_dim[1]  = {DIM2_SIZE};                         /* size of DS 2 dataset */
 hid_t   dset;                                             /* dataset ID */
 hid_t   scale;                                            /* scale ID */
 hid_t   gid;                                              /* group ID */
 hid_t   sid;                                              /* space ID */
 hid_t   sidds; 
 
 printf("Testing error conditions\n");

/*-------------------------------------------------------------------------
 * create a file for the test
 *-------------------------------------------------------------------------
 */  

 /* create a file using default properties */
 if ((fid=H5Fcreate("test_ds2.h5",H5F_ACC_TRUNC,H5P_DEFAULT,H5P_DEFAULT))<0)
  goto out;

/*-------------------------------------------------------------------------
 * attempt to attach the dataset with the dataset
 *-------------------------------------------------------------------------
 */ 
 TESTING2("attach a dataset to itself");

 /* create the data space for the dataset. */
 if ((sid=H5Screate_simple(rank,dims,NULL))<0)
  goto out;
 if ((sidds=H5Screate_simple(rankds,s1_dim,NULL))<0)
  goto out;

 /* create a dataset. */
 if ((dset=H5Dcreate(fid,"dset_1",H5T_NATIVE_INT,sid,H5P_DEFAULT))<0)
  goto out;

 /* create a dataset. */
 if ((scale=H5Dcreate(fid,"scale_1",H5T_NATIVE_INT,sidds,H5P_DEFAULT))<0)
  goto out;

 /* attempt to attach the dataset with the dataset, it should fail */
 if (H5DSattach_scale(dset,dset,0)==SUCCESS)
  goto out;



 if (H5Dclose(scale)<0)
  goto out;
 if (H5Dclose(dset)<0)
  goto out;
 if (H5Sclose(sid)<0)
  goto out;
 if (H5Sclose(sidds)<0)
  goto out;

 PASSED();



/*-------------------------------------------------------------------------
 * end
 *-------------------------------------------------------------------------
 */  

 /* close */
 H5Fclose(fid);

 return 0;
  
 /* error zone, gracefully close */
out:
 H5E_BEGIN_TRY {
  H5Sclose(sid);
  H5Sclose(sidds);
  H5Dclose(dset);
  H5Dclose(scale);
  H5Fclose(fid);
 } H5E_END_TRY;
 H5_FAILED();
 return FAIL;
}


/*-------------------------------------------------------------------------
 * Function: verifiy_scale
 *
 * Purpose: example operator function used by H5DSiterate_scales, used
 *  to veify that SCALE_ID refers to a valid DS dataset
 *
 * Return: 
 * The return values from an operator are: 
 * Zero causes the iterator to continue, returning zero when all group members have been processed. 
 * Positive causes the iterator to immediately return that positive value, indicating 
 *  short-circuit success. The iterator can be restarted at the next group member. 
 * Negative causes the iterator to immediately return that value, indicating failure. 
 *  The iterator can be restarted at the next group member. 
 *
 *-------------------------------------------------------------------------
 */

static herr_t verifiy_scale(hid_t dset, unsigned dim, hid_t scale_id, void *visitor_data)
{

 /* define a default zero value for return. This will cause the iterator to continue */

 int ret = 0;  
  
 /* unused */
 dset=dset;
 dim=dim;
 visitor_data=visitor_data;

 /* define a positive value for return value. This will cause the iterator to 
    immediately return that positive value, indicating short-circuit success 
  */

 /* the parameter DS dataset must be a valid DS dataset */
 if ((H5DSis_scale(scale_id))==1)
 {
  ret = 1;
 }
 
 return ret;
} 


/*-------------------------------------------------------------------------
 * Function: read_scale
 *
 * Purpose: example operator function used by H5DSiterate_scales, used
 *  to read data from DS dataset. compare read and write buffers
 *
 * Return: 
 * The return values from an operator are: 
 * Zero causes the iterator to continue, returning zero when all group members have been processed. 
 * Positive causes the iterator to immediately return that positive value, indicating 
 *  short-circuit success. The iterator can be restarted at the next group member. 
 * Negative causes the iterator to immediately return that value, indicating failure. 
 *  The iterator can be restarted at the next group member 
 *
 *
 *-------------------------------------------------------------------------
 */

static herr_t read_scale(hid_t dset, unsigned dim, hid_t scale_id, void *visitor_data)
{
 int      ret = 0;   /* define a default zero value for return. This will cause the iterator to continue */
 hid_t    sid;       /* space ID */
 hid_t    tid;       /* file type ID */
 hid_t    mtid;      /* memory type ID */
 hssize_t nelmts;    /* number of data elements */
 char     *buf=NULL; /* data buffer */
 size_t   size;
 int      i;
 char     *data=visitor_data;

  /* unused */
 dset=dset;
 dim=dim;

 /* get space */
 if ((sid = H5Dget_space(scale_id))<0)
  goto out;
 /* get type */
 if ((tid = H5Dget_type(scale_id))<0)
   goto out;
 /* get size of the DS array */
 if ((nelmts = H5Sget_simple_extent_npoints(sid))<0)
  goto out;
 /* get type */
 if ((mtid=H5Tget_native_type(tid,H5T_DIR_DEFAULT))<0)
  goto out;
 /* get type size */
 if ((size=H5Tget_size(mtid))==0)
  goto out;
 
 if (nelmts)
 {
  buf=(char *) malloc((unsigned)(nelmts*size));
  if ( buf==NULL)
   goto out;
  if (H5Dread(scale_id,mtid,H5S_ALL,H5S_ALL,H5P_DEFAULT,buf)<0)
   goto out;
  
  for(i=0; i<nelmts; i++)
  {
   if (buf[i] != data[i])
   {
    printf("read and write buffers differ\n");
    goto out;
   }
  }
  
 } /* if */
 
 if (H5Sclose(sid)<0)
  goto out;
 if (H5Tclose(tid)<0) 
  goto out;
 if (H5Tclose(mtid)<0) 
  goto out;
 if (buf)
  free(buf);
 
 
 return ret;

 /* error zone, gracefully close */
 out:
 H5E_BEGIN_TRY {
  H5Sclose(sid);
  H5Tclose(tid);
  H5Tclose(mtid);
  if (buf)
   free(buf);
 } H5E_END_TRY;

  return FAIL;
}