PCL
ParallelProcess.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ParallelProcess.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ParallelProcess_h
53 #define __PCL_ParallelProcess_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Utility.h>
59 
60 namespace pcl
61 {
62 
63 // ----------------------------------------------------------------------------
64 
72 class PCL_CLASS ParallelProcess
73 {
74 public:
75 
82  ParallelProcess() = default;
83 
87  ParallelProcess( const ParallelProcess& ) = default;
88 
92  virtual ~ParallelProcess()
93  {
94  }
95 
99  ParallelProcess& operator =( const ParallelProcess& ) = default;
100 
105  bool IsParallelProcessingEnabled() const noexcept
106  {
107  return m_parallel;
108  }
109 
120  void EnableParallelProcessing( bool enable = true, int maxProcessors = 0 ) noexcept
121  {
122  m_parallel = enable;
123  if ( m_parallel )
124  if ( maxProcessors > 0 )
125  SetMaxProcessors( maxProcessors );
126  }
127 
135  void DisableParallelProcessing( bool disable = true ) noexcept
136  {
137  EnableParallelProcessing( !disable );
138  }
139 
149  int MaxProcessors() const noexcept
150  {
151  return m_maxProcessors;
152  }
153 
170  void SetMaxProcessors( int maxProcessors ) noexcept
171  {
172  if ( maxProcessors > 0 )
173  m_maxProcessors = Min( maxProcessors, PCL_MAX_PROCESSORS );
174  }
175 
179  void Swap( ParallelProcess& process ) noexcept
180  {
181  pcl::Swap( m_maxProcessors, process.m_maxProcessors );
182  pcl::Swap( m_parallel, process.m_parallel );
183  }
184 
185 protected:
186 
187  int m_maxProcessors = PCL_MAX_PROCESSORS; // maximum number of processors allowed
188  bool m_parallel = true; // use multiple threads?
189 };
190 
191 // ----------------------------------------------------------------------------
192 
193 } // pcl
194 
195 #endif // __PCL_ParallelProcess_h
196 
197 // ----------------------------------------------------------------------------
198 // EOF pcl/ParallelProcess.h - Released 2024-06-18T15:48:54Z
A process using multiple concurrent execution threads.
void SetMaxProcessors(int maxProcessors) noexcept
bool IsParallelProcessingEnabled() const noexcept
ParallelProcess()=default
ParallelProcess(const ParallelProcess &)=default
void Swap(ParallelProcess &process) noexcept
void DisableParallelProcessing(bool disable=true) noexcept
int MaxProcessors() const noexcept
void EnableParallelProcessing(bool enable=true, int maxProcessors=0) noexcept
void Swap(GenericPoint< T > &p1, GenericPoint< T > &p2) noexcept
Definition: Point.h:1459
constexpr const T & Min(const T &a, const T &b) noexcept
Definition: Utility.h:90
PCL root namespace.
Definition: AbstractImage.h:77