tatami
C++ API for different matrix representations
|
Delayed special value substitution. More...
#include <substitute_helpers.hpp>
Public Member Functions | |
DelayedUnaryIsometricSpecialSubstituteHelper (OutputValue_ substitute) | |
std::optional< Index_ > | nrow () const |
std::optional< Index_ > | ncol () const |
bool | zero_depends_on_row () const |
bool | zero_depends_on_column () const |
bool | non_zero_depends_on_row () const |
bool | non_zero_depends_on_column () const |
void | dense (bool, Index_, Index_, Index_ length, const InputValue_ *input, OutputValue_ *output) const |
void | dense (bool, Index_, const std::vector< Index_ > &indices, const InputValue_ *input, OutputValue_ *output) const |
bool | is_sparse () const |
void | sparse (bool, Index_, Index_ number, const InputValue_ *input_value, const Index_ *, OutputValue_ *output_value) const |
OutputValue_ | fill (bool, Index_) const |
![]() |
Delayed special value substitution.
This class checks whether each element of a Matrix
is an IEEE special value, and if so, replaces it with another scalar value. It should be used as the Operation_
in the DelayedUnaryIsometricOperation
class, and only when InputValue_ == OutputValue_
.
op_ | The special comparison operation. |
pass_ | Whether to perform the substitution if the special comparison is true. Otherwise the substitution is only performed if the comparison is false. |
OutputValue_ | Type of the result of the operation. |
InputValue_ | Type of the matrix value used in the operation. |
Index_ | Integer type for the row/column indices. |
|
inline |
substitute | Scalar to substitute into the matrix for every element where the special comparison is true (if pass_ = true ) or false (otherwise). |
|
inlinevirtual |
DelayedUnaryIsometricOperation
constructor). If no value is returned, the matrix may have any number of rows. Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
DelayedUnaryIsometricOperation
constructor). If no value is returned, the matrix may have any number of columns. Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
This method is only called when is_sparse()
returns false. It is not necessary to explicitly return false
here for sparsity-preserving operations, as DelayedUnaryIsometricOperation
will automatically recognize such operations as being row-independent.
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
This method is only called when is_sparse()
returns false. It is not necessary to explicitly return false
here for sparsity-preserving operations, as DelayedUnaryIsometricOperation
will automatically recognize such operations as being row-independent.
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
This method accepts a contiguous block of an element of the target dimension from the underlying matrix (input
), applies the operation to each value, and stores the result in another array of different type (output
).
row | Whether the rows are the target dimension. If true, buffer contains row i , otherwise it contains column i . | |
i | Index of the extracted row (if row = true ) or column (otherwise). This argument should be ignored if the operation does not depend on the row/column (i.e., when all of zero_depends_on_row() and friends return false), in which case an arbitrary placeholder may be supplied. | |
start | Start of the contiguous block of columns (if row = true ) or rows (otherwise) extracted from i . | |
length | Length of the contiguous block. | |
[in] | input | Pointer to an array containing a contiguous block of a row/column extracted from the matrix. This has length addressable elements. |
[out] | output | Pointer to an array to store the results of the operation applied to elements of input . This has length addressable elements. If InputValue_ == OutputValue_ , this is guaranteed to be the same as input . |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
This method accepts an indexed subset of an element of the target dimension from the underlying matrix (input
), applies the operation to each value, and stores the result in another array of different type (output
).
row | Whether the rows are the target dimension. If true, buffer contains row i , otherwise it contains column i . | |
i | Index of the extracted row (if row = true ) or column (otherwise). This argument should be ignored if the operation does not depend on the row/column (i.e., when all of zero_depends_on_row() and friends return false), in which case an arbitrary placeholder may be supplied. | |
indices | Sorted and unique indices of columns (if row = true ) or rows (otherwise) extracted from i . | |
[in] | input | Pointer to an array containing an indexed subset of a row/column extracted from the matrix. This has length addressable elements. |
[out] | output | Pointer to an array to store the results of the operation applied to elements of input . This has length addressable elements. If InputValue_ == OutputValue_ , this is guaranteed to be the same as input . |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
This method is expected to iterate over input_value
, apply the operation to each value, and store the result in output_value
. We assume that the operation only needs to be applied to the structural non-zeros; structural zeros are either ignored for sparsity-preserving operations, or the result of the operation on zeros will be populated by fill()
.
If non_zero_depends_on_row() && !row
or non_zero_depends_on_column() && row
, index
is guaranteed to be non-NULL. Otherwise, it may be NULL and should be ignored. Even if non-NULL, indices are not guaranteed to be sorted.
Implementations of this method do not necessarily need to have the same template arguments as shown here. It will be called without any explicit template arguments so anything can be used as long as type deduction works.
row | Whether the rows are the target dimension. If true, buffer contains row i , otherwise it contains column i . | |
i | Index of the extracted row (if row = true ) or column (otherwise). This argument should be ignored if the operation does not depend on the row/column (i.e., when all of zero_depends_on_row() and friends return false), in which case an arbitrary placeholder may be supplied. | |
num | Number of non-zero elements for row/column i . | |
[in] | input_value | Pointer to an array of values of the structural non-zero elements from the row/column of the matrix. This is guaranteed to have num addressable elements. |
[in] | index | Pointer to an array of column (if row = true ) or row indices (otherwise) of the non-zero elements. Alternatively NULL. |
[out] | output_value | Pointer to an array in which to store the result of the operation on each element of input_value . This is guaranteed to have num addressable elements. If InputValue_ == OutputValue_ , this is guaranteed to be the same as input . |
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.
|
inlinevirtual |
row | Whether i refers to the row or column index. |
i | The index of the row (if row = true ) or column (otherwise) containing the zeros. This argument should be ignored if the operation does not depend on the row/column, i.e., when all of zero_depends_on_row() and friends return false. |
i
-th row/column of the matrix.This function will never be called by DelayedUnaryIsometricOperation
if the operation depends on the dimension that is not specified by row
, i.e., when row = true && zero_depends_on_column()
or row = false && zero_depends_on_row()
. In such cases, no single fill value would exist.
Implements tatami::DelayedUnaryIsometricOperationHelper< OutputValue_, InputValue_, Index_ >.