Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions doc/source/_static/dpf_operators.html

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions src/ansys/dpf/core/operators/compression/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
from .apply_svd import apply_svd
from .apply_zfp import apply_zfp
from .kmeans_clustering import kmeans_clustering
from .sketch_matrix import sketch_matrix
from .sketch_matrix_decompress import sketch_matrix_decompress
from .zfp_decompress import zfp_decompress
12 changes: 6 additions & 6 deletions src/ansys/dpf/core/operators/compression/apply_svd.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ class apply_svd(Operator):
scalar_int: int
number of vectors (r) to keep for the future reconstraction of the matrix A, ex. A[m,n]=coef[m,r]*VT[r,n], where coef=U*Sigma
scalar_double: float
threshold (precision) as a double, default value is 1e-7
threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors
boolean: bool
apply svd on the initial input data (true) or transposed (square matrix), default value is false
apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions).

Returns
-------
Expand Down Expand Up @@ -115,13 +115,13 @@ def _spec() -> Specification:
name="scalar_double",
type_names=["double"],
optional=False,
document=r"""threshold (precision) as a double, default value is 1e-7""",
document=r"""threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors""",
),
3: PinSpecification(
name="boolean",
type_names=["bool"],
optional=False,
document=r"""apply svd on the initial input data (true) or transposed (square matrix), default value is false""",
document=r"""apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions).""",
),
},
map_output_pin_spec={
Expand Down Expand Up @@ -268,7 +268,7 @@ def scalar_int(self) -> Input:
def scalar_double(self) -> Input:
r"""Allows to connect scalar_double input to the operator.

threshold (precision) as a double, default value is 1e-7
threshold (precision) as a double, default value is 1e-7. If both pin1 and pin2 are provided, choose the min r-vectors

Returns
-------
Expand All @@ -289,7 +289,7 @@ def scalar_double(self) -> Input:
def boolean(self) -> Input:
r"""Allows to connect boolean input to the operator.

apply svd on the initial input data (true) or transposed (square matrix), default value is false
apply svd on the initial data (Default : false), otherwise use reduced data (square matrix with the smallest dimensions).

Returns
-------
Expand Down
Loading
Loading