[Yuima-commits] r476 - pkg/yuima/man

[noreply at r-forge.r-project.org]

Author: lorenzo
Date: 2016-10-04 15:46:46 +0200 (Tue, 04 Oct 2016)
New Revision: 476

Added:
   pkg/yuima/man/LawMethods.Rd
Modified:
   pkg/yuima/man/setLaw.Rd
   pkg/yuima/man/yuima.Map-class.Rd
   pkg/yuima/man/yuima.law-class.rd
Log:


Added: pkg/yuima/man/LawMethods.Rd
===================================================================
--- pkg/yuima/man/LawMethods.Rd	                        (rev 0)
+++ pkg/yuima/man/LawMethods.Rd	2016-10-04 13:46:46 UTC (rev 476)
@@ -0,0 +1,35 @@
+\encoding{UTF-8}
+\name{LawMethods}
+\alias{LawMethods}
+\alias{rand}
+\alias{rand-method}
+\alias{cdf}
+\alias{quant}
+\alias{char}
+\alias{dens}
+
+\title{Methods for an object of class \code{yuima.law}}
+\description{Methods for yuima.law}
+\usage{
+rand(object, n, param, ...)
+dens(object, x, param, log = FALSE, ...)
+cdf(object, q, param, ...)
+quant(object, p, param, ...)
+}
+\arguments{
+  \item{object}{...}
+  \item{n}{...}
+  \item{param}{...}
+  \item{...}{...}
+  \item{x}{...}
+  \item{log}{...}
+  \item{q}{...}
+  \item{p}{...}
+}
+
+\value{
+Methods for an object of yuima.law-class}
+\author{
+YUIMA TEAM}
+\note{
+Insert additional info}

Modified: pkg/yuima/man/setLaw.Rd
===================================================================
--- pkg/yuima/man/setLaw.Rd	2016-10-04 13:40:05 UTC (rev 475)
+++ pkg/yuima/man/setLaw.Rd	2016-10-04 13:46:46 UTC (rev 476)
@@ -4,15 +4,17 @@
 \title{Random variable constructor }
 \description{Constructor of a random variable}
 \usage{
-setLaw(rng = function(x, ...) {
+setLaw(rng = function(n, ...) {
     NULL
 }, density = function(x, ...) {
     NULL
-}, cdf = function(x, ...) {
+}, cdf = function(q, ...) {
     NULL
+}, quant = function(p, ...) {
+    NULL
 }, characteristic = function(u, ...) {
     NULL
-}, time.var = "t", rand.var = "x", character.var = "u", dim = NA)
+}, time.var = "t", dim = NA)
 }
 %- maybe also 'usage' for other objects documented here.
 \arguments{
@@ -23,14 +25,11 @@
   \item{cdf}{
 function}
   \item{characteristic}{
-function
-}
+function}
+  \item{quant}{
+function}
   \item{time.var}{
 label}
-  \item{rand.var}{
-label}
-  \item{character.var}{
-label}
   \item{dim}{
 label}
 }

Modified: pkg/yuima/man/yuima.Map-class.Rd
===================================================================
--- pkg/yuima/man/yuima.Map-class.Rd	2016-10-04 13:40:05 UTC (rev 475)
+++ pkg/yuima/man/yuima.Map-class.Rd	2016-10-04 13:46:46 UTC (rev 476)
@@ -26,7 +26,7 @@
   \describe{
     \item{\code{Output}:}{It is an object of class \code{info.Map} and it is composed by the following slots:
     \describe{
-        \item{\code{formula}:}{It is a \code{list} that contains the components of map \code{g(theta, Xt, t)} or the operator \code{h(theta, Xt, Yt, t)} }
+        \item{\code{formula}:}{It is a \code{vector} that contains the components of map \code{g(theta, Xt, t)} or the operator \code{h(theta, Xt, Yt, t)} }
         \item{\code{dimension}:}{a \code{numeric} object that is the dimensions of the Map.}
         \item{\code{type}:}{If \code{type = "Maps"}, the Map is a map of stochastic process, If \code{type = "Operator"}, the result is an operator between two independent stochastic process}
        \item{\code{param}}{it is an object of class \code{param.Map} and it is composed by the following slots:

Modified: pkg/yuima/man/yuima.law-class.rd
===================================================================
--- pkg/yuima/man/yuima.law-class.rd	2016-10-04 13:40:05 UTC (rev 475)
+++ pkg/yuima/man/yuima.law-class.rd	2016-10-04 13:46:46 UTC (rev 476)
@@ -3,8 +3,12 @@
 \alias{yuima.law-class}
 \alias{yuima.law}
 \alias{initialize,yuima.law-method}
+\alias{rand,yuima.law-method}
+\alias{dens,yuima.law-method}
+\alias{cdf,yuima.law-method}
+\alias{quant,yuima.law-method}
+\alias{char,yuima.law-method}
 
-
 \title{Class of yuima law}
 
 \description{Insert Description Here}
@@ -17,23 +21,32 @@
   function}
     \item{cdf}{
   function}
-    \item{param.measure}{...}
+    \item{quantile}{function}
     \item{characteristic}{
   function
   }
+  \item{param.measure}{...}
     \item{time.var}{
   label}
-    \item{rand.var}{
-  label}
-    \item{charact.var}{
-  label}
     \item{dim}{
   number}
 }
 }
 
-\section{Methods}{...}
-
+\section{Methods}{
+  \describe{
+    \item{rand}{\code{signature(object = "yuima.law", n = "numeric",
+	  param = "list", ...)}: INSERT HERE DESCRIPTION}
+  \item{dens}{\code{signature(object = "yuima.law", x = "numeric",
+	  param = "list", log = FALSE, ...)}: INSERT HERE DESCRIPTION}
+	\item{cdf}{\code{signature(object = "yuima.law", q = "numeric",
+	  param = "list", ...)}: INSERT HERE DESCRIPTION}
+	\item{quant}{\code{signature(object = "yuima.law", p = "numeric",
+	  param = "list", ...)}: INSERT HERE DESCRIPTION}
+	\item{char}{\code{signature(object = "yuima.law", u = "numeric",
+	  param = "list", ...)}: INSERT HERE DESCRIPTION}
+  }
+}
 \author{The YUIMA Project Team}
 \keyword{classes}