ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <itkVectorContainer.h>
Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface.
This is a full-fleged Object, so there is modification time, debug, and reference count information.
TElementIdentifier | An INTEGRAL type for use in indexing the vector. |
TElement | The element type stored in the container. |
Definition at line 51 of file itkVectorContainer.h.
typedef SmartPointer< const Self > itk::VectorContainer< TElementIdentifier, TElement >::ConstPointer |
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
Definition at line 60 of file itkVectorContainer.h.
typedef TElement itk::VectorContainer< TElementIdentifier, TElement >::Element |
Definition at line 64 of file itkVectorContainer.h.
typedef TElementIdentifier itk::VectorContainer< TElementIdentifier, TElement >::ElementIdentifier |
Save the template parameters.
Definition at line 63 of file itkVectorContainer.h.
typedef SmartPointer< Self > itk::VectorContainer< TElementIdentifier, TElement >::Pointer |
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
Definition at line 59 of file itkVectorContainer.h.
typedef VectorContainer itk::VectorContainer< TElementIdentifier, TElement >::Self |
Standard class typedefs.
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
Definition at line 57 of file itkVectorContainer.h.
typedef VectorType::size_type itk::VectorContainer< TElementIdentifier, TElement >::size_type [private] |
Definition at line 69 of file itkVectorContainer.h.
typedef VectorType itk::VectorContainer< TElementIdentifier, TElement >::STLContainerType |
This type is provided to Adapt this container as an STL container
Definition at line 92 of file itkVectorContainer.h.
typedef Object itk::VectorContainer< TElementIdentifier, TElement >::Superclass |
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
Definition at line 58 of file itkVectorContainer.h.
typedef VectorType::const_iterator itk::VectorContainer< TElementIdentifier, TElement >::VectorConstIterator [private] |
Definition at line 71 of file itkVectorContainer.h.
typedef VectorType::iterator itk::VectorContainer< TElementIdentifier, TElement >::VectorIterator [private] |
Definition at line 70 of file itkVectorContainer.h.
typedef std::vector< Element > itk::VectorContainer< TElementIdentifier, TElement >::VectorType [private] |
Quick access to the STL vector type that was inherited.
Definition at line 68 of file itkVectorContainer.h.
itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer | ( | ) | [inline, protected] |
Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 77 of file itkVectorContainer.h.
itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer | ( | size_type | n | ) | [inline, protected] |
Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 79 of file itkVectorContainer.h.
itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer | ( | size_type | n, |
const Element & | x | ||
) | [inline, protected] |
Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 81 of file itkVectorContainer.h.
itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer | ( | const Self & | r | ) | [inline, protected] |
Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 83 of file itkVectorContainer.h.
itk::VectorContainer< TElementIdentifier, TElement >::VectorContainer | ( | TInputIterator | first, |
TInputIterator | last | ||
) | [inline, protected] |
Provide pass-through constructors corresponding to all the STL vector constructors. These are for internal use only since this is also an Object which must be constructed through the "New()" routine.
Definition at line 86 of file itkVectorContainer.h.
ConstIterator itk::VectorContainer< TElementIdentifier, TElement >::Begin | ( | void | ) | const |
Get a begin const iterator for the vector.
Iterator itk::VectorContainer< TElementIdentifier, TElement >::Begin | ( | void | ) |
Get a begin iterator for the vector.
const STLContainerType& itk::VectorContainer< TElementIdentifier, TElement >::CastToSTLConstContainer | ( | ) | const [inline] |
Cast the container to a const STL container type
Definition at line 111 of file itkVectorContainer.h.
STLContainerType& itk::VectorContainer< TElementIdentifier, TElement >::CastToSTLContainer | ( | ) | [inline] |
Cast the container to a STL container type
Definition at line 105 of file itkVectorContainer.h.
virtual::itk::LightObject::Pointer itk::VectorContainer< TElementIdentifier, TElement >::CreateAnother | ( | void | ) | const [virtual] |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
Element& itk::VectorContainer< TElementIdentifier, TElement >::CreateElementAt | ( | ElementIdentifier | ) |
Get a reference to the element at the given index. If the element location does not exist, it will be created with a default element value.
It is assumed that the value of the element is modified through the reference.
void itk::VectorContainer< TElementIdentifier, TElement >::CreateIndex | ( | ElementIdentifier | ) |
Make sure that the index range of the vector is large enough to allow the given index, expanding it if necessary. The index will contain the default element regardless of whether expansion occured.
void itk::VectorContainer< TElementIdentifier, TElement >::DeleteIndex | ( | ElementIdentifier | ) |
Delete the element defined by the index identifier. In practice, it doesn't make sense to delete a vector index. Instead, this method just overwrite the index with the default element.
Element& itk::VectorContainer< TElementIdentifier, TElement >::ElementAt | ( | ElementIdentifier | ) |
Get a reference to the element at the given index. It is assumed that the index exists, and it will not automatically be created.
It is assumed that the value of the element is modified through the reference.
const Element& itk::VectorContainer< TElementIdentifier, TElement >::ElementAt | ( | ElementIdentifier | ) | const |
Get a reference to the element at the given index. It is assumed that the index exists, and it will not automatically be created.
ConstIterator itk::VectorContainer< TElementIdentifier, TElement >::End | ( | void | ) | const |
Get an end const iterator for the vector.
Iterator itk::VectorContainer< TElementIdentifier, TElement >::End | ( | void | ) |
Get an end iterator for the vector.
Element itk::VectorContainer< TElementIdentifier, TElement >::GetElement | ( | ElementIdentifier | ) | const |
Read the element from the given index. It is assumed that the index exists.
bool itk::VectorContainer< TElementIdentifier, TElement >::GetElementIfIndexExists | ( | ElementIdentifier | , |
Element * | |||
) | const |
Check if the given index is in range of the vector. If it is not, return false. Otherwise, set the element through the pointer (if it isn't NULL), and return true.
virtual const char* itk::VectorContainer< TElementIdentifier, TElement >::GetNameOfClass | ( | ) | const [virtual] |
Standard part of every itk Object.
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
bool itk::VectorContainer< TElementIdentifier, TElement >::IndexExists | ( | ElementIdentifier | ) | const |
Check if the index range of the vector is large enough to allow the given index without expansion.
void itk::VectorContainer< TElementIdentifier, TElement >::Initialize | ( | void | ) |
Clear the elements. The final size will be zero.
void itk::VectorContainer< TElementIdentifier, TElement >::InsertElement | ( | ElementIdentifier | , |
Element | |||
) |
Set the element value at the given index. If the element location does not exist, it will be created with a default element value.
static Pointer itk::VectorContainer< TElementIdentifier, TElement >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::Object.
Reimplemented in itk::PriorityQueueContainer< TElementWrapper, TElementWrapperInterface, TElementPriority, TElementIdentifier >.
void itk::VectorContainer< TElementIdentifier, TElement >::Reserve | ( | ElementIdentifier | ) |
Tell the container to allocate enough memory to allow at least as many elements as the size given to be stored. In the generic case of ITK containers this is NOT guaranteed to actually allocate any memory, but it is useful if the implementation of the container allocates contiguous storage. In the particular implementation of this VectorContainer the call to this method actually allocates memory for the number of elements defined by ElementIdentifier.
void itk::VectorContainer< TElementIdentifier, TElement >::SetElement | ( | ElementIdentifier | , |
Element | |||
) |
Set the element value at the given index. It is assumed that the index exists.
ElementIdentifier itk::VectorContainer< TElementIdentifier, TElement >::Size | ( | void | ) | const |
Get the number of elements currently stored in the vector.
void itk::VectorContainer< TElementIdentifier, TElement >::Squeeze | ( | void | ) |
Tell the container to try to minimize its memory usage for storage of the current number of elements. This is NOT guaranteed to decrease memory usage. This method is included here mainly for providing a unified API with other containers in the toolkit.
friend class ConstIterator [friend] |
Definition at line 159 of file itkVectorContainer.h.
friend class Iterator [friend] |
Friends to this class.
Definition at line 158 of file itkVectorContainer.h.