Skip to content

Commit a25f269

Browse files
zandivxndem0
authored andcommitted
Fix POD docstring: default rank is -1, not 0
1 parent bce1ee3 commit a25f269

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

ezyrb/parallel/pod.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class POD(Reduction):
2828
the method uses the argument for the truncation; if float between 0
2929
and 1, the rank is the number of the biggest singular values that
3030
are needed to reach the 'energy' specified by `svd_rank`; if -1,
31-
the method does not compute truncation. Default is 0. The `rank`
31+
the method does not compute truncation. Default is -1. The `rank`
3232
parameter is available using all the available methods.
3333
:type rank: int or float
3434
:param int subspace_iteration: the number of subspace iteration in the

ezyrb/reduction/pod.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def __init__(
3333
the method uses the argument for the truncation; if float between 0
3434
and 1, the rank is the number of the biggest singular values that
3535
are needed to reach the 'energy' specified by `svd_rank`; if -1,
36-
the method does not compute truncation. Default is 0. The `rank`
36+
the method does not compute truncation. Default is -1. The `rank`
3737
parameter is available using all the available methods.
3838
:type rank: int or float
3939
:param int subspace_iteration: the number of subspace iteration in the

0 commit comments

Comments
 (0)