← Back to branch summary

~ubuntu-branches/ubuntu/trusty/its/trusty-proposed

« back to all changes in this revision

Viewing changes to man/itsArith.rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2004-04-28 09:55:41 UTC
  • Revision ID: james.westby@ubuntu.com-20040428095541-sc8014wgm27q1e4e
Tags: upstream-1.0.3
Import upstream version 1.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/itsArith.rd
 
1
\keyword{ts}
 
2
\keyword{arith}
 
3
\name{itsArith}
 
4
\alias{itsArith}
 
5
\alias{Arith,its,its-method}
 
6
\alias{+}
 
7
 
 
8
\title{Arithmetic Methods for Irregular Time-Series Objects}
 
9
\description{
 
10
  Arithmetic methods for objects of class \code{"its"}.
 
11
}
 
12
 
 
13
\usage{
 
14
     x + y
 
15
     x - y
 
16
     x * y
 
17
     x / y
 
18
     x ^ y
 
19
     x %% y
 
20
     x %/% y
 
21
}
 
22
 
 
23
\arguments{
 
24
  \item{x,y}{an object of class \code{"its"}}
 
25
}
 
26
\details{
 
27
 
 
28
The arithmetic operators return numeric vectors containing the result of the 
 
29
element-by-element operations.  The arguments must be conformable (same dimensions) 
 
30
and their time-stamps must match for each row.
 
31
 
 
32
Note that the matrix multiplication operator, %*%, is inherited from matrix,
 
33
and the result of a matrix multiplication is a matrix, not an \code{"its"}.
 
34
The resulting matrix can be converted back to its using the function its() 
 
35
- see examples.
 
36
}
 
37
 
 
38
\value{
 
39
 
 
40
The returned object is an object of class \code{"its"}, conformable with the
 
41
inputs, and with identical time-stamps.
 
42
 
 
43
}
 
44
\author{Giles Heywood}
 
45
 
 
46
\seealso{
 
47
  \code{\link{ts}},
 
48
  \code{\link{POSIXct}},
 
49
  \code{\link{itsFile}},
 
50
  \code{\link{itsLags}}
 
51
  \code{\link{itsJoin}}
 
52
  \code{\link{itsTimes}}
 
53
  \code{\link{itsSubset}}
 
54
  \code{\link{itsFin}}
 
55
  \code{\link{itsDisp}}
 
56
  \code{\link{itsInfo}}
 
57
  \code{\link{itsCumdif}}
 
58
  \code{\link{itsInterp}}  
 
59
}
 
60
 
 
61
\examples{
 
62
b <- newIts(1:30,ncol=3)
 
63
b+b-2*b
 
64
b/b
 
65
b\%*\%diag(ncol(b))
 
66
its(b\%*\%diag(ncol(b))) 
 
67
}