casacore
|
simple 1-D array More...
#include <Allocator.h>
Public Member Functions | |
Block () | |
Create a zero-length Block. More... | |
template<typename Allocator > | |
Block (AllocSpec< Allocator > const &) | |
Create a zero-length Block. More... | |
Block (size_t n) | |
Create a Block with the given number of points. More... | |
template<typename Allocator > | |
Block (size_t n, AllocSpec< Allocator > const &) | |
Create a Block with the given number of points. More... | |
Block (size_t n, ArrayInitPolicy initPolicy) | |
Create a Block with the given number of points. More... | |
template<typename Allocator > | |
Block (size_t n, ArrayInitPolicy initPolicy, AllocSpec< Allocator > const &) | |
Create a Block with the given number of points. More... | |
Block (size_t n, T const &val) | |
Create a Block of the given length, and initialize (via copy constructor for objects of type T) with the provided value. More... | |
template<typename Allocator > | |
Block (size_t n, T const &val, AllocSpec< Allocator > const &) | |
Create a Block of the given length, and initialize (via copy constructor for objects of type T) with the provided value. More... | |
Block (size_t n, T *&storagePointer, Bool takeOverStorage=True) | |
Create a Block from a C-array (i.e. More... | |
template<typename Allocator > | |
Block (size_t n, T *&storagePointer, Bool takeOverStorage, AllocSpec< Allocator > const &) | |
Create a Block from a C-array (i.e. More... | |
Block (const Block< T > &other) | |
Copy the other block into this one. More... | |
Block< T > & | operator= (const Block< T > &other) |
Assign other to this. More... | |
~Block () | |
Frees up the storage pointed contained in the Block. More... | |
void | resize (size_t n, Bool forceSmaller=False, Bool copyElements=True) |
Resizes the Block. More... | |
void | resize (size_t n, Bool forceSmaller, Bool copyElements, ArrayInitPolicy initPolicy) |
void | remove (size_t whichOne, Bool forceSmaller=True) |
Remove a single element from the Block. More... | |
void | remove (size_t whichOne, Bool forceSmaller, ArrayInitPolicy initPolicy) |
void | prohibitChangingAllocator () |
Prohibit changing allocator for this instance. More... | |
void | permitChangingAllocator () |
Permit changing allocator for this instance. More... | |
void | replaceStorage (size_t n, T *&storagePointer, Bool takeOverStorage=True) |
Replace the internal storage with a C-array (i.e. More... | |
template<typename Allocator > | |
void | replaceStorage (size_t n, T *&storagePointer, Bool takeOverStorage, AllocSpec< Allocator > const &) |
T & | operator[] (size_t index) |
Index into the block (0-based). More... | |
const T & | operator[] (size_t index) const |
Block< T > & | operator= (const T &val) |
Set all values in the block to "val". More... | |
void | set (const T &val) |
T * | storage () |
If you really, really, need a "raw" pointer to the beginning of the storage area this will give it to you. More... | |
const T * | storage () const |
size_t | nelements () const |
The number of elements contained in this Block<T> . More... | |
size_t | size () const |
size_t | capacity () const |
The capacity in this Block<T> . More... | |
Bool | empty () const |
Is the block empty (i.e. More... | |
typedef T | value_type |
Define the STL-style iterators. More... | |
typedef T * | iterator |
typedef const T * | const_iterator |
typedef value_type * | pointer |
typedef const value_type * | const_pointer |
typedef value_type & | reference |
typedef const value_type & | const_reference |
typedef size_t | size_type |
typedef ptrdiff_t | difference_type |
class | Array< T > |
Allocator_private::BulkAllocator < T > * | allocator_p |
The allocator. More... | |
size_t | capacity_p |
The capacity of the vector. More... | |
size_t | used_p |
The number of used elements in the vector. More... | |
T * | array |
The actual storage. More... | |
Bool | destroyPointer |
Can we delete the storage upon destruction? More... | |
Bool | keep_allocator_p |
Can we change allocator or not? More... | |
iterator | begin () |
Get the begin and end iterator object for this block. More... | |
const_iterator | begin () const |
iterator | end () |
const_iterator | end () const |
void | traceAlloc (const void *addr, size_t sz) const |
void | traceFree (const void *addr, size_t sz) const |
Block (size_t n, ArrayInitPolicy initPolicy, Allocator_private::BulkAllocator< T > *allocator) | |
Block (size_t n, Allocator_private::AllocSpec< T > allocator) | |
Block (size_t n, T *&storagePointer, Bool takeOverStorage, Allocator_private::BulkAllocator< T > *allocator) | |
void | construct (size_t pos, size_t n, T const *src) |
void | construct (size_t pos, size_t n, T const &initial_value) |
void | construct (size_t pos, size_type n) |
void | destroy (size_t pos, size_type n) |
Allocator_private::BulkAllocator < T > * | get_allocator () |
void | init (ArrayInitPolicy initPolicy) |
end of friend More... | |
void | deinit () |
void | dealloc () |
template<typename Allocator > | |
Bool | isCompatibleAllocator () |
size_t | get_size () const |
The number of used elements in the vector. More... | |
void | set_size (size_t new_value) |
Set the number of used elements in the vector. More... | |
size_t | get_capacity () const |
The capacity of the vector. More... | |
void | set_capacity (size_t new_value) |
Set the capacity of the vector. More... | |
static bool | init_anyway () |
template<typename Allocator > | |
static Allocator_private::BulkAllocator < typename Allocator::value_type > * | get_allocator () |
Additional Inherited Members | |
Static Public Member Functions inherited from casacore::BlockTrace | |
static void | setTraceSize (size_t sz) |
Set the trace size. More... | |
Static Protected Member Functions inherited from casacore::BlockTrace | |
static void | doTraceAlloc (const void *addr, size_t nelem, DataType type, size_t sz) |
Write alloc and free trace messages. More... | |
static void | doTraceFree (const void *addr, size_t nelem, DataType type, size_t sz) |
Static Protected Attributes inherited from casacore::BlockTrace | |
static size_t | itsTraceSize |
simple 1-D array
forward declarations:
Public interface
This should be viewed as a block of memory without sophisticated manipulation functions. Thus it is called Block
.
Block<T>
is a simple templated 1-D array class. Indices are always 0-based. For efficiency reasons, no index checking is done unless the preprocessor symbol AIPS_ARRAY_INDEX_CHECK
is defined. Block<T>
's may be assigned to and constructed from other Block<T>
's. As no reference counting is done this can be an expensive operation, however.
The net effect of this class is meant to be unsurprising to users who think of arrays as first class objects. The name "Block" is intended to convey the concept of a solid "chunk" of things without any intervening "fancy" memory management, etc. This class was written to be used in the implementations of more functional Vector, Matrix, etc. classes, although it is expected Block<T>
will be useful on its own.
The Block class should be efficient. You should normally use Block
.
Warning: If you use the assignment operator on an element of this class, you may leave dangling references to pointers released from storage()
; Resizing the array will also have this effect if the underlying storage is actually affected;
If index checking is turned on, an out-of-bounds index will generate an indexError<uInt>
exception.
Definition at line 210 of file Allocator.h.
typedef const T* casacore::Block< T >::const_iterator |
typedef const value_type* casacore::Block< T >::const_pointer |
typedef const value_type& casacore::Block< T >::const_reference |
typedef ptrdiff_t casacore::Block< T >::difference_type |
typedef T* casacore::Block< T >::iterator |
typedef value_type* casacore::Block< T >::pointer |
typedef value_type& casacore::Block< T >::reference |
typedef size_t casacore::Block< T >::size_type |
typedef T casacore::Block< T >::value_type |
Define the STL-style iterators.
It makes it possible to iterate through all data elements.
|
inline |
|
inlineexplicit |
|
inlineexplicit |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Create a Block
from a C-array (i.e.
pointer). If takeOverStorage
is True
, The Block assumes that it owns the pointer, i.e. that it is safe to release it via allocator
when the Block is destructed, otherwise the actual storage is not destroyed. If true, storagePointer
is set to 0
. It is strongly recommended to supply an appropriate allocator
argument explicitly whenever takeOverStorage
== True to let Block
to know how to release the storagePointer
. The default allocator set by this constructor will be changed from NewDelAllocator<T>value
to DefaultAllocator<T>value
in future.
|
inline |
|
inline |
Copy the other block into this one.
Uses copy, not reference, semantics.
objcopy(array, other.array, get_size());
|
inline |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inline |
|
inline |
|
inline |
The capacity in this Block<T>
.
size() <= capacity()
is always true.
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
|
inlineprivate |
Definition at line 739 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::deinit(), and casacore::Block< casacore::String >::init().
|
inlineprivate |
Definition at line 733 of file Block.h.
Referenced by casacore::Block< casacore::String >::resize(), and casacore::Block< casacore::String >::~Block().
|
inlineprivate |
|
inline |
Is the block empty (i.e.
no elements)?
Definition at line 620 of file Block.h.
Referenced by casacore::PtrBlock< casacore::RecordDesc * >::empty().
|
inline |
|
inline |
|
inlineprivate |
|
inlinestaticprivate |
|
inlineprivate |
The capacity of the vector.
Definition at line 770 of file Block.h.
Referenced by casacore::Block< casacore::String >::capacity(), casacore::Block< casacore::String >::dealloc(), casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), casacore::Block< casacore::String >::resize(), casacore::Block< casacore::String >::set_size(), and casacore::Block< casacore::String >::size().
|
inlineprivate |
The number of used elements in the vector.
Definition at line 763 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::deinit(), casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::operator=(), casacore::Block< casacore::String >::operator[](), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), casacore::Block< casacore::String >::resize(), and casacore::Block< casacore::String >::set_capacity().
|
inlineprivate |
end of friend
Definition at line 715 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block().
|
inlinestaticprivate |
Definition at line 708 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::remove(), and casacore::Block< casacore::String >::resize().
|
inlineprivate |
|
inline |
The number of elements contained in this Block<T>
.
Definition at line 611 of file Block.h.
Referenced by casacore::CompoundParam< AutoDiff< T > >::CompoundParam(), casacore::genSort(), casacore::MeasConvert< MEpoch >::isNOP(), casacore::PtrBlock< casacore::RecordDesc * >::nelements(), casacore::SimpleOrderedMap< K, V >::ntot(), casacore::BlockIO_global_functions_BlockIO::putBlock(), and casacore::BlockIO_global_functions_BlockIO::showBlock().
|
inline |
Assign other to this.
this resizes itself to the size of other, so after the assignment, this->nelements() == other.nelements() always.
|
inline |
|
inline |
Index into the block (0-based).
If the preprocessor symbol AIPS_ARRAY_INDEX_CHECK
is defined, index checking will be done and an out-of-bounds index will cause an indexError<uInt>
to be thrown. Note that valid indices range between 0 and nelements()-1
.
|
inline |
|
inline |
|
inline |
|
inline |
Remove a single element from the Block.
If forceSmaller is True this will resize the Block and hence involve new memory allocations. This is relatively expensive so setting forceSmaller to False is preferred. When forceSmaller is False the Block is not resized but the elements with an index above the removed element are shuffled down by one. For backward compatibility forceSmaller is True by default.
initPolicy
makes sense to determine whether new storage should be initialized or not before copying when forceSmaller
is True.
Definition at line 444 of file Block.h.
Referenced by casacore::PtrBlock< casacore::RecordDesc * >::remove().
|
inline |
|
inline |
Replace the internal storage with a C-array (i.e.
pointer). If takeOverStorage
is True, The Block assumes that it owns the pointer, i.e. that it is safe to release it via allocator
when the Block
is destructed, otherwise the actual storage is not destroyed. If true, storagePointer is set to NULL
. It is strongly recommended to supply an appropriate allocator
argument explicitly whenever takeOverStorage
== True to let Block
to know how to release the storagePointer
. The default parameter of allocator will be changed from AllocSpec<NewDelAllocator<T> >value
to AllocSpec<DefaultAllocator<T> >value
in future. AipsError is thrown if allocator is incompatible with the current allocator of the instance and changing allocator is prohibited, even if takeOverStorage == False.
Definition at line 529 of file Block.h.
Referenced by casacore::Block< casacore::String >::replaceStorage(), and casacore::PtrBlock< casacore::RecordDesc * >::replaceStorage().
|
inline |
|
inline |
Resizes the Block.
If n == nelements()
resize just returns. If a larger size is requested (n > nelements()
) the Block always resizes. If the requested size is smaller (n < nelements()
), by default the Block does not resize smaller, although it can be forced to with forceSmaller
. The reasoning behind this is that often the user will just want a buffer of at least a certain size, and won't want to pay the cost of multiple resizings.
Normally the old elements are copied over (although if the Block is lengthened the trailing elements will have undefined values), however this can be turned off by setting copyElements to False.
This is written as three functions because default parameters do not always work properly with templates.
initPolicy
makes sense to determine whether extended elements should be initialized or not when you enlarge Block.
Definition at line 377 of file Block.h.
Referenced by casacore::Block< casacore::String >::operator=(), casacore::ConcatRows::reserve(), casacore::Block< casacore::String >::resize(), and casacore::PtrBlock< casacore::RecordDesc * >::resize().
|
inline |
|
inline |
Definition at line 587 of file Block.h.
Referenced by casacore::PtrBlock< casacore::RecordDesc * >::set().
|
inlineprivate |
Set the capacity of the vector.
Definition at line 772 of file Block.h.
Referenced by casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), and casacore::Block< casacore::String >::resize().
|
inlineprivate |
Set the number of used elements in the vector.
Definition at line 765 of file Block.h.
Referenced by casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), casacore::Block< casacore::String >::resize(), and casacore::Block< casacore::String >::set_capacity().
|
inline |
Definition at line 612 of file Block.h.
Referenced by casacore::Block< casacore::String >::empty(), casacore::Block< casacore::String >::end(), casacore::Block< casacore::String >::nelements(), casacore::Block< casacore::String >::operator=(), and casacore::PtrBlock< casacore::RecordDesc * >::size().
|
inline |
If you really, really, need a "raw" pointer to the beginning of the storage area this will give it to you.
This may leave dangling pointers if the block is destructed or if the assignment operator or resize is used. Returns a null pointer if nelements() == 0
. It is best to only use this if you completely control the extent and lifetime of the Block
.
Definition at line 605 of file Block.h.
Referenced by casacore::PtrBlock< casacore::RecordDesc * >::storage().
|
inline |
|
inline |
Definition at line 656 of file Block.h.
Referenced by casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::remove(), and casacore::Block< casacore::String >::resize().
|
inline |
Definition at line 662 of file Block.h.
Referenced by casacore::Block< casacore::String >::dealloc(), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), and casacore::Block< casacore::String >::resize().
|
private |
The allocator.
Definition at line 778 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::construct(), casacore::Block< casacore::String >::dealloc(), casacore::Block< casacore::String >::deinit(), casacore::Block< casacore::String >::destroy(), casacore::Block< casacore::String >::get_allocator(), casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::isCompatibleAllocator(), casacore::Block< casacore::String >::operator=(), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), and casacore::Block< casacore::String >::resize().
|
private |
The actual storage.
Definition at line 784 of file Block.h.
Referenced by casacore::Block< casacore::String >::begin(), casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::construct(), casacore::Block< casacore::String >::dealloc(), casacore::Block< casacore::String >::deinit(), casacore::Block< casacore::String >::destroy(), casacore::Block< casacore::String >::end(), casacore::Block< casacore::String >::init(), casacore::Block< casacore::String >::operator=(), casacore::Block< casacore::String >::operator[](), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), casacore::Block< casacore::String >::resize(), and casacore::Block< casacore::String >::storage().
|
private |
The capacity of the vector.
Definition at line 780 of file Block.h.
Referenced by casacore::Block< casacore::String >::get_capacity(), and casacore::Block< casacore::String >::set_capacity().
|
private |
Can we delete the storage upon destruction?
Definition at line 786 of file Block.h.
Referenced by casacore::Block< casacore::String >::Block(), casacore::Block< casacore::String >::dealloc(), casacore::Block< casacore::String >::deinit(), casacore::Block< casacore::String >::remove(), casacore::Block< casacore::String >::replaceStorage(), and casacore::Block< casacore::String >::resize().
|
private |
Can we change allocator or not?
Definition at line 788 of file Block.h.
Referenced by casacore::Block< casacore::String >::permitChangingAllocator(), casacore::Block< casacore::String >::prohibitChangingAllocator(), and casacore::Block< casacore::String >::replaceStorage().
|
private |
The number of used elements in the vector.
Definition at line 782 of file Block.h.
Referenced by casacore::Block< casacore::String >::get_size(), and casacore::Block< casacore::String >::set_size().