vlsvrs 1.0.0

VLSV reader with C and Python bindings
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
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

#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <setjmp.h>
#include <cmocka.h>

#define BIT_STREAM_WORD_TYPE uint16

#include "zfp/internal/zfp/inline.h"
#include "zfp/bitstream.h"
#include "zfp/bitstream.inl"

#define STREAM_WORD_CAPACITY 4

struct setupVars {
  void* buffer;
  bitstream* b;
};

static int
setup(void **state)
{
  struct setupVars *s = malloc(sizeof(struct setupVars));
  assert_non_null(s);

  s->buffer = calloc(STREAM_WORD_CAPACITY, sizeof(bitstream_word));
  assert_non_null(s->buffer);

  s->b = stream_open(s->buffer, STREAM_WORD_CAPACITY * sizeof(bitstream_word));
  assert_non_null(s->b);

  *state = s;

  return 0;
}

static int
teardown(void **state)
{
  struct setupVars *s = *state;
  free(s->buffer);
  free(s->b);
  free(s);

  return 0;
}

static void
when_ReadBitsSpreadsAcrossMultipleWords_expect_BitsCombinedFromMultipleWords(void **state)
{
  const uint READ_BIT_COUNT = 48;
  const uint PARTIAL_WORD_BIT_COUNT = 8;
  const uint NUM_OVERFLOWED_BITS = READ_BIT_COUNT - PARTIAL_WORD_BIT_COUNT;

  const uint64 WRITE_BITS1 = 0x11;
  const uint64 WRITE_BITS2 = 0x5555;
  const uint64 WRITE_BITS3 = 0x9249;
  const uint64 WRITE_BITS4 = 0x1111 + 0x8000;

  bitstream* s = ((struct setupVars *)*state)->b;
  stream_write_bits(s, WRITE_BITS1, wsize);
  stream_write_bits(s, WRITE_BITS2, wsize);
  stream_write_bits(s, WRITE_BITS3, wsize);
  stream_write_bits(s, WRITE_BITS4, wsize);

  stream_rewind(s);
  s->buffer = stream_read_word(s);
  s->bits = PARTIAL_WORD_BIT_COUNT;

  uint64 readBits = stream_read_bits(s, READ_BIT_COUNT);

  assert_int_equal(s->bits, wsize - (NUM_OVERFLOWED_BITS % wsize));
  assert_int_equal(readBits, WRITE_BITS1
    + (WRITE_BITS2 << PARTIAL_WORD_BIT_COUNT)
    + (WRITE_BITS3 << (wsize + PARTIAL_WORD_BIT_COUNT))
    + ((WRITE_BITS4 & 0xff) << (2*wsize + PARTIAL_WORD_BIT_COUNT)));
  assert_int_equal(s->buffer, (bitstream_word) (WRITE_BITS4 >> (NUM_OVERFLOWED_BITS % wsize)));
}

// overflow refers to what will land in the buffer
// more significant bits than overflow are returned by stream_write_bits()
static void
when_WriteBitsOverflowsBufferByMultipleWords_expect_WordsWrittenAndRemainingOverflowInBuffer(void **state)
{
  const uint EXISTING_BIT_COUNT = 4;
  const uint NUM_BITS_TO_WRITE = 40;
  const uint OVERFLOW_BIT_COUNT = (NUM_BITS_TO_WRITE - (wsize - EXISTING_BIT_COUNT)) % wsize;

  const uint64 EXISTING_BUFFER = 0xf;
  const uint64 WRITE_WORD1 = 0x5555;
  const uint64 WRITE_WORD2 = 0x9249;
  const uint64 WRITE_WORD3 = 0x1111 + 0x8000;

  const uint64 BITS_TO_WRITE = WRITE_WORD1
    + (WRITE_WORD2 << wsize)
    + (WRITE_WORD3 << (2*wsize));

  bitstream* s = ((struct setupVars *)*state)->b;
  stream_write_bits(s, EXISTING_BUFFER, EXISTING_BIT_COUNT);

  uint64 remainingWord = stream_write_bits(s, BITS_TO_WRITE, NUM_BITS_TO_WRITE);

  assert_int_equal(remainingWord, WRITE_WORD3 >> (3*wsize - NUM_BITS_TO_WRITE));
  assert_int_equal(*s->begin, EXISTING_BUFFER
    + ((WRITE_WORD1 << EXISTING_BIT_COUNT) & 0xffff));
  assert_int_equal(*(s->begin + 1), (WRITE_WORD1 >> (wsize - EXISTING_BIT_COUNT))
    + ((WRITE_WORD2 << EXISTING_BIT_COUNT) & 0xffff));
  assert_int_equal(s->bits, OVERFLOW_BIT_COUNT);
  assert_int_equal(s->buffer, (WRITE_WORD2 >> (wsize - EXISTING_BIT_COUNT))
    + ((WRITE_WORD3 << EXISTING_BIT_COUNT) & 0x0fff));
}

int main()
{
  const struct CMUnitTest tests[] = {
    cmocka_unit_test_setup_teardown(when_WriteBitsOverflowsBufferByMultipleWords_expect_WordsWrittenAndRemainingOverflowInBuffer, setup, teardown),
    cmocka_unit_test_setup_teardown(when_ReadBitsSpreadsAcrossMultipleWords_expect_BitsCombinedFromMultipleWords, setup, teardown),
  };

  return cmocka_run_group_tests(tests, NULL, NULL);
}