Commit 7f771412 authored by Martin Reinecke's avatar Martin Reinecke
Browse files

add some words of caution

parent 83a0b1f3
Pipeline #26043 passed with stages
in 16 minutes and 20 seconds
...@@ -42,6 +42,16 @@ class DiagonalOperator(EndomorphicOperator): ...@@ -42,6 +42,16 @@ class DiagonalOperator(EndomorphicOperator):
spaces : int or tuple of int, optional spaces : int or tuple of int, optional
The elements of "domain" on which the operator acts. The elements of "domain" on which the operator acts.
If None, it acts on all elements. If None, it acts on all elements.
Notes
-----
Formally, this operator always supports all operation modes (times,
adjoint_times, inverse_times and inverse_adjoint_times), even if there
are diagonal elements with value 0 or infinity. It is the user's
responsibility to apply the operator only in appropriate ways (e.g. call
inverse_times only if there are no zeros on the diagonal).
This shortcoming will hopefully be fixed in the future.
""" """
def __init__(self, diagonal, domain=None, spaces=None): def __init__(self, diagonal, domain=None, spaces=None):
......
...@@ -35,6 +35,16 @@ class ScalingOperator(EndomorphicOperator): ...@@ -35,6 +35,16 @@ class ScalingOperator(EndomorphicOperator):
The multiplication factor The multiplication factor
domain : Domain or tuple of Domain or DomainTuple domain : Domain or tuple of Domain or DomainTuple
The domain on which the Operator's input Field lives. The domain on which the Operator's input Field lives.
Notes
-----
Formally, this operator always supports all operation modes (times,
adjoint_times, inverse_times and inverse_adjoint_times), even if `factor`
is 0 or infinity. It is the user's responsibility to apply the operator
only in appropriate ways (e.g. call inverse_times only if `factor` is
nonzero).
This shortcoming will hopefully be fixed in the future.
""" """
def __init__(self, factor, domain): def __init__(self, factor, domain):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment