Skip to content

minmax 🔗

Minmax operation.

MinmaxMixin 🔗

Mixin providing the Minmax operation for a Session.

This mixin is intended to be used in combination with BaseSession and should not be instantiated on its own.

Intended usage

class Session(BaseSession, MinmaxMixin): ...

minmax 🔗

minmax(
    indata: bytes, ndata: int, low_threshold: int, high_threshold: int
) -> (bytes, float, float)

Performs the minmax operation.

Wraps the vaccel_minmax() C operation.

Parameters:

Name Type Description Default

indata 🔗

 bytes

The input data as a bytes object.

 required

ndata 🔗

 int

The number of data to be read provided data object.

 required

low_threshold 🔗

 int

The threshold for the min value.

 required

high_threshold 🔗

 int

The threshold for the max value.

 required

Returns:

Type Description
(bytes, float, float)

A tuple containing: - The resulting output data. - The detected min value of the data. - The detected max value of the data.

Raises:

Type Description
RuntimeError

If the Session is uninitialized.
FFIError

If the C operation fails.
Source code in vaccel/ops/minmax.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def minmax(
    self, indata: bytes, ndata: int, low_threshold: int, high_threshold: int
) -> (bytes, float, float):
    """Performs the minmax operation.

    Wraps the `vaccel_minmax()` C operation.

    Args:
        indata: The input data as a `bytes` object.
        ndata: The number of data to be read provided data object.
        low_threshold: The threshold for the min value.
        high_threshold: The threshold for the max value.

    Returns:
        A tuple containing:
            - The resulting output data.
            - The detected min value of the data.
            - The detected max value of the data.

    Raises:
        RuntimeError: If the `Session` is uninitialized.
        FFIError: If the C operation fails.
    """
    c_indata = CBytes(indata)
    c_outdata = CBytes(bytearray(ndata * ffi.sizeof("double")))
    c_min = CFloat(float(0), "double")
    c_max = CFloat(float(0), "double")

    ret = lib.vaccel_minmax(
        self._c_ptr,
        c_indata._as_c_array("double"),
        ndata,
        low_threshold,
        high_threshold,
        c_outdata._as_c_array("double"),
        c_min._c_ptr,
        c_max._c_ptr,
    )
    if ret != 0:
        raise FFIError(ret, "Minmax operation failed")

    return (c_outdata.value, c_min.value, c_max.value)