=================================================================== RCS file: /home/cvs/OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v retrieving revision 1.12 retrieving revision 1.15 diff -u -p -r1.12 -r1.15 --- OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2016/02/14 00:21:50 1.12 +++ OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd 2016/03/01 07:29:18 1.15 @@ -1,4 +1,4 @@ -% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.11 2016/02/13 22:56:50 takayama Exp $ +% $OpenXM: OpenXM/src/R/r-packages/hgm/man/hgm.cwishart.Rd,v 1.14 2016/02/16 02:17:00 takayama Exp $ \name{hgm.pwishart} \alias{hgm.pwishart} %- Also NEED an '\alias' for EACH other topic documented here. @@ -33,7 +33,8 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{dp}{ Sampling interval of solutions by the Runge-Kutta method. - When autoplot=1, it is automatically set. + When autoplot=1 or dp is negative, it is automatically set. + if it is 0, no sample is stored. } \item{q}{ The second value y[0] of this function is the Prob(L1 < q) @@ -42,7 +43,7 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, \item{mode}{ When mode=c(1,0,0), it returns the evaluation of the matrix hypergeometric series and its derivatives at q0. - When mode=c(1,1,(m^2+1)*p), intermediate values of P(L1 < x) with respect to + When mode=c(1,1,(2^m+1)*p), intermediate values of P(L1 < x) with respect to p-steps of x are also returned. Sampling interval is controled by dp. When autoplot=1, it is automatically set. } @@ -53,8 +54,9 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{err}{ When err=c(e1,e2), e1 is the absolute error and e2 is the relative error. - As long as NaN is not returned, it is recommended to set to - err=c(0.0, 1e-10), because initial values are usually very small. + This parameter controls the adative Runge-Kutta method. + If the output is absurd, you may get a correct answer by setting, e.g., + err=c(1e-(xy+5), 1e-10) or by increasing q0 when initial value at q0 is very small as 1e-xy. } \item{automatic}{ automatic=1 is the default value. @@ -75,8 +77,15 @@ hgm.pwishart(m,n,beta,q0,approxdeg,h,dp,q,mode,method, } \item{autoplot}{ autoplot=0 is the default value. - If it is 1, then it outputs an input for plot. + If it is 1, then this function outputs an input for plot + (which is equivalent to setting the 3rd argument of the mode parameter properly). When ans is the output, ans[1,] is c(q,prob at q,...), ans[2,] is c(q0,prob at q0,...), and ans[3,] is c(q0+q/100,prob at q/100,...), ... + When the adaptive Runge-Kutta method is used, the step size h may change + automatically, + which makes the sampling period change, in other words, the sampling points + q0+q/100, q0+2*q/100, q0+3*q/100, ... may change. + In this case, the output matrix may contain zero rows in the tail or overfull. + In case of the overful, use the mode option to get the all result. } } \details{