Return to hgm.cwishart.Rd CVS log

Up to [local] / OpenXM / src / R / r-packages / hgm / man

Annotation of OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd, Revision 1.1

1.1     ! takayama    1: % $OpenXM$
        !             2: \name{hgm.cwishart}
        !             3: \alias{hgm.cwishart}
        !             4: %- Also NEED an '\alias' for EACH other topic documented here.
        !             5: \title{
        !             6:     The function hgm.cwishart evaluates the cumulative distribution function
        !             7:   of random wishart matrix.
        !             8: }
        !             9: \description{
        !            10:     The function hgm.cwishart evaluates the cumulative distribution function
        !            11:   of random wishart matrix of size m times m.
        !            12: }
        !            13: \usage{
        !            14: hgm.cwishart(m,n,beta,x0,approxdeg,h,dp,x)
        !            15: }
        !            16: %- maybe also 'usage' for other objects documented here.
        !            17: \arguments{
        !            18:   \item{m}{}
        !            19:   \item{n}{}
        !            20:   \item{beta}{
        !            21:   }
        !            22:   \item{approxdeg}{
        !            23:   }
        !            24:   \item{h}{
        !            25:   }
        !            26:   \item{dp}{
        !            27:   }
        !            28:   \item{x}{}
        !            29: }
        !            30: \details{
        !            31:   It is evaluated by the Koev-Edelman algorithm near the origin and
        !            32:   and by the HGM when x is far from the origin.
        !            33: %  \code{\link[RCurl]{postForm}}.
        !            34: }
        !            35: \value{
        !            36: The output is x, y[0], ...,  y[0] is the value of the cumulative distribution
        !            37: function at x.  y[1],... are some derivatives.
        !            38: }
        !            39: \references{
        !            40: HNTT,
        !            41: \url{http://arxiv.org/abs/??},
        !            42: }
        !            43: \author{
        !            44: Nobuki Takayama
        !            45: }
        !            46: \note{
        !            47: %%  ~~further notes~~
        !            48: }
        !            49:
        !            50: %% ~Make other sections like Warning with \section{Warning }{....} ~
        !            51:
        !            52: \seealso{
        !            53: %%\code{\link{oxm.matrix_r2tfb}}
        !            54: }
        !            55: \examples{
        !            56: ## =====================================================
        !            57: ## Example 1. Computing normalization constant of the Fisher distribution on SO(3)
        !            58: ## =====================================================
        !            59: hgm.cwishart(m=3,n=5,beta=c(1,2,3),x=10)
        !            60:
        !            61: }
        !            62: % Add one or more standard keywords, see file 'KEYWORDS' in the
        !            63: % R documentation directory.
        !            64: \keyword{ Cumulative distribution function of random wishart matrix }
        !            65: \keyword{ Holonomic gradient method }
        !            66: \keyword{ HGM }
        !            67: