adder.py 1.36 KB
Newer Older
Philipp Arras's avatar
Philipp Arras committed
1 2 3 4 5 6 7 8 9 10 11 12 13
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
14
# Copyright(C) 2013-2019 Max-Planck-Society
Philipp Arras's avatar
Philipp Arras committed
15
#
16
# NIFTy is being developed at the Max-Planck-Institut fuer Astrophysik.
Philipp Arras's avatar
Philipp Arras committed
17

Philipp Arras's avatar
Philipp Arras committed
18 19
from ..field import Field
from ..multi_field import MultiField
Philipp Arras's avatar
Philipp Arras committed
20 21 22
from .operator import Operator


Philipp Arras's avatar
Philipp Arras committed
23 24
class Adder(Operator):
    """Adds a fixed field.
Philipp Arras's avatar
Docs  
Philipp Arras committed
25 26 27

    Parameters
    ----------
Philipp Arras's avatar
Philipp Arras committed
28
    field : Field or MultiField
29 30
        The field by which the input is shifted.
    """
Philipp Arras's avatar
Philipp Arras committed
31
    def __init__(self, field, neg=False):
Philipp Arras's avatar
Philipp Arras committed
32 33
        if not isinstance(field, (Field, MultiField)):
            raise TypeError
Philipp Arras's avatar
Philipp Arras committed
34
        self._field = field
Philipp Arras's avatar
Philipp Arras committed
35
        self._domain = self._target = field.domain
Philipp Arras's avatar
Philipp Arras committed
36
        self._neg = bool(neg)
Philipp Arras's avatar
Philipp Arras committed
37 38 39

    def apply(self, x):
        self._check_input(x)
Philipp Arras's avatar
Philipp Arras committed
40 41
        if self._neg:
            return x - self._field
Philipp Arras's avatar
Philipp Arras committed
42
        return x + self._field