PageRenderTime 78ms CodeModel.GetById 37ms app.highlight 1ms RepoModel.GetById 39ms app.codeStats 0ms

/fingerprint/man/featvec.Rd

http://github.com/rajarshi/cdkr
Unknown | 54 lines | 51 code | 3 blank | 0 comment | 0 complexity | 79473fa713f0131f2a8eeaf07a92a5cb MD5 | raw file
 1\name{featvec-class}
 2\docType{class}
 3\alias{featvec-class}
 4\alias{distance,featvec,featvec,missing-method}
 5\alias{distance,featvec,featvec,character-method}
 6\alias{length,featvec-method}
 7
 8\title{Class "featvec"}
 9\description{This class represents feature vector style fingerprints, where, rather than
10a bit string, the fingerprint is represented as a sequence of (signed) integers or strings.
11Each element of the collection is a representation of a structural feature. For cases where the
12features are integers, this usually corresponds to a hash of the original feature string.
13}
14\section{Objects from the Class}{
15Objects can be created by calls of the form \code{new("featvec", ...)}.
16In contrast to traditional binary fingerprints, operations on feature vectors
17are slightly different and essentially correspond to operations on sets. Thus 
18the logical and (&) would correspond to the union of the two feature vectors.
19}
20\section{Slots}{
21	 \describe{
22    \item{\code{features}:}{Object of class \code{"character"} ~~ A vector
23      containing the numeric or character features. Numeric features are treated
24      as character strings }
25    \item{\code{provider}:}{Object of class \code{"character"} ~~
26      Indicates the source of the fingerprint. Can be useful to keep
27      track of what software generated the fingerprint.}
28    \item{\code{name}:}{Object of class \code{"character"} ~~
29      The name associated with the fingerprint. If not name is available
30    this gets set to an empty string}
31    \item{\code{misc}:}{A list to hold arbitrary items associated with a fingerprint (such as 
32     extra fields from a fingerprint file)}
33  }
34}
35\section{Methods}{
36  \describe{
37    \item{distance}{\code{signature(fp1 = "featvec", fp2 = "featvec", method = "missing")}: ... }
38    \item{distance}{\code{signature(fp1 = "featvec", fp2 = "featvec", method = "character")}: ... }
39    \item{as.character}{\code{signature(fp = "featvec")}: ... }
40    \item{length}{\code{signature(fp = "featvec")}: ... }
41    \item{show}{\code{signature(fp = "featvec")}: ... }
42}
43}
44\author{Rajarshi Guha \email{rajarshi.guha@gmail.com}}
45\seealso{
46  \code{\link{fp.read}}, \code{\link{fp.read.to.matrix}}
47  \code{\link{fp.sim.matrix}}, \code{\link{fp.to.matrix}},
48  \code{\link{fp.factor.matrix}}
49  \code{\link{random.fingerprint}}
50}
51
52 
53\keyword{classes}
54\keyword{logic}