File: sum.Rd

package info (click to toggle)
r-cran-matlab 1.0.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 640 kB
  • sloc: sh: 13; makefile: 2
file content (40 lines) | stat: -rw-r--r-- 902 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
% $Id: sum.Rd 25 2022-05-30 18:46:01Z proebuck $

\name{sum}
\alias{sum}
\alias{sum,array,logical-method}
\alias{sum,array,missing-method}
\alias{sum,matrix,logical-method}
\alias{sum,matrix,missing-method}
\alias{sum,vector,logical-method}
\alias{sum,vector,missing-method}
\alias{sum,ANY,ANY-method}
\alias{sum,missing,ANY-method}
\title{MATLAB sum function}
\description{
  Provides sum of elements.
}
\usage{
sum(x, na.rm=FALSE)
}
\arguments{
  \item{x}{numeric or logical to be summed}
  \item{na.rm}{logical scalar. If \code{TRUE}, remove missing values}
}
\details{
  This is an S4 generic function.
}
\value{
  Return value depends on argument \code{x}. If vector, returns the same as
  \code{\link[base]{sum}}. If matrix, returns vector containing the sum of
  each column.
}
\author{
  P. Roebuck \email{proebuck1701@gmail.com}
}
\examples{
sum(1:9)
sum(matrix(1:9, 3, 3))
}
\keyword{arith}