Return to hgm_fb-package.Rd CVS log

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

Annotation of OpenXM/src/R/r-packages/hgm_fb/man/hgm_fb-package.Rd, Revision 1.1

1.1     ! takayama    1: %% $OpenXM$
        !             2: \name{hgm_fb-package}
        !             3: \alias{hgm_fb-package}
        !             4: \alias{HGM_FB}
        !             5: \alias{hgm_fb}
        !             6: \docType{package}
        !             7: \title{
        !             8: HGM
        !             9: }
        !            10: \description{
        !            11:   This package evaluates the normalizing constant for the Fisher-Bingham distributions and solves MLE problems by utilizing the holonomic gradient
        !            12: method.
        !            13: }
        !            14: \details{
        !            15: \tabular{ll}{
        !            16: Package: \tab hgm_fb\cr
        !            17: Type: \tab Package\cr
        !            18: License: \tab GPL-2\cr
        !            19: LazyLoad: \tab yes\cr
        !            20: }
        !            21:   This package evaluates the normalizing constant for the Fisher-Bingham distributions and solves MLE problems by utilizing the holonomic gradient
        !            22: method.
        !            23: The HGM and HGD are proposed in the paper below.
        !            24: This method based on the fact that a broad class of normalizing constants
        !            25: of unnormalized probability distributions belongs to the class of
        !            26: holonomic functions, which are solutions of holonomic systems of linear
        !            27: partial differential equations.
        !            28: }
        !            29: \note{
        !            30: %  (see \code{\link[gsl]{gsl-package}}).
        !            31: %  When you use the package gsl, it is recommeded to unload the shared libraries
        !            32: %  of the package hgm by \code{library.dynam.unload("hgm")}<--error, todo.
        !            33: %  (see \code{\link[base]{library.dynam.unload}}).
        !            34: }
        !            35: \references{
        !            36: \itemize{
        !            37: \item  [N3OST2]  Hiromasa Nakayama, Kenta Nishiyama, Masayuki Noro, Katsuyoshi Ohara,
        !            38: Tomonari Sei, Nobuki Takayama, Akimichi Takemura,
        !            39: Holonomic Gradient Descent  and its Application to Fisher-Bingham Integral,
        !            40: Advances in Applied Mathematics 47 (2011), 639--658,
        !            41: \url{http://dx.doi.org/10.1016/j.aam.2011.03.001}
        !            42: \item [dojo] Edited by T.Hibi,  Groebner Bases: Statistics and Software Systems, Springer, 2013,
        !            43: \url{http://dx.doi.org/10.1007/978-4-431-54574-3}
        !            44: \item  \url{http://www.openxm.org}
        !            45: }
        !            46: }
        !            47: \keyword{ package }
        !            48: \keyword{ holonomic gradient method}
        !            49: \keyword{ holonomic gradient descent}
        !            50: \keyword{ HGM }
        !            51: \keyword{ HGD }
        !            52: \keyword{Fisher-Bingham distribution}
        !            53: \seealso{
        !            54: \code{\link{hgm.z.mleFBByOptim}},
        !            55: }
        !            56: \examples{
        !            57: \dontrun{
        !            58: }
        !            59: }