The ADiMat Handbook

Johannes Willkomm johannes@johannes-willkomm.de
Andre Vehreschild vehreschild@sc.rwth-aachen.de

1. Introduction

• 1.1 Changes

2. Installation

• 2.1 How to obtain ADiMat
• 2.2 Requirements
• 2.3 Installation on Linux or Unix systems
• 2.4 Installation on Windows
• 2.5 Building and installation on MacOS

3. Supported Matlab constructs

• 3.1 Supported Matlab features
• 3.2 Partially supported Matlab features
• 3.3 Matlab features not supported at all
• 3.4 Limitations of the reverse mode (admDiffRev) (in addition to the above)
• 3.5 Limitations of the classless vector mode (admDiffVFor)
• 3.6 Limitations of admDiffFor and admDiffRev

4. Using ADiMat

• 4.1 General description
• 4.2 High level user interface
• 4.3 Higher order derivatives
• 4.4 Source code transformation
• 4.5 Running the transformed code
• 4.6 Applying AD to an example
• 4.7 Using sparsity exploitation or compression

5. Tips and recipes

• 5.1 Differentiating functions with char, int, struct or cell parameters
• 5.2 Differentiating code in multiple directories

6. The runtime environment

• 6.1 High level user interface functions
• 6.2 Interfaces to program transformation
• 6.3 Derivative and adjoint classes
• 6.4 Stacks for the reverse mode
• 6.5 Other helper functions for the reverse mode

7. The derivative classes

• 7.1 Structure of derivative objects
• 7.2 Creation of derivative objects
• 7.3 Accessing the derivative data
• 7.4 Constructor functions create...()
• 7.5 The options system of the Matlab-class
• 7.6 Matlab's cellarrays/structures and the derivative class

8. Usage

• 8.1 Modes and Toolchains
• 8.2 List of toolchains
• 8.3 Transformation parameters
• 8.4 List of transformation parameters

9. Usage of classic adimat

• 9.1 adimat Options

10. Directives

• 10.1 adimat Directives
• 10.2 admproc Directives

11. Environment variables

12. Dependecy graphs and further information

• 12.1 Calltree of functions
• 12.2 Variable dependency graph
• 12.3 Debugging information

13. Outlining - Simplifying complex expressions

14. Builtins

• 14.1 .amb-files
• 14.2 Builtin-declarations
• 14.3 funcsig
• 14.4 actionstring
• 14.5 types
• 14.6 BVAR
• 14.7 BMFUNC
• 14.8 BCFUNC
• 14.9 BJFUNC
• 14.10 The dbbuild tool

15. ToDo

16. Questions and Answers

17. Examples

18. Known bugs and limitations

19. References

20. Copyright