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
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkThreadedIndexedContainerPartitioner_h
#define itkThreadedIndexedContainerPartitioner_h
#include "itkThreadedDomainPartitioner.h"
#include "itkObjectFactory.h"
#include "itkIndex.h"
namespace itk
{
/** \class ThreadedIndexedContainerPartitioner
* \brief Partitions an indexed container.
*
* The \c DomainType is defined to be a two element itk::Index of ElementIdentifiers:
* the first element defines the start of the domain, and the second element
* defines the end of the domain.
*
* Element counting starts from zero and the identifier at the end of the domain
* is inclusive.
*
* This class is typically used as a template argument to a DomainThreader.
*
* \sa ThreadedDomainPartitioner
* \sa DomainThreader
* \sa IndexedContainerInterface
* \ingroup ITKCommon
*/
class ITKCommon_EXPORT ThreadedIndexedContainerPartitioner : public ThreadedDomainPartitioner<Index<2>>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ThreadedIndexedContainerPartitioner);
/** Standard class type aliases. */
using Self = ThreadedIndexedContainerPartitioner;
using Superclass = ThreadedDomainPartitioner<Index<2>>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ThreadedIndexedContainerPartitioner);
/** Type for convenience of base class methods */
using DomainType = Superclass::DomainType;
/** Synonym for the domain that is more descriptive. */
using IndexRangeType = DomainType;
/** Split the index range \c completeIndexRange into up to \c requestedTotal
* non-overlapping subranges, setting subrange number \c threadId as
* \c subIndexRange and returning the total number of subranges actually available.
*
* This method should be called repeatedly for each value of \c threadId, from 0 up
* to the return value (which is always less than or equal to \c requestedTotal).
*
* It is an error for \c completeIndexRange to be zero-length (i.e. for
* completeIndexRange.End to be less than completeIndexRange.Begin).
* If \c threadId is greater than the return value, the contents of
* \c subIndexRange are undefined.
*/
ThreadIdType
PartitionDomain(const ThreadIdType threadId,
const ThreadIdType requestedTotal,
const DomainType & completeIndexRange,
DomainType & subIndexRange) const override;
protected:
ThreadedIndexedContainerPartitioner();
~ThreadedIndexedContainerPartitioner() override;
};
} // end namespace itk
#endif
|
