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

[Development] Add impulse method to rfunc classes and improve docs #453

Closed
raoulcollenteur opened this issue Jan 10, 2023 · 3 comments
Closed
Assignees
Labels
development Indicates development of new features documentation Indicates a need for improvements or additions to documentation
Milestone

Comments

@raoulcollenteur
Copy link
Member

Describe the proposed feature

@mbakker7 proposed to implement an impulse method for all rfuncs classes, and started implementing this. I create this Issue to record this progress and new feature development.

Additionally, It would perhaps be an idea to add the latex formula to a repr function, such that printing the class would show thee impulse response function and keep everything in one place.

Expected usage

ps.Gamma().impulse()

Additional context

The reason for this change is that it is now not always entirely clear what the impulse response functions exactly is and how it looks from the code and related articles. It should be clear what

  1. the impulse and step response functions are from the code,
  2. and somewhere in the documentation.
@raoulcollenteur raoulcollenteur added the development Indicates development of new features label Jan 10, 2023
@raoulcollenteur raoulcollenteur added this to the 1.0: Arrabiata milestone Jan 10, 2023
@martinvonk
Copy link
Collaborator

martinvonk commented Jan 10, 2023

Maybe we could use latexify?

This way we can check the formula's easily like this:
image

Not sure if it works with NumPy though.

@mbakker7
Copy link
Collaborator

mbakker7 commented Jan 10, 2023 via email

@raoulcollenteur raoulcollenteur added the documentation Indicates a need for improvements or additions to documentation label Jan 19, 2023
@raoulcollenteur
Copy link
Member Author

This feature was aded in #472, closing issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Indicates development of new features documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants