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 Self >	ConstPointer
typedef Superclass::DomainType	DomainType
typedef TIterator	IteratorType
typedef SmartPointer< Self >	Pointer
typedef ThreadedIteratorRangePartitioner	Self
typedef ThreadedDomainPartitioner < ThreadedIteratorRangePartitionerDomain < TIterator > >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Static Public Member Functions
static Pointer	New ()
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 ()

---

Detailed Description

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

Partitions an iterator range for threading.

Template Parameters:

TIterator

The 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

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

Definition at line 112 of file itkThreadedIteratorRangePartitioner.h.

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

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

Definition at line 111 of file itkThreadedIteratorRangePartitioner.h.

template<class TIterator >

typedef ThreadedIteratorRangePartitioner itk::ThreadedIteratorRangePartitioner< TIterator >::Self

Standard class typedefs.

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

Definition at line 109 of file itkThreadedIteratorRangePartitioner.h.

template<class TIterator >

typedef ThreadedDomainPartitioner< ThreadedIteratorRangePartitionerDomain< TIterator > > itk::ThreadedIteratorRangePartitioner< TIterator >::Superclass

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

Definition at line 110 of file itkThreadedIteratorRangePartitioner.h.

---

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

(

)

[protected, 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.

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:

• itkThreadedIteratorRangePartitioner.h