О  ДОКУМЕНТАЦИИ

Подпрограммы Библиотеки разбиты по главам и подглавам в соответствии с выбранной систематикой численного анализа.

Одной из важных частей документации является Систематический Каталог подпрограмм Библиотеки, составленный в соответствии с указанной систематикой.

Информация, приводимая в Каталоге о каждой подпрограмме Библиотеки, разбита на три части. В первой части указывается имя подпрограммы и имена ее версий, если таковые имеются, а также указываются три гиперссылки на описания соответствующих подпрограмм (в виде буквы F  -  на  описание для языка Фортран, в виде буквы C  -  на  описание для языка Си, в виде буквы P  -  на  описание для языка Паскаль).
Во второй части приводится назначение (эффект) подпрограммы.
В третьей части указываются имена ZIP - файлов, содержащих тексты соответствующих подпрограмм и их версий, а также указываются три гиперссылки. Одна (в виде буквы F)  -  на  ZIP - файл с фортранным текстом подпрограммы, другая (в виде буквы C)  -  на  ZIP - файл с текстом на языке Си, и третья (в виде буквы P)  -  на  ZIP - файл с текстом на языке Паскаль.

В начале HTML-файла с описанием подпрограммы для языка Фортран приводятся гиперссылки на ZIP-файлы как с текстами самих подпрограмм, так и с текстами тестовых примеров к ним (для двух или трех языков: Фортран, Си, Паскаль).

Для того чтобы можно было воспользоваться подпрограммами на языке Си, необходимо будет включить в раздел  INCLUDE - файлов  транслятора Си файл с именем f2c.h (для его получения нажмите на ссылку f2c_h.zip ).
Кроме того, при получении исполнимого файла (EXE - файла) необходимо обеспечить подсоединение библиотеки с именем lf2c.lib, заказав ее в командной строке перед другими библиотеками транслятора.
Имеющийся на нашем сайте вариант библиотеки lf2c.lib является лишь подмножеством оригинального варианта этой библиотеки, достаточным для использования Библиотеки численного анализа. (Полный вариант библиотеки lf2c.lib и другую интересующую информацию по процедуре f2c для перевода фортранных текстов на язык Си можно получить по адресу : www.netlib.org/f2c/ ).
Для переписи к себе нашего варианта этой библиотеки в виде, готовом для использования в системе MS DOS, нажмите ссылку  lf2c_lib.zip , для получения ее в текстовом виде нажмите ссылку  lf2c_txt.zip  ).

Далее излагаются общие правила оформления "Описаний подпрограмм" Библиотеки, которые строятся в соответствии со следующей формой.

Подпрограмма: < имя подпрограммы > /Функция: < имя функции >/

Назначение

указывается, для чего предназначена подпрограмма /функция/,  а также, если надо, указывается реализованный метод >

Математическое описание

указывается постановка задачи*); название метода*); особенности метода в данной реализации*); ссылка на литературу, содержащую  детальное описание выбранного метода; математическое  описание должно быть достаточным для понимания работы подпрограммы  /функции/.
Здесь *) указывает на информацию, которая может быть опущена  из описания. >

Использование

        SUBROUTINE < имя подпрограммы > (< список формальных параметров >)

       / t  FUNCTION < имя функции > (< список формальных параметров >) /
       Здесь t - тип функции.

      Параметры

  исчерпывающее описание формальных параметров в порядке их следования в первом операторе подпрограммы (функции) с обязательным указанием их типа; если в качестве соответствующего фактического параметра в списке параметров обращения может быть задана константа (и только в этом случае) тип такого формального параметра указывается в конце последней строки его описания в круглых скобках (например, (тип: целый) ); указание допустимых видов соответствующих формальным фактических параметров, если это соответствие не вкладывается в общеизвестные рамки языка ФОРТРАН. >

      Версии

  любая модификация описываемой подпрограммы, обладающая тем свойством, что она имеет то же количество формальных параметров с теми же их смысловыми нагрузками и тем же порядком их следования, что и данная подпрограмма, может рассматриваться как ее версия; описываемая подпрограмма является основной версией этого семейства подпрограмм; каждая версия может отличаться от основной одним или несколькими свойствами; например, версии могут отличаться типами входных и выходных данных, точностью проводимых вычислений и даже методами; в данном пункте указываются наименования версий, их назначение и отличия от основной версии. Следует отметить, что вводимое здесь понятие версии служит только для обеспечения компактности описания подпрограмм в Руководстве и несколько отличается от понятия версий, вводимого при соглашении на наименование подпрограмм (см. "Оформление подпрограмм") >

      Вызываемые подпрограммы

  указывается список всех подпрограмм Библиотеки, к которым производится обращение из описываемой подпрограммы, и всех ее версий >

      Замечания по использованию

  замечания, ограничения, рекомендации по использованию описываемой подпрограммы и ее версий >

Пример использования

указывается пример (примеры) использования подпрограммы, иллюстрирующий использование подпрограммы и показывающий ее арифметическую правильность >

Цифры результатов, приводимые в документации в примерах по использованию подпрограммы, соответствуют результатам, полученным версией подпрограммы одинарной точности на ЭВМ с максимальным числом десятичных значащих цифр мантиссы, представимых в машинном слове, которое равно 12.