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
|
/*
//
// Copyright 1997-2010 Torsten Rohlfing
//
// Copyright 2004-2011 SRI International
//
// This file is part of the Computational Morphometry Toolkit.
//
// http://www.nitrc.org/projects/cmtk/
//
// The Computational Morphometry Toolkit 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.
//
// The Computational Morphometry Toolkit 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 the Computational Morphometry Toolkit. If not, see
// <http://www.gnu.org/licenses/>.
//
// $Revision: 5436 $
//
// $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
// $LastChangedBy: torstenrohlfing $
//
*/
#ifndef __cmtkMemory_h_included_
#define __cmtkMemory_h_included_
#include <cmtkconfig.h>
#include <stdlib.h>
namespace
cmtk
{
/** \addtogroup System */
//@{
/// Memory-related helper functions.
namespace Memory
{
/** Utility function: get next power of two.
* http://en.wikipedia.org/wiki/Power_of_two#Algorithm_to_find_the_next-highest_power_of_two
*/
size_t GetNextPowerOfTwo( size_t k );
/// Memory deallocation fucntion pointer.
typedef void (*DeallocatorFunctionPointer)( void *const );
/** Memory allocation for C-style array.
*/
class ArrayC
{
public:
/** Allocator function: calls malloc()
*\warning Objects in the array will not be instantiated.
*/
template<class T>
static T* Allocate( const size_t size )
{
return static_cast<T*>( malloc( size * sizeof( T ) ) );
}
/// Delete an array allocated using Allocate().
template<class T>
static void Delete( T *const array )
{
free( array );
}
/** Delete an array allocated using Allocate(), but referred to by a void*.
* This function provides a universal signature that we can use for function pointers.
*/
static void DeleteWrapper( void *const array )
{
free( array );
}
};
/** Memory allocation for C++-style array.
*/
class ArrayCXX
{
public:
/** Allocator function: calls new[]()
*\warning Objects in the array will not be instantiated.
*/
template<class T>
static T* Allocate( const size_t size )
{
return new T[size];
}
/// Delete an array allocated using Allocate().
template<class T>
static void Delete( T *const array )
{
delete[]( array );
}
/** Delete an array allocated using Allocate(), but referred to by a void*.
* This function provides a universal signature that we can use for function pointers.
*/
template<class T>
static void DeleteWrapper( void *const array )
{
delete[]( static_cast<T*>( array ) );
}
};
/** Set (fill) memory region with given value.
* This is the templated version of memset()
*/
template<class T>
inline void
Set( T* const to, const T value, const size_t length )
{
for ( size_t i = 0; i < length; ++i )
to[i] = value;
}
/** Copy memory region.
* This is the templated version of memcpy()
*/
template<class T>
inline void
Copy( T* const to, const T* from, const size_t length )
{
for ( size_t i = 0; i < length; ++i )
to[i] = from[i];
}
/// Byte-swap arbitrary value.
template<class T>
T ByteSwap( T value )
{
char *const cptr = reinterpret_cast<char*>( &value );
unsigned int j = sizeof(T)-1;
for ( unsigned int i = 0; i < j; ++i, --j )
{
char tmp = cptr[i];
cptr[i] = cptr[j];
cptr[j] = tmp;
}
return value;
}
/// Byte-swap arbitrary value in place.
template<class T>
void ByteSwapInPlace( T& value )
{
char *const cptr = reinterpret_cast<char*>( &value );
unsigned int j = sizeof(T)-1;
for ( unsigned int i = 0; i < j; ++i, --j )
{
char tmp = cptr[i];
cptr[i] = cptr[j];
cptr[j] = tmp;
}
}
/**\name Functions for tracing memory allocation and de-allocation.
* These functions can be used to watch the amount of memory allocated and
* freed by other functions. Memory holes can be identified and located.
*/
//@{
/** Get amount of memory used.
*\return The number of bytes allocated by the process the calling function
* is located in.
*/
size_t Used();
/** Print memory usage.
*\param msg An optional message to be printed with the amount of bytes
* allocated by the current process. This allows location of memory holes.
* The parameter may be omitted or given as NULL if no additional message is
* required.
*/
void Info ( const char *msg = NULL );
/** Print difference of memory usage.
*\param before Number of bytes allocated before the inspected operation. This
* parameter can be retrieved by al call to memused().
*\param msg Name of the operation the memory allocation of which was
* inspected.
*/
void Diff ( const size_t before, const char *msg );
} // namespace Memory
//@}
} // namespace cmtk
#endif // #ifndef __cmtkMemory_h_included_
|