Eigen: документация и сторонние модули
Содержание:
1. Проект Eigen;
2.Документация и сторонние модули (Вы читаете данный раздел);
3. Как это работает: библиотека, которая умнее компилятора.
Eigen наглядно демонстрирует, какой должна быть идеальная документация. Проект документирован просто блестяще: качественно, просто и полно. Наполнение http://eigen.tuxfamily.org также заслуживает всяческих похвал: сайт хорошо организован и содержит всю необходимую информацию (см. рис. ниже).
Главная страница проекта - образец продуманного и информативного сайта
Раздел документации содержит доходчивые инструкции для начинающих (http://eigen. tuxfamily.org/dox/GettingStarted.html), а также большое и подробное учебное пособие из 10 частей, последовательно раскрывающее темы создания матриц, векторной арифметики, поэлементных операций, блочных операций, операций линейной алгебры, редукций, геометрических преобразований, разреженных матриц и т.п. После этого пособия справочная документация может не понадобиться, но и она, конечно, есть. Особенно интересна «шпаргалка» - раздел быстрой справки по модулям и синтаксису (http://eigen.tuxfamily.org/ dox/QuickRefPage.html). Отдельно вынесены «технические» разделы, описывающие специфику реализации, и документация сторонних модулей.
Как и положено любой библиотеке, Eigen не несет в себе дополнительных функций, и если, к примеру, Вам необходимо распечатать полученное вами решение задачи или составленный график, то придется воспользоваться функционалом программы, к которой подключена данная библиотека.
«Шпаргалка» - краткая и удобная документация по синтаксису
Отдельно вынесены модули, написанные для Eigen пользователями и не поддерживаемые официально (http://eigen.tuxfamily.org/dox/unsupported/group Unsupported modules. html). Тем не менее, они очень полезны и перекрывают те аспекты функциональности, которых нет в базовой библиотеке.
Среди наиболее полезных модулей стоит отметить FFT для быстрых преобразований Фурье, обеспечивающий интерфейс к специализированным библиотекам kissfft, fftw и Intel MKL, а также модули для численного дифференцирования, удобной работы с OpenGL и модуль нелинейной оптимизации (на основе пакета Minpack).
1. Проект Eigen;
2.
3. Как это работает: библиотека, которая умнее компилятора.
Eigen наглядно демонстрирует, какой должна быть идеальная документация. Проект документирован просто блестяще: качественно, просто и полно. Наполнение http://eigen.tuxfamily.org также заслуживает всяческих похвал: сайт хорошо организован и содержит всю необходимую информацию (см. рис. ниже).
Главная страница проекта - образец продуманного и информативного сайта
Раздел документации содержит доходчивые инструкции для начинающих (http://eigen. tuxfamily.org/dox/GettingStarted.html), а также большое и подробное учебное пособие из 10 частей, последовательно раскрывающее темы создания матриц, векторной арифметики, поэлементных операций, блочных операций, операций линейной алгебры, редукций, геометрических преобразований, разреженных матриц и т.п. После этого пособия справочная документация может не понадобиться, но и она, конечно, есть. Особенно интересна «шпаргалка» - раздел быстрой справки по модулям и синтаксису (http://eigen.tuxfamily.org/ dox/QuickRefPage.html). Отдельно вынесены «технические» разделы, описывающие специфику реализации, и документация сторонних модулей.
Как и положено любой библиотеке, Eigen не несет в себе дополнительных функций, и если, к примеру, Вам необходимо распечатать полученное вами решение задачи или составленный график, то придется воспользоваться функционалом программы, к которой подключена данная библиотека.
«Шпаргалка» - краткая и удобная документация по синтаксису
Отдельно вынесены модули, написанные для Eigen пользователями и не поддерживаемые официально (http://eigen.tuxfamily.org/dox/unsupported/group Unsupported modules. html). Тем не менее, они очень полезны и перекрывают те аспекты функциональности, которых нет в базовой библиотеке.
Среди наиболее полезных модулей стоит отметить FFT для быстрых преобразований Фурье, обеспечивающий интерфейс к специализированным библиотекам kissfft, fftw и Intel MKL, а также модули для численного дифференцирования, удобной работы с OpenGL и модуль нелинейной оптимизации (на основе пакета Minpack).
