Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hp docs #41

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update definition of J()
  • Loading branch information
tyronerees committed Jun 13, 2019
commit 7bacd352a2ef94f6304d0dcb941043aee47f1e50
2 changes: 1 addition & 1 deletion libRALFit/doc/common/subroutines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

.. |eval_J_X| replace:: holds the current point :math:`{\bm x}_{k}^{}` at which to evaluate :math:`{\bm J} ( {\bm x} _{k}^{})`.

.. |eval_J_r| replace:: must be set by the routine to hold the Jacobian of the residual function evaluated at the current point :math:`{\bm x}_{k}^{}`, :math:`{\bm r} ( {\bm x} _{k}^{})`. ``J(i*m+j)`` must be set to hold :math:`\nabla_{x_j} r_i( {\bm x} _{k}^{})`.
.. |eval_J_r| replace:: must be set by the routine to hold the Jacobian of the residual function evaluated at the current point :math:`{\bm x}_{k}^{}`, :math:`{\bm r} ( {\bm x} _{k}^{})`. ``J((i-1)*n+j)`` must be set to hold :math:`\nabla_{x_j} r_i( {\bm x} _{k}^{})`.

.. |eval_J_status| replace:: is initialised to ``0`` before the routine is called. If it is set to a non-zero value by the routine, then |nlls_solve| / |nlls_iterate| will exit with error.

Expand Down