H5::FloatType::FloatType | ( | const PredType & | pred_type | ) |
Creates a floating-point datatype using a predefined type.
pred_type | - IN: Predefined datatype |
H5::DataTypeIException |
References H5::DataType::copy().
H5::FloatType::FloatType | ( | const DataSet & | dataset | ) |
Gets the floating-point datatype of the specified dataset.
dataset | - IN: Dataset that this floating-point datatype associates with |
H5::DataTypeIException |
References H5::DataSet::getId().
H5::FloatType::FloatType | ( | const hid_t | existing_id | ) |
Creates an FloatType object using the id of an existing datatype.
existing_id | - IN: Id of an existing datatype |
H5::DataTypeIException |
size_t H5::FloatType::getEbias | ( | ) | const |
Retrieves the exponent bias of a floating-point type.
H5::DataTypeIException |
void H5::FloatType::getFields | ( | size_t & | spos, | |
size_t & | epos, | |||
size_t & | esize, | |||
size_t & | mpos, | |||
size_t & | msize | |||
) | const |
Retrieves floating point datatype bit field information.
spos | - OUT: Retrieved floating-point sign bit | |
epos | - OUT: Retrieved exponent bit-position | |
esize | - OUT: Retrieved size of exponent, in bits | |
mpos | - OUT: Retrieved mantissa bit-position | |
msize | - OUT: Retrieved size of mantissa, in bits |
H5::DataTypeIException |
H5T_pad_t H5::FloatType::getInpad | ( | H5std_string & | pad_string | ) | const |
Retrieves the internal padding type for unused bits in this floating-point datatypes.
H5T_PAD_ZERO
(0) - Set background to zeros H5T_PAD_ONE
(1) - Set background to ones H5T_PAD_BACKGROUND
(2) - Leave background alone H5::DataTypeIException |
H5T_norm_t H5::FloatType::getNorm | ( | H5std_string & | norm_string | ) | const |
Retrieves mantissa normalization of a floating-point datatype.
norm_string | - OUT: Text string of the normalization type |
H5T_NORM_IMPLIED
(0) - MSB of mantissa is not stored H5T_NORM_MSBSET
(1) - MSB of mantissa is always 1 H5T_NORM_NONE
(2) - Mantissa is not normalized H5::DataTypeIException |
void H5::FloatType::setEbias | ( | size_t | ebias | ) | const |
Sets the exponent bias of a floating-point type.
ebias | - Exponent bias value |
H5::DataTypeIException |
void H5::FloatType::setFields | ( | size_t | spos, | |
size_t | epos, | |||
size_t | esize, | |||
size_t | mpos, | |||
size_t | msize | |||
) | const |
Sets locations and sizes of floating point bit fields.
spos | - OUT: Sign position, i.e., the bit offset of the floating-point sign bit. | |
epos | - OUT: Exponent bit position | |
esize | - OUT: Size of exponent, in bits | |
mpos | - OUT: Mantissa bit-position | |
msize | - OUT: Size of mantissa, in bits |
H5::DataTypeIException |
void H5::FloatType::setInpad | ( | H5T_pad_t | inpad | ) | const |
Fills unused internal floating point bits.
inpad | - IN: Internal padding type |
H5::DataTypeIException |
H5T_PAD_ZERO
(0) - Set background to zeros H5T_PAD_ONE
(1) - Set background to ones H5T_PAD_BACKGROUND
(2) - Leave background alone void H5::FloatType::setNorm | ( | H5T_norm_t | norm | ) | const |
Sets the mantissa normalization of a floating-point datatype.
norm | - IN: Mantissa normalization type |
H5::DataTypeIException |
H5T_NORM_IMPLIED
(0) - MSB of mantissa is not stored H5T_NORM_MSBSET
(1) - MSB of mantissa is always 1 H5T_NORM_NONE
(2) - Mantissa is not normalized