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
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% 050.Object.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{equals.Object}
\alias{equals.Object}
\alias{Object.equals}
\alias{equals,Object-method}
\title{Compares an object with another}
\description{
Compares an object with another and returns \code{\link[base:logical]{TRUE}} if they are equal.
The equal property must be
1) \emph{reflexive}, i.e. \code{equals(o1,o1)} should be \code{\link[base:logical]{TRUE}}.
2) \emph{symmetric}, i.e. \code{equals(o1,o2)} is \code{\link[base:logical]{TRUE}} if and only
if \code{equals(o2,o1)} is \code{\link[base:logical]{TRUE}}.
3) \emph{transitive}, i.e. \code{equals(o1,o2)} is \code{\link[base:logical]{TRUE}} and
\code{equals(o2,o3)} is \code{\link[base:logical]{TRUE}}, then \code{equals(o1,o3)} should
be \code{\link[base:logical]{TRUE}}.
5) \emph{consistent}, i.e. \code{equals(o1,o2)} should return the same
result on multiple invocations as long as nothing has changed.
6) \code{equals(o1,}\code{\link[base]{NULL}}\code{)} should return \code{\link[base:logical]{FALSE}}, unless
\code{o1} is also \code{\link[base]{NULL}}.
By default, the method returns \code{\link[base:logical]{TRUE}} if and only if the two
references compared refer to the same \code{\link[R.oo]{Object}}, i.e.
\code{( !is.null(obj) && (hashCode(this) == hashCode(obj)) )}.
}
\usage{
\method{equals}{Object}(this, other, ...)
}
\arguments{
\item{other}{The other object this \code{\link[R.oo]{Object}} should be compared to.}
\item{...}{Not used.}
}
\value{
Returns \code{\link[base:logical]{TRUE}} if the Object's are equal, otherwise \code{\link[base:logical]{FALSE}}.
}
\examples{
o1 <- Object()
o2 <- clone(o1)
equals(o1, o1) # TRUE
equals(o1, o2) # FALSE
}
\seealso{
\code{\link[R.oo:hashCode.Object]{*hashCode}()}.
For more information see \code{\link{Object}}.
}
\author{Henrik Bengtsson}
\keyword{programming}
\keyword{methods}
\keyword{internal}
\keyword{methods}
|
