Commit 66ccf5ea authored by Martin Reinecke's avatar Martin Reinecke
Browse files

Merge branch 'fix_doc' into 'NIFTy_5'

Fix doc

See merge request !371
parents ee760ed2 bbfe02a1
Pipeline #63691 passed with stages
in 22 minutes and 49 seconds
......@@ -24,20 +24,21 @@ from .linear_operator import LinearOperator
class ContractionOperator(LinearOperator):
"""A :class:`LinearOperator` which sums up fields into the direction of
"""A :class:`LinearOperator` which sums up fields into the direction of
subspaces.
This Operator sums up a field with is defined on a :class:`DomainTuple`
to a :class:`DomainTuple` which contains the former as a subset.
to a :class:`DomainTuple` which is a subset of the former.
Parameters
----------
domain : Domain, tuple of Domain or DomainTuple
spaces : int or tuple of int
spaces : None, int or tuple of int
The elements of "domain" which are contracted.
If `None`, everything is contracted
weight : int, default=0
If nonzero, the fields defined on self.domain are weighted with the
specified power.
specified power along the submdomains which are contracted.
"""
def __init__(self, domain, spaces, weight=0):
......
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