Skip to content

Commit

Permalink
Merge pull request PyDMD#161 from fAndreuzzi/master
Browse files Browse the repository at this point in the history
Fix miscopied docstring
  • Loading branch information
mtezzele committed Mar 31, 2021
2 parents f1b1a36 + 8f93bd2 commit 82a54a3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions pydmd/dmdbase.py
Expand Up @@ -173,12 +173,14 @@ def eigs(self):

def _translate_eigs_exponent(self, tpow):
"""
Get the eigenvalues of A tilde.
Transforms the exponent of the eigenvalues in the dynamics formula
according to the selected value of `self.opt` (check the documentation
for `opt` in :func:`__init__ <dmdbase.DMDBase.__init__>`).
:param tpow: the exponent(s) of Sigma in the original DMD formula.
:type tpow: int or np.ndarray
:return: the eigenvalues from the eigendecomposition of `atilde`.
:rtype: numpy.ndarray
:return: the exponent(s) adjusted according to `self.opt`
:rtype: int or np.ndarray
"""

if isinstance(self.opt, bool):
Expand Down

0 comments on commit 82a54a3

Please sign in to comment.