Commit ab6ea82e authored by Pumpe, Daniel (dpumpe)'s avatar Pumpe, Daniel (dpumpe)
Browse files

Docstrings for ProjectionOperator

parent b8b7c28e
......@@ -25,6 +25,51 @@ from nifty.operators.endomorphic_operator import EndomorphicOperator
class ProjectionOperator(EndomorphicOperator):
"""NIFTY class for projection operators.
The NIFTY PorjectionOperator class is a class derived from the
EndomorphicOperator. It projects
Parameters
----------
projection_field : NIFTy.Field
Field on which the operator projects
Attributes
----------
domain : NIFTy.space
The NIFTy.space in which the operator is defined.
unitary : Boolean
Indicates whether the operator is unitary or not.
self_adjoint : boolean
Indicates whether the operator is self_adjoint or not
Raises
------
TypeError
Raised if
* if porjection_field is not a NIFTy.Field
Notes
-----
Examples
--------
>>> x_space = RGSpace(5)
>>> f1 = Field(x_space, val=3.)
>>> f2 = Field(x_space, val=5.)
>>> P = ProjectionOperator(f1)
>>> res = P.times(f2)
>>> res.val
<distributed_data_object>
array([ 225., 225., 225., 225., 225.])
See Also
--------
EndomorphicOperator
"""
# ---Overwritten properties and methods---
def __init__(self, projection_field):
......
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