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

doc matrix_exp_multiply #2551

Merged

Conversation

yizhang-yiz
Copy link

Submission Checklist

  • Run unit tests: ./runTests.py src/test/unit
  • Run cpplint: make cpplint
  • Declare copyright holder and open-source license: see below

Summary

documenting #2539 .

Intended Effect

docs for two new functions matrix_exp_multiply & scale_matrix_exp_multiply.

How to Verify

doc

Side Effects

n/a

Documentation

Copyright and Licensing

Metrum Research Group, LLC

By submitting this pull request, the copyright holder is agreeing to license the submitted work under the following licenses:

Copy link
Contributor

@bob-carpenter bob-carpenter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be part of the PR to add the functions to the language.

I had one internal change, too.

If the language changes already went in, let me know, and we can merge this. I just don't want the doc to get ahead of the code.

%
\fitem{matrix}{scale\_matrix\_exp\_multiply}{real \farg{t}, matrix \farg{A}, matrix \farg{B}}{
The multiplication of matrix exponential of \farg{t}\farg{A} and
matrix \farg{B}; algebraically equivalent to the less efficient form
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[optional]

This should really be \farg{t} * \farg{A} in the less efficient form. I'll approve and leave it up to you whether to fix it or not.

Copy link
Contributor

@bob-carpenter bob-carpenter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I'm moving the one nitpicky point to the next manual issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants