ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions
itk::ThreadedIteratorRangePartitioner< TIterator > Class Template Reference

#include <itkThreadedIteratorRangePartitioner.h>

+ Inheritance diagram for itk::ThreadedIteratorRangePartitioner< TIterator >:
+ Collaboration diagram for itk::ThreadedIteratorRangePartitioner< TIterator >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef Superclass::DomainType DomainType
typedef TIterator IteratorType
typedef SmartPointer< SelfPointer
typedef
ThreadedIteratorRangePartitioner 
Self
typedef
ThreadedDomainPartitioner
< ThreadedIteratorRangePartitionerDomain
< TIterator > > 
Superclass
- Public Types inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >
virtual ThreadIdType PartitionDomain (const ThreadIdType threadID, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subdomain) const =0
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()
- Protected Member Functions inherited from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >
 ThreadedDomainPartitioner ()
 ~ThreadedDomainPartitioner ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

void operator= (const Self &)
 ThreadedIteratorRangePartitioner (const Self &)
virtual ThreadIdType PartitionDomain (const ThreadIdType i, const ThreadIdType requestedTotal, const DomainType &completeDomain, DomainType &subdomain) const
 ThreadedIteratorRangePartitioner ()
virtual ~ThreadedIteratorRangePartitioner ()

Additional Inherited Members


Detailed Description

template<class TIterator>
class itk::ThreadedIteratorRangePartitioner< TIterator >

Partitions an iterator range for threading.

Template Parameters:
TIteratorThe type of the iterator.

The DomainType is defined to be a two component struct of interators: the first iterator, Begin, defines the start of the domain, and the second iterator, End, defines one element past the end of the domain.

The class assumes that iterating through the domain will be a repeatable process.

While this class will work for most containers that use iterators, indexed containers such as std::vector or Array will be partitioned more efficiently with a ThreadedIndexedContainerPartitioner.

See also:
ThreadedIndexedContainerPartitioner
ThreadedDomainPartitioner
IteratorRangeInterface

Definition at line 104 of file itkThreadedIteratorRangePartitioner.h.


Member Typedef Documentation

template<class TIterator >
typedef SmartPointer< const Self > itk::ThreadedIteratorRangePartitioner< TIterator >::ConstPointer
template<class TIterator >
typedef Superclass::DomainType itk::ThreadedIteratorRangePartitioner< TIterator >::DomainType

Type for convenience of base class methods

Reimplemented from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >.

Definition at line 118 of file itkThreadedIteratorRangePartitioner.h.

template<class TIterator >
typedef TIterator itk::ThreadedIteratorRangePartitioner< TIterator >::IteratorType

Definition at line 123 of file itkThreadedIteratorRangePartitioner.h.

template<class TIterator >
typedef SmartPointer< Self > itk::ThreadedIteratorRangePartitioner< TIterator >::Pointer
template<class TIterator >
typedef ThreadedIteratorRangePartitioner itk::ThreadedIteratorRangePartitioner< TIterator >::Self

Constructor & Destructor Documentation

template<class TIterator >
itk::ThreadedIteratorRangePartitioner< TIterator >::ThreadedIteratorRangePartitioner ( )
protected

Split the Domain into requestedTotal sub-domains, returning sub-domain i as subdomain. This method is called requestedTotal times. The pieces will not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedObject, i.e. return value is less than or equal to requestedTotal.

template<class TIterator >
virtual itk::ThreadedIteratorRangePartitioner< TIterator >::~ThreadedIteratorRangePartitioner ( )
protectedvirtual

Split the Domain into requestedTotal sub-domains, returning sub-domain i as subdomain. This method is called requestedTotal times. The pieces will not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedObject, i.e. return value is less than or equal to requestedTotal.

template<class TIterator >
itk::ThreadedIteratorRangePartitioner< TIterator >::ThreadedIteratorRangePartitioner ( const Self )
private

Member Function Documentation

template<class TIterator >
virtual::itk::LightObject::Pointer itk::ThreadedIteratorRangePartitioner< TIterator >::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.

template<class TIterator >
virtual const char* itk::ThreadedIteratorRangePartitioner< TIterator >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >.

template<class TIterator >
static Pointer itk::ThreadedIteratorRangePartitioner< TIterator >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TIterator >
void itk::ThreadedIteratorRangePartitioner< TIterator >::operator= ( const Self )
private

Mutex lock to protect modification to the reference count

Reimplemented from itk::ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > >.

template<class TIterator >
virtual ThreadIdType itk::ThreadedIteratorRangePartitioner< TIterator >::PartitionDomain ( const ThreadIdType  i,
const ThreadIdType  requestedTotal,
const DomainType completeDomain,
DomainType subdomain 
) const
virtual

Split the Domain into requestedTotal sub-domains, returning sub-domain i as subdomain. This method is called requestedTotal times. The pieces will not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedObject, i.e. return value is less than or equal to requestedTotal.


The documentation for this class was generated from the following file: