File: itkNeighborhoodAllocator.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (211 lines) | stat: -rw-r--r-- 5,237 bytes parent folder | download
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
/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkNeighborhoodAllocator_h
#define itkNeighborhoodAllocator_h
#include "itkMakeUniqueForOverwrite.h"
#include <algorithm>
#include <iostream>
#include <memory>
#include "itkMacro.h"

namespace itk
{
/** \class NeighborhoodAllocator
 *  \brief A memory allocator for use as the default allocator type in
 *         Neighborhood.
 *
 * This is a memory allocator for use as the default allocator type in
 * Neighborhood.  The API is designed to mimic that of vnl_vector so that
 * vnl_vector can also be used as an allocator for Neighborhood.
 *
 * The decision to create this allocator with the vnl_vector api (versus
 * using an STL allocator and wrapping the vnl_vector API) was made because
 * the STL allocator API is not guaranteed stable at this time.
 *
 * \ingroup Operators
 * \ingroup ITKCommon
 */
template <typename TPixel>
class NeighborhoodAllocator
{
public:
  /** Standard class type aliases. */
  using Self = NeighborhoodAllocator;

  /** Iterator support. Note that the naming of the type alias is on purpose.
   * itk::Neighborhood makes reference to the allocator, which because it may
   * be vnl or other type, uses the lower case/underscore forms iterator and
   * const_iterator. */
  using iterator = TPixel *;
  using const_iterator = const TPixel *;

  /** Default constructor */
  NeighborhoodAllocator() = default;

  /** Defaulted destructor */
  ~NeighborhoodAllocator() = default;

  /** Allocates memory. */
  void
  Allocate(unsigned int n)
  {
    m_Data = make_unique_for_overwrite<TPixel[]>(n);
    m_ElementCount = n;
  }

  /** Deallocates memory. */
  void
  Deallocate()
  {
    m_Data.reset();
    m_ElementCount = 0;
  }

  /** Copy constructor. */
  NeighborhoodAllocator(const Self & other)
    : m_ElementCount(other.m_ElementCount)
    , m_Data(make_unique_for_overwrite<TPixel[]>(other.m_ElementCount))
  {
    std::copy_n(other.m_Data.get(), m_ElementCount, m_Data.get());
  }


  /** Move-constructor. */
  NeighborhoodAllocator(Self && other) noexcept
    : m_ElementCount{ other.m_ElementCount }
    , m_Data{ std::move(other.m_Data) }
  {
    other.m_ElementCount = 0;
  }


  /** Assignment operator. */
  Self &
  operator=(const Self & other)
  {
    if (this != &other)
    {
      this->set_size(other.m_ElementCount);
      std::copy_n(other.m_Data.get(), m_ElementCount, m_Data.get());
    }
    return *this;
  }


  /** Move-assignment. */
  Self &
  operator=(Self && other) noexcept
  {
    if (this != &other)
    {
      m_ElementCount = other.m_ElementCount;
      m_Data = std::move(other.m_Data);
      other.m_ElementCount = 0;
    }
    return *this;
  }


  /** STL-style iterator support for the memory buffer. */
  iterator
  begin()
  {
    return m_Data.get();
  }
  const_iterator
  begin() const
  {
    return m_Data.get();
  }
  iterator
  end()
  {
    return (m_Data.get() + m_ElementCount);
  }
  const_iterator
  end() const
  {
    return (m_Data.get() + m_ElementCount);
  }
  unsigned int
  size() const
  {
    return m_ElementCount;
  }

  /** Data access methods */
  const TPixel & operator[](unsigned int i) const { return m_Data[i]; }
  TPixel &       operator[](unsigned int i) { return m_Data[i]; }

  /** Allocates a buffer of size n */
  void
  set_size(unsigned int n)
  {
    if (n != m_ElementCount)
    {
      *this = NeighborhoodAllocator();
      m_Data = make_unique_for_overwrite<TPixel[]>(n);
      m_ElementCount = n;
    }
  }

  TPixel *
  data() noexcept
  {
    return m_Data.get();
  }

  const TPixel *
  data() const noexcept
  {
    return m_Data.get();
  }

private:
  unsigned int              m_ElementCount{ 0 };
  std::unique_ptr<TPixel[]> m_Data;
};

template <typename TPixel>
inline std::ostream &
operator<<(std::ostream & o, const NeighborhoodAllocator<TPixel> & a)
{
  o << "NeighborhoodAllocator { this = " << &a << ", begin = " << static_cast<const void *>(a.begin())
    << ", size=" << a.size() << " }";
  return o;
}


// Equality operator.
template <typename TPixel>
inline bool
operator==(const NeighborhoodAllocator<TPixel> & lhs, const NeighborhoodAllocator<TPixel> & rhs)
{
  const unsigned int size = lhs.size();
  return (size == rhs.size()) && ((size == 0) || std::equal(lhs.begin(), lhs.end(), rhs.begin()));
}

// Inequality operator.
template <typename TPixel>
inline bool
operator!=(const NeighborhoodAllocator<TPixel> & lhs, const NeighborhoodAllocator<TPixel> & rhs)
{
  return !(lhs == rhs);
}
} // end namespace itk
#endif