Toolchains - Parameters - Filters
ADiMat Toolchain Parameters
Parameters
| Name | Default value | Filters | Description | Toolchains |
|---|---|---|---|---|
| a-zeros-function |
'a_zeros'
|
xsl/renice.xsl | Name of the zero adjoint function. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| activityAnalysis | Controls if-then-else. | forward-ad, prepare-fm, prepare-rm, reverse-ad, taylor-ad, xaif | ||
| adimat-function-prefix |
'adimat_'
|
xsl/vector-forward-ad-new.xsl, xsl/vector-forward-ad.xsl, xsl/renice.xsl, xsl/reverse-ad.xsl, xsl/insert-stack-info-calls.xsl | Prefix for derivative functions. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| adjoint-reductions |
not($well-behaved)
|
xsl/renice.xsl | Whether to use adjred wrapper functions in adjoint code. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| adjoint-subsasgn |
not($well-behaved)
|
xsl/renice.xsl | Whether to use adjreshape wrapper functions in adjoint code. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| allow-array-growth |
true()
|
xsl/reverse-ad.xsl | Whether the size of an array being assigned to is allowed to change. | reverse-ad |
| avoid-vararg-functions |
true()
|
xsl/renice.xsl | Whether to use push/pop/a_zeros functions without varargin. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| comment-char |
'%'
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Comment start character | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| comment-spacer |
' '
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Space to insert after comment start character | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| comment-start |
$comment-char
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Comment start text | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| fm | Controls if-then-else. | forward-ad | ||
| fmmode | Controls if-then-else. | forward-ad | ||
| forward-deriv-function-prefix |
$forward-deriv-prefix
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for forward-ad derivative variables | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif |
| forward-deriv-variable-prefix |
$forward-deriv-prefix
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for forward-ad derivative variables | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif |
| from |
'einstein'
|
xsl/rename.xsl | The name of the identifier to rename. | rename |
| ind-to-subs-deep |
$tl-ind-to-subs-deep
|
xsl/index-to-subsref-subsasgn.xsl | Whether to convert nested index expressions deeply or just the outermost (array) index layer. | ind-to-subs |
| indent-unit |
' '
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Indentation unit | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| input-file-name |
$tl-input-file-name
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | For informational purposes only. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| no-missing-adjoint-args |
$well-behaved
|
xsl/reverse-ad.xsl | Whether to conditionally initialize adjoints of output parameters to zero. | reverse-ad |
| nocanonicalize | Controls if-then-else. | forward-ad, prepare-fm, prepare-rm, reverse-ad, taylor-ad, xaif | ||
| output-directory |
$tl-output-directory
|
xsl/update-toplevel-function-name.xsl, xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Only used when output-mode=split-all. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| output-file-path |
$tl-output-file-path
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | For informational purposes only. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| output-file-prefix |
$tl-output-file-prefix
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Only used when output-mode=split-all. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| output-mode |
'plain'
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Set to split-all for one file per function. Otherwise all functions go to "stdout", or the file given with option -o. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| parallel |
0
|
xsl/vector-forward-ad.xsl | Whether to use parfor loops over derivatives. | forward-ad |
| parallel-function-prefix |
'p'
|
xsl/vector-forward-ad.xsl | Prefix for parallel derivative functions. | forward-ad |
| prefix | xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for both derivative variables and functions | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif | |
| print-stack-info |
0
|
xsl/reverse-ad.xsl, xsl/insert-stack-info-calls.xsl | Insert code printing the current size of the stack. 1: call info function between forward and reverse sweep. 2: call info function on entering and leaving each function. | reverse-ad |
| rec-prefix | xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for the recording (forward) sweep version of a differentiated function | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif | |
| ret-prefix | xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for the return sweep version of a differentiated function | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif | |
| rev-prefix | xsl/to-source.xsl, xsl/has-end.xsl, xsl/replicate-funref-assignments.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl | the prefix for the adjoint (recording + return) version of a differentiated function | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif | |
| show-banner |
1
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Insert transformation date into transformed file | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| show-disclaimer |
1
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Insert disclaimer into transformed file | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| show-step-ids |
0
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Show transformation step ids | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| show-step-params |
$show-steps
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Show transformation step parameters | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| show-steps |
0
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | Show transformation steps | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| source-line-numbers |
1
|
xsl/rhs-var-lists.xsl, xsl/rhs-var-lists2.xsl, xsl/input-var-lists.xsl, xsl/to-source.xsl, xsl/has-end.xsl, xsl/lhs-lists.xsl, xsl/replicate-funref-assignments.xsl, xsl/match-signatures3.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl, xsl/min-nargin.xsl, xsl/merge-following-reverseops.xsl | Include source line numbers in stmt. labels if set to 1. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif |
| spook |
contains($show-comments, 'spook') or $show-disclaimer = 0 or $show-authors = 0
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/renice.xsl | codes anarchy Whitehouse Majic defense information warfare Tamil Tigers afsatcom Jet Taiwan insurgency Secure Border Initiative Facility Rule Psix Help Federal Aviation Administration | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad |
| stack-info-function | xsl/reverse-ad.xsl, xsl/insert-stack-info-calls.xsl | Name of the info function to be called when print-stack-info > 0. | reverse-ad | |
| subsref-function-prefix | xsl/index-to-subsref-subsasgn.xsl | Prefix for derivative functions. | ind-to-subs | |
| tmp-mode |
'short'
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/which-to-canonicalize.xsl, xsl/canonicalize.xsl, xsl/nargin-wrapper.xsl, xsl/call-numout.xsl, xsl/match-signatures.xsl, xsl/match-signatures3.xsl, xsl/vector-forward-ad-new.xsl, xsl/vector-forward-ad.xsl, xsl/renice.xsl, xsl/tmp-resolve2.xsl, xsl/outline-index-lhs.xsl, xsl/index-to-subsref-subsasgn.xsl, xsl/canonicalize-outline-index-lhs.xsl | How to name temporary variables. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif |
| tmp-prefix |
'tmp'
|
xsl/to-source.xsl, xsl/has-end.xsl, xsl/which-to-canonicalize.xsl, xsl/canonicalize.xsl, xsl/nargin-wrapper.xsl, xsl/call-numout.xsl, xsl/match-signatures.xsl, xsl/match-signatures3.xsl, xsl/vector-forward-ad-new.xsl, xsl/vector-forward-ad.xsl, xsl/renice.xsl, xsl/outline-index-lhs.xsl, xsl/index-to-subsref-subsasgn.xsl, xsl/canonicalize-outline-index-lhs.xsl | Prefix of temporary variables. | basic-block-to-call, brackets-to-hvcat, for-insert-iteration-indexvar, forward-ad, hvcat-to-brackets, ind-to-subs, nested-to-sub-function, prepare-fm, prepare-rm, pretty-print, rename, reverse-ad, taylor-ad, xaif |
| tmpMode | Controls if-then-else. | forward-ad, reverse-ad, taylor-ad | ||
| to |
'zweistein'
|
xsl/rename.xsl | The name the identifier shall be renamed to. | rename |
| use-adjsum |
not($well-behaved)
|
xsl/renice.xsl | Whether to use adjsum function for summing adjoints. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| use-push-index |
not($well-behaved)
|
xsl/renice.xsl | Whether to allow dynamic resize in subsasgn. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |
| use-subsasgn |
$tl-use-subsasgn
|
xsl/initialize-variables-for.xsl, xsl/vector-forward-ad-new.xsl | Whether to use calls to subsasgn (needed with structures and in this case (FIXME: link)). Turned on if there is an active struct-ref in the code. | forward-ad, prepare-fm, taylor-ad |
| use-subsref |
$tl-use-subsref
|
xsl/vector-forward-ad-new.xsl | Whether to use calls to subsref (needed with structures and in this case (FIXME: link)). Turned on if parameter use-subsasgn is on. | forward-ad, taylor-ad |
| well-behaved |
false()
|
xsl/renice.xsl, xsl/reverse-ad.xsl | Whether the code is well-behaved: Trigger some optimisations. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |