paropt Class Reference

#include <parallel.h>

Public Types
enum	ParStrategy : short { ParStrategy::Default = 0, ParStrategy::TryTBB, ParStrategy::OIIOpool }
enum	SplitDir : short {   SplitDir::X, SplitDir::Y, SplitDir::Z, SplitDir::Biggest,   SplitDir::Tile }

Public Member Functions
constexpr	paropt (int maxthreads=0, SplitDir splitdir=SplitDir::Y, size_t minitems=1024) noexcept
	paropt (string_view name, int maxthreads=0, SplitDir splitdir=SplitDir::Y, size_t minitems=1024) noexcept
constexpr	paropt (ParStrategy strat) noexcept
constexpr	paropt (int maxthreads, ParStrategy strat) noexcept
	paropt (const parallel_options &po) noexcept
void	resolve ()
constexpr bool	singlethread () const noexcept
constexpr int	maxthreads () const noexcept
paropt &	maxthreads (int m) noexcept
constexpr SplitDir	splitdir () const noexcept
paropt &	splitdir (SplitDir s) noexcept
constexpr bool	recursive () const noexcept
paropt &	recursive (bool r) noexcept
constexpr int	minitems () const noexcept
paropt &	minitems (int m) noexcept
thread_pool *	pool () const noexcept
paropt &	pool (thread_pool *p) noexcept
constexpr ParStrategy	strategy () const noexcept
paropt &	strategy (ParStrategy s) noexcept

Detailed Description

Encapsulation of options that control parallel_for() and parallel_image().

Definition at line 79 of file parallel.h.

Member Enumeration Documentation

enum paropt::ParStrategy : short

strong

Enumerator
Default
TryTBB
OIIOpool

Definition at line 81 of file parallel.h.

enum paropt::SplitDir : short

strong

Enumerator
X
Y
Z
Biggest
Tile

Definition at line 82 of file parallel.h.

Constructor & Destructor Documentation

constexpr paropt::paropt ( int  maxthreads = 0, SplitDir  splitdir = SplitDir::Y, size_t  minitems = 1024  )

inlinenoexcept

Definition at line 84 of file parallel.h.

paropt::paropt ( string_view  name, int  maxthreads = 0, SplitDir  splitdir = SplitDir::Y, size_t  minitems = 1024  )

inlinenoexcept

Definition at line 91 of file parallel.h.

constexpr paropt::paropt ( ParStrategy  strat )

inlinenoexcept

Definition at line 98 of file parallel.h.

constexpr paropt::paropt ( int  maxthreads, ParStrategy  strat  )

inlinenoexcept

Definition at line 103 of file parallel.h.

paropt::paropt ( const parallel_options &  po )

inlinenoexcept

Definition at line 110 of file parallel.h.

Member Function Documentation

constexpr int paropt::maxthreads ( ) const

inlinenoexcept

Definition at line 126 of file parallel.h.

paropt& paropt::maxthreads ( int  m )

inlinenoexcept

Definition at line 127 of file parallel.h.

constexpr int paropt::minitems ( ) const

inlinenoexcept

Definition at line 147 of file parallel.h.

paropt& paropt::minitems ( int  m )

inlinenoexcept

Definition at line 148 of file parallel.h.

thread_pool* paropt::pool ( ) const

inlinenoexcept

Definition at line 154 of file parallel.h.

paropt& paropt::pool ( thread_pool *  p )

inlinenoexcept

Definition at line 155 of file parallel.h.

constexpr bool paropt::recursive ( ) const

inlinenoexcept

Definition at line 140 of file parallel.h.

paropt& paropt::recursive ( bool  r )

inlinenoexcept

Definition at line 141 of file parallel.h.

void paropt::resolve

(

)

constexpr bool paropt::singlethread ( ) const

inlinenoexcept

Definition at line 124 of file parallel.h.

constexpr SplitDir paropt::splitdir ( ) const

inlinenoexcept

Definition at line 133 of file parallel.h.

paropt& paropt::splitdir ( SplitDir  s )

inlinenoexcept

Definition at line 134 of file parallel.h.

constexpr ParStrategy paropt::strategy ( ) const

inlinenoexcept

Definition at line 161 of file parallel.h.

paropt& paropt::strategy ( ParStrategy  s )

inlinenoexcept

Definition at line 162 of file parallel.h.

---

The documentation for this class was generated from the following file:

• OpenImageIO/parallel.h