ИМЯ

matherr - библиотека SVID для обработки математических исключений

ОБЗОР

#include <math.h>

int matherr(struct exception *exc);

extern _LIB_VERSION_TYPE _LIB_VERSION;

Компонуется при указании параметра -lm.

ОПИСАНИЕ

Замечание: механизм, описанный на этой странице, больше не поддерживается glibc. До glibc 2.27 он был помечен как устаревший. Начиная с glibc 2.27, механизм был полностью удалён. В новых приложениях нужно использовать методы, описанные в math_error(7) и fenv(3). На этой странице описан механизм matherr() с целью сопровождения и переноса старых приложений.

В System V Interface Definition (SVID) определено какие математические функции должны вызывать функцию matherr(), если обнаруживается математическое исключение. Эта функция вызывает до возврата из самой математической функции; после возврата из matherr() система возвращается в математическую функцию, которая, в свою очередь, возвращает управление вызывающему.

Чтобы задействовать matherr(), программист должен определить макрос тестирования свойств _SVID_SOURCE (до включения каких-либо заголовочных файлов) и присвоить значение _SVID_ внешней переменной _LIB_VERSION.

Система предоставляет matherr() как версию по умолчанию. Эта версия ничего не делает возвращает ноль (назначение этого смотрите далее). Версия по умолчанию matherr() может быть перезаписана версией программиста, которая будет вызываться при возникновении исключений. Функция вызывается с одним аргументом, указателем на структуру exception, определённую следующим образом:

struct exception {

    int    type;      /* тип исключения */

    char  *name;      /* имя функции, вызвавшей исключение */

    double arg1;      /* 1-й аргумент функции */

    double arg2;      /* 2-й аргумент функции */

    double retval;    /* значение, возвращаемое функцией */
}

В поле type может быть одно из следующих значений:

DOMAIN

Произошла ошибка области (аргумент функции вне диапазона, для которого определена функция). Возвращаемое значение зависит от функции; errno присваивается EDOM.

SING

Произошла ошибка особой точки (результат функции равен бесконечности). Возвращаемое значение, в большинстве случаев, равно HUGE (самое большое число с плавающей запятой одинарной точности) с соответствующим знаком. В большинстве случаев, errno присваивается EDOM.

OVERFLOW

Возникло переполнение. В большинстве случаев, возвращается значение HUGE и errno присваивается ERANGE.

UNDERFLOW

Произошла потеря значимости. Возвращается 0.0 и errno присваивается ERANGE.

TLOSS

Полная потеря значимости. Возвращается 0.0 и errno присваивается ERANGE.

PLOSS

Частичная потеря значимости. Это значение не используется в glibc (и многих других системах).

Поля arg1 и arg2 это значения аргументов, переданных функции (arg2 не определено для функций, у которых только один аргумент).

В поле retval указывается возвращаемое значение, которое математическая функция вернёт вызывающему. Написанная программистом matherr() может изменить этого поле, чтобы вернуть другое значение из математической функции.

Если функция matherr() возвращает ноль, то система изменяет errno как описано выше и может вывести сообщение об ошибке в стандартный поток ошибок (смотрите далее).

Если функция matherr() возвращает ненулевое значение, то система не изменяет errno и не печатает сообщение об ошибке.

x        первый аргумент функции
y        второй аргумент функции
fin      конечное значение аргумента
neg      отрицательное значение аргумента
int      целочисленное значение аргумента
o/f      переполнение результата
u/f      потеря значимости результата
|x|      абсолютное значение x
X_TLOSS  константа, определённая в <math.h>

АТРИБУТЫ

Описание терминов данного раздела смотрите в attributes(7).

ПРИМЕР

В примере программы показано использование matherr() при вызове log(3). Программа имеет три аргумента командной строки. Первый аргумент — число с плавающей запятой, передаваемое в log(3). Если указан необязательный второй аргумент, то _LIB_VERSION присваивается значение _SVID_ для того, чтобы вызывалась matherr(), и указанное в командной строке целое число используется как возвращаемое значение matherr(). Если указан необязательный третий аргумент, то им определяется альтернативное возвращаемое значение, которое matherr() должна вернуть как результат математической функции.

Пример запуска, где в log(3) передаётся аргумент 0.0 и не используется matherr():

$ ./a.out 0.0
errno: Числовой результат вне представимого диапазона
x=-inf

В следующем примере вызывается функция matherr() и возвращает 0:

$ ./a.out 0.0 0
исключение matherr SING в функции log()

        арг:   0.000000, 0.000000

        возвр.знач.: -340282346638528859811704183484516925440.000000
log: SING error
errno: Числовой аргумент вне области функции
x=-340282346638528859811704183484516925440.000000

Сообщение «log: SING error» выдаётся библиотекой Си.

В следующем примере вызывается функция matherr() и возвращается не нулевое значение:

$ ./a.out 0.0 1
исключение matherr SING в функции log()

        арг:   0.000000, 0.000000

        возвр.знач.: -340282346638528859811704183484516925440.000000
x=-340282346638528859811704183484516925440.000000

В этом случае библиотека Си не печатает сообщение, и значение errno не изменяется.

В следующем примере вызывается функция matherr(), изменяется возвращаемое значение математической функции и возвращается ненулевое значение:

$ ./a.out 0.0 1 12345.0
исключение matherr SING в функции log()

        арг:   0.000000, 0.000000

        возвр.знач.: -340282346638528859811704183484516925440.000000
x=12345.000000

#define _SVID_SOURCE
#include <errno.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
static int matherr_ret = 0;     /* значение, которое должна

                                    вернуть matherr() */
static int change_retval = 0;   /* должна ли matherr() изменять

                                   возвращаемое функцией значение? */
static double new_retval;       /* новое значение, возвращаемое

                                   функцией */
int
matherr(struct exception *exc)
{

    fprintf(stderr, "исключение matherr %s в функции %s()\n",

           (exc->type == DOMAIN) ?    "DOMAIN" :

           (exc->type == OVERFLOW) ?  "OVERFLOW" :

           (exc->type == UNDERFLOW) ? "UNDERFLOW" :

           (exc->type == SING) ?      "SING" :

           (exc->type == TLOSS) ?     "TLOSS" :

           (exc->type == PLOSS) ?     "PLOSS" : "???",

            exc->name);

    fprintf(stderr, "        арг:   %f, %f\n",

            exc->arg1, exc->arg2);

    fprintf(stderr, "        возвр.знач.: %f\n", exc->retval);

    if (change_retval)

        exc->retval = new_retval;

    return matherr_ret;
}
int
main(int argc, char *argv[])
{

    double x;

    if (argc < 2) {

        fprintf(stderr, "Использование: %s <арг>"

                " [<рез-matherr> [<рез-нов-функ>]]\n", argv[0]);

        exit(EXIT_FAILURE);

    }

    if (argc > 2) {

        _LIB_VERSION = _SVID_;

        matherr_ret = atoi(argv[2]);

    }

    if (argc > 3) {

        change_retval = 1;

        new_retval = atof(argv[3]);

    }

    x = log(atof(argv[1]));

    if (errno != 0)

        perror("errno");

    printf("x=%f\n", x);

    exit(EXIT_SUCCESS);
}

СМОТРИТЕ ТАКЖЕ

fenv(3), math_error(7), standards(7)