summaryrefslogtreecommitdiffstats
path: root/ml/dlib/dlib/sliding_buffer/sliding_buffer_kernel_c.h
blob: a7330e4b5dd574e8f04d78b07b99896e04ea441b (plain)
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
213
214
215
216
217
218
219
220
221
222
// Copyright (C) 2003  Davis E. King (davis@dlib.net)
// License: Boost Software License   See LICENSE.txt for the full license.
#ifndef DLIB_SLIDING_BUFFER_KERNEl_C_
#define DLIB_SLIDING_BUFFER_KERNEl_C_

#include "sliding_buffer_kernel_abstract.h"
#include "../algs.h"
#include "../assert.h"
#include <iostream>

namespace dlib
{

    template <
        typename sb_base
        >
    class sliding_buffer_kernel_c : public sb_base
    {
        typedef typename sb_base::type T;
        
        public:
            void set_size (
                unsigned long exp_size
            );

            const T& operator[] (
                unsigned long index
            ) const;

            T& operator[] (
                unsigned long index
            );

            unsigned long get_element_id (
                unsigned long index
            ) const;

            unsigned long get_element_index (
                unsigned long element_id 
            ) const;

            const T& element (
            ) const;

            T& element (
            );


    };

    template <
        typename sb_base
        >
    inline void swap (
        sliding_buffer_kernel_c<sb_base>& a, 
        sliding_buffer_kernel_c<sb_base>& b 
    ) { a.swap(b); }  

// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------
    // member function definitions
// ----------------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    void sliding_buffer_kernel_c<sb_base>::
    set_size (
        unsigned long exp_size
    ) 
    {
        // make sure requires clause is not broken
        DLIB_CASSERT( 0 < exp_size && exp_size < 32,
            "\tvoid sliding_buffer::set_size(unsigned long)"
            << "\n\texp_size must be some number between 1 and 31"
            << "\n\tthis:     " << this
            << "\n\texp_size: " << exp_size
            );

        // call the real function
        sb_base::set_size(exp_size);
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    unsigned long sliding_buffer_kernel_c<sb_base>::
    get_element_id (
        unsigned long index
    ) const
    {
        // make sure requires clause is not broken
        DLIB_CASSERT( index < this->size(),
            "\tunsigned long sliding_buffer::get_element_id(unsigned long) const"
            << "\n\tindex must be in the range 0 to size()-1"
            << "\n\tthis:   " << this
            << "\n\tsize(): " << this->size()
            << "\n\tindex:  " << index
            );

        // call the real function
        return sb_base::get_element_id(index);
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    unsigned long sliding_buffer_kernel_c<sb_base>::
    get_element_index (
        unsigned long element_id
    ) const
    {
        // make sure requires clause is not broken
        DLIB_CASSERT( element_id < this->size(),
            "\tunsigned long sliding_buffer::get_element_index(unsigned long) const"
            << "\n\tid must be in the range 0 to size()-1"
            << "\n\tthis:   " << this
            << "\n\tsize(): " << this->size()
            << "\n\tid:     " << element_id
            );

        // call the real function
        return sb_base::get_element_index(element_id);
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    const typename sb_base::type& sliding_buffer_kernel_c<sb_base>::
    operator[] (
        unsigned long index
    ) const
    {
        // make sure requires clause is not broken
        DLIB_CASSERT( index < this->size(),
            "\tconst T& sliding_buffer::operator[](unsigned long) const"
            << "\n\tindex must be in the range 0 to size()-1"
            << "\n\tthis:   " << this
            << "\n\tsize(): " << this->size()
            << "\n\tindex:  " << index
            );

        // call the real function
        return sb_base::operator[](index);
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    typename sb_base::type& sliding_buffer_kernel_c<sb_base>::
    operator[] (
        unsigned long index
    ) 
    {
        // make sure requires clause is not broken
        DLIB_CASSERT( index < this->size(),
            "\tT& sliding_buffer::operator[](unsigned long)"
            << "\n\tindex must be in the range 0 to size()-1"
            << "\n\tthis:   " << this
            << "\n\tsize(): " << this->size()
            << "\n\tindex:  " << index
            );

        // call the real function
        return sb_base::operator[](index);
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    const typename sb_base::type& sliding_buffer_kernel_c<sb_base>::
    element (
    ) const
    {
        // make sure requires clause is not broken
        DLIB_CASSERT(this->current_element_valid() == true,
            "\tconst T& sliding_buffer::element"
            << "\n\tyou can't access the current element if it doesn't exist"
            << "\n\tthis: " << this
            );

        // call the real function
        return sb_base::element();
    }

// ----------------------------------------------------------------------------------------

    template <
        typename sb_base
        >
    typename sb_base::type& sliding_buffer_kernel_c<sb_base>::
    element (
    ) 
    {
        // make sure requires clause is not broken
        DLIB_CASSERT(this->current_element_valid() == true,
            "\tT& sliding_buffer::element"
            << "\n\tyou can't access the current element if it doesn't exist"
            << "\n\tthis: " << this
            );

        // call the real function
        return sb_base::element();
    }

// ----------------------------------------------------------------------------------------

}

#endif // DLIB_SLIDING_BUFFER_KERNEl_C_