Return to hgm.so3nc.Rd CVS log

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

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

1.1     ! takayama    1: % $OpenXM$
        !             2: \name{hgm.so3nc}
        !             3: \alias{hgm.so3nc}
        !             4: %- Also NEED an '\alias' for EACH other topic documented here.
        !             5: \title{
        !             6:     The function hgm.so3nc evaluates the normalization constant for the Fisher
        !             7:   distribution on SO(3).
        !             8: }
        !             9: \description{
        !            10:     The function hgm.so3nc evaluates the normalization constant for the Fisher
        !            11:   distribution on SO(3).
        !            12: }
        !            13: \usage{
        !            14: hgm.so3nc(x,y,z,t0=0.0,q=0,deg=0)
        !            15: }
        !            16: %- maybe also 'usage' for other objects documented here.
        !            17: \arguments{
        !            18:   \item{t0}{
        !            19:      It is the initial point to evaluate the series. If it is set to 0.0,
        !            20:      a default value is used.
        !            21:   }
        !            22:   \item{q}{
        !            23:      If it is 1, then the program works in a quiet mode.
        !            24:   }
        !            25:   \item{deg}{
        !            26:      It gives the approximation degree of the power series approximation
        !            27:      of the normalization constant.
        !            28:      If it is 0, a default value is used.
        !            29:   }
        !            30: }
        !            31: \details{
        !            32:   A general algorithm to obtain the normalization constant
        !            33:   is given in the reference below.
        !            34: %  please refer to \url{http://www.openxm.org.}
        !            35: %  The function utilizes \code{\link{oxm.matrix_r2tfb}} and
        !            36: %  \code{\link[RCurl]{postForm}}.
        !            37: }
        !            38: \value{
        !            39: The output is double.
        !            40: }
        !            41: \references{
        !            42: \url{http://arxiv.org/abs/1110.0721}
        !            43:
        !            44: Tomonari Sei, Hiroki Shibata, Akimichi Takemura, Katsuyoshi Ohara, Nobuki Takayama,
        !            45: Properties and applications of Fisher distribution on the rotation group,
        !            46: arxiv:1110.0721
        !            47: }
        !            48: \author{
        !            49: Nobuki Takayama
        !            50: }
        !            51: \note{
        !            52: %%  ~~further notes~~
        !            53: }
        !            54:
        !            55: %% ~Make other sections like Warning with \section{Warning }{....} ~
        !            56:
        !            57: \seealso{
        !            58: %%\code{\link{oxm.matrix_r2tfb}}
        !            59: }
        !            60: \examples{
        !            61: ## =====================================================
        !            62: ## Example 1. Computing normalization constant of the Fisher distribution on SO(3)
        !            63: ## =====================================================
        !            64: hgm.so3nc(1,2,3)
        !            65: }
        !            66: % Add one or more standard keywords, see file 'KEYWORDS' in the
        !            67: % R documentation directory.
        !            68: \keyword{ Normalization constant }
        !            69: \keyword{ Holonomic gradient method }
        !            70: