Implement support for complex number datatypes (#4630)

* Implement support for complex number datatypes

Adds the new datatype class H5T_COMPLEX

Adds the new API function H5Tcomplex_create which creates a complex
number datatype from an ID of a base floating-point datatype

Adds the new feature check macros H5_HAVE_COMPLEX_NUMBERS and
H5_HAVE_C99_COMPLEX_NUMBERS

Adds the new datatype size macros H5_SIZEOF_FLOAT_COMPLEX,
H5_SIZEOF_DOUBLE_COMPLEX and H5_SIZEOF_LONG_DOUBLE_COMPLEX

Adds the new datatype ID macros H5T_NATIVE_FLOAT_COMPLEX,
H5T_NATIVE_DOUBLE_COMPLEX, H5T_NATIVE_LDOUBLE_COMPLEX,
H5T_CPLX_IEEE_F16LE, H5T_CPLX_IEEE_F16BE,
H5T_CPLX_IEEE_F32LE, H5T_CPLX_IEEE_F32BE,
H5T_CPLX_IEEE_F64LE and H5T_CPLX_IEEE_F64BE

Adds hard and soft datatype conversion paths between complex number
datatypes and all the integer and floating-point datatypes, as well as
between other complex number datatypes

Adds a special conversion path between complex number datatypes and
array or compound datatypes where the in-memory layout of data is the
same between the datatypes and data can be converted directly

Adds support for complex number datatypes to the h5dump, h5ls and
h5diff/ph5diff tools. Allows h5dump '-m' option to change floating-point
printing format for float complex and double complex datatypes, as well
as long double complex if it has the same size as double complex

Adds minimal support to the h5watch and h5import tools

Adds support for the predefined complex number datatypes and
H5Tcomplex_create function to the Java wrappers. Also adds initial,
untested support to the JNI for future use with HDFView

Adds support for just the H5T_COMPLEX datatype class to the Fortran
wrappers

Adds support for the predefined complex number datatypes and
H5Tcomplex_create function to the high level library H5LT interface
for use with the H5LTtext_to_dtype and H5LTdtype_to_text functions

Changes some usages of "complex" in the library since it conflicts with
the "complex" keyword from the complex.h header. Also changes various
usages of the word "complex" throughout the library to distinguish
compound datatypes from complex datatypes.

HDF5Examples/C/H5T/200/h5ex_t_complex.c

@@ -0,0 +1,137 @@
+/************************************************************
+
+  This example shows how to read and write complex number
+  datatypes to a dataset.  The program first writes float
+  complex values to a dataset with a dataspace of DIM0xDIM1,
+  then closes the file.  Next, it reopens the file, reads
+  back the data, and outputs it to the screen. This example
+  assumes the C99 complex number types are supported. For an
+  example that uses MSVC's complex number types, see the
+  h5ex_t_complex_msvc.c example file.
+
+ ************************************************************/
+
+#include "hdf5.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <complex.h>
+
+#define FILE    "h5ex_t_complex.h5"
+#define DATASET "DS1"
+#define DIM0    4
+#define DIM1    7
+
+int
+main(void)
+{
+    float _Complex wdata[DIM0][DIM1];   /* Write buffer */
+    float _Complex **rdata;             /* Read buffer */
+    hid_t            file, space, dset; /* Handles */
+    herr_t           status;
+    hsize_t          dims[2] = {DIM0, DIM1};
+    int              ndims;
+    hsize_t          i, j;
+
+    /*
+     * Initialize data.
+     */
+    for (i = 0; i < DIM0; i++)
+        for (j = 0; j < DIM1; j++) {
+            float real      = (float)i / (j + 0.5) + j;
+            float imaginary = (float)i / (j + 0.5) + j + 1;
+            wdata[i][j]     = real + imaginary * I;
+        }
+
+    /*
+     * Create a new file using the default properties.
+     */
+    file = H5Fcreate(FILE, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);
+
+    /*
+     * Create dataspace.  Setting maximum size to NULL sets the maximum
+     * size to be the current size.
+     */
+    space = H5Screate_simple(2, dims, NULL);
+
+    /*
+     * Create the dataset and write the complex number data to it.  In
+     * this example we will save the data as complex numbers of 2 64-bit
+     * little endian IEEE floating point numbers, regardless of the native
+     * type.  The HDF5 library automatically converts between different
+     * complex number types.
+     */
+    dset   = H5Dcreate(file, DATASET, H5T_COMPLEX_IEEE_F64LE, space, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
+    status = H5Dwrite(dset, H5T_NATIVE_FLOAT_COMPLEX, H5S_ALL, H5S_ALL, H5P_DEFAULT, wdata[0]);
+
+    /*
+     * Close and release resources.
+     */
+    status = H5Dclose(dset);
+    status = H5Sclose(space);
+    status = H5Fclose(file);
+
+    /*
+     * Now we begin the read section of this example.  Here we assume
+     * the dataset has the same name and rank, but can have any size.
+     * Therefore we must allocate a new array to read in data using
+     * malloc().
+     */
+
+    /*
+     * Open file and dataset.
+     */
+    file = H5Fopen(FILE, H5F_ACC_RDONLY, H5P_DEFAULT);
+    dset = H5Dopen(file, DATASET, H5P_DEFAULT);
+
+    /*
+     * Get dataspace and allocate memory for read buffer.  This is a
+     * two dimensional dataset so the dynamic allocation must be done
+     * in steps.
+     */
+    space = H5Dget_space(dset);
+    ndims = H5Sget_simple_extent_dims(space, dims, NULL);
+
+    /*
+     * Allocate array of pointers to rows.
+     */
+    rdata = malloc(dims[0] * sizeof(float _Complex *));
+
+    /*
+     * Allocate space for complex number data.
+     */
+    rdata[0] = malloc(dims[0] * dims[1] * sizeof(float _Complex));
+
+    /*
+     * Set the rest of the pointers to rows to the correct addresses.
+     */
+    for (i = 1; i < dims[0]; i++)
+        rdata[i] = rdata[0] + i * dims[1];
+
+    /*
+     * Read the data.
+     */
+    status = H5Dread(dset, H5T_NATIVE_FLOAT_COMPLEX, H5S_ALL, H5S_ALL, H5P_DEFAULT, rdata[0]);
+
+    /*
+     * Output the data to the screen.
+     */
+    printf("%s:\n", DATASET);
+    for (i = 0; i < dims[0]; i++) {
+        printf(" [");
+        for (j = 0; j < dims[1]; j++) {
+            printf(" %6.4f%+6.4fi", crealf(rdata[i][j]), cimagf(rdata[i][j]));
+        }
+        printf("]\n");
+    }
+
+    /*
+     * Close and release resources.
+     */
+    free(rdata[0]);
+    free(rdata);
+    status = H5Dclose(dset);
+    status = H5Sclose(space);
+    status = H5Fclose(file);
+
+    return 0;
+}

HDF5Examples/C/H5T/200/h5ex_t_complex_custom.c

@@ -0,0 +1,145 @@
+/************************************************************
+
+  This example shows how to read and write complex number
+  datatypes to a dataset.  The program first writes float
+  complex values to a dataset with a dataspace of DIM0xDIM1,
+  then closes the file.  Next, it reopens the file, reads
+  back the data, and outputs it to the screen. This example
+  assumes the C99 complex number types are supported. For an
+  example that uses MSVC's complex number types, see the
+  h5ex_t_complex_msvc.c example file.
+
+ ************************************************************/
+
+#include "hdf5.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <complex.h>
+
+#define FILE    "h5ex_t_complex_custom.h5"
+#define DATASET "DS1"
+#define DIM0    4
+#define DIM1    7
+
+int
+main(void)
+{
+    float _Complex wdata[DIM0][DIM1];          /* Write buffer */
+    float _Complex **rdata;                    /* Read buffer */
+    hid_t            file, space, dset, dtype; /* Handles */
+    herr_t           status;
+    hsize_t          dims[2] = {DIM0, DIM1};
+    int              ndims;
+    hsize_t          i, j;
+
+    /*
+     * Initialize data.
+     */
+    for (i = 0; i < DIM0; i++)
+        for (j = 0; j < DIM1; j++) {
+            float real      = (float)i / (j + 0.5) + j;
+            float imaginary = (float)i / (j + 0.5) + j + 1;
+            wdata[i][j]     = real + imaginary * I;
+        }
+
+    /*
+     * Create a new file using the default properties.
+     */
+    file = H5Fcreate(FILE, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);
+
+    /*
+     * Create dataspace.  Setting maximum size to NULL sets the maximum
+     * size to be the current size.
+     */
+    space = H5Screate_simple(2, dims, NULL);
+
+    /*
+     * Create the dataset and write the complex number data to it.  In
+     * this example we will save the data as complex numbers of 2 64-bit
+     * little endian IEEE floating point numbers, regardless of the native
+     * type.  The HDF5 library automatically converts between different
+     * complex number types.
+     */
+    dset = H5Dcreate(file, DATASET, H5T_COMPLEX_IEEE_F64LE, space, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
+
+    /*
+     * Create a datatype for writing to the dataset. This datatype is a
+     * complex number equivalent to the H5T_NATIVE_FLOAT_COMPLEX type.
+     */
+    dtype = H5Tcomplex_create(H5T_NATIVE_FLOAT);
+
+    status = H5Dwrite(dset, dtype, H5S_ALL, H5S_ALL, H5P_DEFAULT, wdata[0]);
+
+    /*
+     * Close and release resources.
+     */
+    status = H5Dclose(dset);
+    status = H5Sclose(space);
+    status = H5Fclose(file);
+
+    /*
+     * Now we begin the read section of this example.  Here we assume
+     * the dataset has the same name and rank, but can have any size.
+     * Therefore we must allocate a new array to read in data using
+     * malloc().
+     */
+
+    /*
+     * Open file and dataset.
+     */
+    file = H5Fopen(FILE, H5F_ACC_RDONLY, H5P_DEFAULT);
+    dset = H5Dopen(file, DATASET, H5P_DEFAULT);
+
+    /*
+     * Get dataspace and allocate memory for read buffer.  This is a
+     * two dimensional dataset so the dynamic allocation must be done
+     * in steps.
+     */
+    space = H5Dget_space(dset);
+    ndims = H5Sget_simple_extent_dims(space, dims, NULL);
+
+    /*
+     * Allocate array of pointers to rows.
+     */
+    rdata = malloc(dims[0] * sizeof(float _Complex *));
+
+    /*
+     * Allocate space for complex number data.
+     */
+    rdata[0] = malloc(dims[0] * dims[1] * sizeof(float _Complex));
+
+    /*
+     * Set the rest of the pointers to rows to the correct addresses.
+     */
+    for (i = 1; i < dims[0]; i++)
+        rdata[i] = rdata[0] + i * dims[1];
+
+    /*
+     * Read the data.
+     */
+    status = H5Dread(dset, dtype, H5S_ALL, H5S_ALL, H5P_DEFAULT, rdata[0]);
+
+    /*
+     * Output the data to the screen.
+     */
+    printf("%s:\n", DATASET);
+    for (i = 0; i < dims[0]; i++) {
+        printf(" [");
+        for (j = 0; j < dims[1]; j++) {
+            printf(" %6.4f%+6.4fi", crealf(rdata[i][j]), cimagf(rdata[i][j]));
+        }
+        printf("]\n");
+    }
+
+    /*
+     * Close and release resources.
+     */
+    free(rdata[0]);
+    free(rdata);
+    status = H5Dclose(dset);
+    status = H5Sclose(space);
+    status = H5Tclose(dtype);
+    status = H5Fclose(file);
+
+    return 0;
+}