diff options
Diffstat (limited to 'c++/src/H5FloatType.cpp')
-rw-r--r-- | c++/src/H5FloatType.cpp | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/c++/src/H5FloatType.cpp b/c++/src/H5FloatType.cpp index a5b1c51..530868f 100644 --- a/c++/src/H5FloatType.cpp +++ b/c++/src/H5FloatType.cpp @@ -56,7 +56,7 @@ FloatType::FloatType( const PredType& pred_type ) : AtomType() //-------------------------------------------------------------------------- // Function: FloatType overloaded constructor -///\brief Creates an FloatType object using the id of an existing +///\brief Creates an FloatType object using the id of an existing /// datatype. ///\param existing_id - IN: Id of an existing datatype ///\exception H5::DataTypeIException @@ -74,7 +74,7 @@ FloatType::FloatType( const FloatType& original ) : AtomType( original ){} //-------------------------------------------------------------------------- // Function: EnumType overloaded constructor ///\brief Gets the floating-point datatype of the specified dataset -///\param dataset - IN: Dataset that this floating-point datatype +///\param dataset - IN: Dataset that this floating-point datatype /// associates with ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -92,7 +92,7 @@ FloatType::FloatType( const DataSet& dataset ) : AtomType() //-------------------------------------------------------------------------- // Function: FloatType::getFields -///\brief Retrieves floating point datatype bit field information. +///\brief Retrieves floating point datatype bit field information. ///\param spos - OUT: Retrieved floating-point sign bit ///\param epos - OUT: Retrieved exponent bit-position ///\param esize - OUT: Retrieved size of exponent, in bits @@ -112,8 +112,8 @@ void FloatType::getFields( size_t& spos, size_t& epos, size_t& esize, size_t& mp //-------------------------------------------------------------------------- // Function: FloatType::setFields -///\brief Sets locations and sizes of floating point bit fields. -///\param spos - OUT: Sign position, i.e., the bit offset of the +///\brief Sets locations and sizes of floating point bit fields. +///\param spos - OUT: Sign position, i.e., the bit offset of the /// floating-point sign bit. ///\param epos - OUT: Exponent bit position ///\param esize - OUT: Size of exponent, in bits @@ -133,7 +133,7 @@ void FloatType::setFields( size_t spos, size_t epos, size_t esize, size_t mpos, //-------------------------------------------------------------------------- // Function: FloatType::getEbias -///\brief Retrieves the exponent bias of a floating-point type. +///\brief Retrieves the exponent bias of a floating-point type. ///\return Exponent bias ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -151,7 +151,7 @@ size_t FloatType::getEbias() const //-------------------------------------------------------------------------- // Function: FloatType::setEbias -///\brief Sets the exponent bias of a floating-point type. +///\brief Sets the exponent bias of a floating-point type. ///\param ebias - Exponent bias value ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -167,16 +167,16 @@ void FloatType::setEbias( size_t ebias ) const //-------------------------------------------------------------------------- // Function: FloatType::getNorm -///\brief Retrieves mantissa normalization of a floating-point datatype. +///\brief Retrieves mantissa normalization of a floating-point datatype. ///\param norm_string - OUT: Text string of the normalization type ///\return Valid normalization type, which can be: /// \li \c H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored -/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 -/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized +/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 +/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized ///\exception H5::DataTypeIException ///\par Description -/// For your convenience, this function also provides the text -/// string of the returned normalization type, via parameter +/// For your convenience, this function also provides the text +/// string of the returned normalization type, via parameter /// \a norm_string. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -199,14 +199,14 @@ H5T_norm_t FloatType::getNorm( string& norm_string ) const //-------------------------------------------------------------------------- // Function: FloatType::setNorm -///\brief Sets the mantissa normalization of a floating-point datatype. +///\brief Sets the mantissa normalization of a floating-point datatype. ///\param norm - IN: Mantissa normalization type ///\exception H5::DataTypeIException ///\par Description /// Valid values for normalization type include: /// \li \c H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored -/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 -/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized +/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 +/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void FloatType::setNorm( H5T_norm_t norm ) const @@ -220,16 +220,16 @@ void FloatType::setNorm( H5T_norm_t norm ) const //-------------------------------------------------------------------------- // Function: FloatType::getInpad -///\brief Retrieves the internal padding type for unused bits in -/// this floating-point datatypes. +///\brief Retrieves the internal padding type for unused bits in +/// this floating-point datatypes. ///\return Internal padding type, which can be: /// \li \c H5T_PAD_ZERO (0) - Set background to zeros /// \li \c H5T_PAD_ONE (1) - Set background to ones /// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone ///\exception H5::DataTypeIException ///\par Description -/// For your convenience, this function also provides the text -/// string of the returned internal padding type, via parameter +/// For your convenience, this function also provides the text +/// string of the returned internal padding type, via parameter /// \a pad_string. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -252,14 +252,14 @@ H5T_pad_t FloatType::getInpad( string& pad_string ) const //-------------------------------------------------------------------------- // Function: FloatType::setInpad -///\brief Fills unused internal floating point bits. +///\brief Fills unused internal floating point bits. ///\param inpad - IN: Internal padding type ///\exception H5::DataTypeIException ///\par Description -/// If any internal bits of a floating point type are unused -/// (that is, those significant bits which are not part of the -/// sign, exponent, or mantissa), then they will be filled -/// according to the padding value provided by \a inpad. +/// If any internal bits of a floating point type are unused +/// (that is, those significant bits which are not part of the +/// sign, exponent, or mantissa), then they will be filled +/// according to the padding value provided by \a inpad. ///\par /// Valid values for normalization type include: /// \li \c H5T_PAD_ZERO (0) - Set background to zeros |