PCL
AlignedAllocator.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.6.5
6 // ----------------------------------------------------------------------------
7 // pcl/AlignedAllocator.h - Released 2024-01-13T15:47:58Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_AlignedAllocator_h
53 #define __PCL_AlignedAllocator_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 #include <pcl/StandardAllocator.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
86 class PCL_CLASS AlignedAllocator : public StandardAllocator
87 {
88 public:
89 
102  AlignedAllocator( bool fastGrowth = true, bool canShrink = true )
103  : StandardAllocator( fastGrowth, canShrink )
104  {
105  }
106 
110  AlignedAllocator( const AlignedAllocator& ) = default;
111 
122  void* AllocateBlock( size_type size )
123  {
124  PCL_PRECONDITION( size != 0 )
125  void* p = PCL_ALIGNED_MALLOC( size, 32 );
126  if ( unlikely( p == nullptr ) )
127  throw std::bad_alloc();
128  return PCL_ASSUME_ALIGNED_32( p );
129  }
130 
140  void DeallocateBlock( void* p )
141  {
142  PCL_PRECONDITION( p != nullptr )
143  PCL_ALIGNED_FREE( p );
144  }
145 };
146 
147 } // pcl
148 
149 // ----------------------------------------------------------------------------
150 
155 inline void* operator new( pcl::size_type, void* p, pcl::AlignedAllocator& )
156 {
157  PCL_PRECONDITION( p != nullptr )
158  return p;
159 }
160 
161 #ifdef _MSC_VER
162 #pragma warning( push )
163 #pragma warning( disable: 4100 ) // 'unreferenced formal parameter'
164 
165 inline void operator delete( void* p, void*, pcl::AlignedAllocator& )
166 {
167  PCL_PRECONDITION( p != nullptr )
168 }
169 
170 #pragma warning( pop )
171 #endif // _MSC_VER
172 
173 // ----------------------------------------------------------------------------
174 
175 #endif // __PCL_AlignedAllocator_h
176 
177 // ----------------------------------------------------------------------------
178 // EOF pcl/AlignedAllocator.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition: AbstractImage.h:76
pcl::AlignedAllocator::DeallocateBlock
void DeallocateBlock(void *p)
Definition: AlignedAllocator.h:140
pcl::AlignedAllocator
A block allocator class for aligned memory allocation/deallocation.
Definition: AlignedAllocator.h:86
pcl::AlignedAllocator::AllocateBlock
void * AllocateBlock(size_type size)
Definition: AlignedAllocator.h:122
pcl::size_type
size_t size_type
Definition: Defs.h:612
pcl::StandardAllocator
A block allocator class that uses the standard new and delete operators.
Definition: StandardAllocator.h:81
StandardAllocator.h
pcl::AlignedAllocator::AlignedAllocator
AlignedAllocator(bool fastGrowth=true, bool canShrink=true)
Definition: AlignedAllocator.h:102
Defs.h