Skip to content

Commit

Permalink
Hide workspace definitions in docs for dense mocks/wrappers.
Browse files Browse the repository at this point in the history
  • Loading branch information
@LTLA
LTLA committed Apr 9, 2024
1 parent 91258fd commit a1624a9
Showing 1 changed file with 32 additions and 15 deletions.
47 changes: 32 additions & 15 deletions include/tatami_chunked/mock_dense_chunk.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace tatami_chunked {
*/
namespace MockDenseChunk_internal {

template<typename InflatedValue_>
using Workspace = std::vector<InflatedValue_>;

template<class Blob_>
struct Core {
Core() = default;
Expand All @@ -26,8 +29,6 @@ struct Core {

typedef typename Blob_::value_type value_type;

typedef std::vector<double> Workspace;

public:
template<bool accrow_>
auto get_primary_chunkdim() const {
Expand All @@ -49,7 +50,7 @@ struct Core {

public:
template<bool accrow_, typename Index_>
void extract(Index_ primary_start, Index_ primary_length, Index_ secondary_start, Index_ secondary_length, Workspace& work, value_type* output, size_t stride) const {
void extract(Index_ primary_start, Index_ primary_length, Index_ secondary_start, Index_ secondary_length, Workspace<value_type>& work, value_type* output, size_t stride) const {
chunk.inflate(work);
output += primary_start * stride;

Expand Down Expand Up @@ -80,7 +81,7 @@ struct Core {
}

template<bool accrow_, typename Index_>
void extract(Index_ primary_start, Index_ primary_length, const std::vector<Index_>& secondary_indices, Workspace& work, value_type* output, size_t stride) const {
void extract(Index_ primary_start, Index_ primary_length, const std::vector<Index_>& secondary_indices, Workspace<value_type>& work, value_type* output, size_t stride) const {
chunk.inflate(work);
output += primary_start * stride;

Expand Down Expand Up @@ -114,7 +115,7 @@ struct Core {

public:
template<bool accrow_, typename Index_>
void extract(const std::vector<Index_>& primary_indices, Index_ secondary_start, Index_ secondary_length, Workspace& work, value_type* output, size_t stride) const {
void extract(const std::vector<Index_>& primary_indices, Index_ secondary_start, Index_ secondary_length, Workspace<value_type>& work, value_type* output, size_t stride) const {
chunk.inflate(work);

if constexpr(Blob_::row_major == accrow_) {
Expand All @@ -140,7 +141,7 @@ struct Core {
}

template<bool accrow_, typename Index_>
void extract(const std::vector<Index_>& primary_indices, const std::vector<Index_>& secondary_indices, Workspace& work, value_type* output, size_t stride) const {
void extract(const std::vector<Index_>& primary_indices, const std::vector<Index_>& secondary_indices, Workspace<value_type>& work, value_type* output, size_t stride) const {
chunk.inflate(work);

if constexpr(Blob_::row_major == accrow_) {
Expand Down Expand Up @@ -222,7 +223,15 @@ struct MockSimpleDenseChunk {
* One instance of this workspace will be re-used in multiple `extract()` calls for the same or even different chunks.
* Implementations may use any data structure here.
*/
typedef std::vector<value_type> Workspace;
struct Workspace {
/**
* @cond
*/
MockDenseChunk_internal::Workspace<value_type> work;
/**
* @endcond
*/
};

/**
* Whether to extract a subset of elements on the primary dimension.
Expand Down Expand Up @@ -270,7 +279,7 @@ struct MockSimpleDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(Index_ secondary_start, Index_ secondary_length, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_, Index_>(0, core.template get_primary_chunkdim<accrow_>(), secondary_start, secondary_length, work, output, stride);
core.template extract<accrow_, Index_>(0, core.template get_primary_chunkdim<accrow_>(), secondary_start, secondary_length, work.work, output, stride);
}

/**
Expand All @@ -296,7 +305,7 @@ struct MockSimpleDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(const std::vector<Index_>& secondary_indices, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_, Index_>(0, core.template get_primary_chunkdim<accrow_>(), secondary_indices, work, output, stride);
core.template extract<accrow_, Index_>(0, core.template get_primary_chunkdim<accrow_>(), secondary_indices, work.work, output, stride);
}
};

Expand Down Expand Up @@ -326,7 +335,7 @@ struct SimpleDenseChunkWrapper {
*/
typedef typename Blob_::value_type value_type;

typedef std::vector<value_type> Workspace;
typedef MockDenseChunk_internal::Workspace<value_type> Workspace;

static constexpr bool use_subset = false;

Expand Down Expand Up @@ -381,7 +390,15 @@ struct MockSubsettedDenseChunk {
* One instance of this workspace will be re-used in multiple `extract()` calls for the same or even different chunks.
* Implementations may use any data structure here.
*/
typedef std::vector<value_type> Workspace;
struct Workspace {
/**
* @cond
*/
MockDenseChunk_internal::Workspace<value_type> work;
/**
* @endcond
*/
};

/**
* Whether to extract a subset of elements on the primary dimension.
Expand Down Expand Up @@ -432,7 +449,7 @@ struct MockSubsettedDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(Index_ primary_start, Index_ primary_length, Index_ secondary_start, Index_ secondary_length, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_>(primary_start, primary_length, secondary_start, secondary_length, work, output, stride);
core.template extract<accrow_>(primary_start, primary_length, secondary_start, secondary_length, work.work, output, stride);
}

/**
Expand Down Expand Up @@ -462,7 +479,7 @@ struct MockSubsettedDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(Index_ primary_start, Index_ primary_length, const std::vector<Index_>& secondary_indices, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_>(primary_start, primary_length, secondary_indices, work, output, stride);
core.template extract<accrow_>(primary_start, primary_length, secondary_indices, work.work, output, stride);
}

public:
Expand Down Expand Up @@ -493,7 +510,7 @@ struct MockSubsettedDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(const std::vector<Index_>& primary_indices, Index_ secondary_start, Index_ secondary_length, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_>(primary_indices, secondary_start, secondary_length, work, output, stride);
core.template extract<accrow_>(primary_indices, secondary_start, secondary_length, work.work, output, stride);
}

/**
Expand Down Expand Up @@ -521,7 +538,7 @@ struct MockSubsettedDenseChunk {
*/
template<bool accrow_, typename Index_>
void extract(const std::vector<Index_>& primary_indices, const std::vector<Index_>& secondary_indices, Workspace& work, value_type* output, size_t stride) const {
core.template extract<accrow_>(primary_indices, secondary_indices, work, output, stride);
core.template extract<accrow_>(primary_indices, secondary_indices, work.work, output, stride);
}
};

Expand Down

0 comments on commit a1624a9

Please sign in to comment.