diagonal_operator.py 7.32 KB
Newer Older
1
2
3
4
5
6
7
# -*- coding: utf-8 -*-

import numpy as np

from d2o import distributed_data_object,\
                STRATEGIES as DISTRIBUTION_STRATEGIES

8
from nifty.config import nifty_configuration as gc
9
10
11
from nifty.field import Field
from nifty.operators.endomorphic_operator import EndomorphicOperator

12
13
14
import logging
logger = logging.getLogger('NIFTy.DiagonalOperator')

15
16
17
18
19

class DiagonalOperator(EndomorphicOperator):

    # ---Overwritten properties and methods---

20
    def __init__(self, domain=(), field_type=(), implemented=True,
21
22
                 diagonal=None, bare=False, copy=True,
                 distribution_strategy=None):
23
24
        self._domain = self._parse_domain(domain)
        self._field_type = self._parse_field_type(field_type)
25

26
27
        self._implemented = bool(implemented)

28
        if distribution_strategy is None:
29
            if isinstance(diagonal, distributed_data_object):
30
                distribution_strategy = diagonal.distribution_strategy
31
            elif isinstance(diagonal, Field):
32
                distribution_strategy = diagonal.distribution_strategy
33

34
        self._distribution_strategy = self._parse_distribution_strategy(
35
36
                               distribution_strategy=distribution_strategy,
                               val=diagonal)
37
38
39
40

        self.set_diagonal(diagonal=diagonal, bare=bare, copy=copy)

    def _times(self, x, spaces, types):
41
42
        return self._times_helper(x, spaces, types,
                                  operation=lambda z: z.__mul__)
43
44

    def _adjoint_times(self, x, spaces, types):
45
46
        return self._times_helper(x, spaces, types,
                                  operation=lambda z: z.adjoint().__mul__)
47
48

    def _inverse_times(self, x, spaces, types):
49
50
        return self._times_helper(x, spaces, types,
                                  operation=lambda z: z.__rdiv__)
51
52

    def _adjoint_inverse_times(self, x, spaces, types):
53
54
        return self._times_helper(x, spaces, types,
                                  operation=lambda z: z.adjoint().__rdiv__)
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

    def diagonal(self, bare=False, copy=True):
        if bare:
            diagonal = self._diagonal.weight(power=-1)
        elif copy:
            diagonal = self._diagonal.copy()
        else:
            diagonal = self._diagonal
        return diagonal

    def inverse_diagonal(self, bare=False):
        return 1/self.diagonal(bare=bare, copy=False)

    def trace(self, bare=False):
        return self.diagonal(bare=bare, copy=False).sum()

    def inverse_trace(self, bare=False):
        return self.inverse_diagonal(bare=bare, copy=False).sum()

    def trace_log(self):
        log_diagonal = self.diagonal(copy=False).apply_scalar_function(np.log)
        return log_diagonal.sum()

    def determinant(self):
        return self.diagonal(copy=False).val.prod()

    def inverse_determinant(self):
        return 1/self.determinant()

    def log_determinant(self):
        return np.log(self.determinant())

    # ---Mandatory properties and methods---

89
90
91
92
93
94
95
96
    @property
    def domain(self):
        return self._domain

    @property
    def field_type(self):
        return self._field_type

97
98
99
100
    @property
    def implemented(self):
        return self._implemented

101
102
103
104
105
106
107
108
109
110
111
    @property
    def symmetric(self):
        return self._symmetric

    @property
    def unitary(self):
        return self._unitary

    # ---Added properties and methods---

    @property
112
113
    def distribution_strategy(self):
        return self._distribution_strategy
114

115
116
    def _parse_distribution_strategy(self, distribution_strategy, val):
        if distribution_strategy is None:
117
            if isinstance(val, distributed_data_object):
118
                distribution_strategy = val.distribution_strategy
119
            elif isinstance(val, Field):
120
                distribution_strategy = val.distribution_strategy
121
            else:
122
                logger.info("Datamodel set to default!")
123
124
                distribution_strategy = gc['default_distribution_strategy']
        elif distribution_strategy not in DISTRIBUTION_STRATEGIES['all']:
125
126
            raise ValueError(
                    "Invalid distribution_strategy!")
127
        return distribution_strategy
128
129
130
131
132
133

    def set_diagonal(self, diagonal, bare=False, copy=True):
        # use the casting functionality from Field to process `diagonal`
        f = Field(domain=self.domain,
                  val=diagonal,
                  field_type=self.field_type,
134
                  distribution_strategy=self.distribution_strategy,
135
136
                  copy=copy)

137
138
139
140
141
142
143
144
145
146
        # weight if the given values were `bare` and `implemented` is True
        # do inverse weightening if the other way around
        if bare and self.implemented:
            # If `copy` is True, we won't change external data by weightening
            # Otherwise, inplace weightening would change the external field
            f.weight(inplace=copy)
        elif not bare and not self.implemented:
            # If `copy` is True, we won't change external data by weightening
            # Otherwise, inplace weightening would change the external field
            f.weight(inplace=copy, power=-1)
147
148
149
150
151
152
153
154
155

        # check if the operator is symmetric:
        self._symmetric = (f.val.imag == 0).all()

        # check if the operator is unitary:
        self._unitary = (f.val * f.val.conjugate() == 1).all()

        # store the diagonal-field
        self._diagonal = f
156
157
158
159
160
161
162
163
164
165
166
167

    def _times_helper(self, x, spaces, types, operation):
        # if the domain and field_type match directly
        # -> multiply the fields directly
        if x.domain == self.domain and x.field_type == self.field_type:
            # here the actual multiplication takes place
            return operation(self.diagonal(copy=False))(x)

        # if the distribution_strategy of self is sub-slice compatible to
        # the one of x, reshape the local data of self and apply it directly
        active_axes = []
        if spaces is None:
168
169
170
            if self.domain != ():
                for axes in x.domain_axes:
                    active_axes += axes
171
172
173
174
175
        else:
            for space_index in spaces:
                active_axes += x.domain_axes[space_index]

        if types is None:
176
177
178
            if self.field_type != ():
                for axes in x.field_type_axes:
                    active_axes += axes
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
        else:
            for type_index in types:
                active_axes += x.field_type_axes[type_index]

        axes_local_distribution_strategy = \
            x.val.get_axes_local_distribution_strategy(active_axes)
        if axes_local_distribution_strategy == self.distribution_strategy:
            local_diagonal = self._diagonal.val.get_local_data(copy=False)
        else:
            # create an array that is sub-slice compatible
            redistr_diagonal_val = self._diagonal.val.copy(
                distribution_strategy=axes_local_distribution_strategy)
            local_diagonal = redistr_diagonal_val.get_local_data(copy=False)

        reshaper = [x.shape[i] if i in active_axes else 1
                    for i in xrange(len(x.shape))]
        reshaped_local_diagonal = np.reshape(local_diagonal, reshaper)

        # here the actual multiplication takes place
        local_result = operation(reshaped_local_diagonal)(
                           x.val.get_local_data(copy=False))

        result_field = x.copy_empty(dtype=local_result.dtype)
        result_field.val.set_local_data(local_result, copy=False)
        return result_field