[Distr-commits] r577 - branches/distr-2.2/pkg/distrEllipse/man

noreply at r-forge.r-project.org noreply at r-forge.r-project.org
Fri Sep 4 19:31:03 CEST 2009


Author: stamats
Date: 2009-09-04 19:31:03 +0200 (Fri, 04 Sep 2009)
New Revision: 577

Added:
   branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution-class.Rd
   branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution.Rd
   branches/distr-2.2/pkg/distrEllipse/man/MVtParameter-class.Rd
Removed:
   branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd
   branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution.Rd
   branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd
Log:
some further renaming

Copied: branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution-class.Rd (from rev 575, branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd)
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution-class.Rd	                        (rev 0)
+++ branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution-class.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -0,0 +1,70 @@
+\name{MVtDistribution-class}
+\docType{class}
+\alias{MVtDistribution-class}
+\alias{sigma,MVtDistribution-method}
+\alias{df,MVtDistribution-method}
+\alias{ncp,MVtDistribution-method}
+
+
+\title{MVt distribution class}
+\description{
+Class \code{MVtDistribution} implements multivariate t distributions using
+code from package \pkg{mvtnorm}. For details to this implementation confer
+to the references given in this package.
+}
+\section{Objects from the Class}{
+  Objects could in principle be created by calls to \code{new}, but more 
+  frequently you would create them  via the generating function 
+  \code{\link{MVtDistribution}}.
+}
+\section{Slots}{
+  \describe{
+    \item{\code{img}:}{Object of class \code{"Reals"}. }
+    \item{\code{param}:}{Object of class \code{"MVtParameter"}. }
+    \item{\code{r}:}{function with argument \code{n}; random number generator}
+    \item{\code{d}:}{ the density of this distribution, \code{\link[mvtnorm]{dmvt}}}
+    \item{\code{p}:}{the (vectorized) function \code{\link[mvtnorm]{pmvt}}.}
+    \item{\code{q}:}{the (vectorized) function \code{\link[mvtnorm]{qmvt}}.}
+    \item{\code{radDistr}:}{an object of class \code{AbscontDistribution}
+    with density 
+    \deqn{{\rm dim} {({\rm dim}+{\rm df}-1)/2\choose{{\rm df}/2-1}} x^{{\rm dim}-1} {\rm df}^{-{\rm dim}/2}/
+      (1+x^2/{\rm df})^{({\rm dim}+{\rm df})/2}}{
+      dim * choose((dim+df-1)/2, (df-1)/2) * x ^{dim-1} *  df^(-dim/2) * 
+      (1+x^2/df)^{-(dim+df)/2}}
+    }
+    \item{\code{.withArith}:}{FALSE}
+    \item{\code{.withSim}:}{FALSE}
+    \item{\code{.logExact}:}{TRUE}
+    \item{\code{.lowerExact}:}{TRUE}
+    \item{\code{Symmetry}:}{object of class \code{"EllipticalSymmetry"} about 
+    center \code{loc}; used internally to avoid unnecessary calculations.}
+}}
+\section{Extends}{
+Class \code{"EllipticalDistribution"}, directly. \cr
+Class \code{"SphericalDistribution"}, by class \code{"EllipticalDistribution"}. \cr
+Class \code{"MultivariateDistribution"}, by class \code{"SphericalDistribution"}.
+Class \code{"Distribution"}, by class \code{"MultivariateDistribution"}.
+}
+\section{Methods}{
+  \describe{
+    \item{sigma}{\code{signature(object = "MVtDistribution")}: wrapped access method for
+      slot \code{sigma} of slot \code{param}. }
+
+    \item{ncp}{\code{signature(object = "MVtDistribution")}: wrapped access method for
+      slot \code{ncp} of slot \code{param}. }
+
+    \item{df}{\code{signature(x = "MVtDistribution")}: wrapped access method for
+      slot \code{scale} of slot \code{param}. }
+
+
+  }
+}
+\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\examples{
+}
+\seealso{Package \pkg{mvtnorm}}
+\concept{Multivariate t Distribution}
+\keyword{distribution}
+\concept{extreme value distribution}
+\concept{absolutely continuous distribution}
+\concept{S4 distribution class}


Property changes on: branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution-class.Rd
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution.Rd (from rev 575, branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution.Rd)
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution.Rd	                        (rev 0)
+++ branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -0,0 +1,42 @@
+\name{MVtDistribution}
+\alias{MVtDistribution}
+\alias{MVt}
+
+\title{Generating function for MvtDistribution-class}
+\description{
+  Generates an object of class \code{"MvtDistribution"}.
+}
+\usage{MVt(loc = c(0,0), scale = diag(length(loc)), df = 1, ncp = 0)}
+
+\arguments{
+  \item{loc}{ real number: location / center of the elliptical distribution.} 
+  \item{scale}{ a square matrix (with \code{nrow(scale)==ncol(scale)==length(loc)})
+                of full rank: the / a scale matrix of the elliptical distribution
+                --- unique only upto \code{scale\%*\%t(scale)
+                }, i.e. if \code{A1} and 
+                \code{A2} are two square matrices of full rank such that 
+                \code{A1\%*\%t(A1)==A2\%*\%t(A2)
+                }, then we obtain the same elliptical distribution
+                for \code{scale = A1} and for \code{scale = A2}.} 
+ \item{df}{integer; degrees of freedom} 
+ \item{ncp}{positive real number; non-centrality parameter} 
+}
+%\details{}
+\value{Object of class \code{"MvtDistribution"}}
+%\references{}
+\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\seealso{\code{\link{MVtDistribution-class}}}
+\examples{
+E0 <- MVt()
+plot(E0)
+E1 <- diag(1,2)\%*\%E0+c(1,2)
+plot(E1)
+E(E1)
+var(E1)
+}
+
+\concept{MvtDistribution}
+\keyword{distribution}
+\concept{absolutely continuous distribution}
+\concept{elliptical distribution}
+\concept{generating function}


Property changes on: branches/distr-2.2/pkg/distrEllipse/man/MVtDistribution.Rd
___________________________________________________________________
Name: svn:mergeinfo
   + 

Copied: branches/distr-2.2/pkg/distrEllipse/man/MVtParameter-class.Rd (from rev 575, branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd)
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MVtParameter-class.Rd	                        (rev 0)
+++ branches/distr-2.2/pkg/distrEllipse/man/MVtParameter-class.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -0,0 +1,53 @@
+\name{MVtParameter-class}
+\docType{class}
+\alias{MVtParameter-class}
+\alias{sigma,MVtParameter-method}
+\alias{df,MVtParameter-method}
+\alias{ncp,MVtParameter-method}
+
+\title{Paramter of a multivariate t distribution}
+\description{The class of the parameter of MVt distributions.}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("MVtParameter", ...)}.
+}
+\section{Slots}{
+  \describe{
+    \item{\code{loc}:}{ numeric; center / location of the distribution. }
+    \item{\code{scale}:}{ matrix; the scale matrix; the number of rows of this 
+    matrix must be the same as the length of \code{location}.}
+    \item{\code{df}:}{ integer; the degrees of freedom. }
+    \item{\code{ncp}:}{ positive real; the non-centrality parameter.}
+    \item{\code{name}:}{ default name is 
+      \dQuote{parameter of a Elliptical distribution}. }
+  }
+}
+\section{Extends}{
+Class \code{"Parameter"}, directly.\cr
+Class \code{"OptionalParameter"}, by class \code{"Parameter"}.
+}
+\section{Methods}{
+  \describe{
+    \item{mean}{\code{signature(object = "MVnormParameter")}: access method for
+      slot \code{location}. }
+    \item{sigma}{\code{signature(x = "MVnormParameter")}: utility function; returns
+      \code{S\%*\%t(S)
+      } for \code{S=scale(x)}. }
+    \item{ncp}{\code{signature(object = "MVnormParameter")}: access method for
+      slot \code{ncp}. }
+    \item{df}{\code{signature(x = "MVnormParameter")}: access method for slot
+    \code{df}. }
+  }
+}
+%\references{}
+\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+%\note{}
+\seealso{\code{\link{MVtDistribution-class}}, \code{\link[distr]{Parameter-class}}}
+\examples{
+new("MVtParameter")
+}
+\concept{MVt distribution}
+\keyword{distribution}
+\concept{parameter}
+\concept{S4 parameter class}
+\keyword{models}
+\concept{generating function}


Property changes on: branches/distr-2.2/pkg/distrEllipse/man/MVtParameter-class.Rd
___________________________________________________________________
Name: svn:mergeinfo
   + 

Deleted: branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd	2009-09-04 17:30:04 UTC (rev 576)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -1,70 +0,0 @@
-\name{MVtDistribution-class}
-\docType{class}
-\alias{MVtDistribution-class}
-\alias{sigma,MVtDistribution-method}
-\alias{df,MVtDistribution-method}
-\alias{ncp,MVtDistribution-method}
-
-
-\title{MVt distribution class}
-\description{
-Class \code{MVtDistribution} implements multivariate t distributions using
-code from package \pkg{mvtnorm}. For details to this implementation confer
-to the references given in this package.
-}
-\section{Objects from the Class}{
-  Objects could in principle be created by calls to \code{new}, but more 
-  frequently you would create them  via the generating function 
-  \code{\link{MVtDistribution}}.
-}
-\section{Slots}{
-  \describe{
-    \item{\code{img}:}{Object of class \code{"Reals"}. }
-    \item{\code{param}:}{Object of class \code{"MVtParameter"}. }
-    \item{\code{r}:}{function with argument \code{n}; random number generator}
-    \item{\code{d}:}{ the density of this distribution, \code{\link[mvtnorm]{dmvt}}}
-    \item{\code{p}:}{the (vectorized) function \code{\link[mvtnorm]{pmvt}}.}
-    \item{\code{q}:}{the (vectorized) function \code{\link[mvtnorm]{qmvt}}.}
-    \item{\code{radDistr}:}{an object of class \code{AbscontDistribution}
-    with density 
-    \deqn{{\rm dim} {({\rm dim}+{\rm df}-1)/2\choose{{\rm df}/2-1}} x^{{\rm dim}-1} {\rm df}^{-{\rm dim}/2}/
-      (1+x^2/{\rm df})^{({\rm dim}+{\rm df})/2}}{
-      dim * choose((dim+df-1)/2, (df-1)/2) * x ^{dim-1} *  df^(-dim/2) * 
-      (1+x^2/df)^{-(dim+df)/2}}
-    }
-    \item{\code{.withArith}:}{FALSE}
-    \item{\code{.withSim}:}{FALSE}
-    \item{\code{.logExact}:}{TRUE}
-    \item{\code{.lowerExact}:}{TRUE}
-    \item{\code{Symmetry}:}{object of class \code{"EllipticalSymmetry"} about 
-    center \code{loc}; used internally to avoid unnecessary calculations.}
-}}
-\section{Extends}{
-Class \code{"EllipticalDistribution"}, directly. \cr
-Class \code{"SphericalDistribution"}, by class \code{"EllipticalDistribution"}. \cr
-Class \code{"MultivariateDistribution"}, by class \code{"SphericalDistribution"}.
-Class \code{"Distribution"}, by class \code{"MultivariateDistribution"}.
-}
-\section{Methods}{
-  \describe{
-    \item{sigma}{\code{signature(object = "MVtDistribution")}: wrapped access method for
-      slot \code{sigma} of slot \code{param}. }
-
-    \item{ncp}{\code{signature(object = "MVtDistribution")}: wrapped access method for
-      slot \code{ncp} of slot \code{param}. }
-
-    \item{df}{\code{signature(x = "MVtDistribution")}: wrapped access method for
-      slot \code{scale} of slot \code{param}. }
-
-
-  }
-}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-\examples{
-}
-\seealso{Package \pkg{mvtnorm}}
-\concept{Multivariate t Distribution}
-\keyword{distribution}
-\concept{extreme value distribution}
-\concept{absolutely continuous distribution}
-\concept{S4 distribution class}

Deleted: branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution.Rd	2009-09-04 17:30:04 UTC (rev 576)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -1,42 +0,0 @@
-\name{MVtDistribution}
-\alias{MVtDistribution}
-\alias{MVt}
-
-\title{Generating function for MvtDistribution-class}
-\description{
-  Generates an object of class \code{"MvtDistribution"}.
-}
-\usage{MVt(loc = c(0,0), scale = diag(length(loc)), df = 1, ncp = 0)}
-
-\arguments{
-  \item{loc}{ real number: location / center of the elliptical distribution.} 
-  \item{scale}{ a square matrix (with \code{nrow(scale)==ncol(scale)==length(loc)})
-                of full rank: the / a scale matrix of the elliptical distribution
-                --- unique only upto \code{scale\%*\%t(scale)
-                }, i.e. if \code{A1} and 
-                \code{A2} are two square matrices of full rank such that 
-                \code{A1\%*\%t(A1)==A2\%*\%t(A2)
-                }, then we obtain the same elliptical distribution
-                for \code{scale = A1} and for \code{scale = A2}.} 
- \item{df}{integer; degrees of freedom} 
- \item{ncp}{positive real number; non-centrality parameter} 
-}
-%\details{}
-\value{Object of class \code{"MvtDistribution"}}
-%\references{}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-\seealso{\code{\link{MVtDistribution-class}}}
-\examples{
-E0 <- MVt()
-plot(E0)
-E1 <- diag(1,2)\%*\%E0+c(1,2)
-plot(E1)
-E(E1)
-var(E1)
-}
-
-\concept{MvtDistribution}
-\keyword{distribution}
-\concept{absolutely continuous distribution}
-\concept{elliptical distribution}
-\concept{generating function}

Deleted: branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd	2009-09-04 17:30:04 UTC (rev 576)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd	2009-09-04 17:31:03 UTC (rev 577)
@@ -1,53 +0,0 @@
-\name{MVtParameter-class}
-\docType{class}
-\alias{MVtParameter-class}
-\alias{sigma,MVtParameter-method}
-\alias{df,MVtParameter-method}
-\alias{ncp,MVtParameter-method}
-
-\title{Paramter of a multivariate t distribution}
-\description{The class of the parameter of MVt distributions.}
-\section{Objects from the Class}{
-Objects can be created by calls of the form \code{new("MVtParameter", ...)}.
-}
-\section{Slots}{
-  \describe{
-    \item{\code{loc}:}{ numeric; center / location of the distribution. }
-    \item{\code{scale}:}{ matrix; the scale matrix; the number of rows of this 
-    matrix must be the same as the length of \code{location}.}
-    \item{\code{df}:}{ integer; the degrees of freedom. }
-    \item{\code{ncp}:}{ positive real; the non-centrality parameter.}
-    \item{\code{name}:}{ default name is 
-      \dQuote{parameter of a Elliptical distribution}. }
-  }
-}
-\section{Extends}{
-Class \code{"Parameter"}, directly.\cr
-Class \code{"OptionalParameter"}, by class \code{"Parameter"}.
-}
-\section{Methods}{
-  \describe{
-    \item{mean}{\code{signature(object = "MVnormParameter")}: access method for
-      slot \code{location}. }
-    \item{sigma}{\code{signature(x = "MVnormParameter")}: utility function; returns
-      \code{S\%*\%t(S)
-      } for \code{S=scale(x)}. }
-    \item{ncp}{\code{signature(object = "MVnormParameter")}: access method for
-      slot \code{ncp}. }
-    \item{df}{\code{signature(x = "MVnormParameter")}: access method for slot
-    \code{df}. }
-  }
-}
-%\references{}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-%\note{}
-\seealso{\code{\link{MVtDistribution-class}}, \code{\link[distr]{Parameter-class}}}
-\examples{
-new("MVtParameter")
-}
-\concept{MVt distribution}
-\keyword{distribution}
-\concept{parameter}
-\concept{S4 parameter class}
-\keyword{models}
-\concept{generating function}



More information about the Distr-commits mailing list