diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /DOCS | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'DOCS')
-rw-r--r-- | DOCS/Doxyfile | 1753 | ||||
-rw-r--r-- | DOCS/groups-usr.dox | 410 | ||||
-rw-r--r-- | DOCS/lawn81.tex | 1688 | ||||
-rw-r--r-- | DOCS/org2.ps | 768 | ||||
-rw-r--r-- | DOCS/psfig.tex | 391 |
5 files changed, 5010 insertions, 0 deletions
diff --git a/DOCS/Doxyfile b/DOCS/Doxyfile new file mode 100644 index 00000000..9eef1d8a --- /dev/null +++ b/DOCS/Doxyfile @@ -0,0 +1,1753 @@ +# Doxyfile 1.7.5.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = LAPACK + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 3.4.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "LAPACK: Linear Algebra PACKage" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = explore-html + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = YES + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = YES + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this +# tag. The format is ext=language, where ext is a file extension, and language +# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, +# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions +# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. The create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = DOCS/groups-usr.dox . + + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.f + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to directory from which doxygen is run. + +EXCLUDE = CMAKE + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = *.py \ + *.txt \ + *.in \ + *.inc \ + Makefile + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = YES + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is adviced to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the stylesheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> +# Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> +# Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = YES + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the +# mathjax.org site, so you can quickly see the result without installing +# MathJax, but it is strongly recommended to install a local copy of MathJax +# before deployment. + +MATHJAX_RELPATH = http://www.mathjax.org/mathjax + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = YES + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /sw/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = YES + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/DOCS/groups-usr.dox b/DOCS/groups-usr.dox new file mode 100644 index 00000000..91b20f94 --- /dev/null +++ b/DOCS/groups-usr.dox @@ -0,0 +1,410 @@ +/** + * + **** + * + * @defgroup lapack LAPACK + * This is the group of LAPACK routines. + * + * @defgroup GE General Matrices + * @ingroup lapack + * This is the group of General Matrices routines + * @defgroup GB General Band Matrix + * @ingroup lapack + * This is the group of General Band routines + * @defgroup SY Symmetric Matrix + * @ingroup lapack + * This is the group of Symmetric Matrix routines + * @defgroup PO Positive Definite Matrix + * @ingroup lapack + * This is the group of Positive Definite routines + * @defgroup auxOTHERauxiliary Other Auxiliary Routines + * @ingroup lapack + * This is the group of Other Auxiliary routines + * + **** + * + * @defgroup solveGE Linear Solve + * @ingroup GE + * This is the group of Linear Solve Driver routines + * @defgroup solveGB Linear Solve + * @ingroup GB + * This is the group of Linear Solve Driver routines + * @defgroup solveSY Linear Solve + * @ingroup SY + * This is the group of Linear Solve Driver routines + * @defgroup solvePO Linear Solve + * @ingroup PO + * This is the group of Linear Solve Driver routines + * @defgroup eigenGE Eigenvalue + * @ingroup GE + * This is the group of Eigenvalue Driver routines + * @defgroup eigenSY Eigenvalue + * @ingroup SY + * This is the group of Eigenvalue Driver routines + * @defgroup singGE Singular Value + * @ingroup GE + * This is the group of Singular Value Driver routines + * @defgroup computationalGE Computational routines + * @ingroup GE + * This is the group of Computational routines + * @defgroup computationalGB Computational routines + * @ingroup GB + * This is the group of Computational routines + * @defgroup computationalSY Computational routines + * @ingroup SY + * This is the group of Computational routines + * @defgroup computationalPO Computational routines + * @ingroup PO + * This is the group of Computational routines + * @defgroup auxiliaryGE Auxiliary routines + * @ingroup GE + * This is the group of Auxiliary routines + * @defgroup auxiliaryGB Auxiliary routines + * @ingroup GB + * This is the group of Auxiliary routines + * @defgroup auxiliarySY Auxiliary routines + * @ingroup SY + * This is the group of Auxiliary routines + * @defgroup auxiliaryPO Auxiliary routines + * @ingroup PO + * This is the group of Auxiliary routines + * + **** + * + * @defgroup doubleGEsolve double + * @ingroup solveGE + * This is the group of double solve driver functions for GE matrices + * @defgroup doublePOsolve double + * @ingroup solvePO + * This is the group of double solve driver functions for PO matrices + * @defgroup doubleSYsolve double + * @ingroup solveSY + * This is the group of double solve driver functions for SY matrices + * @defgroup doubleGBsolve double + * @ingroup solveGB + * This is the group of double solve driver functions for GB matrices + * @defgroup doubleGEeigen double + * @ingroup eigenGE + * This is the group of double eigenvalue driver functions for GE matrices + * @defgroup doubleSYeigen double + * @ingroup eigenSY + * This is the group of double eigenvalue driver functions for SY matrices + * @defgroup doubleGEsing double + * @ingroup singGE + * This is the group of double singular value driver functions for GE matrices + * @defgroup doubleGEcomputational double + * @ingroup computationalGE + * This is the group of double computational functions for GE matrices + * @defgroup doublePOcomputational double + * @ingroup computationalPO + * This is the group of double computational functions for PO matrices + * @defgroup doubleSYcomputational double + * @ingroup computationalSY + * This is the group of double computational functions for SY matrices + * @defgroup doubleGBcomputational double + * @ingroup computationalGB + * This is the group of double computational functions for GB matrices + * @defgroup doubleGEauxiliary double + * @ingroup auxiliaryGE + * This is the group of double auxiliary functions for GE matrices + * @defgroup doublePOauxiliary double + * @ingroup auxiliaryPO + * This is the group of double auxiliary functions for PO matrices + * @defgroup doubleSYauxiliary double + * @ingroup auxiliarySY + * This is the group of double auxiliary functions for SY matrices + * @defgroup doubleGBauxiliary double + * @ingroup auxiliaryGB + * This is the group of double auxiliary functions for GB matrices + * + **** + * + * @defgroup realGEsolve real + * @ingroup solveGE + * This is the group of real solve driver functions for GE matrices + * @defgroup realPOsolve real + * @ingroup solvePO + * This is the group of real solve driver functions for PO matrices + * @defgroup realSYsolve real + * @ingroup solveSY + * This is the group of real solve driver functions for SY matrices + * @defgroup realGBsolve real + * @ingroup solveGB + * This is the group of real solve driver functions for GB matrices + * @defgroup realGEeigen real + * @ingroup eigenGE + * This is the group of real eigenvalue driver functions for GE matrices + * @defgroup realSYeigen real + * @ingroup eigenSY + * This is the group of real eigenvalue driver functions for SY matrices + * @defgroup realGEsing real + * @ingroup singGE + * This is the group of real singular value driver functions for GE matrices + * @defgroup realGEcomputational real + * @ingroup computationalGE + * This is the group of real computational functions for GE matrices + * @defgroup realPOcomputational real + * @ingroup computationalPO + * This is the group of real computational functions for PO matrices + * @defgroup realSYcomputational real + * @ingroup computationalSY + * This is the group of real computational functions for SY matrices + * @defgroup realGBcomputational real + * @ingroup computationalGB + * This is the group of real computational functions for GB matrices + * @defgroup realGEauxiliary real + * @ingroup auxiliaryGE + * This is the group of real auxiliary functions for GE matrices + * @defgroup realPOauxiliary real + * @ingroup auxiliaryPO + * This is the group of real auxiliary functions for PO matrices + * @defgroup realSYauxiliary real + * @ingroup auxiliarySY + * This is the group of real auxiliary functions for SY matrices + * @defgroup realGBauxiliary real + * @ingroup auxiliaryGB + * This is the group of real auxiliary functions for GB matrices + * + **** + * + * @defgroup complexGEsolve complex + * @ingroup solveGE + * This is the group of complex solve driver functions for GE matrices + * @defgroup complexPOsolve complex + * @ingroup solvePO + * This is the group of complex solve driver functions for PO matrices + * @defgroup complexSYsolve complex + * @ingroup solveSY + * This is the group of complex solve driver functions for SY matrices + * @defgroup complexGBsolve complex + * @ingroup solveGB + * This is the group of complex solve driver functions for GB matrices + * @defgroup complexGEeigen complex + * @ingroup eigenGE + * This is the group of complex eigenvalue driver functions for GE matrices + * @defgroup complexSYeigen complex + * @ingroup eigenSY + * This is the group of complex eigenvalue driver functions for SY matrices + * @defgroup complexGEsing complex + * @ingroup singGE + * This is the group of complex singular value driver functions for GE matrices + * @defgroup complexGEcomputational complex + * @ingroup computationalGE + * This is the group of complex computational functions for GE matrices + * @defgroup complexPOcomputational complex + * @ingroup computationalPO + * This is the group of complex computational functions for PO matrices + * @defgroup complexSYcomputational complex + * @ingroup computationalSY + * This is the group of complex computational functions for SY matrices + * @defgroup complexGBcomputational complex + * @ingroup computationalGB + * This is the group of complex computational functions for GB matrices + * @defgroup complexGEauxiliary complex + * @ingroup auxiliaryGE + * This is the group of complex auxiliary functions for GE matrices + * @defgroup complexPOauxiliary complex + * @ingroup auxiliaryPO + * This is the group of complex auxiliary functions for PO matrices + * @defgroup complexSYauxiliary complex + * @ingroup auxiliarySY + * This is the group of complex auxiliary functions for SY matrices + * @defgroup complexGBauxiliary complex + * @ingroup auxiliaryGB + * This is the group of complex auxiliary functions for GB matrices + * + **** + * + * @defgroup complex16GEsolve complex16 + * @ingroup solveGE + * This is the group of complex16 solve driver functions for GE matrices + * @defgroup complex16POsolve complex16 + * @ingroup solvePO + * This is the group of complex16 solve driver functions for PO matrices + * @defgroup complex16SYsolve complex16 + * @ingroup solveSY + * This is the group of complex16 solve driver functions for SY matrices + * @defgroup complex16GBsolve complex16 + * @ingroup solveGB + * This is the group of complex16 solve driver functions for GB matrices + * @defgroup complex16GEeigen complex16 + * @ingroup eigenGE + * This is the group of complex16 eigenvalue driver functions for GE matrices + * @defgroup complex16SYeigen complex16 + * @ingroup eigenSY + * This is the group of complex16 eigenvalue driver functions for SY matrices + * @defgroup complex16GEsing complex16 + * @ingroup singGE + * This is the group of complex16 singular value driver functions for GE matrices + * @defgroup complex16GEcomputational complex16 + * @ingroup computationalGE + * This is the group of complex16 computational functions for GE matrices + * @defgroup complex16POcomputational complex16 + * @ingroup computationalPO + * This is the group of complex16 computational functions for PO matrices + * @defgroup complex16SYcomputational complex16 + * @ingroup computationalSY + * This is the group of complex16 computational functions for SY matrices + * @defgroup complex16GBcomputational complex16 + * @ingroup computationalGB + * This is the group of complex16 computational functions for GB matrices + * @defgroup complex16GEauxiliary complex16 + * @ingroup auxiliaryGE + * This is the group of complex16 auxiliary functions for GE matrices + * @defgroup complex16POauxiliary complex16 + * @ingroup auxiliaryPO + * This is the group of complex16 auxiliary functions for PO matrices + * @defgroup complex16SYauxiliary complex16 + * @ingroup auxiliarySY + * This is the group of complex16 auxiliary functions for SY matrices + * @defgroup complex16GBauxiliary complex16 + * @ingroup auxiliaryGB + * This is the group of complex16 auxiliary functions for GB matrices + * + **** + * + * @defgroup testing LAPACK Testing + * This is the group of LAPACK TESTING routines. + * + * @defgroup matgen Matrix Generation + * @ingroup testing + * This is the group of LAPACK TESTING MATGEN routines. + * + * @defgroup lin Linear Solve + * @ingroup testing + * This is the group of LAPACK TESTING LIN routines. + * + * @defgroup eig Eigenvalue and Singular value + * @ingroup testing + * This is the group of LAPACK TESTING EIG routines. + * + * @defgroup real_matgen real + * @ingroup matgen + * This is the group of real LAPACK TESTING MATGEN routines. + * + * @defgroup double_matgen double + * @ingroup matgen + * This is the group of double LAPACK TESTING MATGEN routines. + * + * @defgroup complex_matgen complex + * @ingroup matgen + * This is the group of complex LAPACK TESTING MATGEN routines. + * + * @defgroup complex16_matgen complex16 + * @ingroup matgen + * This is the group of complex16 LAPACK TESTING MATGEN routines. + * + * @defgroup aux_matgen aux + * @ingroup matgen + * This is the group of auxiliary LAPACK TESTING MATGEN routines. + * + * @defgroup single_lin real + * @ingroup lin + * This is the group of real LAPACK TESTING LIN routines. + * + * @defgroup double_lin double + * @ingroup lin + * This is the group of double LAPACK TESTING LIN routines. + * + * @defgroup complex_lin complex + * @ingroup lin + * This is the group of complex LAPACK TESTING LIN routines. + * + * @defgroup complex16_lin complex16 + * @ingroup lin + * This is the group of complex16 LAPACK TESTING LIN routines. + * + * @defgroup aux_lin aux + * @ingroup lin + * This is the group of auxiliary LAPACK TESTING LIN routines. + * + * @defgroup single_eig real + * @ingroup eig + * This is the group of real LAPACK TESTING EIG routines. + * + * @defgroup double_eig double + * @ingroup eig + * This is the group of double LAPACK TESTING EIG routines. + * + * @defgroup complex_eig complex + * @ingroup eig + * This is the group of complex LAPACK TESTING EIG routines. + * + * @defgroup complex16_eig complex16 + * @ingroup eig + * This is the group of complex16 LAPACK TESTING EIG routines. + * + * @defgroup aux_eig aux + * @ingroup eig + * This is the group of auxiliary LAPACK TESTING EIG routines. + * + **** + * @defgroup blas Reference BLAS + * This is the group of BLAS routines. + * + * @defgroup level1 Level1 + * @ingroup blas + * This is the group of LEVEL 1 BLAS routines. + * @defgroup level2 Level2 + * @ingroup blas + * This is the group of LEVEL 2 BLAS routines. + * @defgroup level3 Level3 + * @ingroup blas + * This is the group of LEVEL 3 BLAS routines. + * @defgroup blastesting Testing + * @ingroup blas + * This is the group of BLAS TESTING routines. + * + * @defgroup single_blas_level1 real + * @ingroup level1 + * This is the group of real LEVEL 1 BLAS routines. + * @defgroup double_blas_level1 double + * @ingroup level1 + * This is the group of double LEVEL 1 BLAS routines. + * @defgroup complex_blas_level1 complex + * @ingroup level1 + * This is the group of complex LEVEL 1 BLAS routines. + * @defgroup complex16_blas_level1 complex16 + * @ingroup level1 + * This is the group of complex16 LEVEL 1 BLAS routines. + * + * @defgroup single_blas_level2 real + * @ingroup level2 + * This is the group of real LEVEL 2 BLAS routines. + * @defgroup double_blas_level1 double + * @ingroup level2 + * This is the group of double LEVEL 2 BLAS routines. + * @defgroup complex_blas_level2 complex + * @ingroup level2 + * This is the group of complex LEVEL 2 BLAS routines. + * @defgroup complex16_blas_level2 complex16 + * @ingroup level2 + * This is the group of complex16 LEVEL 2 BLAS routines. + * + * @defgroup single_blas_level3 real + * @ingroup level3 + * This is the group of real LEVEL 3 BLAS routines. + * @defgroup double_blas_level3 double + * @ingroup level3 + * This is the group of double LEVEL 3 BLAS routines. + * @defgroup complex_blas_level3 complex + * @ingroup level3 + * This is the group of complex LEVEL 3 BLAS routines. + * @defgroup complex16_blas_level3 complex16 + * @ingroup level3 + * This is the group of complex16 LEVEL 3 BLAS routines. + * + * @defgroup single_blas_testing real + * @ingroup blastesting + * This is the group of real BLAS TESTING routines. + * @defgroup double_blas_testing double + * @ingroup blastesting + * This is the group of double BLAS TESTING routines. + * @defgroup complex_blas_testing complex + * @ingroup blastesting + * This is the group of complex BLAS TESTING routines. + * @defgroup complex16_blas_testing complex16 + * @ingroup blastesting + * This is the group of complex16 BLAS TESTING routines. + * +**/ diff --git a/DOCS/lawn81.tex b/DOCS/lawn81.tex new file mode 100644 index 00000000..16efef76 --- /dev/null +++ b/DOCS/lawn81.tex @@ -0,0 +1,1688 @@ +\documentclass[11pt]{report} + +\usepackage{indentfirst} +\usepackage[body={6in,8.5in}]{geometry} +\usepackage{hyperref} +\usepackage{graphicx} +\DeclareGraphicsRule{.ps}{eps}{}{} + +\renewcommand{\thesection}{\arabic{section}} +\setcounter{tocdepth}{3} +\setcounter{secnumdepth}{3} + +\begin{document} +\begin{center} + {\Large LAPACK Working Note 81\\ + Quick Installation Guide for LAPACK on Unix Systems\footnote{This work was + supported by NSF Grant No. ASC-8715728 and NSF Grant No. 0444486}} +\end{center} +\begin{center} +% Edward Anderson\footnote{Current address: Cray Research Inc., +% 655F Lone Oak Drive, Eagan, MN 55121}, + The LAPACK Authors\\ + Department of Computer Science \\ + University of Tennessee \\ + Knoxville, Tennessee 37996-1301 \\ +\end{center} +\begin{center} + REVISED: VERSION 3.1.1, February 2007 \\ + REVISED: VERSION 3.2.0, November 2008 +\end{center} + +\begin{center} +Abstract +\end{center} +This working note describes how to install, and test version 3.2.0 +of LAPACK, a linear algebra package for high-performance +computers, on a Unix System. The timing routines are not actually included in +release 3.2.0, and that part of the LAWN refers to release 3.0. Also, +version 3.2.0 contains many prototype routines needing user feedback. +Non-Unix installation instructions and +further details of the testing and timing suites are only contained in +LAPACK Working Note 41, and not in this abbreviated version. +%Separate instructions are provided for the Unix and non-Unix +%versions of the test package. +%Further details are also given on the design of the test and timing +%programs. +\newpage + +\tableofcontents + +\newpage +% Introduction to Implementation Guide + +\section{Introduction} + +LAPACK is a linear algebra library for high-performance +computers. +The library includes Fortran subroutines for +the analysis and solution of systems of simultaneous linear algebraic +equations, linear least-squares problems, and matrix eigenvalue +problems. +Our approach to achieving high efficiency is based on the use of +a standard set of Basic Linear Algebra Subprograms (the BLAS), +which can be optimized for each computing environment. +By confining most of the computational work to the BLAS, +the subroutines should be +transportable and efficient across a wide range of computers. + +This working note describes how to install, test, and time this +release of LAPACK on a Unix System. + +The instructions for installing, testing, and timing +\footnote{timing are only provided in LAPACK 3.0 and before} +are designed for a person whose +responsibility is the maintenance of a mathematical software library. +We assume the installer has experience in compiling and running +Fortran programs and in creating object libraries. +The installation process involves untarring the file, creating a set of +libraries, and compiling and running the test and timing programs +\footnotemark[\value{footnote}]. + +%This guide combines the instructions for the Unix and non-Unix +%versions of the LAPACK test package (the non-Unix version is in Appendix +%~\ref{appendixe}). +%At this time, the non-Unix version of LAPACK can only be obtained +%after first untarring the Unix tar tape and then following the instructions in +%Appendix ~\ref{appendixe}. + +Section~\ref{fileformat} describes how the files are organized in the +file, and +Section~\ref{overview} gives a general overview of the parts of the test package. +Step-by-step instructions appear in Section~\ref{installation}. +%for the Unix version and in the appendix for the non-Unix version. + +For users desiring additional information, please refer to LAPACK +Working Note 41. +% Sections~\ref{moretesting} +%and ~\ref{moretiming} give +%details of the test and timing programs and their input files. +%Appendices ~\ref{appendixa} and ~\ref{appendixb} briefly describe +%the LAPACK routines and auxiliary routines provided +%in this release. +%Appendix ~\ref{appendixc} lists the operation counts we have computed +%for the BLAS and for some of the LAPACK routines. +Appendix ~\ref{appendixd}, entitled ``Caveats'', is a compendium of the known +problems from our own experiences, with suggestions on how to +overcome them. + +\textbf{It is strongly advised that the user read Appendix +A before proceeding with the installation process.} +%Appendix E contains the execution times of the different test +%and timing runs on two sample machines. +%Appendix ~\ref{appendixe} contains the instructions to install LAPACK on a non-Unix +%system. + +\section{Revisions Since the First Public Release} + +Since its first public release in February, 1992, LAPACK has had +several updates, which have encompassed the introduction of new routines +as well as extending the functionality of existing routines. The first +update, +June 30, 1992, was version 1.0a; the second update, October 31, 1992, +was version 1.0b; the third update, March 31, 1993, was version 1.1; +version 2.0 on September 30, 1994, coincided with the release of the +Second Edition of the LAPACK Users' Guide; +version 3.0 on June 30, 1999 coincided with the release of the Third Edition of +the LAPACK Users' Guide; +version 3.1 was released on November, 2006; +version 3.1.1 was released on November, 2007; +and version 3.2.0 was released on November, 2008. + +All LAPACK routines reflect the current version number with the date +on the routine indicating when it was last modified. +For more information on revisions in the latest release, please refer +to the \texttt{revisions.info} file in the lapack directory on netlib. +\begin{quote} +\url{http://www.netlib.org/lapack/revisions.info} +\end{quote} + +%The distribution \texttt{tar} file \texttt{lapack.tar.z} that is +%available on netlib is always the most up-to-date. +% +%On-line manpages (troff files) for LAPACK driver and computational +%routines, as well as most of the BLAS routines, are available via +%the \texttt{lapack} index on netlib. + +\section{File Format}\label{fileformat} + +The software for LAPACK is distributed in the form of a +gzipped tar file (via anonymous ftp or the World Wide Web), +which contains the Fortran source for LAPACK, +the Basic Linear Algebra Subprograms +(the Level 1, 2, and 3 BLAS) needed by LAPACK, the testing programs, +and the timing programs\footnotemark[\value{footnote}]. +Users who wish to have a non-Unix installation should refer to LAPACK +Working Note 41, +although the overview in section~\ref{overview} applies to both the Unix and non-Unix +versions. +%Users who wish to have a non-Unix installation should go to Appendix ~\ref{appendixe}, +%although the overview in section ~\ref{overview} applies to both the Unix and non-Unix +%versions. + +The package may be accessed via the World Wide Web through +the URL address: +\begin{quote} +\url{http://www.netlib.org/lapack/lapack.tgz} +\end{quote} + +Or, you can retrieve the file via anonymous ftp at netlib: + +\begin{verbatim} + ftp ftp.netlib.org + login: anonymous + password: <your email address> + cd lapack + binary + get lapack.tgz + quit +\end{verbatim} + +The software in the \texttt{tar} file +is organized in a number of essential directories as shown +in Figure 1. Please note that this figure does not reflect everything +that is contained in the \texttt{LAPACK} directory. Input and instructional +files are also located at various levels. +\begin{figure} +\vspace{11pt} +\centerline{\includegraphics[width=6.5in,height=3in]{org2.ps}} +\caption{Unix organization of LAPACK 3.0} +\vspace{11pt} +\end{figure} +Libraries are created in the LAPACK directory and +executable files are created in one of the directories BLAS, TESTING, +or TIMING\footnotemark[\value{footnote}]. Input files for the test and +timing\footnotemark[\value{footnote}] programs are also +found in these three directories so that testing may be carried out +in the directories LAPACK/BLAS, LAPACK/TESTING, and LAPACK/TIMING \footnotemark[\value{footnote}]. +A top-level makefile in the LAPACK directory is provided to perform the +entire installation procedure. + +\section{Overview of Tape Contents}\label{overview} + +Most routines in LAPACK occur in four versions: REAL, +DOUBLE PRECISION, COMPLEX, and COMPLEX*16. +The first three versions (REAL, DOUBLE PRECISION, and COMPLEX) +are written in standard Fortran and are completely portable; +the COMPLEX*16 version is provided for +those compilers which allow this data type. +Some routines use features of Fortran 90. +For convenience, we often refer to routines by their single precision +names; the leading `S' can be replaced by a `D' for double precision, +a `C' for complex, or a `Z' for complex*16. +For LAPACK use and testing you must decide which version(s) +of the package you intend to install at your site (for example, +REAL and COMPLEX on a Cray computer or DOUBLE PRECISION and +COMPLEX*16 on an IBM computer). + +\subsection{LAPACK Routines} + +There are three classes of LAPACK routines: +\begin{itemize} + +\item \textbf{driver} routines solve a complete problem, such as solving +a system of linear equations or computing the eigenvalues of a real +symmetric matrix. Users are encouraged to use a driver routine if there +is one that meets their requirements. The driver routines are listed +in LAPACK Working Note 41~\cite{WN41} and the LAPACK Users' Guide~\cite{LUG}. +%in Appendix ~\ref{appendixa}. + +\item \textbf{computational} routines, also called simply LAPACK routines, +perform a distinct computational task, such as computing +the $LU$ decomposition of an $m$-by-$n$ matrix or finding the +eigenvalues and eigenvectors of a symmetric tridiagonal matrix using +the $QR$ algorithm. +The LAPACK routines are listed in LAPACK Working Note 41~\cite{WN41} +and the LAPACK Users' Guide~\cite{LUG}. +%The LAPACK routines are listed in Appendix ~\ref{appendixa}; see also LAPACK +%Working Note \#5 \cite{WN5}. + +\item \textbf{auxiliary} routines are all the other subroutines called +by the driver routines and computational routines. +%Among them are subroutines to perform subtasks of block algorithms, +%in particular, the unblocked versions of the block algorithms; +%extensions to the BLAS, such as matrix-vector operations involving +%complex symmetric matrices; +%the special routines LSAME and XERBLA which first appeared with the +%BLAS; +%and a number of routines to perform common low-level computations, +%such as computing a matrix norm, generating an elementary Householder +%transformation, and applying a sequence of plane rotations. +%Many of the auxiliary routines may be of use to numerical analysts +%or software developers, so we have documented the Fortran source for +%these routines with the same level of detail used for the LAPACK +%routines and driver routines. +The auxiliary routines are listed in LAPACK Working Note 41~\cite{WN41} +and the LAPACK Users' Guide~\cite{LUG}. +%The auxiliary routines are listed in Appendix ~\ref{appendixb}. +\end{itemize} + +\subsection{Level 1, 2, and 3 BLAS} + +The BLAS are a set of Basic Linear Algebra Subprograms that perform +vector-vector, matrix-vector, and matrix-matrix operations. +LAPACK is designed around the Level 1, 2, and 3 BLAS, and nearly all +of the parallelism in the LAPACK routines is contained in the BLAS. +Therefore, +the key to getting good performance from LAPACK lies in having an +efficient version of the BLAS optimized for your particular machine. +Optimized BLAS libraries are available on a variety of architectures, +refer to the BLAS FAQ on netlib for further information. +\begin{quote} +\url{http://www.netlib.org/blas/faq.html} +\end{quote} +There are also freely available BLAS generators that automatically +tune a subset of the BLAS for a given architecture. E.g., +\begin{quote} +\url{http://www.netlib.org/atlas/} +\end{quote} +And, if all else fails, there is the Fortran~77 reference implementation +of the Level 1, 2, and 3 BLAS available on netlib (also included in +the LAPACK distribution tar file). +\begin{quote} +\url{http://www.netlib.org/blas/blas.tgz} +\end{quote} +No matter which BLAS library is used, the BLAS test programs should +always be run. + +Users should not expect too much from the Fortran~77 reference implementation +BLAS; these versions were written to define the basic operations and do not +employ the standard tricks for optimizing Fortran code. + +The formal definitions of the Level 1, 2, and 3 BLAS +are in \cite{BLAS1}, \cite{BLAS2}, and \cite{BLAS3}. +The BLAS Quick Reference card is available on netlib. + +\subsection{Mixed- and Extended-Precision BLAS: XBLAS} + +The XBLAS extend the BLAS to work with mixed input and output +precisions as well as using extra precision internally. The XBLAS are +used in the prototype extra-precise iterative refinement codes. + +The current release of the XBLAS is available through +Netlib\footnote{Development versions may be available through + \url{http://www.cs.berkeley.edu/~yozo/} or + \url{http://www.nersc.gov/~xiaoye/XBLAS/}.} at +\begin{quote} + \url{http://www.netlib.org/xblas} +\end{quote} +Their formal definition is in \cite{XBLAS}. + +\subsection{LAPACK Test Routines} + +This release contains two distinct test programs for LAPACK routines +in each data type. One test program tests the routines for solving +linear equations and linear least squares problems, +and the other tests routines for the matrix eigenvalue problem. +The routines for generating test matrices are used by both test +programs and are compiled into a library for use by both test programs. + +\subsection{LAPACK Timing Routines (for LAPACK 3.0 and before) } + +This release also contains two distinct timing programs for the +LAPACK routines in each data type. +The linear equation timing program gathers performance data in +megaflops on the factor, solve, and inverse routines for solving +linear systems, the routines to generate or apply an orthogonal matrix +given as a sequence of elementary transformations, and the reductions +to bidiagonal, tridiagonal, or Hessenberg form for eigenvalue +computations. +The operation counts used in computing the megaflop rates are computed +from a formula; +see LAPACK Working Note 41~\cite{WN41}. +% see Appendix ~\ref{appendixc}. +The eigenvalue timing program is used with the eigensystem routines +and returns the execution time, number of floating point operations, and +megaflop rate for each of the requested subroutines. +In this program, the number of operations is computed while the +code is executing using special instrumented versions of the LAPACK +subroutines. + +\section{Installing LAPACK on a Unix System}\label{installation} + +Installing, testing, and timing\footnotemark[\value{footnote}] the Unix version of LAPACK +involves the following steps: +\begin{enumerate} +\item Gunzip and tar the file. + +\item Copy and edit the file \texttt{LAPACK/make.inc.example to LAPACK/make.inc}. + +\item Edit the file \texttt{LAPACK/Makefile} and type \texttt{make}. + +%\item Test and Install the Machine-Dependent Routines \\ +%\emph{(WARNING: You may need to supply a correct version of second.f and +%dsecnd.f for your machine)} +%{\tt +%\begin{list}{}{} +%\item cd LAPACK +%\item make install +%\end{list} } +% +%\item Create the BLAS Library, \emph{if necessary} \\ +%\emph{(NOTE: For best performance, it is recommended you use the manufacturers' BLAS)} +%{\tt +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make blaslib} +%\end{list} } +% +%\item Run the Level 1, 2, and 3 BLAS Test Programs +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make blas\_testing} +%\end{list} +% +%\item Create the LAPACK Library +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make lapacklib} +%\end{list} +% +%\item Create the Library of Test Matrix Generators +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make tmglib} +%\end{list} +% +%\item Run the LAPACK Test Programs +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make testing} +%\end{list} +% +%\item Run the LAPACK Timing Programs +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make timing} +%\end{list} +% +%\item Run the BLAS Timing Programs +%\begin{list}{}{} +%\item \texttt{cd LAPACK} +%\item \texttt{make blas\_timing} +%\end{list} +\end{enumerate} + +\subsection{Untar the File} + +If you received a tar file of LAPACK via the World Wide +Web or anonymous ftp, enter the following command: + +\begin{list}{} +\item{\texttt{gunzip -c lapack.tgz | tar xvf -}} +\end{list} + +\noindent +This will create a top-level directory called \texttt{LAPACK}, which +requires approximately 34 Mbytes of disk space. +The total space requirements including the object files and executables +is approximately 100 Mbytes for all four data types. + +\subsection{Copy and edit the file \texttt{LAPACK/make.inc.example to LAPACK/make.inc}} + +Before the libraries can be built, or the testing and timing\footnotemark[\value{footnote}] programs +run, you must define all machine-specific parameters for the +architecture to which you are installing LAPACK. All machine-specific +parameters are contained in the file \texttt{LAPACK/make.inc}. +An example of \texttt{LAPACK/make.inc} for a LINUX machine with GNU compilers is given +in \texttt{LAPACK/make.inc.example}, copy that file to LAPACK/make.inc by entering the following command: + +\begin{list}{} +\item{\texttt{cp LAPACK/make.inc.example LAPACK/make.inc}} +\end{list} + +\noindent +Now modify your \texttt{LAPACK/make.inc} by applying the following recommendations. +The first line of this \texttt{make.inc} file is: +\begin{quote} +SHELL = /bin/sh +\end{quote} +and it will need to be modified to \texttt{SHELL = /sbin/sh} if you are +installing LAPACK on an SGI architecture. +Second, you will +need to modify the \texttt{PLAT} definition, which is appended to all +library names, to specify the architecture to which you are installing +LAPACK. This features avoids confusion in library names when you are +installing LAPACK on more than one architecture. Next, you will need +to modify \texttt{FORTRAN}, \texttt{OPTS}, \texttt{DRVOPTS}, \texttt{NOOPT}, \texttt{LOADER}, +and \texttt{LOADOPTS} to specify +the compiler, compiler options, compiler options for the testing and +timing\footnotemark[\value{footnote}] main programs, loader, loader options. +Next you will have to choose which function you will use to time in the \texttt{SECOND} and \texttt{DSECND} routines. +\begin{verbatim} +#The Default : SECOND and DSECND will use a call to the EXTERNAL FUNCTION ETIME +TIMER = EXT_ETIME +# For RS6K : SECOND and DSECND will use a call to the EXTERNAL FUNCTION ETIME_ +# TIMER = EXT_ETIME_ +# For gfortran compiler: SECOND and DSECND will use the INTERNAL FUNCTION ETIME +# TIMER = INT_ETIME +# If your Fortran compiler does not provide etime (like Nag Fortran Compiler, etc...) +# SECOND and DSECND will use a call to the INTERNAL FUNCTION CPU_TIME +# TIMER = INT_CPU_TIME +# If neither of this works...you can use the NONE value... +# In that case, SECOND and DSECND will always return 0 +# TIMER = NONE +\end{verbatim} +Refer to the section~\ref{second} to get more information. + + +Next, you will need to modify \texttt{ARCH}, \texttt{ARCHFLAGS}, and \texttt{RANLIB} to specify archiver, +archiver options, and ranlib for your machine. If your architecture +does not require \texttt{ranlib} to be run after each archive command (as +is the case with CRAY computers running UNICOS, Hewlett Packard +computers running HP-UX, or SUN SPARCstations running Solaris), set +\texttt{ranlib=echo}. And finally, you must +modify the \texttt{BLASLIB} definition to specify the BLAS library to which +you will be linking. If an optimized version of the BLAS is available +on your machine, you are highly recommended to link to that library. +Otherwise, by default, \texttt{BLASLIB} is set to the Fortran~77 version. + +If you want to enable the XBLAS, define the variable \texttt{USEXBLAS} +to some value, for example \texttt{USEXBLAS = Yes}. Then set the +variable \texttt{XBLASLIB} to point at the XBLAS library. Note that +the prototype iterative refinement routines and their testers will not +be built unless \texttt{USEXBLAS} is defined. + +\textbf{NOTE:} Example \texttt{make.inc} include files are contained in the +\texttt{LAPACK/INSTALL} directory. Please refer to +Appendix~\ref{appendixd} for machine-specific installation hints, and/or +the \texttt{release\_notes} file on \texttt{netlib}. +\begin{quote} +\url{http://www.netlib.org/lapack/release\_notes} +\end{quote} + +\subsection{Edit the file \texttt{LAPACK/Makefile}}\label{toplevelmakefile} + +This \texttt{Makefile} can be modified to perform as much of the +installation process as the user desires. Ideally, this is the ONLY +makefile the user must modify. However, modification of lower-level +makefiles may be necessary if a specific routine needs to be compiled +with a different level of optimization. + +First, edit the definitions of \texttt{blaslib}, \texttt{lapacklib}, +\texttt{tmglib}, \texttt{lapack\_testing}, and \texttt{timing}\footnotemark[\value{footnote}] in the file \texttt{LAPACK/Makefile} +to specify the data types desired. For example, +if you only wish to compile the single precision real version of the +LAPACK library, you would modify the \texttt{lapacklib} definition to be: + +\begin{verbatim} +lapacklib: + ( cd SRC; $(MAKE) single ) +\end{verbatim} + +Likewise, you could specify \texttt{double, complex, or complex16} to +build the double precision real, single precision complex, or double +precision complex libraries, respectively. By default, the presence of +no arguments following the \texttt{make} command will result in the +building of all four data types. +The make command can be run more than once to add another +data type to the library if necessary. + +%If you are installing LAPACK on a Silicon Graphics machine, you must +%modify the respective definitions of \texttt{testing} and \texttt{timing} to be +%\begin{verbatim} +%testing: +% ( cd TESTING; $(MAKE) -f Makefile.sgi ) +%\end{verbatim} +%and +%\begin{verbatim} +%timing: +% ( cd TIMING; $(MAKE) -f Makefile.sgi ) +%\end{verbatim} + +Next, if you will be using a locally available BLAS library, you will need +to remove \texttt{blaslib} from the \texttt{lib} definition. And finally, +if you do not wish to build all of the libraries individually and +likewise run all of the testing and timing separately, you can +modify the \texttt{all} definition to specify the amount of the +installation process that you want performed. By default, +the \texttt{all} definition is set to +\begin{verbatim} +all: lapack_install lib lapack_testing blas_testing +\end{verbatim} +which will perform all phases of the installation +process -- testing of machine-dependent routines, building the libraries, +BLAS testing and LAPACK testing. + +The entire installation process will then be performed by typing +\texttt{make}. + +Questions and/or comments can be directed to the +authors as described in Section~\ref{sendresults}. If test failures +occur, please refer to the appropriate subsection in +Section~\ref{furtherdetails}. + +If disk space is limited, we suggest building each data type separately +and/or deleting all object files after building the libraries. Likewise, all +testing and timing executables can be deleted after the testing and timing +process is completed. The removal of all object files and executables +can be accomplished by the following: + +\begin{list}{}{} +\item \texttt{cd LAPACK} +\item \texttt{make clean} +\end{list} + +\section{Further Details of the Installation Process}\label{furtherdetails} + +Alternatively, you can choose to run each of the phases of the +installation process separately. The following sections give details +on how this may be achieved. + +\subsection{Test and Install the Machine-Dependent Routines.} + +There are six machine-dependent functions in the test and timing +package, at least three of which must be installed. They are + +\begin{tabbing} +MONOMO \= DOUBLE PRECYSION \= \kill +LSAME \> LOGICAL \> Test if two characters are the same regardless of case \\ +SLAMCH \> REAL \> Determine machine-dependent parameters \\ +DLAMCH \> DOUBLE PRECISION \> Determine machine-dependent parameters \\ +SECOND \> REAL \> Return time in seconds from a fixed starting time \\ +DSECND \> DOUBLE PRECISION \> Return time in seconds from a fixed starting time\\ +ILAENV \> INTEGER \> Checks that NaN and infinity arithmetic are IEEE-754 compliant +\end{tabbing} + +\noindent +If you are working only in single precision, you do not need to install +DLAMCH and DSECND, and if you are working only in double precision, +you do not need to install SLAMCH and SECOND. + +These six subroutines are provided in \texttt{LAPACK/INSTALL}, +along with six test programs. +To compile the six test programs and run the tests, go to \texttt{LAPACK} and +type \texttt{make lapack\_install}. The test programs are called +\texttt{testlsame, testslamch, testdlamch, testsecond, testdsecnd} and +\texttt{testieee}. +If you do not wish to run all tests, you will need to modify the +\texttt{lapack\_install} definition in the \texttt{LAPACK/Makefile} to only include the +tests you wish to run. Otherwise, all tests will be performed. +The expected results of each test program are described below. + +\subsubsection{Installing LSAME} + +LSAME is a logical function with two character parameters, A and B. +It returns .TRUE. if A and B are the same regardless of case, or .FALSE. +if they are different. +For example, the expression + +\begin{list}{}{} +\item \texttt{LSAME( UPLO, 'U' )} +\end{list} +\noindent +is equivalent to +\begin{list}{}{} +\item \texttt{( UPLO.EQ.'U' ).OR.( UPLO.EQ.'u' )} +\end{list} + +The test program in \texttt{lsametst.f} tests all combinations of +the same character in upper and lower case for A and B, and two +cases where A and B are different characters. + +Run the test program by typing \texttt{testlsame}. +If LSAME works correctly, the only message you should see after the +execution of \texttt{testlsame} is +\begin{verbatim} + ASCII character set + Tests completed +\end{verbatim} +The file \texttt{lsame.f} is automatically copied to +\texttt{LAPACK/BLAS/SRC/} and \texttt{LAPACK/SRC/}. +The function LSAME is needed by both the BLAS and LAPACK, so it is safer +to have it in both libraries as long as this does not cause trouble +in the link phase when both libraries are used. + +\subsubsection{Installing SLAMCH and DLAMCH} + +SLAMCH and DLAMCH are real functions with a single character parameter +that indicates the machine parameter to be returned. The test +program in \texttt{slamchtst.f} +simply prints out the different values computed by SLAMCH, +so you need to know something about what the values should be. +For example, the output of the test program executable \texttt{testslamch} +for SLAMCH on a Sun SPARCstation is +\begin{verbatim} + Epsilon = 5.96046E-08 + Safe minimum = 1.17549E-38 + Base = 2.00000 + Precision = 1.19209E-07 + Number of digits in mantissa = 24.0000 + Rounding mode = 1.00000 + Minimum exponent = -125.000 + Underflow threshold = 1.17549E-38 + Largest exponent = 128.000 + Overflow threshold = 3.40282E+38 + Reciprocal of safe minimum = 8.50706E+37 +\end{verbatim} +On a Cray machine, the safe minimum underflows its output +representation and the overflow threshold overflows its output +representation, so the safe minimum is printed as 0.00000 and overflow +is printed as R. This is normal. +If you would prefer to print a representable number, you can modify +the test program to print SFMIN*100. and RMAX/100. for the safe +minimum and overflow thresholds. + +Likewise, the test executable \texttt{testdlamch} is run for DLAMCH. + +If both tests were successful, go to Section~\ref{second}. + +If SLAMCH (or DLAMCH) returns an invalid value, you will have to create +your own version of this function. The following options are used in +LAPACK and must be set: + +\begin{list}{}{} +\item {`B': } Base of the machine +\item {`E': } Epsilon (relative machine precision) +\item {`O': } Overflow threshold +\item {`P': } Precision = Epsilon*Base +\item {`S': } Safe minimum (often same as underflow threshold) +\item {`U': } Underflow threshold +\end{list} + +Some people may be familiar with R1MACH (D1MACH), a primitive +routine for setting machine parameters in which the user must +comment out the appropriate assignment statements for the target +machine. If a version of R1MACH is on hand, the assignments in +SLAMCH can be made to refer to R1MACH using the correspondence + +\begin{list}{}{} +\item {SLAMCH( `U' )} $=$ R1MACH( 1 ) +\item {SLAMCH( `O' )} $=$ R1MACH( 2 ) +\item {SLAMCH( `E' )} $=$ R1MACH( 3 ) +\item {SLAMCH( `B' )} $=$ R1MACH( 5 ) +\end{list} + +\noindent +The safe minimum returned by SLAMCH( 'S' ) is initially set to the +underflow value, but if $1/(\mathrm{overflow}) \geq (\mathrm{underflow})$ +it is recomputed as $(1/(\mathrm{overflow})) * ( 1 + \varepsilon )$, +where $\varepsilon$ is the machine precision. + +BE AWARE that the initial call to SLAMCH or DLAMCH is expensive. +We suggest that installers run it once, save the results, and hard-code +the constants in the version they put in their library. + +\subsubsection{Installing SECOND and DSECND}\label{second} + +Both the timing routines\footnotemark[\value{footnote}] and the test routines call SECOND +(DSECND), a real function with no arguments that returns the time +in seconds from some fixed starting time. +Our version of this routine +returns only ``user time'', and not ``user time $+$ system time''. +The following version of SECOND in \texttt{second\_EXT\_ETIME.f, second\_INT\_ETIME.f} calls +ETIME, a Fortran library routine available on some computer systems. +If ETIME is not available or a better local timing function exists, +you will have to provide the correct interface to SECOND and DSECND +on your machine. + +Since LAPACK 3.1.1 we provide 5 different flavours of the SECOND and DSECND routines. +The version that will be used depends on the value of the TIMER variable in the make.inc + +\begin{itemize} +\item If ETIME is available as an external function, set the value of the TIMER variable in your +make.inc to \texttt{EXT\_ETIME}:\texttt{second\_EXT\_ETIME.f} and \texttt{dsecnd\_EXT\_ETIME.f} will be used. +Usually on HPPA architectures, +the compiler and loader flag \texttt{+U77} should be included to access +the function \texttt{ETIME}. + +\item If ETIME\_ is available as an external function, set the value of the TIMER variable in your make.inc +to \texttt{EXT\_ETIME\_}:\texttt{second\_EXT\_ETIME\_.f} and \texttt{dsecnd\_EXT\_ETIME\_.f} will be used. +It is the case on some IBM architectures such as IBM RS/6000s. + +\item If ETIME is available as an internal function, set the value of the TIMER variable in your make.inc +to \texttt{INT\_ETIME}:\texttt{second\_INT\_ETIME.f} and \texttt{dsecnd\_INT\_ETIME.f} will be used. +This is the case with gfortan. + +\item If CPU\_TIME is available as an internal function, set the value of the TIMER variable in your make.inc +to \texttt{INT\_CPU\_TIME}:\texttt{second\_INT\_CPU\_TIME.f} and \texttt{dsecnd\_INT\_CPU\_TIME.f} will be used. + +\item If none of these function is available, set the value of the TIMER variable in your make.inc +to \texttt{NONE:}\texttt{second\_NONE.f} and \texttt{dsecnd\_NONE.f} will be used. +These routines will always return zero. +\end{itemize} + +The test program in \texttt{secondtst.f} +performs a million operations using 5000 iterations of +the SAXPY operation $y := y + \alpha x$ on a vector of length 100. +The total time and megaflops for this test is reported, then +the operation is repeated including a call to SECOND on each of +the 5000 iterations to determine the overhead due to calling SECOND. +The test program executable is called \texttt{testsecond} (or \texttt{testdsecnd}). +There is no single right answer, but the times +in seconds should be positive and the megaflop ratios should be +appropriate for your machine. + +\subsubsection{Testing IEEE arithmetic and ILAENV}\label{testieee} + +%\textbf{If you are installing LAPACK on a non-IEEE machine, you MUST +%modify ILAENV! Otherwise, ILAENV will crash . By default, ILAENV +%assumes an IEEE machine, and does a test for IEEE-754 compliance.} + +As some new routines in LAPACK rely on IEEE-754 compliance, +two settings (\texttt{ISPEC=10} and \texttt{ISPEC=11}) have been added to ILAENV +(\texttt{LAPACK/SRC/ilaenv.f}) to denote IEEE-754 compliance for NaN and +infinity arithmetic, respectively. By default, ILAENV assumes an IEEE +machine, and does a test for IEEE-754 compliance. \textbf{NOTE: If you +are installing LAPACK on a non-IEEE machine, you MUST modify ILAENV, +as this test inside ILAENV will crash!} + +If \texttt{ILAENV( 10, $\ldots$ )} or \texttt{ILAENV( 11, $\ldots$ )} is +issued, then \texttt{ILAENV=1} is returned to signal IEEE-754 compliance, +and \texttt{ILAENV=0} if the architecture is non-IEEE-754 compliant. + +Thus, for non-IEEE machines, the user must hard-code the setting of +(\texttt{ILAENV=0}) for (\texttt{ISPEC=10} and \texttt{ISPEC=11}) in the version +of \texttt{LAPACK/SRC/ilaenv.f} to be put in +his library. There are also specialized testing and timing\footnotemark[\value{footnote}] versions of +ILAENV that will also need to be modified. +\begin{itemize} +\item Testing/timing version of \texttt{LAPACK/TESTING/LIN/ilaenv.f} +\item Testing/timing version of \texttt{LAPACK/TESTING/EIG/ilaenv.f} +\item Testing/timing version of \texttt{LAPACK/TIMING/LIN/ilaenv.f} +\item Testing/timing version of \texttt{LAPACK/TIMING/EIG/ilaenv.f} +\end{itemize} + +%Some new routines in LAPACK rely on IEEE-754 compliance, and if non-compliance +%is detected (via a call to the function ILAENV), alternative (slower) +%algorithms will be chosen. +%For further details, refer to the leading comments of routines such +%as \texttt{LAPACK/SRC/sstevr.f}. + +The test program in \texttt{LAPACK/INSTALL/tstiee.f} checks an installation +architecture +to see if infinity arithmetic and NaN arithmetic are IEEE-754 compliant. +A warning message to the user is printed if non-compliance is detected. +This same test is performed inside the function ILAENV. If +\texttt{ILAENV( 10, $\ldots$ )} or \texttt{ILAENV( 11, $\ldots$ )} is +issued, then \texttt{ILAENV=1} is returned to signal IEEE-754 compliance, +and \texttt{ILAENV=0} if the architecture is non-IEEE-754 compliant. + +To avoid this IEEE test being run every time you call +\texttt{ILAENV( 10, $\ldots$)} or \texttt{ILAENV( 11, $\ldots$ )}, we suggest +that the user hard-code the setting of +\texttt{ILAENV=1} or \texttt{ILAENV=0} in the version of \texttt{LAPACK/SRC/ilaenv.f} to be put in +his library. As aforementioned, there are also specialized testing and +timing\footnotemark[\value{footnote}] versions of ILAENV that will also need to be modified. + +\subsection{Create the BLAS Library} + +Ideally, a highly optimized version of the BLAS library already +exists on your machine. +In this case you can go directly to Section~\ref{testblas} to +make the BLAS test programs. + +\begin{itemize} +\item[a)] +Go to \texttt{LAPACK} and edit the definition of \texttt{blaslib} in the +file \texttt{Makefile} to specify the data types desired, as in the example +in Section~\ref{toplevelmakefile}. + +If you already have some of the BLAS, you will need to edit the file +\texttt{LAPACK/BLAS/SRC/Makefile} to comment out the lines +defining the BLAS you have. + +\item[b)] +Type \texttt{make blaslib}. +The make command can be run more than once to add another +data type to the library if necessary. +\end{itemize} + +\noindent +The BLAS library is created in \texttt{LAPACK/blas\_PLAT.a}, where +\texttt{PLAT} is the user-defined architecture suffix specified in the file +\texttt{LAPACK/make.inc}. + +\subsection{Run the BLAS Test Programs}\label{testblas} + +Test programs for the Level 1, 2, and 3 BLAS are in the directory +\texttt{LAPACK/BLAS/TESTING}. + +To compile and run the Level 1, 2, and 3 BLAS test programs, +go to \texttt{LAPACK} and type \texttt{make blas\_testing}. The executable +files are called \texttt{xblat\_s}, \texttt{xblat\_d}, \texttt{xblat\_c}, and +\texttt{xblat\_z}, where the \_ (underscore) is replaced by 1, 2, or 3, +depending upon the level of BLAS that it is testing. All executable and +output files are created in \texttt{LAPACK/BLAS/}. +For the Level 1 BLAS tests, the output file names are \texttt{sblat1.out}, +\texttt{dblat1.out}, \texttt{cblat1.out}, and \texttt{zblat1.out}. For the Level +2 and 3 BLAS, the name of the output file is indicated on the first line of the +input file and is currently defined to be \texttt{sblat2.out} for +the Level 2 REAL version, and \texttt{sblat3.out} for the Level 3 REAL +version, with similar names for the other data types. + +If the tests using the supplied data files were completed successfully, +consider whether the tests were sufficiently thorough. +For example, on a machine with vector registers, at least one value +of $N$ greater than the length of the vector registers should be used; +otherwise, important parts of the compiled code may not be +exercised by the tests. +If the tests were not successful, either because the program did not +finish or the test ratios did not pass the threshold, you will +probably have to find and correct the problem before continuing. +If you have been testing a system-specific +BLAS library, try using the Fortran BLAS for the routines that +did not pass the tests. +For more details on the BLAS test programs, +see \cite{BLAS2-test} and \cite{BLAS3-test}. + +\subsection{Create the LAPACK Library} + +\begin{itemize} +\item[a)] +Go to the directory \texttt{LAPACK} and edit the definition of +\texttt{lapacklib} in the file \texttt{Makefile} to specify the data types desired, +as in the example in Section~\ref{toplevelmakefile}. + +\item[b)] +Type \texttt{make lapacklib}. +The make command can be run more than once to add another +data type to the library if necessary. + +\end{itemize} + +\noindent +The LAPACK library is created in \texttt{LAPACK/lapack\_PLAT.a}, where +\texttt{PLAT} is the user-defined architecture suffix specified in the file +\texttt{LAPACK/make.inc}. + +\subsection{Create the Test Matrix Generator Library} + +\begin{itemize} +\item[a)] +Go to the directory \texttt{LAPACK} and edit the definition of \texttt{tmglib} +in the file \texttt{Makefile} to specify the data types desired, as in the +example in Section~\ref{toplevelmakefile}. + +\item[b)] +Type \texttt{make tmglib}. +The make command can be run more than once to add another +data type to the library if necessary. + +\end{itemize} + +\noindent +The test matrix generator library is created in \texttt{LAPACK/tmglib\_PLAT.a}, +where \texttt{PLAT} is the user-defined architecture suffix specified in the +file \texttt{LAPACK/make.inc}. + +\subsection{Run the LAPACK Test Programs} + +There are two distinct test programs for LAPACK routines +in each data type, one for the linear equation routines and +one for the eigensystem routines. +In each data type, there is one input file for testing the linear +equation routines and eighteen input files for testing the eigenvalue +routines. +The input files reside in \texttt{LAPACK/TESTING}. +For more information on the test programs and how to modify the +input files, please refer to LAPACK Working Note 41~\cite{WN41}. +% see Section~\ref{moretesting}. + +If you do not wish to run each of the tests individually, you can +go to \texttt{LAPACK}, edit the definition \texttt{lapack\_testing} in the file +\texttt{Makefile} to specify the data types desired, and type \texttt{make +lapack\_testing}. This will +compile and run the tests as described in sections~\ref{testlin} +and ~\ref{testeig}. + +%If you are installing LAPACK on a Silicon Graphics machine, you must +%modify the definition of \texttt{testing} to be +%\begin{verbatim} +%testing: +% ( cd TESTING; $(MAKE) -f Makefile.sgi ) +%\end{verbatim} + +\subsubsection{Testing the Linear Equations Routines}\label{testlin} + +\begin{itemize} + +\item[a)] +Go to \texttt{LAPACK/TESTING/LIN} and type \texttt{make} followed by the data types +desired. The executable files are called \texttt{xlintsts, xlintstc, +xlintstd}, or \texttt{xlintstz} and are created in \texttt{LAPACK/TESTING}. + +\item[b)] +Go to \texttt{LAPACK/TESTING} and run the tests for each data type. +For the REAL version, the command is +\begin{list}{}{} +\item{} \texttt{xlintsts < stest.in > stest.out} +\end{list} + +\noindent +The tests using \texttt{xlintstd}, \texttt{xlintstc}, and \texttt{xlintstz} are similar +with the leading `s' in the input and output file names replaced +by `d', `c', or `z'. + +\end{itemize} + +If you encountered failures in this phase of the testing process, please +refer to Section~\ref{sendresults}. + +\subsubsection{Testing the Eigensystem Routines}\label{testeig} + +\begin{itemize} + +\item[a)] +Go to \texttt{LAPACK/TESTING/EIG} and type \texttt{make} followed by the data types +desired. The executable files are called \texttt{xeigtsts, +xeigtstc, xeigtstd}, and \texttt{xeigtstz} and are created +in \texttt{LAPACK/TESTING}. + +\item[b)] +Go to \texttt{LAPACK/TESTING} and run the tests for each data type. +The tests for the eigensystem routines use eighteen separate input files +for testing the nonsymmetric eigenvalue problem, +the symmetric eigenvalue problem, the banded symmetric eigenvalue +problem, the generalized symmetric eigenvalue +problem, the generalized nonsymmetric eigenvalue problem, the +singular value decomposition, the banded singular value decomposition, +the generalized singular value +decomposition, the generalized QR and RQ factorizations, the generalized +linear regression model, and the constrained linear least squares +problem. +The tests for the REAL version are as follows: +\begin{list}{}{} +\item \texttt{xeigtsts < nep.in > snep.out} +\item \texttt{xeigtsts < sep.in > ssep.out} +\item \texttt{xeigtsts < svd.in > ssvd.out} +\item \texttt{xeigtsts < sec.in > sec.out} +\item \texttt{xeigtsts < sed.in > sed.out} +\item \texttt{xeigtsts < sgg.in > sgg.out} +\item \texttt{xeigtsts < sgd.in > sgd.out} +\item \texttt{xeigtsts < ssg.in > ssg.out} +\item \texttt{xeigtsts < ssb.in > ssb.out} +\item \texttt{xeigtsts < sbb.in > sbb.out} +\item \texttt{xeigtsts < sbal.in > sbal.out} +\item \texttt{xeigtsts < sbak.in > sbak.out} +\item \texttt{xeigtsts < sgbal.in > sgbal.out} +\item \texttt{xeigtsts < sgbak.in > sgbak.out} +\item \texttt{xeigtsts < glm.in > sglm.out} +\item \texttt{xeigtsts < gqr.in > sgqr.out} +\item \texttt{xeigtsts < gsv.in > sgsv.out} +\item \texttt{xeigtsts < lse.in > slse.out} +\end{list} +The tests using \texttt{xeigtstc}, \texttt{xeigtstd}, and \texttt{xeigtstz} also +use the input files \texttt{nep.in}, \texttt{sep.in}, \texttt{svd.in}, +\texttt{glm.in}, \texttt{gqr.in}, \texttt{gsv.in}, and \texttt{lse.in}, +but the leading `s' in the other input file names must be changed +to `c', `d', or `z'. +\end{itemize} + +If you encountered failures in this phase of the testing process, please +refer to Section~\ref{sendresults}. + +\subsection{Run the LAPACK Timing Programs (For LAPACK 3.0 and before)} + +There are two distinct timing programs for LAPACK routines +in each data type, one for the linear equation routines and +one for the eigensystem routines. The timing program for the +linear equation routines is also used to time the BLAS. +We encourage you to conduct these timing experiments +in REAL and COMPLEX or in DOUBLE PRECISION and COMPLEX*16; it is +not necessary to send timing results in all four data types. + +Two sets of input files are provided, a small set and a large set. +The small data sets are appropriate for a standard workstation or +other non-vector machine. +The large data sets are appropriate for supercomputers, vector +computers, and high-performance workstations. +We are mainly interested in results from the large data sets, and +it is not necessary to run both the large and small sets. +The values of N in the large data sets are about five times larger +than those in the small data set, +and the large data sets use additional values for parameters such as the +block size NB and the leading array dimension LDA. +Small data sets finished with the \_small in their name , such as +\texttt{stime\_small.in}, and large data sets finished with \_large in their name, +such as \texttt{stime\_large.in}. +Except as noted, the leading `s' in the input file name must be +replaced by `d', `c', or `z' for the other data types. + +We encourage you to obtain timing results with the large data sets, +as this allows us to compare different machines. +If this would take too much time, suggestions for paring back the large +data sets are given in the instructions below. +We also encourage you to experiment with these timing +programs and send us any interesting results, such as results for +larger problems or for a wider range of block sizes. +The main programs are dimensioned for the large data sets, +so the parameters in the main program may have to be reduced in order +to run the small data sets on a small machine, or increased to run +experiments with larger problems. + +The minimum time each subroutine will be timed is set to 0.0 in +the large data files and to 0.05 in the small data files, and on +many machines this value should be increased. +If the timing interval is not long +enough, the time for the subroutine after subtracting the overhead +may be very small or zero, resulting in megaflop rates that are +very large or zero. (To avoid division by zero, the megaflop rate is +set to zero if the time is less than or equal to zero.) +The minimum time that should be used depends on the machine and the +resolution of the clock. + +For more information on the timing programs and how to modify the +input files, please refer to LAPACK Working Note 41~\cite{WN41}. +% see Section~\ref{moretiming}. + +If you do not wish to run each of the timings individually, you can +go to \texttt{LAPACK}, edit the definition \texttt{lapack\_timing} in the file +\texttt{Makefile} to specify the data types desired, and type \texttt{make +lapack\_timing}. This will compile +and run the timings for the linear equation routines and the eigensystem +routines (see Sections~\ref{timelin} and ~\ref{timeeig}). + +%If you are installing LAPACK on a Silicon Graphics machine, you must +%modify the definition of \texttt{timing} to be +%\begin{verbatim} +%timing: +% ( cd TIMING; $(MAKE) -f Makefile.sgi ) +%\end{verbatim} + +If you encounter failures in any phase of the timing process, please +feel free to contact the authors as directed in Section~\ref{sendresults}. +Tell us the +type of machine on which the tests were run, the version of the operating +system, the compiler and compiler options that were used, +and details of the BLAS library or libraries that you used. You should +also include a copy of the output file in which the failure occurs. + +Please note that the BLAS +timing runs will still need to be run as instructed in ~\ref{timeblas}. + +\subsubsection{Timing the Linear Equations Routines}\label{timelin} + +The linear equation timing program is found in \texttt{LAPACK/TIMING/LIN} +and the input files are in \texttt{LAPACK/TIMING}. +Three input files are provided in each data type for timing the +linear equation routines, one for square matrices, one for band +matrices, and one for rectangular matrices. The small data sets for the REAL version +are \texttt{stime\_small.in}, \texttt{sband\_small.in}, and \texttt{stime2\_small.in}, respectively, +and the large data sets are +\texttt{stime\_large.in}, \texttt{sband\_large.in}, and \texttt{stime2\_large.in}. + +The timing program for the least squares routines uses special instrumented +versions of the LAPACK routines to time individual sections of the code. +The first step in compiling the timing program is therefore to make a library +of the instrumented routines. + +\begin{itemize} +\item[a)] +\begin{sloppypar} +To make a library of the instrumented LAPACK routines, first +go to \texttt{LAPACK/TIMING/LIN/LINSRC} and type \texttt{make} followed +by the data types desired, as in the examples of Section~\ref{toplevelmakefile}. +The library of instrumented code is created in +\texttt{LAPACK/TIMING/LIN/linsrc\_PLAT.a}, +where \texttt{PLAT} is the user-defined architecture suffix specified in the +file \texttt{LAPACK/make.inc}. +\end{sloppypar} + +\item[b)] +To make the linear equation timing programs, +go to \texttt{LAPACK/TIMING/LIN} and type \texttt{make} followed by the data +types desired, as in the examples in Section~\ref{toplevelmakefile}. +The executable files are called \texttt{xlintims}, +\texttt{xlintimc}, \texttt{xlintimd}, and \texttt{xlintimz} and are created +in \texttt{LAPACK/TIMING}. + +\item[c)] +Go to \texttt{LAPACK/TIMING} and +make any necessary modifications to the input files. +You may need to set the minimum time a subroutine will +be timed to a positive value, or to restrict the size of the tests +if you are using a computer with performance in between that of a +workstation and that of a supercomputer. +The computational requirements can be cut in half by using only one +value of LDA. +If it is necessary to also reduce the matrix sizes or the values of +the blocksize, corresponding changes should be made to the +BLAS input files (see Section~\ref{timeblas}). + +\item[d)] +Run the programs for each data type you are using. +For the REAL version, the commands for the small data sets are + +\begin{list}{}{} +\item{} \texttt{xlintims < stime\_small.in > stime\_small.out } +\item{} \texttt{xlintims < sband\_small.in > sband\_small.out } +\item{} \texttt{xlintims < stime2\_small.in > stime2\_small.out } +\end{list} +or the commands for the large data sets are +\begin{list}{}{} +\item{} \texttt{xlintims < stime\_large.in > stime\_large.out } +\item{} \texttt{xlintims < sband\_large.in > sband\_large.out } +\item{} \texttt{xlintims < stime2\_large.in > stime2\_large.out } +\end{list} + +\noindent +Similar commands should be used for the other data types. +\end{itemize} + +\subsubsection{Timing the BLAS}\label{timeblas} + +The linear equation timing program is also used to time the BLAS. +Three input files are provided in each data type for timing the Level +2 and 3 BLAS. +These input files time the BLAS using the matrix shapes encountered +in the LAPACK routines, and we will use the results to analyze the +performance of the LAPACK routines. +For the REAL version, the small data files are +\texttt{sblasa\_small.in}, \texttt{sblasb\_small.in}, and \texttt{sblasc\_small.in} +and the large data files are +\texttt{sblasa\_large.in}, \texttt{sblasb\_large.in}, and \texttt{sblasc\_large.in}. +There are three sets of inputs because there are three +parameters in the Level 3 BLAS, M, N, and K, and +in most applications one of these parameters is small (on the order +of the blocksize) while the other two are large (on the order of the +matrix size). +In \texttt{sblasa\_small.in}, M and N are large but K is +small, while in \texttt{sblasb\_small.in} the small parameter is M, and +in \texttt{sblasc\_small.in} the small parameter is N. +The Level 2 BLAS are timed only in the first data set, where K +is also used as the bandwidth for the banded routines. + +\begin{itemize} + +\item[a)] +Go to \texttt{LAPACK/TIMING} and +make any necessary modifications to the input files. +You may need to set the minimum time a subroutine will +be timed to a positive value. +If you modified the values of N or NB +in Section~\ref{timelin}, set M, N, and K accordingly. +The large parameters among M, N, and K +should be the same as the matrix sizes used in timing the linear +equation routines, +and the small parameter should be the same as the +blocksizes used in timing the linear equation routines. +If necessary, the large data set can be simplified by using only one +value of LDA. + +\item[b)] +Run the programs for each data type you are using. +For the REAL version, the commands for the small data sets are + +\begin{list}{}{} +\item{} \texttt{xlintims < sblasa\_small.in > sblasa\_small.out } +\item{} \texttt{xlintims < sblasb\_small.in > sblasb\_small.out } +\item{} \texttt{xlintims < sblasc\_small.in > sblasc\_small.out } +\end{list} +or the commands for the large data sets are +\begin{list}{}{} +\item{} \texttt{xlintims < sblasa\_large.in > sblasa\_large.out } +\item{} \texttt{xlintims < sblasb\_large.in > sblasb\_large.out } +\item{} \texttt{xlintims < sblasc\_large.in > sblasc\_large.out } +\end{list} + +\noindent +Similar commands should be used for the other data types. +\end{itemize} + +\subsubsection{Timing the Eigensystem Routines}\label{timeeig} + +The eigensystem timing program is found in \texttt{LAPACK/TIMING/EIG} +and the input files are in \texttt{LAPACK/TIMING}. +Four input files are provided in each data type for timing the +eigensystem routines, +one for the generalized nonsymmetric eigenvalue problem, +one for the nonsymmetric eigenvalue problem, +one for the symmetric and generalized symmetric eigenvalue problem, +and one for the singular value decomposition. +For the REAL version, the small data sets are called \texttt{sgeptim\_small.in}, +\texttt{sneptim\_small.in}, \texttt{sseptim\_small.in}, and \texttt{ssvdtim\_small.in}, respectively. +and the large data sets are called \texttt{sgeptim\_large.in}, \texttt{sneptim\_large.in}, +\texttt{sseptim\_large.in}, and \texttt{ssvdtim\_large.in}. +Each of the four input files reads a different set of parameters, +and the format of the input is indicated by a 3-character code +on the first line. + +The timing program for eigenvalue/singular value routines accumulates +the operation count as the routines are executing using special +instrumented versions of the LAPACK routines. The first step in +compiling the timing program is therefore to make a library of the +instrumented routines. + +\begin{itemize} +\item[a)] +\begin{sloppypar} +To make a library of the instrumented LAPACK routines, first +go to \texttt{LAPACK/TIMING/EIG/EIGSRC} and type \texttt{make} followed +by the data types desired, as in the examples of Section~\ref{toplevelmakefile}. +The library of instrumented code is created in +\texttt{LAPACK/TIMING/EIG/eigsrc\_PLAT.a}, +where \texttt{PLAT} is the user-defined architecture suffix specified in the +file \texttt{LAPACK/make.inc}. +\end{sloppypar} + +\item[b)] +To make the eigensystem timing programs, +go to \texttt{LAPACK/TIMING/EIG} and +type \texttt{make} followed by the data types desired, as in the examples +of Section~\ref{toplevelmakefile}. The executable files are called +\texttt{xeigtims}, \texttt{xeigtimc}, \texttt{xeigtimd}, and \texttt{xeigtimz} +and are created in \texttt{LAPACK/TIMING}. + +\item[c)] +Go to \texttt{LAPACK/TIMING} and +make any necessary modifications to the input files. +You may need to set the minimum time a subroutine will +be timed to a positive value, or to restrict the number of tests +if you are using a computer with performance in between that of a +workstation and that of a supercomputer. +Instead of decreasing the matrix dimensions to reduce the time, +it would be better to reduce the number of matrix types to be timed, +since the performance varies more with the matrix size than with the +type. For example, for the nonsymmetric eigenvalue routines, +you could use only one matrix of type 4 instead of four matrices of +types 1, 3, 4, and 6. +Refer to LAPACK Working Note 41~\cite{WN41} for further details. +% See Section~\ref{moretiming} for further details. + +\item[d)] +Run the programs for each data type you are using. +For the REAL version, the commands for the small data sets are + +\begin{list}{}{} +\item{} \texttt{xeigtims < sgeptim\_small.in > sgeptim\_small.out } +\item{} \texttt{xeigtims < sneptim\_small.in > sneptim\_small.out } +\item{} \texttt{xeigtims < sseptim\_small.in > sseptim\_small.out } +\item{} \texttt{xeigtims < ssvdtim\_small.in > ssvdtim\_small.out } +\end{list} +or the commands for the large data sets are +\begin{list}{}{} +\item{} \texttt{xeigtims < sgeptim\_large.in > sgeptim\_large.out } +\item{} \texttt{xeigtims < sneptim\_large.in > sneptim\_large.out } +\item{} \texttt{xeigtims < sseptim\_large.in > sseptim\_large.out } +\item{} \texttt{xeigtims < ssvdtim\_large.in > ssvdtim\_large.out } +\end{list} + +\noindent +Similar commands should be used for the other data types. +\end{itemize} + +\subsection{Send the Results to Tennessee}\label{sendresults} + +Congratulations! You have now finished installing, testing, and +timing LAPACK. If you encountered failures in any phase of the +testing or timing process, please +consult our \texttt{release\_notes} file on netlib. +\begin{quote} +\url{http://www.netlib.org/lapack/release\_notes} +\end{quote} +This file contains machine-dependent installation clues which hopefully will +alleviate your difficulties or at least let you know that other users +have had similar difficulties on that machine. If there is not an entry +for your machine or the suggestions do not fix your problem, please feel +free to contact the authors at +\begin{list}{}{} +\item \href{mailto:lapack@cs.utk.edu}{\texttt{lapack@cs.utk.edu}}. +\end{list} +Tell us the +type of machine on which the tests were run, the version of the operating +system, the compiler and compiler options that were used, +and details of the BLAS library or libraries that you used. You should +also include a copy of the output file in which the failure occurs. + +We would like to keep our \texttt{release\_notes} file as up-to-date as possible. +Therefore, if you do not see an entry for your machine, please contact us +with your testing results. + +Comments and suggestions are also welcome. + +We encourage you to make the LAPACK library available to your +users and provide us with feedback from their experiences. +%This release of LAPACK is not guaranteed to be compatible +%with any previous test release. + +\subsection{Get support}\label{getsupport} +First, take a look at the complete installation manual in the LAPACK Working Note 41~\cite{WN41}. +if you still cannot solve your problem, you have 2 ways to go: +\begin{itemize} +\item +either send a post in the LAPACK forum +\begin{quote} +\url{http://icl.cs.utk.edu/lapack-forum} +\end{quote} +\item +or send an email to the LAPACK mailing list: +\begin{list}{}{} +\item \href{mailto:lapack@cs.utk.edu}{\texttt{lapack@cs.utk.edu}}. +\end{list} +\end{itemize} +\section*{Acknowledgments} + +Ed Anderson and Susan Blackford contributed to previous versions of this report. + +\appendix + +\chapter{Caveats}\label{appendixd} + +In this appendix we list a few of the machine-specific difficulties we +have +encountered in our own experience with LAPACK. A more detailed list +of machine-dependent problems, bugs, and compiler errors encountered +in the LAPACK installation process is maintained +on \emph{netlib}. +\begin{quote} +\url{http://www.netlib.org/lapack/release\_notes} +\end{quote} + +We assume the user has installed the machine-specific routines +correctly and that the Level 1, 2 and 3 BLAS test programs have run +successfully, so we do not list any warnings associated with those +routines. + +\section{\texttt{LAPACK/make.inc}} + +All machine-specific +parameters are specified in the file \texttt{LAPACK/make.inc}. + +The first line of this \texttt{make.inc} file is: +\begin{quote} +SHELL = /bin/sh +\end{quote} +and will need to be modified to \texttt{SHELL = /sbin/sh} if you are +installing LAPACK on an SGI architecture. + +\section{ETIME} + +On HPPA architectures, +the compiler and loader flag \texttt{+U77} should be included to access +the function \texttt{ETIME}. + +\section{ILAENV and IEEE-754 compliance} + +%By default, ILAENV (\texttt{LAPACK/SRC/ilaenv.f}) assumes an IEEE and IEEE-754 +%compliant architecture, and thus sets (\texttt{ILAENV=1}) for (\texttt{ISPEC=10}) +%and (\texttt{ISPEC=11}) settings in ILAENV. +% +%If you are installing LAPACK on a non-IEEE machine, you MUST modify ILAENV, +%as this test inside ILAENV will crash! + +As some new routines in LAPACK rely on IEEE-754 compliance, +two settings (\texttt{ISPEC=10} and \texttt{ISPEC=11}) have been added to ILAENV +(\texttt{LAPACK/SRC/ilaenv.f}) to denote IEEE-754 compliance for NaN and +infinity arithmetic, respectively. By default, ILAENV assumes an IEEE +machine, and does a test for IEEE-754 compliance. \textbf{NOTE: If you +are installing LAPACK on a non-IEEE machine, you MUST modify ILAENV, +as this test inside ILAENV will crash!} + +Thus, for non-IEEE machines, the user must hard-code the setting of +(\texttt{ILAENV=0}) for (\texttt{ISPEC=10} and \texttt{ISPEC=11}) in the version +of \texttt{LAPACK/SRC/ilaenv.f} to be put in +his library. For further details, refer to section~\ref{testieee}. + +Be aware +that some IEEE compilers by default do not enforce IEEE-754 compliance, and +a compiler flag must be explicitly set by the user. + +On SGIs for example, you must set the \texttt{-OPT:IEEE\_NaN\_inf=ON} compiler +flag to enable IEEE-754 compliance. + +And lastly, the test inside ILAENV to detect IEEE-754 compliance, will +result in IEEE exceptions for ``Divide by Zero'' and ``Invalid Operation''. +Thus, if the user is installing on a machine that issues IEEE exception +warning messages (like a Sun SPARCstation), the user can disregard these +messages. To avoid these messages, the user can hard-code the values +inside ILAENV as explained in section~\ref{testieee}. + +\section{Lack of \texttt{/tmp} space} + +If \texttt{/tmp} space is small (i.e., less than approximately 16 MB) on your +architecture, you may run out of space +when compiling. There are a few possible solutions to this problem. +\begin{enumerate} +\item You can ask your system administrator to increase the size of the +\texttt{/tmp} partition. +\item You can change the environment variable \texttt{TMPDIR} to point to +your home directory for temporary space. E.g., +\begin{quote} +\texttt{setenv TMPDIR /home/userid/} +\end{quote} +where \texttt{/home/userid/} is the user's home directory. +\item If your archive command has an \texttt{l} option, you can change the +archive command to \texttt{ar crl} so that the +archive command will only place temporary files in the current working +directory rather than in the default temporary directory /tmp. +\end{enumerate} + +\section{BLAS} + +If you suspect a BLAS-related problem and you are linking +with an optimized version of the BLAS, we would strongly suggest +as a first step that you link to the Fortran~77 version of +the suspected BLAS routine and see if the error has disappeared. + +We have included test programs for the Level 1 BLAS. +Users should therefore beware of a common problem in machine-specific +implementations of xNRM2, +the function to compute the 2-norm of a vector. +The Fortran version of xNRM2 avoids underflow or overflow +by scaling intermediate results, but some library versions of xNRM2 +are not so careful about scaling. +If xNRM2 is implemented without scaling intermediate results, some of +the LAPACK test ratios may be unusually high, or +a floating point exception may occur in the problems scaled near +underflow or overflow. +The solution to these problems is to link the Fortran version of +xNRM2 with the test program. \emph{On some CRAY architectures, the Fortran77 +version of xNRM2 should be used.} + +\section{Optimization} + +If a large numbers of test failures occur for a specific matrix type +or operation, it could be that there is an optimization problem with +your compiler. Thus, the user could try reducing the level of +optimization or eliminating optimization entirely for those routines +to see if the failures disappear when you rerun the tests. + +%LAPACK is written in Fortran 77. Prospective users with only a +%Fortran 66 compiler will not be able to use this package. + +\section{Compiling testing/timing drivers} + +The testing and timing main programs (xCHKAA, xCHKEE, xTIMAA, and +xTIMEE) +allocate large amounts of local variables. Therefore, it is vitally +important that the user know if his compiler by default allocates local +variables statically or on the stack. It is not uncommon for those +compilers which place local variables on the stack to cause a stack +overflow at runtime in the testing or timing process. The user then +has two options: increase your stack size, or force all local variables +to be allocated statically. + +On HPPA architectures, the +compiler and loader flag \texttt{-K} should be used when compiling these testing +and timing main programs to avoid such a stack overflow. I.e., set +\texttt{DRVOPTS = -K} in the \texttt{LAPACK/make.inc} file. + +For similar reasons, +on SGI architectures, the compiler and loader flag \texttt{-static} should be +used. I.e., set \texttt{DRVOPTS = -static} in the \texttt{LAPACK/make.inc} file. + +\section{IEEE arithmetic} + +Some of our test matrices are scaled near overflow or underflow, +but on the Crays, problems with the arithmetic near overflow and +underflow forced us to scale by only the square root of overflow +and underflow. +The LAPACK auxiliary routine SLABAD (or DLABAD) is called to +take the square root of underflow and overflow in cases where it +could cause difficulties. +We assume we are on a Cray if $ \log_{10} (\mathrm{overflow})$ +is greater than 2000 +and take the square root of underflow and overflow in this case. +The test in SLABAD is as follows: +\begin{verbatim} + IF( LOG10( LARGE ).GT.2000. ) THEN + SMALL = SQRT( SMALL ) + LARGE = SQRT( LARGE ) + END IF +\end{verbatim} +Users of other machines with similar restrictions on the effective +range of usable numbers may have to modify this test so that the +square roots are done on their machine as well. \emph{Usually on +HPPA architectures, a similar restriction in SLABAD should be enforced +for all testing involving complex arithmetic.} +SLABAD is located in \texttt{LAPACK/SRC}. + +For machines which have a narrow exponent range or lack gradual +underflow (DEC VAXes for example), it is not uncommon to experience +failures in sec.out and/or dec.out with SLAQTR/DLAQTR or DTRSYL. +The failures in SLAQTR/DLAQTR and DTRSYL +occur with test problems which are very badly scaled when the norm of +the solution is very close to the underflow +threshold (or even underflows to zero). We believe that these failures +could probably be avoided by an even greater degree of care in scaling, +but we did not want to delay the release of LAPACK any further. These +tests pass successfully on most other machines. An example failure in +dec.out on a MicroVAX II looks like the following: + +\begin{verbatim} +Tests of the Nonsymmetric eigenproblem condition estimation routines +DLALN2, DLASY2, DLANV2, DLAEXC, DTRSYL, DTREXC, DTRSNA, DTRSEN, DLAQTR + +Relative machine precision (EPS) = 0.277556D-16 +Safe minimum (SFMIN) = 0.587747D-38 + +Routines pass computational tests if test ratio is less than 20.00 + +DEC routines passed the tests of the error exits ( 35 tests done) +Error in DTRSYL: RMAX = 0.155D+07 +LMAX = 5323 NINFO= 1600 KNT= 27648 +Error in DLAQTR: RMAX = 0.344D+04 +LMAX = 15792 NINFO= 26720 KNT= 45000 +\end{verbatim} + +\section{Timing programs} + +In the eigensystem timing program, calls are made to the LINPACK +and EISPACK equivalents of the LAPACK routines to allow a direct +comparison of performance measures. +In some cases we have increased the minimum number of +iterations in the LINPACK and EISPACK routines to allow +them to converge for our test problems, but +even this may not be enough. +One goal of the LAPACK project is to improve the convergence +properties of these routines, so error messages in the output +file indicating that a LINPACK or EISPACK routine did not +converge should not be regarded with alarm. + +In the eigensystem timing program, we have equivalenced some work +arrays and then passed them to a subroutine, where both arrays are +modified. This is a violation of the Fortran~77 standard, which +says ``if a subprogram reference causes a dummy argument in the +referenced subprogram to become associated with another dummy +argument in the referenced subprogram, neither dummy argument may +become defined during execution of the subprogram.'' +\footnote{ ANSI X3.9-1978, sec. 15.9.3.6} +If this causes any difficulties, the equivalence +can be commented out as explained in the comments for the main +eigensystem timing programs. + +%\section*{MACHINE-SPECIFIC DIFFICULTIES} +%Some IBM compilers do not recognize DBLE as a generic function as used +%in LAPACK. The software tools we use to convert from single precision +%to double precision convert REAL(C) and AIMAG(C), where C is COMPLEX, +%to DBLE(Z) and DIMAG(Z), where Z is COMPLEX*16, but +%IBM compilers use DREAL(Z) and DIMAG(Z) to take the real and +%imaginary parts of a double complex number. +%IBM users can fix this problem by changing DBLE to DREAL when the +%argument of DBLE is COMPLEX*16. +% +%IBM compilers do not permit the data type COMPLEX*16 in a FUNCTION +%subprogram definition. The data type on the first line of the +%function subprogram must be changed from COMPLEX*16 to DOUBLE COMPLEX +%for the following functions: +% +%\begin{tabbing} +%\dent ZLATMOO \= from the test matrix generator library \kill +%\dent ZBEG \> from the Level 2 BLAS test program \\ +%\dent ZBEG \> from the Level 3 BLAS test program \\ +%\dent ZLADIV \> from the LAPACK library \\ +%\dent ZLARND \> from the test matrix generator library \\ +%\dent ZLATM2 \> from the test matrix generator library \\ +%\dent ZLATM3 \> from the test matrix generator library +%\end{tabbing} +%The functions ZDOTC and ZDOTU from the Level 1 BLAS are already +%declared DOUBLE COMPLEX. If that doesn't work, try the declaration +%COMPLEX FUNCTION*16. + + +\newpage +\addcontentsline{toc}{section}{Bibliography} + +\begin{thebibliography}{9} + +\bibitem{LUG} +E. Anderson, Z. Bai, C. Bischof, J. Demmel, J. Dongarra, +J. Du Croz, A. Greenbaum, S. Hammarling, A. McKenney, +S. Ostrouchov, and D. Sorensen, +\textit{LAPACK Users' Guide}, Second Edition, +{SIAM}, Philadelphia, PA, 1995. + +\bibitem{WN16} +E. Anderson and J. Dongarra, +\textit{LAPACK Working Note 16: +Results from the Initial Release of LAPACK}, +University of Tennessee, CS-89-89, November 1989. + +\bibitem{WN41} +E. Anderson, J. Dongarra, and S. Ostrouchov, +\textit{LAPACK Working Note 41: +Installation Guide for LAPACK}, +University of Tennessee, CS-92-151, February 1992 (revised June 1999). + +\bibitem{WN5} +C. Bischof, J. Demmel, J. Dongarra, J. Du Croz, A. Greenbaum, +S. Hammarling, and D. Sorensen, +\textit{LAPACK Working Note \#5: Provisional Contents}, +Argonne National Laboratory, ANL-88-38, September 1988. + +\bibitem{WN13} +Z. Bai, J. Demmel, and A. McKenney, +\textit{LAPACK Working Note \#13: On the Conditioning of the Nonsymmetric +Eigenvalue Problem: Theory and Software}, +University of Tennessee, CS-89-86, October 1989. + +\bibitem{XBLAS} +X. S. Li, J. W. Demmel, D. H. Bailey, G. Henry, Y. Hida, J. Iskandar, +W. Kahan, S. Y. Kang, A. Kapur, M. C. Martin, B. J. Thompson, T. Tung, +and D. J. Yoo, \textit{Design, implementation and testing of extended + and mixed precision BLAS}, +\textit{ACM Trans. Math. Soft.}, 28, 2:152--205, June 2002. + +\bibitem{BLAS3} +J. Dongarra, J. Du Croz, I. Duff, and S. Hammarling, +``A Set of Level 3 Basic Linear Algebra Subprograms,'' +\textit{ACM Trans. Math. Soft.}, 16, 1:1-17, March 1990 +%Argonne National Laboratory, ANL-MCS-P88-1, August 1988. + +\bibitem{BLAS3-test} +J. Dongarra, J. Du Croz, I. Duff, and S. Hammarling, +``A Set of Level 3 Basic Linear Algebra Subprograms: +Model Implementation and Test Programs,'' +\textit{ACM Trans. Math. Soft.}, 16, 1:18-28, March 1990 +%Argonne National Laboratory, ANL-MCS-TM-119, June 1988. + +\bibitem{BLAS2} +J. Dongarra, J. Du Croz, S. Hammarling, and R. Hanson, +``An Extended Set of Fortran Basic Linear Algebra Subprograms,'' +\textit{ACM Trans. Math. Soft.}, 14, 1:1-17, March 1988. + +\bibitem{BLAS2-test} +J. Dongarra, J. Du Croz, S. Hammarling, and R. Hanson, +``An Extended Set of Fortran Basic Linear Algebra Subprograms: +Model Implementation and Test Programs,'' +\textit{ACM Trans. Math. Soft.}, 14, 1:18-32, March 1988. + +\bibitem{BLAS1} +C. L. Lawson, R. J. Hanson, D. R. Kincaid, and F. T. Krogh, +``Basic Linear Algebra Subprograms for Fortran Usage,'' +\textit{ACM Trans. Math. Soft.}, 5, 3:308-323, September 1979. + +\end{thebibliography} + +\end{document} diff --git a/DOCS/org2.ps b/DOCS/org2.ps new file mode 100644 index 00000000..48159d69 --- /dev/null +++ b/DOCS/org2.ps @@ -0,0 +1,768 @@ +%!PS-Adobe-3.0 EPSF-3.0 +%%Creator: xpdf/pdftops 3.00 +%%LanguageLevel: 2 +%%BoundingBox: 0 0 520 230 +%%DocumentSuppliedResources: (atend) +%%EndComments +%%BeginProlog +%%BeginResource: procset xpdf 3.00 0 +/xpdf 75 dict def xpdf begin +% PDF special state +/pdfDictSize 15 def +/pdfSetup { + 3 1 roll 2 array astore + /setpagedevice where { + pop 3 dict begin + /PageSize exch def + /ImagingBBox null def + /Policies 1 dict dup begin /PageSize 3 def end def + { /Duplex true def } if + currentdict end setpagedevice + } { + pop pop + } ifelse +} def +/pdfStartPage { + pdfDictSize dict begin + /pdfFill [0] def + /pdfStroke [0] def + /pdfLastFill false def + /pdfLastStroke false def + /pdfTextMat [1 0 0 1 0 0] def + /pdfFontSize 0 def + /pdfCharSpacing 0 def + /pdfTextRender 0 def + /pdfTextRise 0 def + /pdfWordSpacing 0 def + /pdfHorizScaling 1 def + /pdfTextClipPath [] def +} def +/pdfEndPage { end } def +% separation convention operators +/findcmykcustomcolor where { + pop +}{ + /findcmykcustomcolor { 5 array astore } def +} ifelse +/setcustomcolor where { + pop +}{ + /setcustomcolor { + exch + [ exch /Separation exch dup 4 get exch /DeviceCMYK exch + 0 4 getinterval cvx + [ exch /dup load exch { mul exch dup } /forall load + /pop load dup ] cvx + ] setcolorspace setcolor + } def +} ifelse +/customcolorimage where { + pop +}{ + /customcolorimage { + gsave + [ exch /Separation exch dup 4 get exch /DeviceCMYK exch + 0 4 getinterval + [ exch /dup load exch { mul exch dup } /forall load + /pop load dup ] cvx + ] setcolorspace + 10 dict begin + /ImageType 1 def + /DataSource exch def + /ImageMatrix exch def + /BitsPerComponent exch def + /Height exch def + /Width exch def + /Decode [1 0] def + currentdict end + image + grestore + } def +} ifelse +% PDF color state +/sCol { + pdfLastStroke not { + pdfStroke aload length + dup 1 eq { + pop setgray + }{ + dup 3 eq { + pop setrgbcolor + }{ + 4 eq { + setcmykcolor + }{ + findcmykcustomcolor exch setcustomcolor + } ifelse + } ifelse + } ifelse + /pdfLastStroke true def /pdfLastFill false def + } if +} def +/fCol { + pdfLastFill not { + pdfFill aload length + dup 1 eq { + pop setgray + }{ + dup 3 eq { + pop setrgbcolor + }{ + 4 eq { + setcmykcolor + }{ + findcmykcustomcolor exch setcustomcolor + } ifelse + } ifelse + } ifelse + /pdfLastFill true def /pdfLastStroke false def + } if +} def +% build a font +/pdfMakeFont { + 4 3 roll findfont + 4 2 roll matrix scale makefont + dup length dict begin + { 1 index /FID ne { def } { pop pop } ifelse } forall + /Encoding exch def + currentdict + end + definefont pop +} def +/pdfMakeFont16 { + exch findfont + dup length dict begin + { 1 index /FID ne { def } { pop pop } ifelse } forall + /WMode exch def + currentdict + end + definefont pop +} def +/pdfMakeFont16L3 { + 1 index /CIDFont resourcestatus { + pop pop 1 index /CIDFont findresource /CIDFontType known + } { + false + } ifelse + { + 0 eq { /Identity-H } { /Identity-V } ifelse + exch 1 array astore composefont pop + } { + pdfMakeFont16 + } ifelse +} def +% graphics state operators +/q { gsave pdfDictSize dict begin } def +/Q { end grestore } def +/cm { concat } def +/d { setdash } def +/i { setflat } def +/j { setlinejoin } def +/J { setlinecap } def +/M { setmiterlimit } def +/w { setlinewidth } def +% color operators +/g { dup 1 array astore /pdfFill exch def setgray + /pdfLastFill true def /pdfLastStroke false def } def +/G { dup 1 array astore /pdfStroke exch def setgray + /pdfLastStroke true def /pdfLastFill false def } def +/rg { 3 copy 3 array astore /pdfFill exch def setrgbcolor + /pdfLastFill true def /pdfLastStroke false def } def +/RG { 3 copy 3 array astore /pdfStroke exch def setrgbcolor + /pdfLastStroke true def /pdfLastFill false def } def +/k { 4 copy 4 array astore /pdfFill exch def setcmykcolor + /pdfLastFill true def /pdfLastStroke false def } def +/K { 4 copy 4 array astore /pdfStroke exch def setcmykcolor + /pdfLastStroke true def /pdfLastFill false def } def +/ck { 6 copy 6 array astore /pdfFill exch def + findcmykcustomcolor exch setcustomcolor + /pdfLastFill true def /pdfLastStroke false def } def +/CK { 6 copy 6 array astore /pdfStroke exch def + findcmykcustomcolor exch setcustomcolor + /pdfLastStroke true def /pdfLastFill false def } def +% path segment operators +/m { moveto } def +/l { lineto } def +/c { curveto } def +/re { 4 2 roll moveto 1 index 0 rlineto 0 exch rlineto + neg 0 rlineto closepath } def +/h { closepath } def +% path painting operators +/S { sCol stroke } def +/Sf { fCol stroke } def +/f { fCol fill } def +/f* { fCol eofill } def +% clipping operators +/W { clip newpath } def +/W* { eoclip newpath } def +% text state operators +/Tc { /pdfCharSpacing exch def } def +/Tf { dup /pdfFontSize exch def + dup pdfHorizScaling mul exch matrix scale + pdfTextMat matrix concatmatrix dup 4 0 put dup 5 0 put + exch findfont exch makefont setfont } def +/Tr { /pdfTextRender exch def } def +/Ts { /pdfTextRise exch def } def +/Tw { /pdfWordSpacing exch def } def +/Tz { /pdfHorizScaling exch def } def +% text positioning operators +/Td { pdfTextMat transform moveto } def +/Tm { /pdfTextMat exch def } def +% text string operators +/cshow where { + pop + /cshow2 { + dup { + pop pop + 1 string dup 0 3 index put 3 index exec + } exch cshow + pop pop + } def +}{ + /cshow2 { + currentfont /FontType get 0 eq { + 0 2 2 index length 1 sub { + 2 copy get exch 1 add 2 index exch get + 2 copy exch 256 mul add + 2 string dup 0 6 5 roll put dup 1 5 4 roll put + 3 index exec + } for + } { + dup { + 1 string dup 0 3 index put 3 index exec + } forall + } ifelse + pop pop + } def +} ifelse +/awcp { + exch { + false charpath + 5 index 5 index rmoveto + 6 index eq { 7 index 7 index rmoveto } if + } exch cshow2 + 6 {pop} repeat +} def +/Tj { + fCol + 1 index stringwidth pdfTextMat idtransform pop + sub 1 index length dup 0 ne { div } { pop pop 0 } ifelse + pdfWordSpacing pdfHorizScaling mul 0 pdfTextMat dtransform 32 + 4 3 roll pdfCharSpacing pdfHorizScaling mul add 0 + pdfTextMat dtransform + 6 5 roll Tj1 +} def +/Tj16 { + fCol + 2 index stringwidth pdfTextMat idtransform pop + sub exch div + pdfWordSpacing pdfHorizScaling mul 0 pdfTextMat dtransform 32 + 4 3 roll pdfCharSpacing pdfHorizScaling mul add 0 + pdfTextMat dtransform + 6 5 roll Tj1 +} def +/Tj16V { + fCol + 2 index stringwidth pdfTextMat idtransform exch pop + sub exch div + 0 pdfWordSpacing pdfTextMat dtransform 32 + 4 3 roll pdfCharSpacing add 0 exch + pdfTextMat dtransform + 6 5 roll Tj1 +} def +/Tj1 { + 0 pdfTextRise pdfTextMat dtransform rmoveto + currentpoint 8 2 roll + pdfTextRender 1 and 0 eq { + 6 copy awidthshow + } if + pdfTextRender 3 and dup 1 eq exch 2 eq or { + 7 index 7 index moveto + 6 copy + currentfont /FontType get 3 eq { fCol } { sCol } ifelse + false awcp currentpoint stroke moveto + } if + pdfTextRender 4 and 0 ne { + 8 6 roll moveto + false awcp + /pdfTextClipPath [ pdfTextClipPath aload pop + {/moveto cvx} + {/lineto cvx} + {/curveto cvx} + {/closepath cvx} + pathforall ] def + currentpoint newpath moveto + } { + 8 {pop} repeat + } ifelse + 0 pdfTextRise neg pdfTextMat dtransform rmoveto +} def +/TJm { pdfFontSize 0.001 mul mul neg 0 + pdfTextMat dtransform rmoveto } def +/TJmV { pdfFontSize 0.001 mul mul neg 0 exch + pdfTextMat dtransform rmoveto } def +/Tclip { pdfTextClipPath cvx exec clip newpath + /pdfTextClipPath [] def } def +% Level 2 image operators +/pdfImBuf 100 string def +/pdfIm { + image + { currentfile pdfImBuf readline + not { pop exit } if + (%-EOD-) eq { exit } if } loop +} def +/pdfImSep { + findcmykcustomcolor exch + dup /Width get /pdfImBuf1 exch string def + dup /Decode get aload pop 1 index sub /pdfImDecodeRange exch def + /pdfImDecodeLow exch def + begin Width Height BitsPerComponent ImageMatrix DataSource end + /pdfImData exch def + { pdfImData pdfImBuf1 readstring pop + 0 1 2 index length 1 sub { + 1 index exch 2 copy get + pdfImDecodeRange mul 255 div pdfImDecodeLow add round cvi + 255 exch sub put + } for } + 6 5 roll customcolorimage + { currentfile pdfImBuf readline + not { pop exit } if + (%-EOD-) eq { exit } if } loop +} def +/pdfImM { + fCol imagemask + { currentfile pdfImBuf readline + not { pop exit } if + (%-EOD-) eq { exit } if } loop +} def +end +%%EndResource +%%EndProlog +%%BeginSetup +xpdf begin +%%BeginResource: font T3_9_0 +8 dict begin +/FontType 3 def +/FontMatrix [0.001 0 0 0.001 0 0] def +/FontBBox [-50 -250 1000 1000] def +/Encoding 256 array def + 0 1 255 { Encoding exch /.notdef put } for +/BuildGlyph { + exch /CharProcs get exch + 2 copy known not { pop /.notdef } if + get exec +} bind def +/BuildChar { + 1 index /Encoding get exch get + 1 index /BuildGlyph get exec +} bind def +/CharProcs 1 dict def +CharProcs begin +/Cbr { +0 0 -50 -250 0 1000 setcachedevice +q +q +-50 -250 50 1250 re +W +[] 0 d +40 w +10 M +0 J +0 j +0 -250 m +0 750 l +Sf +Q +Q +} def +end +currentdict end +/T3_9_0 exch definefont pop +%%EndResource +/F9_0 /T3_9_0 1 1 +[ /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /space/exclam/quotedbl/numbersign/dollar/percent/ampersand/quoteright + /parenleft/parenright/asterisk/plus/comma/hyphen/period/slash + /zero/one/two/three/four/five/six/seven + /eight/nine/colon/semicolon/less/equal/greater/question + /at/A/B/C/D/E/F/G + /H/I/J/K/Cbr/M/N/O + /P/Q/R/S/T/U/V/W + /X/Y/Z/bracketleft/backslash/bracketright/asciicircum/underscore + /quoteleft/a/b/c/d/e/f/g + /h/i/j/k/l/m/n/o + /p/q/r/s/t/u/v/w + /x/y/z/braceleft/bar/braceright/asciitilde/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/exclamdown/cent/sterling/fraction/yen/florin/section + /currency/quotesingle/quotedblleft/guillemotleft/guilsinglleft/guilsinglright/fi/fl + /.notdef/endash/dagger/daggerdbl/periodcentered/.notdef/paragraph/bullet + /quotesinglbase/quotedblbase/quotedblright/guillemotright/ellipsis/perthousand/.notdef/questiondown + /.notdef/grave/acute/circumflex/tilde/macron/breve/dotaccent + /dieresis/.notdef/ring/cedilla/.notdef/hungarumlaut/ogonek/caron + /emdash/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/AE/.notdef/ordfeminine/.notdef/.notdef/.notdef/.notdef + /Lslash/Oslash/OE/ordmasculine/.notdef/.notdef/.notdef/.notdef + /.notdef/ae/.notdef/.notdef/.notdef/dotlessi/.notdef/.notdef + /lslash/oslash/oe/germandbls/.notdef/.notdef/.notdef/.notdef] +pdfMakeFont +/F8_0 /Times-Roman 1 1 +[ /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /space/exclam/quotedbl/numbersign/dollar/percent/ampersand/quoteright + /parenleft/parenright/asterisk/plus/comma/hyphen/period/slash + /zero/one/two/three/four/five/six/seven + /eight/nine/colon/semicolon/less/equal/greater/question + /at/A/B/C/D/E/F/G + /H/I/J/K/L/M/N/O + /P/Q/R/S/T/U/V/W + /X/Y/Z/bracketleft/backslash/bracketright/asciicircum/underscore + /quoteleft/a/b/c/d/e/f/g + /h/i/j/k/l/m/n/o + /p/q/r/s/t/u/v/w + /x/y/z/braceleft/bar/braceright/asciitilde/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/exclamdown/cent/sterling/fraction/yen/florin/section + /currency/quotesingle/quotedblleft/guillemotleft/guilsinglleft/guilsinglright/fi/fl + /.notdef/endash/dagger/daggerdbl/periodcentered/.notdef/paragraph/bullet + /quotesinglbase/quotedblbase/quotedblright/guillemotright/ellipsis/perthousand/.notdef/questiondown + /.notdef/grave/acute/circumflex/tilde/macron/breve/dotaccent + /dieresis/.notdef/ring/cedilla/.notdef/hungarumlaut/ogonek/caron + /emdash/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef + /.notdef/AE/.notdef/ordfeminine/.notdef/.notdef/.notdef/.notdef + /Lslash/Oslash/OE/ordmasculine/.notdef/.notdef/.notdef/.notdef + /.notdef/ae/.notdef/.notdef/.notdef/dotlessi/.notdef/.notdef + /lslash/oslash/oe/germandbls/.notdef/.notdef/.notdef/.notdef] +pdfMakeFont +%%EndSetup +pdfStartPage +[] 0 d +1 i +0 j +0 J +10 M +1 w +0 g +0 G +q +q +[0.1 0 0 0.1 0 0] cm +0 G +0 g +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 216.4 212.8] Tm +0 0 Td +/F8_0 11 Tf +(LAP) 20.779 Tj +34.4549 TJm +(ACK) 23.221 Tj +Q +2.4 w +1 i +2382 2078 m +315.598 1538 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 5.69961 140.8] Tm +0 0 Td +/F8_0 11 Tf +(INST) 24.442 Tj +85.601 TJm +(ALL) 21.384 Tj +Q +280 1358 m +280 1178 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 -1.5 108.9] Tm +0 0 Td +/F8_0 9 Tf +(Machine) 31.491 Tj +-289.845 TJm +(depen-) 24.489 Tj +5.69961 -10.8 Td +(dent) 15.498 Tj +-278.043 TJm +(routines) 28.998 Tj +Q +2382 2078 m +1143.6 1538 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 96.9 140.8] Tm +0 0 Td +/F8_0 11 Tf +(BLAS) 28.116 Tj +Q +1108 1358 m +748.004 818.004 l +S +1108 1358 m +1468 818.004 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 64.4996 68.8] Tm +0 0 Td +/F8_0 11 Tf +(SRC) 20.79 Tj +10.3004 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +10.3004 -24 Td +(L) 0 Tj +-16.0996 -35.5004 Td +/F8_0 9 Tf +(Level) 20.493 Tj +-278.512 TJm +(1) 4.5 Tj +-255.556 TJm +(BLAS) 23.004 Tj +-16.0996 -46.3004 Td +(Level) 20.493 Tj +-278.512 TJm +(2) 4.5 Tj +-255.556 TJm +(BLAS) 23.004 Tj +-16.0996 -57.1004 Td +(Level) 20.493 Tj +-278.512 TJm +(3) 4.5 Tj +-255.556 TJm +(BLAS) 23.004 Tj +59.5004 7.10543e-15 Td +/F8_0 11 Tf +(TESTING) 45.826 Tj +82.3004 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +82.3004 -24 Td +(L) 0 Tj +53.3004 -35.5004 Td +/F8_0 9 Tf +(BLAS2) 27.504 Tj +-244 TJm +(&) 7.002 Tj +-233.111 TJm +(3) 4.5 Tj +-255.556 TJm +(test) 12.501 Tj +67.7004 -46.3004 Td +(routines) 28.998 Tj +Q +2382 2078 m +1935.6 1538 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 183.3 140.8] Tm +0 0 Td +/F8_0 11 Tf +(SRC) 20.79 Tj +Q +1936 1358 m +1936 1178 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 160 108.9] Tm +0 0 Td +/F8_0 9 Tf +(LAP) 17.001 Tj +22.3334 TJm +(ACK) 18.999 Tj +-233.445 TJm +(routines) 28.998 Tj +-3.10039 -10.8 Td +(&) 7.002 Tj +-233.154 TJm +(auxiliary) 31.995 Tj +-333.845 TJm +(routines) 28.998 Tj +Q +2382 2078 m +2907.59 1538 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 268 140.8] Tm +0 0 Td +/F8_0 11 Tf +(TESTING) 45.826 Tj +Q +2908 1358 m +2296 818.004 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 290.8 127.4] Tm +0 0 Td +/F9_0 11 Tf +(L) 0 Tj +0 -9.80039 Td +(L) 0 Tj +0 -20.9004 Td +(L) 0 Tj +0 -31.9004 Td +(L) 0 Tj +0 -43.0004 Td +(L) 0 Tj +Q +2908 1358 m +3520 818.004 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 216.9 68.8] Tm +0 0 Td +/F8_0 11 Tf +(LIN) 18.326 Tj +9.10039 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +9.10039 -24 Td +(L) 0 Tj +50.9004 0 Td +/F8_0 11 Tf +(MA) 17.721 Tj +83.7269 TJm +(TGEN) 29.326 Tj +73.9004 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +73.9004 -24 Td +(L) 0 Tj +129.6 0 Td +/F8_0 11 Tf +(EIG) 18.326 Tj +138.7 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +138.7 -24 Td +(L) 0 Tj +-11.4996 -35.5004 Td +/F8_0 9 Tf +(Linear) 23.49 Tj +-290.001 TJm +(eqn.) 15.246 Tj +-12.9996 -46.3004 Td +(test) 12.501 Tj +-266.555 TJm +(routines) 28.998 Tj +53.3004 -35.5004 Td +(T) 5.499 Tj +55.4443 TJm +(est) 9.999 Tj +-244.512 TJm +(matrix) 23.499 Tj +54.9 -46.3004 Td +(generators) 37.485 Tj +115.7 -35.5004 Td +(Eigensystem) 45.999 Tj +116.6 -46.3004 Td +(test) 12.501 Tj +-266.599 TJm +(routines) 28.998 Tj +Q +2382 2078 m +4527.59 1538 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 436.7 140.8] Tm +0 0 Td +/F8_0 11 Tf +(TIMING) 39.71 Tj +Q +4564 1358 m +4204 818.004 l +S +4564 1358 m +4924 818.004 l +S +q +[10 0 0 10 0 0] cm +[1 0 0 1 0 0] Tm +0 0 Td +[1 0 0 1 411.3 68.8] Tm +0 0 Td +/F8_0 11 Tf +(LIN) 18.326 Tj +9.1 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +9.1 -24 Td +(L) 0 Tj +72 0 Td +/F8_0 11 Tf +(EIG) 18.326 Tj +81.1 -13.4 Td +/F9_0 11 Tf +(L) 0 Tj +81.1 -24 Td +(L) 0 Tj +-11.5004 -35.5004 Td +/F8_0 9 Tf +(Linear) 23.49 Tj +-290.001 TJm +(eqn.) 15.246 Tj +-18.7004 -46.3004 Td +(timing) 23.508 Tj +-288 TJm +(routines) 28.998 Tj +58.0996 -35.5004 Td +(Eigensystem) 45.999 Tj +53.2996 -46.3004 Td +(timing) 23.508 Tj +-288 TJm +(routines) 28.998 Tj +Q +Q +Q +showpage +%%PageTrailer +pdfEndPage +%%Trailer +end +%%DocumentSuppliedResources: +%%+ font T3_9_0 +%%EOF diff --git a/DOCS/psfig.tex b/DOCS/psfig.tex new file mode 100644 index 00000000..e1e65a92 --- /dev/null +++ b/DOCS/psfig.tex @@ -0,0 +1,391 @@ +% Psfig/TeX Release 1.2 +% dvi2ps-li version +% +% All software, documentation, and related files in this distribution of +% psfig/tex are Copyright 1987, 1988 Trevor J. Darrell +% +% Permission is granted for use and non-profit distribution of psfig/tex +% providing that this notice be clearly maintained, but the right to +% distribute any portion of psfig/tex for profit or as part of any commercial +% product is specifically reserved for the author. +% +% $Header$ +% $Source$ +% +% Thanks to Greg Hager (GDH) and Ned Batchelder for their contributions +% to this project. +% +\catcode`\@=11\relax +\newwrite\@unused +\def\typeout#1{{\let\protect\string\immediate\write\@unused{#1}}} +\typeout{psfig/tex 1.2-dvi2ps-li} + +%% Here's how you define your figure path. Should be set up with null +%% default and a user useable definition. + +\def\figurepath{./} +\def\psfigurepath#1{\edef\figurepath{#1}} + +% +% @psdo control structure -- similar to Latex @for. +% I redefined these with different names so that psfig can +% be used with TeX as well as LaTeX, and so that it will not +% be vunerable to future changes in LaTeX's internal +% control structure, +% +\def\@nnil{\@nil} +\def\@empty{} +\def\@psdonoop#1\@@#2#3{} +\def\@psdo#1:=#2\do#3{\edef\@psdotmp{#2}\ifx\@psdotmp\@empty \else + \expandafter\@psdoloop#2,\@nil,\@nil\@@#1{#3}\fi} +\def\@psdoloop#1,#2,#3\@@#4#5{\def#4{#1}\ifx #4\@nnil \else + #5\def#4{#2}\ifx #4\@nnil \else#5\@ipsdoloop #3\@@#4{#5}\fi\fi} +\def\@ipsdoloop#1,#2\@@#3#4{\def#3{#1}\ifx #3\@nnil + \let\@nextwhile=\@psdonoop \else + #4\relax\let\@nextwhile=\@ipsdoloop\fi\@nextwhile#2\@@#3{#4}} +\def\@tpsdo#1:=#2\do#3{\xdef\@psdotmp{#2}\ifx\@psdotmp\@empty \else + \@tpsdoloop#2\@nil\@nil\@@#1{#3}\fi} +\def\@tpsdoloop#1#2\@@#3#4{\def#3{#1}\ifx #3\@nnil + \let\@nextwhile=\@psdonoop \else + #4\relax\let\@nextwhile=\@tpsdoloop\fi\@nextwhile#2\@@#3{#4}} +% +% +\def\psdraft{ + \def\@psdraft{0} + %\typeout{draft level now is \@psdraft \space . } +} +\def\psfull{ + \def\@psdraft{100} + %\typeout{draft level now is \@psdraft \space . } +} +\psfull +\newif\if@prologfile +\newif\if@postlogfile +\newif\if@noisy +\def\pssilent{ + \@noisyfalse +} +\def\psnoisy{ + \@noisytrue +} +\psnoisy +%%% These are for the option list. +%%% A specification of the form a = b maps to calling \@p@@sa{b} +\newif\if@bbllx +\newif\if@bblly +\newif\if@bburx +\newif\if@bbury +\newif\if@height +\newif\if@width +\newif\if@rheight +\newif\if@rwidth +\newif\if@clip +\newif\if@verbose +\def\@p@@sclip#1{\@cliptrue} + +%%% GDH 7/26/87 -- changed so that it first looks in the local directory, +%%% then in a specified global directory for the ps file. + +\def\@p@@sfile#1{\def\@p@sfile{null}% + \openin1=#1 + \ifeof1\closein1% + \openin1=\figurepath#1 + \ifeof1\typeout{Error, File #1 not found} + \else\closein1 + \edef\@p@sfile{\figurepath#1}% + \fi% + \else\closein1% + \def\@p@sfile{#1}% + \fi} +\def\@p@@sfigure#1{\def\@p@sfile{null}% + \openin1=#1 + \ifeof1\closein1% + \openin1=\figurepath#1 + \ifeof1\typeout{Error, File #1 not found} + \else\closein1 + \def\@p@sfile{\figurepath#1}% + \fi% + \else\closein1% + \def\@p@sfile{#1}% + \fi} + +\def\@p@@sbbllx#1{ + %\typeout{bbllx is #1} + \@bbllxtrue + \dimen100=#1 + \edef\@p@sbbllx{\number\dimen100} +} +\def\@p@@sbblly#1{ + %\typeout{bblly is #1} + \@bbllytrue + \dimen100=#1 + \edef\@p@sbblly{\number\dimen100} +} +\def\@p@@sbburx#1{ + %\typeout{bburx is #1} + \@bburxtrue + \dimen100=#1 + \edef\@p@sbburx{\number\dimen100} +} +\def\@p@@sbbury#1{ + %\typeout{bbury is #1} + \@bburytrue + \dimen100=#1 + \edef\@p@sbbury{\number\dimen100} +} +\def\@p@@sheight#1{ + \@heighttrue + \dimen100=#1 + \edef\@p@sheight{\number\dimen100} + %\typeout{Height is \@p@sheight} +} +\def\@p@@swidth#1{ + %\typeout{Width is #1} + \@widthtrue + \dimen100=#1 + \edef\@p@swidth{\number\dimen100} +} +\def\@p@@srheight#1{ + %\typeout{Reserved height is #1} + \@rheighttrue + \dimen100=#1 + \edef\@p@srheight{\number\dimen100} +} +\def\@p@@srwidth#1{ + %\typeout{Reserved width is #1} + \@rwidthtrue + \dimen100=#1 + \edef\@p@srwidth{\number\dimen100} +} +\def\@p@@ssilent#1{ + \@verbosefalse +} +\def\@p@@sprolog#1{\@prologfiletrue\def\@prologfileval{#1}} +\def\@p@@spostlog#1{\@postlogfiletrue\def\@postlogfileval{#1}} +\def\@cs@name#1{\csname #1\endcsname} +\def\@setparms#1=#2,{\@cs@name{@p@@s#1}{#2}} +% +% initialize the defaults (size the size of the figure) +% +\def\ps@init@parms{ + \@bbllxfalse \@bbllyfalse + \@bburxfalse \@bburyfalse + \@heightfalse \@widthfalse + \@rheightfalse \@rwidthfalse + \def\@p@sbbllx{}\def\@p@sbblly{} + \def\@p@sbburx{}\def\@p@sbbury{} + \def\@p@sheight{}\def\@p@swidth{} + \def\@p@srheight{}\def\@p@srwidth{} + \def\@p@sfile{} + \def\@p@scost{10} + \def\@sc{} + \@prologfilefalse + \@postlogfilefalse + \@clipfalse + \if@noisy + \@verbosetrue + \else + \@verbosefalse + \fi + +} +% +% Go through the options setting things up. +% +\def\parse@ps@parms#1{ + \@psdo\@psfiga:=#1\do + {\expandafter\@setparms\@psfiga,}} +% +% Compute bb height and width +% +\newif\ifno@bb +\newif\ifnot@eof +\newread\ps@stream +\def\bb@missing{ + \if@verbose{ + \typeout{psfig: searching \@p@sfile \space for bounding box} + }\fi + \openin\ps@stream=\@p@sfile + \no@bbtrue + \not@eoftrue + \catcode`\%=12 + \loop + \read\ps@stream to \line@in + \global\toks200=\expandafter{\line@in} + \ifeof\ps@stream \not@eoffalse \fi + %\typeout{ looking at :: \the\toks200 } + \@bbtest{\toks200} + \if@bbmatch\not@eoffalse\expandafter\bb@cull\the\toks200\fi + \ifnot@eof \repeat + \catcode`\%=14 +} +\catcode`\%=12 +\newif\if@bbmatch +\def\@bbtest#1{\expandafter\@a@\the#1%%BoundingBox:\@bbtest\@a@} +\long\def\@a@#1%%BoundingBox:#2#3\@a@{\ifx\@bbtest#2\@bbmatchfalse\else\@bbmatchtrue\fi} +\long\def\bb@cull#1 #2 #3 #4 #5 { + \dimen100=#2 bp\edef\@p@sbbllx{\number\dimen100} + \dimen100=#3 bp\edef\@p@sbblly{\number\dimen100} + \dimen100=#4 bp\edef\@p@sbburx{\number\dimen100} + \dimen100=#5 bp\edef\@p@sbbury{\number\dimen100} + \no@bbfalse +} +\catcode`\%=14 +% +\def\compute@bb{ + \no@bbfalse + \if@bbllx \else \no@bbtrue \fi + \if@bblly \else \no@bbtrue \fi + \if@bburx \else \no@bbtrue \fi + \if@bbury \else \no@bbtrue \fi + \ifno@bb \bb@missing \fi + \ifno@bb \typeout{FATAL ERROR: no bb supplied or found} + \no-bb-error + \fi + % + \count203=\@p@sbburx + \count204=\@p@sbbury + \advance\count203 by -\@p@sbbllx + \advance\count204 by -\@p@sbblly + \edef\@bbw{\number\count203} + \edef\@bbh{\number\count204} + %\typeout{ bbh = \@bbh, bbw = \@bbw } +} +% +% \in@hundreds performs #1 * (#2 / #3) correct to the hundreds, +% then leaves the result in @result +% +\def\in@hundreds#1#2#3{\count240=#2 \count241=#3 + \count100=\count240 % 100 is first digit #2/#3 + \divide\count100 by \count241 + \count101=\count100 + \multiply\count101 by \count241 + \advance\count240 by -\count101 + \multiply\count240 by 10 + \count101=\count240 %101 is second digit of #2/#3 + \divide\count101 by \count241 + \count102=\count101 + \multiply\count102 by \count241 + \advance\count240 by -\count102 + \multiply\count240 by 10 + \count102=\count240 % 102 is the third digit + \divide\count102 by \count241 + \count200=#1\count205=0 + \count201=\count200 + \multiply\count201 by \count100 + \advance\count205 by \count201 + \count201=\count200 + \divide\count201 by 10 + \multiply\count201 by \count101 + \advance\count205 by \count201 + % + \count201=\count200 + \divide\count201 by 100 + \multiply\count201 by \count102 + \advance\count205 by \count201 + % + \edef\@result{\number\count205} +} +\def\compute@wfromh{ + % computing : width = height * (bbw / bbh) + \in@hundreds{\@p@sheight}{\@bbw}{\@bbh} + %\typeout{ \@p@sheight * \@bbw / \@bbh, = \@result } + \edef\@p@swidth{\@result} + %\typeout{w from h: width is \@p@swidth} +} +\def\compute@hfromw{ + % computing : height = width * (bbh / bbw) + \in@hundreds{\@p@swidth}{\@bbh}{\@bbw} + %\typeout{ \@p@swidth * \@bbh / \@bbw = \@result } + \edef\@p@sheight{\@result} + %\typeout{h from w : height is \@p@sheight} +} +\def\compute@handw{ + \if@height + \if@width + \else + \compute@wfromh + \fi + \else + \if@width + \compute@hfromw + \else + \edef\@p@sheight{\@bbh} + \edef\@p@swidth{\@bbw} + \fi + \fi +} +\def\compute@resv{ + \if@rheight \else \edef\@p@srheight{\@p@sheight} \fi + \if@rwidth \else \edef\@p@srwidth{\@p@swidth} \fi +} +% +% Compute any missing values +\def\compute@sizes{ + \compute@bb + \compute@handw + \compute@resv +} +% +% \psfig +% usage : \psfig{file=, height=, width=, bbllx=, bblly=, bburx=, bbury=, +% rheight=, rwidth=, clip=} +% +% "clip=" is a switch and takes no value, but the `=' must be present. +\def\psfig#1{\vbox { + % do a zero width hard space so that a single + % \psfig in a centering enviornment will behave nicely + %{\setbox0=\hbox{\ }\ \hskip-\wd0} + % + \ps@init@parms + \parse@ps@parms{#1} + \compute@sizes + % + \ifnum\@p@scost<\@psdraft{ + \if@verbose{ + \typeout{psfig: including \@p@sfile \space } + }\fi + % + \special{ pstext="\@p@swidth \space + \@p@sheight \space + \@p@sbbllx \space \@p@sbblly \space + \@p@sbburx \space + \@p@sbbury \space startTexFig" \space} + \if@clip{ + \if@verbose{ + \typeout{(clip)} + }\fi + \special{ pstext="doclip \space"} + }\fi + \if@prologfile + \special{psfile=\@prologfileval \space } \fi + \special{psfile=\@p@sfile \space } + \if@postlogfile + \special{psfile=\@postlogfileval \space } \fi + \special{pstext=endTexFig \space } + % Create the vbox to reserve the space for the figure + \vbox to \@p@srheight true sp{ + \hbox to \@p@srwidth true sp{ + \hss + } + \vss + } + }\else{ + % draft figure, just reserve the space and print the + % path name. + \vbox to \@p@srheight true sp{ + \vss + \hbox to \@p@srwidth true sp{ + \hss + \if@verbose{ + \@p@sfile + }\fi + \hss + } + \vss + } + }\fi +}} +\def\psglobal{\typeout{psfig: PSGLOBAL is OBSOLETE; use psprint -m instead}} +\catcode`\@=12\relax + |