Skip to content

Commit

Permalink
Merge branch 'devl'
Browse files Browse the repository at this point in the history
  • Loading branch information
fredo-dedup committed Aug 23, 2014
2 parents 43384c9 + da2821d commit 662ed5e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Installation

Install the ReverseDiffSource package at the Julia command line by running::

Pkg.Install("ReverseDiffSource")
Pkg.add("ReverseDiffSource")

This only needs to be done once.

Expand Down
4 changes: 2 additions & 2 deletions doc/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Showing the code graph
Starting from an expression, it is possible to have a dump of the nodes composing its equivalent graph with the (unexported) ``tograph()`` call :

ex = quote
a = 1 + x
2 * exp(-a)
a = 1 + x
2 * exp(-a)
end

g = ReverseDiffSource.tograph(ex)
Expand Down
4 changes: 2 additions & 2 deletions doc/maincall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Arguments

:ex: is a Julia Expression containing the code to derive

:outsym: (keyword arg, default = nothing) is the symbol of the variable within ex where the expression output is to be derived against. This variable must evaluate to a Real. If not specified, ``outsym`` defaults to ``nothing`` which signals to rdiff that the last statement is the result of interest for derivation.
:outsym: (keyword arg, default = nothing) is the symbol of the variable within ``ex`` containing the expression output (the result whose derivatives are needed). This variable must evaluate to a ``Real``. If not specified, ``outsym`` defaults to ``nothing`` which signals to ``rdiff`` that the last statement is the result of interest for derivation.

:order: (keyword arg, default = 1) is an integer indicating the derivation order (1 for 1st order, etc.). Order 0 is allowed and will produce an expression that is a processed version of ``ex`` with some variables names rewritten and possibly some optimizations.

Expand All @@ -19,7 +19,7 @@ Arguments
Output
^^^^^^

An expression returning a tuple containing the expression value and the derivative at first, second , etc.. order.
An expression which, when evaluated, will return a tuple containing the expression value and the derivative at first, second , etc.. order.


Usage
Expand Down

0 comments on commit 662ed5e

Please sign in to comment.