itkPoolMultiThreader.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkPoolMultiThreader_h
#define itkPoolMultiThreader_h

#include "itkMultiThreaderBase.h"
#include "itkThreadPool.h"

namespace itk
{
class ITKCommon_EXPORT PoolMultiThreader : public MultiThreaderBase
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(PoolMultiThreader);

  using Self = PoolMultiThreader;
  using Superclass = MultiThreaderBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro(PoolMultiThreader, MultiThreaderBase);


  void SingleMethodExecute() override;

  void SetSingleMethod(ThreadFunctionType, void *data) override;

  void
  ParallelizeArray(
    SizeValueType firstIndex,
    SizeValueType lastIndexPlus1,
    ArrayThreadingFunctorType aFunc,
    ProcessObject* filter ) override;

  void
  ParallelizeImageRegion(
    unsigned int dimension,
    const IndexValueType index[],
    const SizeValueType size[],
    ThreadingFunctorType funcP,
    ProcessObject* filter) override;

  void SetMaximumNumberOfThreads( ThreadIdType numberOfThreads ) override;

  struct ThreadPoolInfoStruct :WorkUnitInfo
    {
    std::future< ITK_THREAD_RETURN_TYPE > Future;
    };

protected:
  PoolMultiThreader();
  ~PoolMultiThreader() override;
  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  // Thread pool instance and factory
  ThreadPool::Pointer m_ThreadPool;

  ThreadPoolInfoStruct m_ThreadInfoArray[ITK_MAX_THREADS];

  friend class ProcessObject;
};

}  // end namespace itk
#endif