# doc-cache created by Octave 11.1.0
# name: cache
# type: cell
# rows: 3
# columns: 7
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 8
h5create


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2656
 -- Function File: h5create (FILENAME, DSETNAME, SIZE)
 -- Function File: h5create (FILENAME, DSETNAME, SIZE, KEY, VAL,...)

     Create a HDF5 dataset.

     ‘h5create (FILENAME, DSETNAME, SIZE)’ creates a dataset with name
     DSETNAME and size SIZE in the HDF5 file specified by FILENAME.

     ‘h5create (FILENAME, DSETNAME, SIZE, KEY, VAL,...)’ specifies one
     or more key-value arguments.

     Input arguments:

     FILENAME
          The path of the HDF5 file as a string.  If the file does not
          exist it will be created.
     DSETNAME
          A string specifying the complete path to the dataset starting
          from the root group "/".  Intermediate groups are created as
          necessary.
     SIZE
          A vector specifying the dimensions of the dataset.  SIZE may
          contain one or several Inf values.  This will lead to
          unlimited maximum extent of the dataset in the respective
          dimensions and 0 initial extent.  Datasets with at least one
          unlimited dimension must be chunked.  Chunking is generally
          recommended for large datasets.

          ‘size==1’ or ‘size==[1 1]’ results in a scalar (0-dimensional)
          dataset.

          Note that due to the difference in array storage layout
          between OCTAVE (column-major) and HDF5 (row-major), arrays are
          saved transposed in the HDF5 file.  Thus, if a
          ‘hdf5oct’-generated file is opened by another application the
          arrays will appear transposed.

     The list of KEY, VAL arguments allows to specify certain properties
     of the dataset.  Allowed settings are:

     ‘Datatype’
          one of the strings: ‘double’ (default) | ‘single’ | ‘double
          complex’ | ‘single complex’ | ‘uint64’ | ‘uint32’ | ‘uint16’ |
          ‘uint8’ | ‘int64’ | ‘int32’ | ‘int16’ | ‘int8’ | ‘logical’ |
          ‘string’

          The ‘complex’ and ‘logical’ datatypes are not supported in the
          MATLAB high-level HDF5 interface.

          ‘hdf5oct’ supports these types in compatibility with ‘h5py’:

          - the ‘complex’ types are mapped to compound HDF5 datatypes
          with 2 members, ‘r’ and ‘i’, for real and imaginary part,
          respectively.

          - the ‘logical’ type is mapped to a HDF5 Enum: ‘(FALSE = 0,
          TRUE = 1)’

     ‘ChunkSize’
          The value may be either a vector specifying the chunk size, or
          an empty vector [], which means no chunking (this is the
          default).

     See also: h5write.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
Create a HDF5 dataset.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
h5disp


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 633
 -- Function File: h5disp (FILENAME)
 -- Function File: h5disp (FILENAME,LOCATION)
 -- Function File: h5disp (FILENAME,LOCATION,MODE)

     Display the contents of a HDF5 file.

     ‘h5disp(FILENAME)’ displays the metadata that describes the
     structure of the specified HDF5 file.

     ‘h5disp(FILENAME,LOCATION)’ displays the metadata for the specified
     location within the file.

     ‘h5disp(FILENAME,LOCATION,MODE)’, where MODE is 'min', displays
     only the group and dataset names.  The default for mode is
     'simple', which displays the dataset metadata and attribute values.

     See also: h5info.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 36
Display the contents of a HDF5 file.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
h5load


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 810
 -- Function File: DATA = h5load (FILENAME)
 -- Function File: DATA = h5load (FILENAME,LOCATION)

     Load an entire HDF5 file or a portion of it as a struct.

     ‘h5load(FILENAME)’ loads all datasets in FILENAME and returns the
     struct DATA.  Datasets and Groups become fields of the structure
     reproducting the internal hierarchy of the HDF5 file.  Attributes,
     datatypes and other components are not loaded.

     ‘h5disp(FILENAME,LOCATION)’ loads all datasets in FILENAME below
     the node specified by LOCATION.  If LOCATION is a group, then all
     datasets and groups below it are returned in DATA.  If LOCATION is
     a dataset, then only this dataset will be returned.

     This function is not provided by the MATLAB high-level HDF5
     interface.

     See also: h5read.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 56
Load an entire HDF5 file or a portion of it as a struct.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 6
h5read


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2273
 -- Function File: DATA= h5read (FILENAME, DSETNAME)
 -- Function File: DATA= h5read (FILENAME, DSETNAME, START, COUNT)
 -- Function File: DATA= h5read (FILENAME, DSETNAME, START, COUNT,
          STRIDE)

     Read data from a HDF5 dataset.

     ‘data = h5read(FILENAME, DSETNAME)’ reads all the data from the
     dataset DSETNAME contained in the HDF5 file FILENAME.

     ‘data = h5read(FILENAME, DSETNAME, START, COUNT)’ reads a subset of
     data from the dataset beginning at the location specified in START.
     COUNT specifies the number of elements to read along each
     dimension.

     ‘data = h5read(FILENAME, DSETNAME, START, COUNT, STRIDE)’ returns a
     subset of data with the interval between the indices of each
     dimension of the dataset specified by stride.

     Input arguments:

     FILENAME
          Filename of an existing HDF5 file, specified as a string
     DSETNAME
          Dataset name, specified as a string scalar or character vector
          containing the name of an existing dataset in the HDF5 file.
     START
          Starting location, specified as a numeric vector of positive
          integers.  For an n-dimensional dataset, start is a vector of
          length n containing 1-based indices.  The elements of start
          correspond, in order, to the dataset dimensions.  If any
          dimension of ds is unlimited, you must specify start.

          If you do not specify start, then the h5write function starts
          writing to the dataset from the first index along each
          dimension.
     COUNT
          Number of elements to write, specified as a numeric vector of
          positive integers.  For an n-dimensional dataset, count is a
          vector of length n, specifying the number of elements to write
          to the dataset along each dimension.  If any dimension of ds
          is unlimited, then count must be specified.
     STRIDE
          Optional spacing between elements along each dimension.  For
          an n-dimensional dataset, stride is a vector of length n.  A
          value of 1 reads without skipping elements in the
          corresponding dimension, a value of 2 reads every other
          element, and so on.

     See also: h5create, h5write.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 30
Read data from a HDF5 dataset.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
h5readatt


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 682
 -- Function File: ATT_VAL= h5readatt (FILENAME, LOCATION, ATTR)

     Read a HDF5 attribute.

     Retrieves the value of the specified attribute named ATTR from the
     specified location LOCATION in the HDF5 file FILENAME.

     Input arguments:

     FILENAME
          Filename of an existing HDF5 file, specified as a string
     LOCATION
          The path to an existing node in the HDF5 file, which can be
          either a Group, a Dataset or a Named DataType.  The root
          group, "/", is also valid.
     ATTR
          Name of attribute, specified as a string scalar.
     ATT_VAL
          Value of the attribute read from the file.

     See also: h5writeatt.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
Read a HDF5 attribute.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
h5write


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 3089
 -- Function File: h5write (FILENAME, DSETNAME, DATA)
 -- Function File: h5write (FILENAME, DSETNAME, DATA, START, COUNT)
 -- Function File: h5write (FILENAME, DSETNAME, DATA, START, COUNT,
          STRIDE)

     Write data to a HDF5 dataset.

     ‘h5write(filename,dsetname,data)’ writes data to an entire dataset,
     dsetname, in the specified HDF5 file.  If the dataset is fixed in
     size, the amount of data to be written must match the size of the
     dataset.

     ‘h5write(filename,ds,data,start,count)’ writes a subset of data to
     a dataset, beginning at starting location start, and continuing for
     count elements.  In a multidimensional dataset, count specifies a
     distance in each direction.  ‘h5write’ extends an extendable
     dataset along any unlimited dimensions, if necessary.

     ‘h5write(filename,ds,data,start,count,stride)’ specifies the
     spacing between elements, STRIDE, along each dimension of the
     dataset.

     FILENAME
          Filename of an existing HDF5 file, specified as a string
     DSETNAME
          The full path to an existing dataset, specified as a string.
     DATA
          Data to be written to the HDF5 file.  If a numeric datatype
          was specified in the corresponding call to h5create, then data
          is a numeric matrix containing floating-point or integer data.
          Data must be non sparse, and must be the same size as the HDF5
          dataset if you do not specify start or count.  If a dimension
          in the dataset is unlimited, then the data to be written can
          be any size along that dimension.

          If "string" was specified as the datatype in the corresponding
          call to h5create, data is either a single string or a cell
          string array.  The array dimensions must match those specified
          in the call to h5create.

     START
          Starting location, specified as a numeric vector of positive
          integers.  For an n-dimensional dataset, start is a vector of
          length n containing 1-based indices.  The elements of start
          correspond, in order, to the dataset dimensions.  If any
          dimension of ds is unlimited, you must specify start.

          If you do not specify start, then the h5write function starts
          writing to the dataset from the first index along each
          dimension.

     COUNT
          Number of elements to write, specified as a numeric vector of
          positive integers.  For an n-dimensional dataset, count is a
          vector of length n, specifying the number of elements to write
          to the dataset along each dimension.  If any dimension of ds
          is unlimited, then count must be specified.
     STRIDE
          Optional spacing between elements along each dimension.  For
          an n-dimensional dataset, stride is a vector of length n.  A
          value of 1 writes without skipping elements in the
          corresponding dimension, a value of 2 writes every other
          element, and so on.

     See also: h5create.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 29
Write data to a HDF5 dataset.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
h5writeatt


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 898
 -- Function File: h5writeatt (FILENAME, LOCATION, ATTR, VAL)

     Write a HDF5 attribute.

     Input arguments:

     FILENAME
          Filename of an existing HDF5 file, specified as a string.
     LOCATION
          The full path to an existing node in the HDF5 file, which can
          be either a Group, a Dataset or a Named DataType.  The root
          group, "/", is also valid.
     ATTR
          Name of attribute, specified as a string scalar.  If the
          attribute does not exist, h5writeatt creates the attribute
          with the name specified.  If the specified attribute already
          exists, it will be overwritten.
     VAL
          Value of the attribute to be written.  It can be a scalar or
          array variable, numeric or string (UTF8 by default).  The HDF5
          standard suggests that attributes should be small in size.

     See also: h5readatt.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
Write a HDF5 attribute.





