tatami_stats::LocalOutputBuffers< Output_, GetOutput_ > Class Template Reference

Local output buffers for running calculations. More...

#include <utils.hpp>

Public Member Functions
template<typename Number_ , typename Index_ >
	LocalOutputBuffers (int thread, Number_ number, Index_ start, Index_ length, GetOutput_ outfun, Output_ fill)
template<typename Number_ , typename Index_ >
	LocalOutputBuffers (int thread, Number_ number, Index_ start, Index_ length, GetOutput_ outfun)
	LocalOutputBuffers ()=default
std::size_t	size () const
Output_ *	data (std::size_t i)
const Output_ *	data (std::size_t i) const
void	transfer ()

Detailed Description

template<typename Output_, class GetOutput_>
class tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >

Local output buffers for running calculations.

Zero, one or more local output buffers to be created in each thread to avoid false sharing. This class is equivalent to a vector of LocalOutputBuffer instances, but is easier to initialize and more memory-efficient. In particular, no vector is created at all for the first thread, avoiding an unnecessary allocation in the serial case.

Template Parameters

Output_	Type of the result.
GetOutput_	Functor object that returns a pointer to the output buffer.

Constructor & Destructor Documentation

LocalOutputBuffers() [1/3]

template<typename Output_ , class GetOutput_ >

template<typename Number_ , typename Index_ >

tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::LocalOutputBuffers ( int thread, Number_ number, Index_ start, Index_ length, GetOutput_ outfun, Output_ fill )

inline

Template Parameters

Number_	Integer type of the number of buffers.
Index_	Integer type of the start index and length.

Parameters

thread	Identity of the thread, starting from zero to the total number of threads.
number	Number of output buffers.
start	Index of the first objective vector in the contiguous block for this thread.
length	Number of objective vectors in the contiguous block for this thread.
outfun	Function that accepts an std::size_t specifying the index of an output buffer in [0, number) and returns a Output_* pointer to that buffer.
fill	Initial value to fill the buffer.

LocalOutputBuffers() [2/3]

template<typename Output_ , class GetOutput_ >

template<typename Number_ , typename Index_ >

tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::LocalOutputBuffers ( int thread, Number_ number, Index_ start, Index_ length, GetOutput_ outfun )

inline

Overloaded constructor that sets the default fill = 0.

Template Parameters

Number_	Integer type of the number of buffers.
Index_	Integer type of the start index and length.

Parameters

thread	Identity of the thread, starting from zero to the total number of threads.
number	Number of output buffers.
start	Index of the first objective vector in the contiguous block for this thread.
length	Number of objective vectors in the contiguous block for this thread.
outfun	Function that accepts an Index_ specifying the index of an output buffer in [0, number) and returns a Output_* pointer to that buffer.

LocalOutputBuffers() [3/3]

template<typename Output_ , class GetOutput_ >

tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::LocalOutputBuffers ( )

default

Default constructor.

Member Function Documentation

size()

template<typename Output_ , class GetOutput_ >

std::size_t tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::size ( ) const

inline

Returns

Number of output buffers. This is the same as number in the constructor.

data() [1/2]

template<typename Output_ , class GetOutput_ >

Output_ * tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::data ( std::size_t i )

inline

Parameters

i	Index of the output buffer.

Returns

Pointer to the i-th output buffer to use in this thread. This contains at least length addressable elements (see the argument of the same name in the constructor). For thread = 0, this will be equal to outfun(i) + start.

data() [2/2]

template<typename Output_ , class GetOutput_ >

const Output_ * tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::data ( std::size_t i ) const

inline

Parameters

i	Index of the output buffer.

Returns

Const pointer to the i-th output buffer to use for this thread. This contains at least length addressable elements (see the argument of the same name in the constructor). For thread = 0, this will be equal to outfun(i) + start.

transfer()

template<typename Output_ , class GetOutput_ >

void tatami_stats::LocalOutputBuffers< Output_, GetOutput_ >::transfer ( )

inline

Transfer results from the local buffer to the global buffer (i.e., outfun(i) for i in [0, number) from the constructor). For thread = 0, this will be a no-op.

---

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

• tatami_stats/utils.hpp