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

[GSOC 2.3] Add System Margins for Transfer Functions #25418

Merged
merged 9 commits into from Aug 15, 2023

Conversation

faze-geek
Copy link
Contributor

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

  • physics.control
    • Added phase and gain margins for transfer functions.

@sympy-bot
Copy link

sympy-bot commented Jul 25, 2023

Hi, I am the SymPy bot (v170). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

  • physics.control

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.13.

Click here to see the pull request description that was parsed.
<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->


#### Brief description of what is fixed or changed


#### Other comments


#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers. Formerly, `log(-x)` incorrectly gave `-log(x)`.

* physics.units
  * Corrected a semantical error in the conversion between volt and statvolt which
    reported the volt as being larger than the statvolt.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
* physics.control
  * Added phase and gain margins for transfer functions.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@faze-geek faze-geek marked this pull request as draft July 25, 2023 04:01
@faze-geek faze-geek changed the title Add System Margins for Transfer Functions [GSOC 2.3] Add System Margins for Transfer Functions Jul 26, 2023
@faze-geek faze-geek marked this pull request as ready for review July 28, 2023 06:23
@github-actions
Copy link

github-actions bot commented Jul 28, 2023

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)

Significantly changed benchmark results (master vs previous release)

       before           after         ratio
     [8059df73]       [38780650]
     <sympy-1.12^0>                 
-         104±1ms         69.0±2ms     0.66  integrate.TimeIntegrationRisch02.time_doit(10)
-         103±2ms       66.1±0.3ms     0.64  integrate.TimeIntegrationRisch02.time_doit_risch(10)
-     2.45±0.01ms          783±2μs     0.32  polys.TimePREM_LinearDenseQuadraticGCD.time_op(3, 'sparse')
-      12.1±0.2ms      2.37±0.02ms     0.20  polys.TimePREM_LinearDenseQuadraticGCD.time_op(5, 'sparse')
-        452±10μs         98.5±1μs     0.22  polys.TimePREM_QuadraticNonMonicGCD.time_op(1, 'sparse')
-      5.81±0.3ms          443±9μs     0.08  polys.TimePREM_QuadraticNonMonicGCD.time_op(3, 'sparse')
-      12.7±0.7ms      1.31±0.04ms     0.10  polys.TimePREM_QuadraticNonMonicGCD.time_op(5, 'sparse')
-      7.63±0.4ms       5.01±0.2ms     0.66  polys.TimeSUBRESULTANTS_LinearDenseQuadraticGCD.time_op(2, 'sparse')
-      32.2±0.4ms       14.5±0.2ms     0.45  polys.TimeSUBRESULTANTS_LinearDenseQuadraticGCD.time_op(3, 'sparse')
-      8.60±0.1ms      1.41±0.01ms     0.16  polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(1, 'sparse')
-     19.1±0.07ms      11.0±0.02ms     0.58  polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(2, 'sparse')
-       244±0.3ms       84.5±0.1ms     0.35  polys.TimeSUBRESULTANTS_QuadraticNonMonicGCD.time_op(3, 'sparse')
-      7.32±0.1ms         644±30μs     0.09  polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(3, 'sparse')
-        33.7±1ms      1.03±0.02ms     0.03  polys.TimeSUBRESULTANTS_SparseGCDHighDegree.time_op(5, 'sparse')
-         732±9μs          240±5μs     0.33  polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(1, 'sparse')
-      7.52±0.1ms          251±8μs     0.03  polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(3, 'sparse')
-      19.6±0.5ms          252±7μs     0.01  polys.TimeSUBRESULTANTS_SparseNonMonicQuadratic.time_op(5, 'sparse')
-       191±0.7μs          109±3μs     0.57  solve.TimeMatrixOperations.time_rref(3, 0)
-         366±5μs          131±1μs     0.36  solve.TimeMatrixOperations.time_rref(4, 0)
-        38.4±2ms       16.4±0.6ms     0.43  solve.TimeSolveLinSys189x49.time_solve_lin_sys

Full benchmark results can be found as artifacts in GitHub Actions
(click on checks at the top of the PR).

Copy link
Member

@Sc0rpi0n101 Sc0rpi0n101 left a comment

Choose a reason for hiding this comment

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

Add a few more tests to have better coverage, but otherwise looks good.

Copy link
Member

@Sc0rpi0n101 Sc0rpi0n101 left a comment

Choose a reason for hiding this comment

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

I'm merging this. Thank you for your contribution @faze-geek

We should add some more references to some examples to make it easier for folks who are newer to this.

@Sc0rpi0n101 Sc0rpi0n101 merged commit 3236f74 into sympy:master Aug 15, 2023
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants