Renames all identifiers given by parameter "from" to the value of parameter "to".
| 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 |
| 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 |
| 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 |
'%' | xsl/renice.xsl, xsl/to-source.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 |
' ' | xsl/renice.xsl, xsl/to-source.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-char | xsl/renice.xsl, xsl/to-source.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 |
| forward-deriv-function-prefix | $forward-deriv-prefix | xsl/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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 |
| indent-unit | ' ' | xsl/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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-directory | $tl-output-directory | xsl/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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 |
| prefix | | xsl/renice.xsl, xsl/to-source.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 |
| rec-prefix | | xsl/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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 |
| tmp-mode | 'short' | xsl/renice.xsl, xsl/to-source.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/renice.xsl, xsl/to-source.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 |
| 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 |
| well-behaved | false() | xsl/renice.xsl | Whether the code is well-behaved: Trigger some optimisations. | forward-ad, prepare-fm, prepare-rm, rename, reverse-ad, taylor-ad |