File size: 8,528 Bytes
68ce2fc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Daniel Li, Ofri Sadowsky, Anton Deguet
  Created on: 2006-07-06

  (C) Copyright 2006-2007 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#pragma once
#ifndef _vctDynamicNArrayRefOwner_h
#define _vctDynamicNArrayRefOwner_h

/*!
  \file
  \brief Declaration of vctDynamicNArrayRefOwner
*/

#include <cisstVector/vctVarStrideNArrayIterator.h>

/*!
  This templated class owns a dynamically allocated array, but does
  not provide any other operations */
template<class _elementType, vct::size_type _dimension>
class vctDynamicNArrayRefOwner
{
public:
    /* define most types from vctContainerTraits and vctNArrayTraits */
    enum {DIMENSION = _dimension};
    VCT_CONTAINER_TRAITS_TYPEDEFS(_elementType);
    VCT_NARRAY_TRAITS_TYPEDEFS(DIMENSION);

    /*! The type of this owner. */
    typedef vctDynamicNArrayRefOwner<_elementType, DIMENSION> ThisType;

    /* iterators are container specific */
    typedef vctVarStrideNArrayIterator<ThisType, true> iterator;
    typedef vctVarStrideNArrayConstIterator<ThisType, true> const_iterator;
    typedef vctVarStrideNArrayIterator<ThisType, false> reverse_iterator;
    typedef vctVarStrideNArrayConstIterator<ThisType, false> const_reverse_iterator;


    vctDynamicNArrayRefOwner():
        SizesMember(0),
        StridesMember(0),
        Data(0)
    {}

    vctDynamicNArrayRefOwner(pointer data,
                             const nsize_type & sizes,
                             const nstride_type & strides)
    {
        SetRef(data, sizes, strides);
    }

    void SetRef(pointer data,
                const nsize_type & sizes,
                const nstride_type & strides)
    {
        Data = data;
        SizesMember = sizes;
        StridesMember = strides;
        this->UpdateCachedData();
    }

    /*! Return the number of dimensions of the nArray.
        \return the number of dimensions of this nArray */
    dimension_type dimension(void) const
    {
        return DIMENSION;
    }

    /*! Return the size of each dimension.
        \return a vector containing the size of the nArray in each dimension */
    const nsize_type & sizes(void) const
    {
        return SizesMember;
    }

    /*! Return the size of a dimension.
        \param dimension the dimension of interest
        \return the size of the nArray in the given dimension

        \note the dimension is zero-based
     */
    size_type size(dimension_type dimension) const
    {
        if (dimension < DIMENSION)
            return SizesMember[dimension];
        else
            return 1;
    }

    /*! Return the size of the nArray.
        \return the number of elements

        \note This method returns 0 if the dimension
        of the nArray is zero.
     */
    size_type size(void) const
    {
        if (SizesMember.size() == 0)
            return 0;
        else
            return SizesMember.ProductOfElements();
    }

    /*! Return the strides of each dimension.
        \return a vector containing the strides of the nArray in each dimension */
    const nstride_type & strides(void) const
    {
        return StridesMember;
    }

    /*! Return the stride of a dimension.
        \param dimension the dimension of interest
        \return the stride of the nArray in the given dimension */
    difference_type stride(dimension_type dimension) const
    {
        if (dimension < DIMENSION)
            return StridesMember[dimension];
        else
            return 1;
    }

    /*! Return a pointer to the nArray's data.
        \return a pointer to this nArray's data */
    pointer Pointer(void)
    {
        return Data;
    }

    /*! Return a pointer to the nArray's data at the specified element.
        \return a pointer to this nArray's data at the specified element */
    pointer Pointer(const nindex_type & indices)
    {
        vctFixedSizeConstVectorRef<stride_type, DIMENSION, 1>
            indicesRef(reinterpret_cast<stride_type *>(const_cast<size_type *>(indices.Pointer())));
        return (Data + StridesMember.DotProduct(indicesRef));
    }

    /*! Return a const pointer to the nArray's data.
        \return a const pointer to this nArray's data */
    const_pointer Pointer(void) const
    {
        return Data;
    }

    /*! Return a const pointer to the nArray's data at the specified element.
        \return a const pointer to this nArray's data at the specified element */
    const_pointer Pointer(const nsize_type & indices) const
    {
        vctFixedSizeConstVectorRef<stride_type, DIMENSION, 1>
            indicesRef(reinterpret_cast<stride_type *>(const_cast<size_type *>(indices.Pointer())));
        return Data + StridesMember.DotProduct(indicesRef);
    }

    iterator begin(void)
    {
        return iterator(this, 0);
    }

    iterator end(void)
    {
        return iterator(this, 0) + size();
    }

    const_iterator begin(void) const
    {
        return const_iterator(this, 0);
    }

    const_iterator end(void) const
    {
        return const_iterator(this, 0) + size();
    }

    reverse_iterator rbegin(void)
    {
        size_type endIndex = size() - 1;
        return reverse_iterator(this, endIndex);
    }

    reverse_iterator rend(void)
    {
        return reverse_iterator(this, 0) + 1;
    }

    const_reverse_iterator rbegin(void) const
    {
        size_type endIndex = size() - 1;
        return const_reverse_iterator(this, endIndex);
    }

    const_reverse_iterator rend(void) const
    {
        return const_reverse_iterator(this, 0) + 1;
    }


    inline bool IsCompact(void) const
    {
        return IsCompactMember;
    }


protected:
    nsize_type SizesMember;
    nstride_type StridesMember;
    pointer Data;
    bool IsCompactMember;

    inline void UpdateCachedData(void) {
        /* sort strides and sizes, using Gnome sort as found on
           wikipedia and www.cs.vu.nl/~dick/gnomesort.html */
        nsize_type sorted_sizes(SizesMember);
        nstride_type sorted_strides(StridesMember);

        index_type i = 0;
        bool swap;
        while (i < this->dimension()) {
            swap = true;
            if (i == 0) {
                swap = false;
            } else {
                if (sorted_strides[i - 1] == sorted_strides[i]) {
                    if (sorted_sizes[i - 1] >= sorted_sizes[i]) {
                        swap = false;
                    }
                } else {
                    if (sorted_strides[i - 1] > sorted_strides[i]) {
                        swap = false;
                    }
                }
            }
            if (swap) {
                std::swap(sorted_strides[i - 1], sorted_strides[i]);
                std::swap(sorted_sizes[i - 1], sorted_sizes[i]);
                i--;
            } else {
                i++;
            }
        }

        /* check compactness for sorted strides and sizes */
        typename nsize_type::const_reverse_iterator sizesIter = sorted_sizes.rbegin();
        typename nstride_type::const_reverse_iterator stridesIter = sorted_strides.rbegin();
        const typename nstride_type::const_reverse_iterator stridesEnd = sorted_strides.rend();
        size_type sizesIter_value;
        stride_type previous_stride;

        if (stridesIter != stridesEnd) {
            if (*stridesIter != 1) {
                IsCompactMember = false;
                return;
            } else {
                previous_stride = 1;
                ++stridesIter;
            }
        }

        for (;
             stridesIter != stridesEnd;
             ++stridesIter, ++sizesIter) {
            sizesIter_value = (*sizesIter == 0) ? 1 : *sizesIter;
            if (*stridesIter != static_cast<stride_type>(sizesIter_value) * previous_stride) {
                IsCompactMember = false;
                return;
            } else {
                previous_stride = *stridesIter;
            }
        }
        IsCompactMember = true;
    }

private:
    // copy constructor private to prevent any call
    vctDynamicNArrayRefOwner(const ThisType & CMN_UNUSED(other)) {};

};


#endif // _vctDynamicNArrayRefOwner_h