`lossless`

compression_safeguards.safeguards.pointwise.lossless

Lossless reconstruction safeguard.

Classes:

LosslessSafeguard –

The LosslessSafeguard guarantees that all elements are reconstructed

LosslessSafeguard

LosslessSafeguard()

Bases: PointwiseSafeguard

flowchart LR compression_safeguards.safeguards.pointwise.lossless.LosslessSafeguard[LosslessSafeguard] compression_safeguards.safeguards.pointwise.abc.PointwiseSafeguard[PointwiseSafeguard] compression_safeguards.safeguards.abc.Safeguard[Safeguard] compression_safeguards.safeguards.pointwise.abc.PointwiseSafeguard --> compression_safeguards.safeguards.pointwise.lossless.LosslessSafeguard compression_safeguards.safeguards.abc.Safeguard --> compression_safeguards.safeguards.pointwise.abc.PointwiseSafeguard click compression_safeguards.safeguards.pointwise.lossless.LosslessSafeguard href "" "compression_safeguards.safeguards.pointwise.lossless.LosslessSafeguard" click compression_safeguards.safeguards.pointwise.abc.PointwiseSafeguard href "" "compression_safeguards.safeguards.pointwise.abc.PointwiseSafeguard" click compression_safeguards.safeguards.abc.Safeguard href "" "compression_safeguards.safeguards.abc.Safeguard"

The LosslessSafeguard guarantees that all elements are reconstructed exactly, i.e. losslessly.

This safeguard is an alternative to using a zero error bound safeguard.

This safeguards can be used with the SelectSafeguard to express regions that are of extra special interest and must be kept exactly the same.

Methods:

check_pointwise –

Check for which elements the data and approximation are bitwise
compute_safe_intervals –

The safe intervals for each element in the data array only contain
compute_footprint –

Compute the footprint of the foot array, e.g. for expanding data
compute_inverse_footprint –

Compute the inverse footprint of the foot array, e.g. for expanding
get_config –

Returns the configuration of the safeguard.

kind `class-attribute`

kind: str = 'lossless'

late_bound `property`

late_bound: Set[Parameter]

The set of late-bound parameters that this safeguard has.

Late-bound parameters are only bound when checking and applying the safeguard, in contrast to the normal early-bound parameters that are configured during safeguard initialisation.

Late-bound parameters can be used for parameters that depend on the specific data that is to be safeguarded.

check_pointwise

check_pointwise(
    data: ndarray[S, dtype[T]],
    approximation: ndarray[S, dtype[T]],
    *,
    late_bound: Bindings,
    where: Literal[True] | ndarray[S, dtype[bool]] = True,
) -> ndarray[S, dtype[bool]]

Check for which elements the data and approximation are bitwise equivalent.

Parameters:

data (ndarray[S, dtype[T]]) –

Original data array, relative to which the approximation is checked.
approximation (ndarray[S, dtype[T]]) –

Approximation of the data array.
late_bound (Bindings) –

Bindings for late-bound parameters, including for this safeguard.
where (Literal[True] | ndarray[S, dtype[bool]], default: True ) –

Only check at data points where the condition is True.

Returns:	`ok`( `ndarray[S, dtype[bool]]` ) – Pointwise, `True` if the check succeeded for this element.

compute_safe_intervals

compute_safe_intervals(
    data: ndarray[S, dtype[T]],
    *,
    late_bound: Bindings,
    where: Literal[True] | ndarray[S, dtype[bool]] = True,
) -> IntervalUnion[T, int, int]

The safe intervals for each element in the data array only contain this element.

Parameters:	`data` (`ndarray[S, dtype[T]]`) – Data for which the safe intervals should be computed. `late_bound` (`Bindings`) – Bindings for late-bound parameters, including for this safeguard. `where` (`Literal[True] \| ndarray[S, dtype[bool]]`, default: `True` ) – Only compute the safe intervals at pointwise checks where the condition is `True`.

Returns:	`intervals`( `IntervalUnion[T, int, int]` ) – Singleton interval union that only contains the `data`.

compute_footprint

compute_footprint(
    foot: ndarray[S, dtype[bool]],
    *,
    late_bound: Bindings,
    where: Literal[True] | ndarray[S, dtype[bool]] = True,
) -> ndarray[S, dtype[bool]]

Compute the footprint of the foot array, e.g. for expanding data points into the pointwise checks that they contribute to.

The footprint is equivalent to foot & where.

Parameters:	`foot` (`ndarray[S, dtype[bool]]`) – Array for which the footprint is computed. `late_bound` (`Bindings`) – Bindings for late-bound parameters, including for this safeguard. `where` (`Literal[True] \| ndarray[S, dtype[bool]]`, default: `True` ) – Only compute the footprint at pointwise checks where the condition is `True`.

Returns:	`print`( `ndarray[S, dtype[bool]]` ) – The footprint of the `foot` array.

compute_inverse_footprint

compute_inverse_footprint(
    foot: ndarray[S, dtype[bool]],
    *,
    late_bound: Bindings,
    where: Literal[True] | ndarray[S, dtype[bool]] = True,
) -> ndarray[S, dtype[bool]]

Compute the inverse footprint of the foot array, e.g. for expanding pointwise check fails into the points that could have contributed to the failures.

The inverse footprint is equivalent to foot & where.

Parameters:	`foot` (`ndarray[S, dtype[bool]]`) – Array for which the inverse footprint is computed. `late_bound` (`Bindings`) – Bindings for late-bound parameters, including for this safeguard. `where` (`Literal[True] \| ndarray[S, dtype[bool]]`, default: `True` ) – Only compute the inverse footprint at pointwise checks where the condition is `True`.

Returns:	`print`( `ndarray[S, dtype[bool]]` ) – The inverse footprint of the `foot` array.

get_config

get_config() -> dict[str, JSON]

Returns the configuration of the safeguard.

Returns:	`config`( `dict` ) – Configuration of the safeguard.

lossless