MADNESS 0.10.1
madness::MacroTaskPartitioner Class Reference

partition one (two) vectors into 1D (2D) batches. More...

#include <macrotaskpartitioner.h>

Inheritance diagram for madness::MacroTaskPartitioner:

Public Types

typedef std::list< std::pair< Batch, double > > partitionT

Public Member Functions

 MacroTaskPartitioner ()
virtual ~MacroTaskPartitioner ()
virtual double compute_priority (const Batch &batch) const
 simple default priority function: size of the input batch
partitionT do_1d_partition (const std::size_t vsize, const std::string policy) const
partitionT do_2d_partition (const std::size_t vsize, const std::size_t v2size, const std::string policy) const
 outer product of 2 1d-partitionings – result batches correspond to first input batches
virtual partitionT do_partitioning (const std::size_t &vsize1, const std::size_t &vsize2, const std::string policy) const
 override this if you want your own partitioning
template<typename tupleT>
partitionT partition_tasks (const tupleT &argtuple) const
 this will be called by MacroTask, it will always partition first (and possibly second) vector of arguments
MacroTaskPartitioner & set_dimension (const std::size_t &n)
MacroTaskPartitioner & set_max_batch_size (const long &n)
MacroTaskPartitioner & set_min_batch_size (const long &n)
MacroTaskPartitioner & set_nsubworld (const long &n)
MacroTaskPartitioner & set_policy (const std::string &n)

Static Public Member Functions

template<typename argtupleT>
static void recompute_priorities (partitionT &partition, const argtupleT &argtuple, const std::function< double(const Batch &batch, const argtupleT &)> &predicate)
 the task can provide a priority function, otherwise the default is used

Public Attributes

std::size_t dimension = 1
 partition one or two vectors
std::size_t max_batch_size = 10
 maximum batch size (for memory management)
std::size_t min_batch_size =5
 minimum batch size
std::size_t nsubworld =1
 number of worlds (try to have enough batches for all worlds)
std::string policy = "guided"
 how to partition the batches

Friends

class Batch

Detailed Description

partition one (two) vectors into 1D (2D) batches.

derive from this class and override the \it{do_partitioning} method if you want to implement your custom partitioner

Member Typedef Documentation

◆ partitionT

typedef std::list<std::pair<Batch,double> > madness::MacroTaskPartitioner::partitionT

Constructor & Destructor Documentation

◆ MacroTaskPartitioner()

madness::MacroTaskPartitioner::MacroTaskPartitioner ( )
inline

◆ ~MacroTaskPartitioner()

virtual madness::MacroTaskPartitioner::~MacroTaskPartitioner ( )
inlinevirtual

Member Function Documentation

◆ compute_priority()

virtual double madness::MacroTaskPartitioner::compute_priority ( const Batch & batch) const
inlinevirtual

simple default priority function: size of the input batch

Reimplemented in madness::Exchange< T, NDIM >::ExchangeImpl< T, NDIM >::MacroTaskExchangeSimple::MacroTaskPartitionerExchange.

References Batch, and madness::Batch::size_of_input().

Referenced by do_1d_partition(), and do_2d_partition().

◆ do_1d_partition()

◆ do_2d_partition()

partitionT madness::MacroTaskPartitioner::do_2d_partition ( const std::size_t vsize,
const std::size_t v2size,
const std::string policy ) const
inline

outer product of 2 1d-partitionings – result batches correspond to first input batches

[begin1,end1) <– [begin1,end1) [begin2,end2)

References Batch, compute_priority(), do_1d_partition(), and policy.

Referenced by do_partitioning().

◆ do_partitioning()

virtual partitionT madness::MacroTaskPartitioner::do_partitioning ( const std::size_t & vsize1,
const std::size_t & vsize2,
const std::string policy ) const
inlinevirtual

◆ partition_tasks()

template<typename tupleT>
partitionT madness::MacroTaskPartitioner::partition_tasks ( const tupleT & argtuple) const
inline

this will be called by MacroTask, it will always partition first (and possibly second) vector of arguments

References dimension, do_partitioning(), madness::get_index_of_first_vector_argument(), madness::get_index_of_second_vector_argument(), MADNESS_EXCEPTION, madness::name(), and policy.

Referenced by test_partitioner().

◆ recompute_priorities()

template<typename argtupleT>
void madness::MacroTaskPartitioner::recompute_priorities ( partitionT & partition,
const argtupleT & argtuple,
const std::function< double(const Batch &batch, const argtupleT &)> & predicate )
inlinestatic

the task can provide a priority function, otherwise the default is used

signature: taskT::compute_priority(const Batch&, const argtupleT&) const -> double

References Batch, and p().

Referenced by madness::MacroTask< taskT >::operator()().

◆ set_dimension()

MacroTaskPartitioner & madness::MacroTaskPartitioner::set_dimension ( const std::size_t & n)
inline

◆ set_max_batch_size()

MacroTaskPartitioner & madness::MacroTaskPartitioner::set_max_batch_size ( const long & n)
inline

◆ set_min_batch_size()

MacroTaskPartitioner & madness::MacroTaskPartitioner::set_min_batch_size ( const long & n)
inline

◆ set_nsubworld()

MacroTaskPartitioner & madness::MacroTaskPartitioner::set_nsubworld ( const long & n)
inline

References MacroTaskPartitioner(), and nsubworld.

Referenced by test_partitioner().

◆ set_policy()

MacroTaskPartitioner & madness::MacroTaskPartitioner::set_policy ( const std::string & n)
inline

References MacroTaskPartitioner(), and policy.

◆ Batch

Member Data Documentation

◆ dimension

std::size_t madness::MacroTaskPartitioner::dimension = 1

◆ max_batch_size

◆ min_batch_size

std::size_t madness::MacroTaskPartitioner::min_batch_size =5

◆ nsubworld

std::size_t madness::MacroTaskPartitioner::nsubworld =1

◆ policy


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