File: ringbuf.c

package info (click to toggle)
gsl 2.5%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 25,628 kB
  • sloc: ansic: 245,573; sh: 11,435; makefile: 911; python: 68
file content (212 lines) | stat: -rw-r--r-- 4,748 bytes parent folder | download | duplicates (7)
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
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
148
149
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
184
185
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
/* movstat/ringbuf.c
 *
 * Ring buffer module
 * 
 * Copyright (C) 2018 Patrick Alken
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef __GSL_RINGBUF_C__
#define __GSL_RINGBUF_C__

/*typedef int ringbuf_type;*/

typedef struct
{
  ringbuf_type_t *array;
  int head;
  int tail;
  int size;       /* total elements allocated */
} ringbuf;

static size_t ringbuf_size(const size_t n);
static int ringbuf_empty(ringbuf * d);
static int ringbuf_is_empty(const ringbuf * d);
static int ringbuf_is_full(const ringbuf * d);
static int ringbuf_insert(const ringbuf_type_t x, ringbuf * d);
static int ringbuf_pop_back(ringbuf * b);
static ringbuf_type_t ringbuf_peek(const int i, const ringbuf * b);
static ringbuf_type_t ringbuf_peek_front(const ringbuf * d);
static ringbuf_type_t ringbuf_peek_back(const ringbuf * d);
static size_t ringbuf_copy(double * dest, const ringbuf * b);

static size_t
ringbuf_size(const size_t n)
{
  size_t size = 0;

  size += sizeof(ringbuf);
  size += n * sizeof(ringbuf_type_t); /* b->array */

  return size;
}

static int
ringbuf_init(const size_t n, ringbuf * b)
{
  b->array = (ringbuf_type_t *) ((char *) b + sizeof(ringbuf));
  b->head = -1;
  b->tail = 0;
  b->size = (int) n;
  return GSL_SUCCESS;
}

/* empty the buffer */
static int
ringbuf_empty(ringbuf * b)
{
  b->head = -1;
  b->tail = 0;
  return GSL_SUCCESS;
}

/* check if buffer is empty */
static int
ringbuf_is_empty(const ringbuf * b)
{
  return (b->head == -1);
}

/* check if buffer is full */
static int
ringbuf_is_full(const ringbuf * b)
{
  return ((b->head == 0 && b->tail == b->size - 1) ||
          (b->head == b->tail + 1));
}

/* insert element into buffer, overwriting oldest element if necessary */
static int
ringbuf_insert(const ringbuf_type_t x, ringbuf * b)
{
  if (b->head == -1)     /* buffer is empty */
    {
      b->head = 0;
      b->tail = 0;
    }
  else if (b->head == 0) /* head is in first position, wrap to end */
    {
      b->head = b->size - 1;

      if (b->tail == b->head && b->size > 1)
        --(b->tail);     /* buffer is full so decrease tail */
    }
  else                   /* decrement head */
    {
      --(b->head);

      if (b->tail == b->head)
        {
          /* buffer is full so update tail */
          if (b->tail == 0)
            b->tail = b->size - 1;
          else
            --(b->tail);
        }
    }

  /* insert element */
  b->array[b->head] = x;

  return GSL_SUCCESS;
}

static int
ringbuf_pop_back(ringbuf * b)
{
  if (ringbuf_is_empty(b) || b->tail < 0)
    {
      GSL_ERROR("buffer is empty", GSL_EBADLEN);
    }
  else
    {
      if (b->head == b->tail) /* buffer has only one element */
        {
          b->head = -1;
          b->tail = -1;
        }
      else if (b->tail == 0)  /* tail is in first position, wrap to end */
        {
          b->tail = b->size - 1;
        }
      else                    /* decrement tail */
        {
          --(b->tail);
        }

      return GSL_SUCCESS;
    }
}

static ringbuf_type_t
ringbuf_peek(const int i, const ringbuf * b)
{
  if (ringbuf_is_empty(b))
    {
      GSL_ERROR("buffer is empty", GSL_EBADLEN);
    }
  else
    {
      return b->array[(b->head + i) % b->size];
    }
}

static ringbuf_type_t
ringbuf_peek_front(const ringbuf * b)
{
  if (ringbuf_is_empty(b))
    {
      GSL_ERROR("buffer is empty", GSL_EBADLEN);
    }
  else
    {
      return b->array[b->head];
    }
}

static ringbuf_type_t
ringbuf_peek_back(const ringbuf * b)
{
  if (ringbuf_is_empty(b) || b->tail < 0)
    {
      GSL_ERROR("buffer is empty", GSL_EBADLEN);
    }
  else
    {
      return b->array[b->tail];
    }
}

static size_t
ringbuf_copy(double * dest, const ringbuf * b)
{
  if (ringbuf_is_empty(b) || b->tail < 0)
    {
      return 0;
    }
  else
    {
      const int n = (b->head > b->tail) ? (b->size - b->head + b->tail + 1) : (b->tail - b->head + 1);
      int i;

      for (i = 0; i < n; ++i)
        dest[n - i - 1] = b->array[(b->head + i) % b->size];

      return (size_t) n;
    }
}

#endif /* __GSL_RINGBUF_C__ */