Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shifted aspects of the isometric helper contracts back to runtime. #99

Merged
merged 6 commits into from
May 20, 2024
Merged

Shifted aspects of the isometric helper contracts back to runtime. #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c2fc4c9
Shift some isometric operation contracts out of compile-time.
LTLA May 20, 2024
13401fd
Continue trying to streamline this thing.
LTLA May 20, 2024
d63441d
Made a little bit more progress.
LTLA May 20, 2024
9662f52
Small test fix.
LTLA May 20, 2024
0c57f70
Added the extra tests.
LTLA May 20, 2024
8961b86
Docfixes.
LTLA May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,7 +997,8 @@ RECURSIVE = YES
EXCLUDE = ../include/tatami/subset/utils.hpp \
../include/tatami/sparse/secondary_extraction.hpp \
../include/tatami/sparse/primary_extraction.hpp \
../include/tatami/isometric/binary/utils.hpp
../include/tatami/isometric/binary/utils.hpp \
../include/tatami/isometric/depends_utils.hpp

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down
91 changes: 33 additions & 58 deletions include/tatami/isometric/binary/DelayedBinaryIsometricOperation.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,14 @@
#include "../../utils/new_extractor.hpp"
#include "../../utils/copy.hpp"
#include "../../dense/SparsifiedWrapper.hpp"
#include "../depends_utils.hpp"

#include <memory>
#include <vector>
#include <type_traits>

/**
* @file DelayedBinaryIsometricOp.hpp
* @file DelayedBinaryIsometricOperation.hpp
*
* @brief Delayed binary isometric operations.
*/
Expand All @@ -23,31 +24,6 @@ namespace tatami {
*/
namespace DelayedBinaryIsometricOperation_internal {

template<class Operation_, bool oracle_, typename Index_>
class MaybeOracleDepends {
public:
MaybeOracleDepends(const MaybeOracle<oracle_, Index_>& oracle, bool row) {
if ((row && Operation_::zero_depends_on_row) || (!row && Operation_::zero_depends_on_column)) {
my_oracle = oracle;
}
}

Index_ get(Index_ i) {
if constexpr(oracle_) {
if constexpr(Operation_::zero_depends_on_row || Operation_::zero_depends_on_column) {
if (my_oracle) {
return my_oracle->get(my_used++);
}
}
}
return i;
}

private:
MaybeOracle<oracle_, Index_> my_oracle;
typename std::conditional<oracle_, size_t, bool>::type my_used = 0;
};

/********************
*** Dense simple ***
********************/
Expand All @@ -64,7 +40,7 @@ class DenseSimpleFull : public DenseExtractor<oracle_, Value_, Index_> {
const Options& opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row)
my_oracle(oracle, my_operation, row)
{
my_left_ext = new_extractor<false, oracle_>(left, my_row, oracle, opt);
my_right_ext = new_extractor<false, oracle_>(right, my_row, std::move(oracle), opt);
Expand All @@ -83,7 +59,7 @@ class DenseSimpleFull : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;

std::unique_ptr<DenseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
Index_ my_extent;
Expand All @@ -104,7 +80,7 @@ class DenseSimpleBlock : public DenseExtractor<oracle_, Value_, Index_> {
const Options& opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row),
my_oracle(oracle, my_operation, row),
my_block_start(block_start),
my_block_length(block_length)
{
Expand All @@ -124,7 +100,7 @@ class DenseSimpleBlock : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;

Index_ my_block_start, my_block_length;
std::unique_ptr<DenseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
Expand All @@ -144,7 +120,7 @@ class DenseSimpleIndex : public DenseExtractor<oracle_, Value_, Index_> {
const Options& opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row),
my_oracle(oracle, my_operation, row),
my_indices_ptr(std::move(indices_ptr))
{
my_left_ext = new_extractor<false, oracle_>(left, my_row, oracle, my_indices_ptr, opt);
Expand All @@ -163,7 +139,7 @@ class DenseSimpleIndex : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;

VectorPtr<Index_> my_indices_ptr;
std::unique_ptr<DenseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
Expand All @@ -186,7 +162,7 @@ class DenseExpandedFull : public DenseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(op),
my_row(row),
my_oracle(oracle, row)
my_oracle(oracle, my_operation, row)
{
opt.sparse_extract_value = true;
opt.sparse_extract_index = true;
Expand All @@ -210,9 +186,10 @@ class DenseExpandedFull : public DenseExtractor<oracle_, Value_, Index_> {
i = my_oracle.get(i);
auto num = my_operation.sparse(my_row, i, lres, rres, my_output_vbuffer.data(), my_output_ibuffer.data(), true, true);

// Avoid calling zero() if possible, as this might throw zero-related errors in non-IEEE platforms.
// Avoid calling my_operation.fill() if possible, as this might throw
// zero-related errors in non-IEEE platforms.
if (num < my_extent) {
std::fill_n(buffer, my_extent, my_operation.template fill<Value_>(i));
std::fill_n(buffer, my_extent, my_operation.template fill<Value_>(my_row, i));
}

for (Index_ j = 0; j < num; ++j) {
Expand All @@ -224,7 +201,7 @@ class DenseExpandedFull : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;

std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
Index_ my_extent;
Expand All @@ -246,7 +223,7 @@ class DenseExpandedBlock : public DenseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row),
my_oracle(oracle, my_operation, row),
my_block_start(block_start),
my_block_length(block_length)
{
Expand All @@ -271,9 +248,10 @@ class DenseExpandedBlock : public DenseExtractor<oracle_, Value_, Index_> {
i = my_oracle.get(i);
auto num = my_operation.sparse(my_row, i, lres, rres, my_output_vbuffer.data(), my_output_ibuffer.data(), true, true);

// Avoid calling zero() if possible, as this might throw zero-related errors in non-IEEE platforms.
// Avoid calling my_operation.fill() if possible, as this might throw
// zero-related errors in non-IEEE platforms.
if (num < my_block_length) {
std::fill_n(buffer, my_block_length, my_operation.template fill<Value_>(i));
std::fill_n(buffer, my_block_length, my_operation.template fill<Value_>(my_row, i));
}

for (Index_ j = 0; j < num; ++j) {
Expand All @@ -285,7 +263,7 @@ class DenseExpandedBlock : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;
Index_ my_block_start, my_block_length;

std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
Expand All @@ -306,7 +284,7 @@ class DenseExpandedIndex : public DenseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row),
my_oracle(oracle, my_operation, row),
my_extent(indices_ptr->size())
{
// Create a remapping vector to map the extracted indices back to the
Expand Down Expand Up @@ -342,9 +320,10 @@ class DenseExpandedIndex : public DenseExtractor<oracle_, Value_, Index_> {
i = my_oracle.get(i);
auto num = my_operation.sparse(my_row, i, lres, rres, my_output_vbuffer.data(), my_output_ibuffer.data(), true, true);

// Avoid calling zero() if possible, as this might throw zero-related errors in non-IEEE platforms.
// Avoid calling my_operation.fill() if possible, as this might throw
// zero-related errors in non-IEEE platforms.
if (num < my_extent) {
std::fill_n(buffer, my_extent, my_operation.template fill<Value_>(i));
std::fill_n(buffer, my_extent, my_operation.template fill<Value_>(my_row, i));
}

for (Index_ j = 0; j < num; ++j) {
Expand All @@ -356,7 +335,7 @@ class DenseExpandedIndex : public DenseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;
Index_ my_extent;

std::vector<Index_> my_remapping;
Expand All @@ -383,7 +362,7 @@ class Sparse : public SparseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row)
my_oracle(oracle, my_operation, row)
{
initialize(my_row ? left->ncol() : left->nrow(), opt);
my_left_ext = new_extractor<true, oracle_>(left, my_row, oracle, opt);
Expand All @@ -401,7 +380,7 @@ class Sparse : public SparseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row)
my_oracle(oracle, my_operation, row)
{
initialize(block_length, opt);
my_left_ext = new_extractor<true, oracle_>(left, my_row, oracle, block_start, block_length, opt);
Expand All @@ -418,7 +397,7 @@ class Sparse : public SparseExtractor<oracle_, Value_, Index_> {
Options opt) :
my_operation(operation),
my_row(row),
my_oracle(oracle, row)
my_oracle(oracle, my_operation, row)
{
initialize(indices_ptr->size(), opt); // do this before the move.
my_left_ext = new_extractor<true, oracle_>(left, my_row, oracle, indices_ptr, opt);
Expand Down Expand Up @@ -466,7 +445,7 @@ class Sparse : public SparseExtractor<oracle_, Value_, Index_> {
private:
const Operation_& my_operation;
bool my_row;
MaybeOracleDepends<Operation_, oracle_, Index_> my_oracle;
DelayedIsometricOperation_internal::MaybeOracleDepends<oracle_, Operation_, Index_> my_oracle;

std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > my_left_ext, my_right_ext;
std::vector<Value_> my_left_vbuffer, my_right_vbuffer;
Expand Down Expand Up @@ -513,7 +492,7 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {

my_prefer_rows_proportion = (my_left->prefer_rows_proportion() + my_right->prefer_rows_proportion()) / 2;

if constexpr(is_advanced) {
if constexpr(!Operation_::is_basic) {
if (my_operation.is_sparse()) {
my_is_sparse = my_left->is_sparse() && my_right->is_sparse();

Expand All @@ -531,8 +510,6 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {
double my_is_sparse_proportion = 0;
bool my_is_sparse = false;

static constexpr bool is_advanced = (!Operation_::zero_depends_on_row || !Operation_::zero_depends_on_column);

public:
Index_ nrow() const {
return my_left->nrow();
Expand Down Expand Up @@ -650,11 +627,9 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {

template<bool oracle_, typename ... Args_>
std::unique_ptr<DenseExtractor<oracle_, Value_, Index_> > dense_internal(bool row, Args_&& ... args) const {
if constexpr(is_advanced) {
if constexpr(!Operation_::is_basic) {
if (my_left->is_sparse() && my_right->is_sparse()) {
// If we don't depend on the rows, then we don't need row indices when 'row = false'.
// Similarly, if we don't depend on columns, then we don't column row indices when 'row = true'.
if ((!Operation_::zero_depends_on_row && !row) || (!Operation_::zero_depends_on_column && row)) {
if (DelayedIsometricOperation_internal::can_dense_expand(my_operation, row)) {
return dense_expanded_internal<oracle_>(row, std::forward<Args_>(args)...);
}
}
Expand Down Expand Up @@ -682,7 +657,7 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {
private:
template<bool oracle_>
std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > sparse_internal(bool row, MaybeOracle<oracle_, Index_> oracle, const Options& opt) const {
if constexpr(is_advanced) {
if constexpr(!Operation_::is_basic) {
if (my_is_sparse) {
return std::make_unique<DelayedBinaryIsometricOperation_internal::Sparse<oracle_, Value_, Index_, Operation_> >(
my_left.get(),
Expand All @@ -704,7 +679,7 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {

template<bool oracle_>
std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > sparse_internal(bool row, MaybeOracle<oracle_, Index_> oracle, Index_ block_start, Index_ block_length, const Options& opt) const {
if constexpr(is_advanced) {
if constexpr(!Operation_::is_basic) {
if (my_is_sparse) {
return std::make_unique<DelayedBinaryIsometricOperation_internal::Sparse<oracle_, Value_, Index_, Operation_> >(
my_left.get(),
Expand All @@ -729,7 +704,7 @@ class DelayedBinaryIsometricOperation : public Matrix<Value_, Index_> {

template<bool oracle_>
std::unique_ptr<SparseExtractor<oracle_, Value_, Index_> > sparse_internal(bool row, MaybeOracle<oracle_, Index_> oracle, VectorPtr<Index_> indices_ptr, const Options& opt) const {
if constexpr(is_advanced) {
if constexpr(!Operation_::is_basic) {
if (my_is_sparse) {
return std::make_unique<DelayedBinaryIsometricOperation_internal::Sparse<oracle_, Value_, Index_, Operation_> >(
my_left.get(),
Expand Down
6 changes: 2 additions & 4 deletions include/tatami/isometric/binary/arithmetic_helpers.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ class DelayedBinaryIsometricArithmetic {
op_ == ArithmeticOperation::SUBTRACT ||
op_ == ArithmeticOperation::MULTIPLY);

static constexpr bool zero_depends_on_row = false;

static constexpr bool zero_depends_on_column = false;
static constexpr bool is_basic = false;
/**
* @endcond
*/
Expand Down Expand Up @@ -72,7 +70,7 @@ class DelayedBinaryIsometricArithmetic {
}

template<typename Value_, typename Index_>
Value_ fill(Index_) const {
Value_ fill(bool, Index_) const {
if constexpr(known_sparse) {
return 0;
} else if constexpr(op_ == ArithmeticOperation::POWER) {
Expand Down
6 changes: 2 additions & 4 deletions include/tatami/isometric/binary/boolean_helpers.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ struct DelayedBinaryIsometricBoolean {
// It's sparse if f(0, 0) == 0.
static constexpr bool known_sparse = (op_ != BooleanOperation::EQUAL);

static constexpr bool zero_depends_on_row = false;

static constexpr bool zero_depends_on_column = false;
static constexpr bool is_basic = false;
/**
* @endcond
*/
Expand Down Expand Up @@ -69,7 +67,7 @@ struct DelayedBinaryIsometricBoolean {
}

template<typename Value_, typename Index_>
Value_ fill(Index_) const {
Value_ fill(bool, Index_) const {
if constexpr(known_sparse) {
return 0;
} else {
Expand Down
6 changes: 2 additions & 4 deletions include/tatami/isometric/binary/compare_helpers.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@ struct DelayedBinaryIsometricCompare {
op_ != CompareOperation::GREATER_THAN_OR_EQUAL &&
op_ != CompareOperation::LESS_THAN_OR_EQUAL);

static constexpr bool zero_depends_on_row = false;

static constexpr bool zero_depends_on_column = false;
static constexpr bool is_basic = false;
/**
* @endcond
*/
Expand Down Expand Up @@ -76,7 +74,7 @@ struct DelayedBinaryIsometricCompare {
}

template<typename Value_, typename Index_>
Value_ fill(Index_) const {
Value_ fill(bool, Index_) const {
if constexpr(known_sparse) {
return 0;
} else {
Expand Down
Loading
Loading