Sum of Entries

The sum of entries in a vector or matrix.

sum_entries(expr, axis = NA_real_, keepdims = FALSE)

# S3 method for class 'Expression'
sum(..., na.rm = FALSE)

Arguments

expr

An Expression, vector, or matrix.

axis

(Optional) The dimension across which to apply the function: 1 indicates rows, 2 indicates columns, and NA indicates rows and columns. The default is NA.

keepdims

(Optional) Should dimensions be maintained when applying the atom along an axis? If FALSE, result will be collapsed into an \(n x 1\) column vector. The default is FALSE.

...

Numeric scalar, vector, matrix, or Expression objects.

na.rm

(Unimplemented) A logical value indicating whether missing values should be removed.

Value

An Expression representing the sum of the entries of the input.

Examples

x <- Variable(2)
prob <- Problem(Minimize(sum_entries(x)), list(t(x) >= matrix(c(1,2), nrow = 1, ncol = 2)))
result <- solve(prob)
result$value
#> [1] 3
result$getValue(x)
#>      [,1]
#> [1,]    1
#> [2,]    2

C <- Variable(3,2)
prob <- Problem(Maximize(sum_entries(C)), list(C[2:3,] <= 2, C[1,] == 1))
result <- solve(prob)
result$value
#> [1] 10
result$getValue(C)
#>      [,1] [,2]
#> [1,]    1    1
#> [2,]    2    2
#> [3,]    2    2
x <- Variable(2)
prob <- Problem(Minimize(sum_entries(x)), list(t(x) >= matrix(c(1,2), nrow = 1, ncol = 2)))
result <- solve(prob)
result$value
#> [1] 3
result$getValue(x)
#>      [,1]
#> [1,]    1
#> [2,]    2

C <- Variable(3,2)
prob <- Problem(Maximize(sum_entries(C)), list(C[2:3,] <= 2, C[1,] == 1))
result <- solve(prob)
result$value
#> [1] 10
result$getValue(C)
#>      [,1] [,2]
#> [1,]    1    1
#> [2,]    2    2
#> [3,]    2    2