Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattsignorelli committed Aug 8, 2024
1 parent 9906a4e commit e6b4993
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/src/man/h_gjh.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ GTPSA.hessian!(H, f [, include_params=bool])

------

`J = GTPSA.jacobian(F)` extracts the Jacobian matrix from the vector of TPSs `F`, defined as ``J_{ij} = \frac{\partial F_i}{\partial x_j}``
`J = GTPSA.jacobian(F)` extracts the Jacobian matrix from the array of TPSs `F`, defined as ``J_{ij} = \frac{\partial F_i}{\partial x_j}``

`GTPSA.jacobian!(J, F)` fills the `J` matrix in-place with the Jacobian extracted from the vector of TPSs `F`
`GTPSA.jacobian!(J, F)` fills the `J` matrix in-place with the Jacobian extracted from the array of TPSs `F`

------

Expand Down
8 changes: 4 additions & 4 deletions src/getset.jl
Original file line number Diff line number Diff line change
Expand Up @@ -374,14 +374,14 @@ end
"""
GTPSA.jacobian!(result, m::AbstractArray{<:TPS}; include_params=false)
Extracts the first-order partial derivatives (evaluated at 0) from the Vector of TPSs.
Extracts the first-order partial derivatives (evaluated at 0) from the array of TPSs.
and fills the `result` matrix in-place. The partial derivatives wrt the parameters will
also be extracted when the `include_params` flag is set to `true`. Note that this function
is not calculating anything - just extracting the first-order monomial coefficients already
in the TPSs.
### Input
- `m` -- Vector of TPSs to extract the Jacobian from, must be 1-based indexing
- `m` -- Array of TPSs to extract the Jacobian from, must be 1-based indexing
- `include_params` -- (Optional) Extract partial derivatives wrt parameters. Default is false
### Output
Expand Down Expand Up @@ -410,13 +410,13 @@ end
"""
GTPSA.jacobian(m::AbstractArray{<:TPS}; include_params=false)
Extracts the first-order partial derivatives (evaluated at 0) from the Vector of TPSs.
Extracts the first-order partial derivatives (evaluated at 0) from the array of TPSs.
The partial derivatives wrt the parameters will also be extracted when the `include_params`
flag is set to `true`. Note that this function is not calculating anything - just extracting
the first-order monomial coefficients already in the TPSs.
### Input
- `m` -- Vector of TPSs to extract the Jacobian from, must be 1-based indexing
- `m` -- Array of TPSs to extract the Jacobian from, must be 1-based indexing
- `include_params` -- (Optional) Extract partial derivatives wrt parameters. Default is false
### Output
Expand Down

0 comments on commit e6b4993

Please sign in to comment.