[Yuima-commits] r40 - in pkg/yuima: R man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Wed Dec 9 05:36:48 CET 2009
Author: iacus
Date: 2009-12-09 05:36:48 +0100 (Wed, 09 Dec 2009)
New Revision: 40
Modified:
pkg/yuima/R/AllClasses.R
pkg/yuima/R/yuima.sampling.R
pkg/yuima/man/setSampling.Rd
pkg/yuima/man/yuima.sampling-class.Rd
Log:
updated docs and added slot scale in yuima.sampling. Passes make check
Modified: pkg/yuima/R/AllClasses.R
===================================================================
--- pkg/yuima/R/AllClasses.R 2009-12-09 04:07:30 UTC (rev 39)
+++ pkg/yuima/R/AllClasses.R 2009-12-09 04:36:48 UTC (rev 40)
@@ -57,6 +57,7 @@
delta = "numeric",
grid = "numeric",
random = "ANY",
+ scale = "ANY",
regular = "logical"
)
)
Modified: pkg/yuima/R/yuima.sampling.R
===================================================================
--- pkg/yuima/R/yuima.sampling.R 2009-12-09 04:07:30 UTC (rev 39)
+++ pkg/yuima/R/yuima.sampling.R 2009-12-09 04:36:48 UTC (rev 40)
@@ -5,8 +5,9 @@
setMethod("initialize", "yuima.sampling",
- function(.Object, Initial, Terminal, division, delta, grid, random, regular){
-
+ function(.Object, Initial, Terminal, division, delta, grid, random,
+ scale, regular){
+ .Object at scale <- 1
if(length(grid)>0){
testInitial<-(min(grid)==Initial)
@@ -74,8 +75,11 @@
return(.Object)
})
-setSampling <- function(Initial=0, Terminal=1, division=100, delta=0.1, grid=as.numeric(NULL), random=FALSE){
- return(new("yuima.sampling", Initial=Initial, Terminal=Terminal, division=division, delta=delta, grid=grid, random=random, regular=TRUE))
+setSampling <- function(Initial=0, Terminal=1, division=100, delta=0.1,
+ grid=as.numeric(NULL), random=FALSE, scale=1){
+ return(new("yuima.sampling", Initial=Initial, Terminal=Terminal,
+ division=division, delta=delta, grid=grid, random=random,
+ scale=scale, regular=TRUE))
}
# accessors
Modified: pkg/yuima/man/setSampling.Rd
===================================================================
--- pkg/yuima/man/setSampling.Rd 2009-12-09 04:07:30 UTC (rev 39)
+++ pkg/yuima/man/setSampling.Rd 2009-12-09 04:36:48 UTC (rev 40)
@@ -5,29 +5,43 @@
Set sampling information and create a `sampling' object.
}
\description{
- \code{setSampling} is a constructor for \code{sampling} class.
+ \code{setSampling} is a constructor for \code{\link{yuima.sampling-class}}.
}
\usage{
- setSampling(Initial = 0, Terminal = 1, division = 100, delta =
- 0.1, grid = as.numeric(NULL), random = FALSE)
+ setSampling(Initial = 0, Terminal = 1, division = 100, delta = 0.1,
+ grid = as.numeric(NULL), random = FALSE, scale=1)
}
\arguments{
- \item{Initial}{Initial}
- \item{Terminal}{Terminal}
- \item{division}{division}
- \item{delta}{mesh size in case of regular grid}
- \item{grid}{a grid of times for the simulation, possibly empty}
- \item{random}{specify if it is random sampling}
+ \item{Initial}{Initial time of the grid.}
+ \item{Terminal}{Terminal time of the grid.}
+ \item{division}{division into this number of intervals.}
+ \item{delta}{mesh size in case of regular grid.}
+ \item{grid}{a grid of times for the simulation, possibly empty.}
+ \item{random}{specify if it is random sampling. See Details.}
+ \item{scale}{by default 1. NOT YET IN USE.}
}
\details{
- class \code{sampling} has two slots,
- \code{Terminal} is a hoge of \code{sampling}, and
- \code{division} is a hoge of \code{sampling}
+The function creates an object of type
+ \code{\link{yuima.sampling-class}} with several slots.
+\describe{
+ \item{\code{Initial}:}{initial time of the grid.}
+ \item{\code{Terminal}:}{terminal time fo the grid.}
+ \item{\code{division}:}{the number of observations - 1.}
+ \item{\code{delta}:}{in case of a regular grid is the mesh.}
+ \item{\code{grid}:}{the grid of times.}
+ \item{\code{random}:}{either \code{FALSE} or the distribution
+ of the random times.}
+ \item{\code{scale}:}{by default 1. NOT YET IN USE.}
+ \item{\code{regular}:}{indicator of whether the grid is regular or not.
+ For internal use only.}
}
+}
\value{
- An object of class \code{sampling}.
+ An object of type \code{\link{yuima.sampling-class}}.
}
\author{The YUIMA Project Team}
-% Add one or more standard keywords, see file 'KEYWORDS' in the
-% R documentation directory.
+\examples{
+samp <- setSampling(Terminal=1, division=1000)
+str(samp)
+}
\keyword{ts}
Modified: pkg/yuima/man/yuima.sampling-class.Rd
===================================================================
--- pkg/yuima/man/yuima.sampling-class.Rd 2009-12-09 04:07:30 UTC (rev 39)
+++ pkg/yuima/man/yuima.sampling-class.Rd 2009-12-09 04:36:48 UTC (rev 40)
@@ -8,14 +8,21 @@
}
\section{Slots}{
\describe{
- \item{Initial}{Initial time of the data and/or model.}
- \item{Terminal}{Horizon of the stochastic processes.}
- \item{division}{Time division for the data and/or model.}
- \item{grid}{a grid of time points on which data are simulated.}
- \item{random}{whether simulation consists of random times.}
- \item{delta}{the mesh size in case of regular sampling.}
- \item{regular}{whether the ampling is regular. For internal use only.}
+ \item{\code{Initial}:}{initial time of the grid.}
+ \item{\code{Terminal}:}{terminal time fo the grid.}
+ \item{\code{division}:}{the number of observations - 1.}
+ \item{\code{delta}:}{in case of a regular grid is the mesh.}
+ \item{\code{grid}:}{the grid of times.}
+ \item{\code{random}:}{either \code{FALSE} or the distribution
+ of the random times.}
+ \item{\code{scale}:}{by default 1. NOT YET IN USE.}
+ \item{\code{regular}:}{indicator of whether the grid is regular or not.
+ For internal use only.}
}
}
+\details{
+This object is created by \code{\link{setSampling}} or as a result of a
+simulation scheme by the \code{\link{simulate}} function.
+}
\author{The YUIMA Project Team}
\keyword{classes}
More information about the Yuima-commits
mailing list