File: H5T_ARRAY-class.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,192 kB
  • sloc: ansic: 76,883; sh: 82; python: 32; makefile: 13
file content (57 lines) | stat: -rw-r--r-- 1,781 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/R6Classes_H5T.R
\docType{class}
\name{H5T_ARRAY-class}
\alias{H5T_ARRAY-class}
\alias{H5T_ARRAY}
\title{Class for HDF5 array datatypes.}
\value{
Object of class \code{\link[=H5T_ARRAY]{H5T_ARRAY}}.
}
\description{
Inherits from class \code{\link[=H5T]{H5T}}. This class represents an array. As datasets in HDF5
are itself already arrays, this datatype is not needed there. It is mostly useful when a column in a
\code{H5T_COMPUND} object is intended to be an array. This however makes it difficult to work
with such objects in R - as a column of the corresponding \code{data.frame} has to be an array. So please
use with care.
}
\section{Methods}{

\describe{
\item{\code{new(dims, dtype_base, id = NULL)}}{

Create an array datatype.

\strong{Parameters}
\describe{
\item{dims}{The dimension of the datatype}
\item{dtype_base}{The datatype that makes up the elements of the array}
\item{id}{internal use only}
}}

\item{\code{get_array_ndims()}}{

This function implements the HDF5-API function H5Tget_array_ndims.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_ARRAY_NDIMS} for details.}

\item{\code{get_array_dims()}}{

This function implements the HDF5-API function H5Tget_array_dims2.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_ARRAY_DIMS2} for details.}

\item{\code{get_super()}}{

This function implements the HDF5-API function H5Tget_super.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_SUPER} for details.}

\item{\code{describe()}}{

Print a detailed description of the datatype; this is experimental}
}}

\seealso{
\code{\link[=H5T]{H5T}}
}
\author{
Holger Hoefling
}