lc-framework-src 0.1.0+lc.2025

Source files for the LC compression framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

/*
This file is part of the LC framework for synthesizing high-speed parallel lossless and error-bounded lossy data compression and decompression algorithms for CPUs and GPUs.

BSD 3-Clause License

Copyright (c) 2021-2025, Noushin Azami, Alex Fallin, Brandon Burtchell, Andrew Rodriguez, Benila Jerald, Yiqian Liu, Anju Mongandampulath Akathoott, and Martin Burtscher
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

URL: The latest version of this code is available at https://github.com/burtscher/LC-framework.

Sponsor: This code is based upon work supported by the U.S. Department of Energy, Office of Science, Office of Advanced Scientific Research (ASCR), under contract DE-SC0022223.
*/


static void MAXREL_f64(const long long size, const byte* const __restrict__ recon, const byte* const __restrict__ orig, const int paramc, const double paramv [])
{ 
  using type_f = double;
  using type_i = long long;
  assert(sizeof(type_f) == sizeof(type_i));

  if ((size % sizeof(type_f)) != 0) {fprintf(stderr, "ERROR: MAXREL_f64 requires data to be a multiple of %ld bytes long\n", sizeof(type_f)); throw std::runtime_error("LC error");}
  if (paramc != 1) {fprintf(stderr, "ERROR: MAXREL_f64 requires one parameter that specifies the maximum allowed relative error\n"); throw std::runtime_error("LC error");}
  const type_f errorbound = paramv[0];
  if (errorbound <= 0) {fprintf(stderr, "ERROR: MAXREL_f64 requires the maximum allowed relative error to be greater than zero\n"); throw std::runtime_error("LC error");}

  const type_f* const orig_f = (type_f*)orig;
  const type_f* const recon_f = (type_f*)recon;
  const long long len = size / sizeof(type_f);

  for (long long i = 0; i < len; i++) {
    if ((orig_f[i] == 0) || (recon_f[i] == 0)) {  // at least one value is zero
      if (orig_f[i] != recon_f[i]) {
        fprintf(stderr, "MAXREL_f64 ERROR: relative error bound of %e exceeded at position %lld: value is '%e' vs '%e'\n\n", errorbound, i, recon_f[i], orig_f[i]);
        throw std::runtime_error("LC error");
      }
    } else if (!std::isfinite(orig_f[i]) || !std::isfinite(recon_f[i])) {  // at least one value is INF or NaN
      if (recon_f[i] != orig_f[i]) {
        if (!std::isnan(orig_f[i]) || !std::isnan(recon_f[i])) {  // at least one value isn't a NaN
          fprintf(stderr, "MAXREL_f64 ERROR: relative error bound of %e exceeded at position %lld: value is '%e' vs '%e'\n\n", errorbound, i, recon_f[i], orig_f[i]);
          throw std::runtime_error("LC error");
        }
      }
    } else {
      const type_f abs_orig_f = std::abs(orig_f[i]);
      const type_f abs_recon_f = std::abs(recon_f[i]);
      const type_f lower = abs_orig_f / (1 + errorbound);
      const type_f upper = abs_orig_f * (1 + errorbound);
      if ((std::signbit(orig_f[i]) != std::signbit(recon_f[i])) || (abs_recon_f < lower) || (abs_recon_f > upper)) {
        fprintf(stderr, "MAXREL_f64 ERROR: relative error bound of %e exceeded at position %lld: value is '%e' vs '%e'\n\n", errorbound, i, recon_f[i], orig_f[i]);
        throw std::runtime_error("LC error");
      }
    }
  }

  printf("MAXREL_f64 verification passed\n");
}