:orphan: .. index:: pair: group; Numeric operations. .. _doxid-group__te__tools__te__numeric: Numeric operations. =================== .. toctree:: :hidden: enum_te_scalar_type.rst Overview ~~~~~~~~ Numeric operations. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`te_scalar_type` :ref:`te_scalar_type`; // enums enum :ref:`te_scalar_type`; // global variables const :ref:`te_enum_map` :ref:`te_scalar_type_names`[]; // global functions uintmax_t :ref:`te_scalar_type_max`(:ref:`te_scalar_type` type); intmax_t :ref:`te_scalar_type_min`(:ref:`te_scalar_type` type); size_t :ref:`te_scalar_type_sizeof`(:ref:`te_scalar_type` type); bool :ref:`te_scalar_type_is_signed`(:ref:`te_scalar_type` type); :ref:`te_errno` :ref:`te_scalar_type_fit_size`(bool is_signed, size_t size, :ref:`te_scalar_type`* type); :ref:`te_errno` :ref:`te_scalar_dynamic_cast`(:ref:`te_scalar_type` src_type, const void* src, :ref:`te_scalar_type` dst_type, void* dst); :ref:`te_errno` :ref:`te_double2int_safe`(long double val, intmax_t lim, intmax_t* result); :ref:`te_errno` :target:`te_double2uint_safe`(long double val, uintmax_t max, uintmax_t* result); // macros #define :ref:`TE_SCALAR_TYPE_LIST`(HANDLER_) .. _details-group__te__tools__te__numeric: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Numeric operations. Typedefs -------- .. index:: pair: typedef; te_scalar_type .. _doxid-group__te__tools__te__numeric_1ga3c029c2d5803298c39b6cd92af1cf590: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`te_scalar_type` te_scalar_type Scalar types enumeration Global Variables ---------------- .. index:: pair: variable; te_scalar_type_names .. _doxid-group__te__tools__te__numeric_1gab9b6e1ccd36c688fe2f4d141b4380cdf: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`te_enum_map` te_scalar_type_names[] Maps te_scalar_type into a string name of corresponding C type Global Functions ---------------- .. index:: pair: function; te_scalar_type_max .. _doxid-group__te__tools__te__numeric_1gaf30fbdfa2ef4bde398dbc1734a97068d: .. ref-code-block:: cpp :class: doxyrest-title-code-block uintmax_t te_scalar_type_max(:ref:`te_scalar_type` type) Get the maximum value of the given scalar type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Scalar type. .. rubric:: Returns: Maximum value of the scalar ``type``. .. index:: pair: function; te_scalar_type_min .. _doxid-group__te__tools__te__numeric_1ga6c2ffefd3dfbe6a73b72663d0b69cfc7: .. ref-code-block:: cpp :class: doxyrest-title-code-block intmax_t te_scalar_type_min(:ref:`te_scalar_type` type) Get the minimum value of the given scalar type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Scalar type. .. rubric:: Returns: Minimum value of the scalar ``type``. .. index:: pair: function; te_scalar_type_sizeof .. _doxid-group__te__tools__te__numeric_1ga462690e0fcdf5488dc7c23f707aed000: .. ref-code-block:: cpp :class: doxyrest-title-code-block size_t te_scalar_type_sizeof(:ref:`te_scalar_type` type) Return the size of storage for values of given type (akin to ``sizeof``). .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Scalar type. .. rubric:: Returns: Size of type. .. index:: pair: function; te_scalar_type_is_signed .. _doxid-group__te__tools__te__numeric_1gabf36dbf38fd8a165c27ae9ff62715023: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool te_scalar_type_is_signed(:ref:`te_scalar_type` type) Checks whether a type is signed or unsigned. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - type - Scalar type. .. rubric:: Returns: ``true`` if the ``type`` is signed. .. index:: pair: function; te_scalar_type_fit_size .. _doxid-group__te__tools__te__numeric_1ga40affd7eac9cbe6afe4c5d0245477919: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_scalar_type_fit_size(bool is_signed, size_t size, :ref:`te_scalar_type`* type) Return a type spec than can hold values of given size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - is_signed - Sign of value type. * - size - Size of value type (the same as size of some scalar C type). * - type[out] - Location for the scalar type. * - TE_ERANGE - There is no scalar type of the requested size and sign. .. rubric:: Returns: Status code. .. index:: pair: function; te_scalar_dynamic_cast .. _doxid-group__te__tools__te__numeric_1ga9590972a3e72adb9f2b92d326142481a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_scalar_dynamic_cast(:ref:`te_scalar_type` src_type, const void* src, :ref:`te_scalar_type` dst_type, void* dst) Cast the source value to the destination type. If the ``src`` value cannot be represented in the ``dst_type`` exactly an error is returned. However, if the ``dst`` is not ``NULL``, it is always overwritten by the casted ``src`` even if ``src`` value does not fit the range of ``dst_type``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - src_type - Type of source value. * - src - Pointer to memory holding the source value. * - dst_type - Type of destination value. * - dst - Location for the casted value (may be ``NULL``). * - TE_EOVERFLOW - Value does not fit the destination type. .. rubric:: Returns: Status code. .. index:: pair: function; te_double2int_safe .. _doxid-group__te__tools__te__numeric_1ga91f96dabaf60f28b74f8908403cb0fe5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_double2int_safe(long double val, intmax_t lim, intmax_t* result) Safely converts a double ``val`` to an integer. The value is truncated towards zero, as with the regular conversion, but non-finite values and overflows are taken care of. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - val - input value * - lim - limit value: the absolute of ``val`` shall not be greater than ``lim`` * - result - output value * - 0 - Conversion is successful. * - TE_ERANGE - The absolute value of ``val`` is greater than ``lim`` * - TE_EDOM - ``val`` is non-zero and is less than ``1.0``. * - TE_EINVAL - ``val`` is not finite. .. rubric:: Returns: status code Macros ------ .. index:: pair: define; TE_SCALAR_TYPE_LIST .. _doxid-group__te__tools__te__numeric_1gacf94993037727e8e01bf6f91ba4330c5: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TE_SCALAR_TYPE_LIST(HANDLER_) List of scalar types and their properties. Each member of the list specifies one of the scalar types and describes its properties: #. name of the scalar type: named constants are declared in the enum of scalar types; #. corresponding type in C language; #. minimum value of the scalar type (zero for unsigned types); #. maximum value of the scalar type. The properties are processed by a user-defined ``HANDLER_`` which normally should be a local macro accepting at least four arguments, e.g.: .. ref-code-block:: cpp #define PRINT(scalar_type_, c_type_, min_, max_) \ printf("- %s %jd %ju", #c_type_, (min_), (max_)); TE_SCALAR_TYPE_LIST(PRINT) #undef PRINT Refer `https://en.wikipedia.org/wiki/X_macro `__ for a description of the trick. When adding new types to the list two constraints must be satisfied for :ref:`te_scalar_type_fit_size() ` to work properly: * fixed-size types must precede semantic types; * fixed-size types must be ordered by their size. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - HANDLER\_ - Name of the user-defined handler for members of the list