rkeops (version 2.2.2)

sum.LazyTensor: Sum operation or sum reduction

Description

Sum operation or sum reduction for LazyTensor objects.

Usage

# S3 method for LazyTensor
sum(x, index = NA, ...)
sum_reduction(x, index)

Value

a LazyTensor if index = NA or an array storing the result of the specified sum reduction otherwise.

Arguments

x

a LazyTensor or a ComplexLazyTensor.

index

a character corresponding to the wanted reduction dimension, either "i" or "j", to specify whether if the reduction is done along the index i or j. It can be NA (default) when no reduction is desired.

...

not used, only present for method compatibility with the corresponding generic function.

Author

Chloe Serre-Combe, Amelie Vernay

Details

If x is a LazyTensor, sum(x, index) will :

• if index = "i", return the sum reduction of x over the i index.

• if index = "j", return the sum reduction of x over the j index.

• if index = NA (default), return a new LazyTensor object representing the symbolic sum of the values along the inner dimension of x.

Note: Run browseVignettes("rkeops") to access the vignettes and find details about this function in the "RKeOps LazyTensor" vignette, at section "Reductions".

Note: index input argument cannot be NA for the sum_reduction() function.

See Also

sum_reduction()

Examples

if (FALSE) {
x <- matrix(runif(150 * 3), 150, 3) # arbitrary R matrix, 150 rows, 3 columns
x_i <- LazyTensor(x, index = 'i')   # creating LazyTensor from matrix x, 
                                    # indexed by 'i'

sum_x <- sum(x_i)                   # LazyTensor object
sum_red_x <- sum(x_i, "i")          # sum reduction indexed by 'i'
}

if (FALSE) {
x <- matrix(runif(150 * 3), 150, 3) # arbitrary R matrix, 150 rows, 3 columns
x_i <- LazyTensor(x, index = 'i')   # creating LazyTensor from matrix x, 
                                    # indexed by 'i'

sum_reduction(x_i, "i")
}