File: methods-mathOps.Rd

package info (click to toggle)
r-cran-timedate 3012.100-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 2,592 kB
  • ctags: 4
  • sloc: makefile: 13
file content (94 lines) | stat: -rw-r--r-- 2,218 bytes parent folder | download | duplicates (5)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
\name{timeDateMathOps}


\alias{timeDateMathOps}


\alias{Ops,timeDate,timeDate-method}
\alias{+,timeDate,timeDate-method}
\alias{+,timeDate,numeric-method}
\alias{-,timeDate,timeDate-method}
\alias{-,timeDate,numeric-method}
\alias{-,numeric,timeDate-method}
\alias{+,numeric,timeDate-method}

\title{timeDate Mathematical Operations}


\description{
    
    Functions for mathematical and logical operations on 'timeDate'
    objects.
    \cr
     
    The functions are:
    
    \tabular{ll}{
    \code{Ops,timeDate} \tab Group 'Ops' generic functions for 'timeDate' objects, \cr
    \code{+,timeDate} \tab Performs arithmetic + operation on 'timeDate' objects, \cr
    \code{-,timeDate} \tab Performs arithmetic - operation on 'timeDate' objects. }
       
}


\usage{
\S4method{Ops}{timeDate,timeDate}(e1, e2)

% \S4method{+}{timeDate,timeDate}(e1, e2)
% \S4method{+}{timeDate,numeric}(e1, e2)
% \S4method{-}{timeDate,timeDate}(e1, e2)
% \S4method{-}{timeDate,numeric}(e1, e2)    

}


\arguments{
 
   \item{e1, e2}{
       usually objects of class \code{timeDate}, in the case of
       addition and subtraction \code{e2} may be of class
       \code{numeric}.
       }    
      
}


\value{
    
    \code{Ops.timeDate}
    \cr
    these are functions for mathematical operations. Group \code{Ops} are 
    generic functions which manage mathematical operations. 
    
    \code{+.timeDate}\cr
    \code{-.timeDate}
    \cr
    The plus operator \code{"+"} performs arithmetic "+" operation on 
    \code{timeDate} objects, and the minus operator \code{"-"} returns a 
    \code{difftime} object if both arguments \code{e1} and \code{e2} 
    are \code{"timeDate"} objects, or returns a \code{"timeDate"} object 
    \code{e2} seconds earlier than \code{e1}.

}


\examples{
## Create Character Vectors:
   dts = c("1989-09-28", "2001-01-15", "2004-08-30", "1990-02-09")
   dts
   tms = c(  "23:12:55",   "10:34:02",   "08:30:00",   "11:18:23")
   tms
   
## "+/-" - 
   # Add One Day to a Given timeDate Object:
   GMT = timeDate(dts, zone = "GMT", FinCenter = "GMT")
   GMT
   ZUR = timeDate(dts, zone = "GMT", FinCenter = "Europe/Zurich")
   ZUR
   GMT + 24*3600
   ZUR[2] - ZUR[1] 
}


\keyword{chron}