=================================================================== RCS file: /home/cvs/OpenXM/src/R/r-packages/hgm/man/hgm-package.Rd,v retrieving revision 1.1 retrieving revision 1.2 diff -u -p -r1.1 -r1.2 --- OpenXM/src/R/r-packages/hgm/man/hgm-package.Rd 2013/02/07 07:38:23 1.1 +++ OpenXM/src/R/r-packages/hgm/man/hgm-package.Rd 2013/02/08 01:27:01 1.2 @@ -1,16 +1,18 @@ -%% $OpenXM$ +%% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm-package.Rd,v 1.1 2013/02/07 07:38:23 takayama Exp $ \name{hgm-package} \alias{hgm-package} +\alias{HGM} \alias{hgm} \docType{package} \title{ HGM } \description{ -The holonomic gradient method (hgm) gives a way to evaluate normalization +The holonomic gradient method (HGM, hgm) gives a way to evaluate normalization constants of unnormalized probability distributions by utilizing holonomic - system of differential equations. The holonomic gradient descent gives a method - to find maximal likelihood estimates by utilizing the hgm. + systems of differential equations. + The holonomic gradient descent (HGD, hgd) gives a method + to find maximal likelihood estimates by utilizing the HGM. } \details{ \tabular{ll}{ @@ -18,18 +20,45 @@ Package: \tab hgm\cr Type: \tab Package\cr Version: \tab 1.0\cr Date: \tab 2013-02-07\cr -License: \tab GPL\cr +License: \tab GPL-2\cr LazyLoad: \tab yes\cr } -More details. +The HGM and HGD are proposed in the paper below. +This method based on the fact that a broad class of normalization constants +of unnormalized probability distributions belongs to the class of +holonomic functions, which are solutions of holonomic systems of linear +partial differential equations. } \author{ -Nobuki Takayama (takayama@math.kobe-u.ac.jp) +\itemize{ +\item Nobuki Takayama (takayama@math.kobe-u.ac.jp) } +} +\note{ + This package includes a small subset of the Gnu scientific library codes + (\url{http://www.gnu.org/software/gsl/}). + Then, it might cause a conflict with the package gsl + (see \code{\link[gsl]{gsl-package}}). + When you use the package gsl, it is recommeded to unload the shared libraries + of the package hgm by \code{library.dynam.unload("hgm")} + (see \code{\link[base]{library.dynam.unload}}). +} \references{ - \url{http://www.openxm.org} +\itemize{ +\item Hiromasa Nakayama, Kenta Nishiyama, Masayuki Noro, Katsuyoshi Ohara, + Tomonari Sei, Nobuki Takayama, Akimichi Takemura, +Holonomic Gradient Descent and its Application to Fisher-Bingham Integral, +Advances in Applied Mathematics 47 (2011), 639--658, +\url{http://dx.doi.org/10.1016/j.aam.2011.03.001} + +\item \url{http://www.openxm.org} } +} \keyword{ package } +\keyword{ holonomic gradient method} +\keyword{ holonomic gradient descent} +\keyword{ HGM } +\keyword{ HGD } \seealso{ \code{\link{hgm.so3nc}} }