Navigation

Operators and Keywords

Function List:

• » Octave core
• » by package
• » alphabetical

C++ API

: sum (x)

: sum (x, dim)

: sum (…, "native")

: sum (…, "double")

: sum (…, "extra")

Sum of elements along dimension dim.

If dim is omitted, it defaults to the first non-singleton dimension.

The optional "type" input determines the class of the variable used for calculations. If the argument "native" is given, then the operation is performed in the same type as the original argument, rather than the default double type.

For example:

sum ([true, true])
  ⇒ 2
sum ([true, true], "native")
  ⇒ true

On the contrary, if "double" is given, the sum is performed in double precision even for single precision inputs.

For double precision inputs, the "extra" option will use a more accurate algorithm than straightforward summation. For single precision inputs, "extra" is the same as "double". Otherwise, "extra" has no effect.

See also: cumsum, sumsq, prod.

Package: octave