LapackDoc Tour

Let's start with the documentation of DGETRF. It was extracted from the source file dgetrf.f.

Documentation

Right after the title we have a box containing the subroutine declaration. Clicking on it leads you to its definition inside the source code.

Further we have a Purpose and Arguments section. The variable names in the Arguments section are also clickable. For example INFO is linked with its definition in the source code.

Finally we have sections with a Call Graph and Caller Graph. Each node is linked with the documentation of the corresponding subroutine or function.

Source Code

When you look at the source file dgetrf.f you notice that variables and function/subroutine names are linked. Links are underlined:

dotted underlined links a variable to its point of definition. Check out what happens if you click on IPIV.
solid black underlined links to an external definition or documentation. Check this out:
- Click in the first line of dgetrf.f on DGETRF. This leads you to the documentation of this SUBROUTINE.
- Click on DGETF2. This leads you to its source file.
- Click on LDA. This leads you to its description in the Arguments section of the DGETRF documentation.
solid red underlined means that more than one external definition was found. Clicking pops up a selection box. For example ILAENV