DataNode.Rd 2.98 KB
Newer Older
1
2
3
4
5
6
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/node.R
\docType{class}
\name{DataNode}
\alias{DataNode}
\title{DataNode}
7
8
\format{
Object of \code{\link{R6Class}} with methods for constructing a DAG.
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
}
\value{
Object of \code{\link{DataNode}}
}
\description{
Represents a static data node in a DAG.
}
\details{
Derived from \link{Node}, please see base class documentation.
}
\section{Methods}{

\describe{
  \item{\code{getData()}}{returns the node's data.}
  }
}
25

26
27
\keyword{DAG}
\keyword{node}
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
\section{Super class}{
\code{\link[sourceR:Node]{sourceR::Node}} -> \code{DataNode}
}
\section{Public fields}{
\if{html}{\out{<div class="r6-fields">}}
\describe{
\item{\code{data}}{the data}
}
\if{html}{\out{</div>}}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-new}{\code{DataNode$new()}}
\item \href{#method-getData}{\code{DataNode$getData()}}
\item \href{#method-clone}{\code{DataNode$clone()}}
}
}
\if{html}{
\out{<details open ><summary>Inherited methods</summary>}
\itemize{
\item \out{<span class="pkg-link" data-pkg="sourceR" data-topic="Node" data-id="addChild">}\href{../../sourceR/html/Node.html#method-addChild}{\code{sourceR::Node$addChild()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="sourceR" data-topic="Node" data-id="addParent">}\href{../../sourceR/html/Node.html#method-addParent}{\code{sourceR::Node$addParent()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="sourceR" data-topic="Node" data-id="logDensity">}\href{../../sourceR/html/Node.html#method-logDensity}{\code{sourceR::Node$logDensity()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="sourceR" data-topic="Node" data-id="removeChild">}\href{../../sourceR/html/Node.html#method-removeChild}{\code{sourceR::Node$removeChild()}}\out{</span>}
\item \out{<span class="pkg-link" data-pkg="sourceR" data-topic="Node" data-id="removeParent">}\href{../../sourceR/html/Node.html#method-removeParent}{\code{sourceR::Node$removeParent()}}\out{</span>}
}
\out{</details>}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}}
\subsection{Method \code{new()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DataNode$new(data, name)}\if{html}{\out{</div>}}
}

}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-getData"></a>}}
\if{latex}{\out{\hypertarget{method-getData}{}}}
\subsection{Method \code{getData()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DataNode$getData()}\if{html}{\out{</div>}}
}

}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DataNode$clone(deep = FALSE)}\if{html}{\out{</div>}}
}

\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{deep}}{Whether to make a deep clone.}
}
\if{html}{\out{</div>}}
}
}
}