core
/
eccodes
mirror of https://github.com/ecmwf/eccodes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Change documentation format from Doxygen to ReadTheDocs

This commit is contained in:
Eugen Betke 2023-10-09 11:58:12 +00:00
parent e47d12e646
commit 9af40cac08
2 changed files with 30 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/grib_ibmfloat.cc
View File

@ -53,8 +53,9 @@ static ibm_table_t ibm_table = { 0, {0,}, {0,}, 0, 0 };
/**
* @brief (see the documentation for init_ieee_float() in grib_ieeefloat.cc)
*/
.. seealso::
Documentation for ``init_ieee_float()`` in ``grib_ieeefloat.cc``
*/
static void init_ibm_table()
{

46
src/grib_ieeefloat.cc
View File

@ -58,25 +58,33 @@ static ieee_table_t ieee_table = { 0, {0,}, {0,}, 0, 0 };
/**
* @brief Initializes the ieee_table with IEE754 single precision (32-bit) values.
*
* Nearest smaller values (e.g., reference values for grid_simple and grid_ccsds)
* are taken from this table.
*
* @details The table layout is as follows:
*
* | idx (i) | multiplier (e) | value (v = mmin * e) |
* |---------|----------------|----------------------|
* | 1 | 2^(-149) | 0x800000 * 2^(-149) |
* | 2 | 2^(-148) | 0x800000 * 2^(-148) |
* | ... | ... | ... |
* | 253 | 2^103 | 0x800000 * 2^103 |
* | 254 | 2^104 | 0x800000 * 2^104 |
*
* The vmin and vmax boundaries are defined as:
* - vmin = 0x800000 * 2^(-149)
* - vmax = 0xffffff * 2^104
*/
.. _init_ieee_table:
Init IEEE Table
===============
Initializes the ieee_table with IEEE754 single precision (32-bit) values. Nearest smaller values (e.g., reference values for grid_simple and grid_ccsds) are taken from this table.
Details
-------
The table layout is as follows:
+-------+----------------+----------------------+
| idx (i) | multiplier (e) | value (v = mmin * e) |
+-------+----------------+----------------------+
| 1 | 2^(-149) | 0x800000 * 2^(-149) |
| 2 | 2^(-148) | 0x800000 * 2^(-148) |
| ... | ... | ... |
| 253 | 2^103 | 0x800000 * 2^103 |
| 254 | 2^104 | 0x800000 * 2^104 |
+-------+----------------+----------------------+
The vmin and vmax boundaries are defined as:
- vmin = 0x800000 * 2^(-149)
- vmax = 0xffffff * 2^104
*/
static void init_ieee_table()
{