itkThreadedDomainPartitioner.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkThreadedDomainPartitioner_h
#define itkThreadedDomainPartitioner_h
 
#include "itkIntTypes.h"
#include "itkMultiThreaderBase.h"
#include "itkObject.h"
 
namespace itk
{

template <typename TDomain>
class ITK_TEMPLATE_EXPORT ThreadedDomainPartitioner : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ThreadedDomainPartitioner);

  using Self = ThreadedDomainPartitioner;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ThreadedDomainPartitioner);

  using DomainType = TDomain;

  virtual ThreadIdType
  PartitionDomain(const ThreadIdType threadId,
                  const ThreadIdType requestedTotal,
                  const DomainType & completeDomain,
                  DomainType &       subDomain) const = 0;
 
protected:
  ThreadedDomainPartitioner() = default;
  ~ThreadedDomainPartitioner() override = default;
};
 
} // end namespace itk
 
#endif