Skip to content

mode_util

mode_util

Gilbert modes related tools.

Dimensions dataclass

Container for system dimensions.

Source code in cssfinder/algorithm/mode_util.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
@dataclass
class Dimensions:
    """Container for system dimensions."""

    depth: int
    """Depth of system, ie.

    number of dimensions in qu(D)it. (d)

    """

    quantity: int
    """Quantity of systems.

    ie. number of qu(D)its in state. (n)

    """

depth instance-attribute 

depth: int

Depth of system, ie.

number of dimensions in qu(D)it. (d)

quantity instance-attribute 

quantity: int

Quantity of systems.

ie. number of qu(D)its in state. (n)

ModeUtil

Bases: ABC

Base class for implementing mode specific utilities eg.

shape deduction.

Source code in cssfinder/algorithm/mode_util.py 
 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
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class ModeUtil(ABC):
    """Base class for implementing mode specific utilities eg.

    shape deduction.

    """

    @staticmethod
    def new(mode: AlgoMode) -> ModeUtil:
        """Create new ModeUtil subclass instance.

        Parameters
        ----------
        mode : AlgoMode
            Util set selector.

        Returns
        -------
        ModeUtil
            Instance of subclass of ModeUtil.

        Raises
        ------
        NotImplementedError
            For unsupported AlgoModes and incorrect input.

        """
        if mode == AlgoMode.FSnQd:
            return FSnQdUtil()

        if mode == AlgoMode.SBiPa:
            return SBiPaUtil()

        if mode == AlgoMode.G3PaE3qD:
            return G3PaE3qDUtil()

        msg = f"Unsupported mode {mode.name}"
        raise NotImplementedError(msg)

    def get_dimensions(self, state: npt.NDArray[np.complex128]) -> Dimensions:
        """Detect both system depth and system quantity.

        Parameters
        ----------
        state : int
            State matrix to detect dimensions for.

        Returns
        -------
        Dimensions
            System dimensions within dedicated container.

        Raises
        ------
        ValueError
            When depth and quantity can't be determined.

        """
        dim = self.detect_depth_and_quantity(len(state))

        logging.debug(
            "Deduced quantity %r and depth %r when given total size %r",
            dim.depth,
            dim.quantity,
            len(state),
        )
        return dim

    @abstractmethod
    def detect_depth_and_quantity(self, total: int) -> Dimensions:
        """Detect both system depth and system quantity.

        Parameters
        ----------
        total : int
            Dimension along one of axes. Matrix is expected to be square.

        Returns
        -------
        Dimensions
            System dimensions within dedicated container.

        Raises
        ------
        ValueError
            When depth and quantity can't be determined.

        """

new staticmethod 

new(mode: AlgoMode) -> ModeUtil

Create new ModeUtil subclass instance.

Parameters:

Name Type Description Default
mode AlgoMode

Util set selector.

 required

Returns:

Type Description
ModeUtil

Instance of subclass of ModeUtil.

Raises:

Type Description
NotImplementedError

For unsupported AlgoModes and incorrect input.
Source code in cssfinder/algorithm/mode_util.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
@staticmethod
def new(mode: AlgoMode) -> ModeUtil:
    """Create new ModeUtil subclass instance.

    Parameters
    ----------
    mode : AlgoMode
        Util set selector.

    Returns
    -------
    ModeUtil
        Instance of subclass of ModeUtil.

    Raises
    ------
    NotImplementedError
        For unsupported AlgoModes and incorrect input.

    """
    if mode == AlgoMode.FSnQd:
        return FSnQdUtil()

    if mode == AlgoMode.SBiPa:
        return SBiPaUtil()

    if mode == AlgoMode.G3PaE3qD:
        return G3PaE3qDUtil()

    msg = f"Unsupported mode {mode.name}"
    raise NotImplementedError(msg)

get_dimensions 

get_dimensions(
    state: npt.NDArray[np.complex128],
) -> Dimensions

Detect both system depth and system quantity.

Parameters:

Name Type Description Default
state int

State matrix to detect dimensions for.

 required

Returns:

Type Description
Dimensions

System dimensions within dedicated container.

Raises:

Type Description
ValueError

When depth and quantity can't be determined.
Source code in cssfinder/algorithm/mode_util.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def get_dimensions(self, state: npt.NDArray[np.complex128]) -> Dimensions:
    """Detect both system depth and system quantity.

    Parameters
    ----------
    state : int
        State matrix to detect dimensions for.

    Returns
    -------
    Dimensions
        System dimensions within dedicated container.

    Raises
    ------
    ValueError
        When depth and quantity can't be determined.

    """
    dim = self.detect_depth_and_quantity(len(state))

    logging.debug(
        "Deduced quantity %r and depth %r when given total size %r",
        dim.depth,
        dim.quantity,
        len(state),
    )
    return dim

detect_depth_and_quantity abstractmethod 

detect_depth_and_quantity(total: int) -> Dimensions

Detect both system depth and system quantity.

Parameters:

Name Type Description Default
total int

Dimension along one of axes. Matrix is expected to be square.

 required

Returns:

Type Description
Dimensions

System dimensions within dedicated container.

Raises:

Type Description
ValueError

When depth and quantity can't be determined.
Source code in cssfinder/algorithm/mode_util.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
@abstractmethod
def detect_depth_and_quantity(self, total: int) -> Dimensions:
    """Detect both system depth and system quantity.

    Parameters
    ----------
    total : int
        Dimension along one of axes. Matrix is expected to be square.

    Returns
    -------
    Dimensions
        System dimensions within dedicated container.

    Raises
    ------
    ValueError
        When depth and quantity can't be determined.

    """

FSnQdUtil

Bases: ModeUtil

FSnQd specific implementation of utilities eg.

shape deduction.

Source code in cssfinder/algorithm/mode_util.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
class FSnQdUtil(ModeUtil):
    """FSnQd specific implementation of utilities eg.

    shape deduction.

    """

    def detect_depth_and_quantity(self, total: int) -> Dimensions:
        """Detect both system depth and system quantity.

        Parameters
        ----------
        total : int
            Dimension along one of axes. Matrix is expected to be square.

        Returns
        -------
        Dimensions
            System dimensions within dedicated container.

        Raises
        ------
        ValueError
            When depth and quantity can't be determined.

        """
        for depth in PRIMES:
            quantity = int(math.log(total, depth))

            if quantity == int(quantity):
                return Dimensions(depth, quantity)

        reason = "prime number range exceeded"
        raise UndefinedSystemSizeError(reason)

detect_depth_and_quantity 

detect_depth_and_quantity(total: int) -> Dimensions

Detect both system depth and system quantity.

Parameters:

Name Type Description Default
total int

Dimension along one of axes. Matrix is expected to be square.

 required

Returns:

Type Description
Dimensions

System dimensions within dedicated container.

Raises:

Type Description
ValueError

When depth and quantity can't be determined.
Source code in cssfinder/algorithm/mode_util.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
def detect_depth_and_quantity(self, total: int) -> Dimensions:
    """Detect both system depth and system quantity.

    Parameters
    ----------
    total : int
        Dimension along one of axes. Matrix is expected to be square.

    Returns
    -------
    Dimensions
        System dimensions within dedicated container.

    Raises
    ------
    ValueError
        When depth and quantity can't be determined.

    """
    for depth in PRIMES:
        quantity = int(math.log(total, depth))

        if quantity == int(quantity):
            return Dimensions(depth, quantity)

    reason = "prime number range exceeded"
    raise UndefinedSystemSizeError(reason)

SBiPaUtil

Bases: ModeUtil

SBiPa specific implementation of utilities eg.

shape deduction.

Source code in cssfinder/algorithm/mode_util.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
class SBiPaUtil(ModeUtil):
    """SBiPa specific implementation of utilities eg.

    shape deduction.

    """

    def detect_depth_and_quantity(self, total: int) -> Dimensions:
        """Detect both system depth and system quantity.

        Parameters
        ----------
        total : int
            Dimension along one of axes. Matrix is expected to be square.

        Returns
        -------
        Dimensions
            System dimensions within dedicated container.

        Raises
        ------
        ValueError
            When depth and quantity can't be determined.

        """
        total_sqrt = math.sqrt(total)
        floored_total_sqrt = int(total_sqrt)

        if total_sqrt == floored_total_sqrt:
            return Dimensions(floored_total_sqrt, floored_total_sqrt)

        for depth in PRIMES:
            if total % depth == 0:
                quantity = int(total / depth)
                return Dimensions(depth, quantity)

        reason = "prime number range exceeded"
        raise UndefinedSystemSizeError(reason)

detect_depth_and_quantity 

detect_depth_and_quantity(total: int) -> Dimensions

Detect both system depth and system quantity.

Parameters:

Name Type Description Default
total int

Dimension along one of axes. Matrix is expected to be square.

 required

Returns:

Type Description
Dimensions

System dimensions within dedicated container.

Raises:

Type Description
ValueError

When depth and quantity can't be determined.
Source code in cssfinder/algorithm/mode_util.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
def detect_depth_and_quantity(self, total: int) -> Dimensions:
    """Detect both system depth and system quantity.

    Parameters
    ----------
    total : int
        Dimension along one of axes. Matrix is expected to be square.

    Returns
    -------
    Dimensions
        System dimensions within dedicated container.

    Raises
    ------
    ValueError
        When depth and quantity can't be determined.

    """
    total_sqrt = math.sqrt(total)
    floored_total_sqrt = int(total_sqrt)

    if total_sqrt == floored_total_sqrt:
        return Dimensions(floored_total_sqrt, floored_total_sqrt)

    for depth in PRIMES:
        if total % depth == 0:
            quantity = int(total / depth)
            return Dimensions(depth, quantity)

    reason = "prime number range exceeded"
    raise UndefinedSystemSizeError(reason)

UndefinedSystemSizeError

Bases: ValueError

Raised when it is not possible to determine system dimensions.

Source code in cssfinder/algorithm/mode_util.py 
227
228
229
230
231
class UndefinedSystemSizeError(ValueError):
    """Raised when it is not possible to determine system dimensions."""

    def __init__(self, reason: str) -> None:
        super().__init__(f"Couldn't determine size of system: {reason}.")

G3PaE3qDUtil

Bases: ModeUtil

G3PaE3q specific implementation of utilities eg.

shape deduction.

Source code in cssfinder/algorithm/mode_util.py 
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
class G3PaE3qDUtil(ModeUtil):
    """G3PaE3q specific implementation of utilities eg.

    shape deduction.

    """

    def detect_depth_and_quantity(self, total: int) -> Dimensions:
        """Detect both system depth and system quantity.

        Parameters
        ----------
        total : int
            Dimension along one of axes. Matrix is expected to be square.

        Returns
        -------
        Dimensions
            System dimensions within dedicated container.

        Raises
        ------
        ValueError
            When depth and quantity can't be determined.

        """
        if round(total ** (1.0 / 3), 3) == round(total ** (1.0 / 3), 0):
            return Dimensions(depth=int(total ** (1.0 / 3)), quantity=3)

        reason = "prime number range exceeded"
        raise UndefinedSystemSizeError(reason)

detect_depth_and_quantity 

detect_depth_and_quantity(total: int) -> Dimensions

Detect both system depth and system quantity.

Parameters:

Name Type Description Default
total int

Dimension along one of axes. Matrix is expected to be square.

 required

Returns:

Type Description
Dimensions

System dimensions within dedicated container.

Raises:

Type Description
ValueError

When depth and quantity can't be determined.
Source code in cssfinder/algorithm/mode_util.py 
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
def detect_depth_and_quantity(self, total: int) -> Dimensions:
    """Detect both system depth and system quantity.

    Parameters
    ----------
    total : int
        Dimension along one of axes. Matrix is expected to be square.

    Returns
    -------
    Dimensions
        System dimensions within dedicated container.

    Raises
    ------
    ValueError
        When depth and quantity can't be determined.

    """
    if round(total ** (1.0 / 3), 3) == round(total ** (1.0 / 3), 0):
        return Dimensions(depth=int(total ** (1.0 / 3)), quantity=3)

    reason = "prime number range exceeded"
    raise UndefinedSystemSizeError(reason)