RiDMC/man/cycles.Rd

   1 \name{cycles}
   2 \alias{cycles}
   3 \alias{cycles_find}
   4 \title{
   5 Periodic cycles
   6 }
   7 \usage{
   8 cycles_find(idmc_model, par, var, period, eps, max.iter=100)
   9 }
  10 \arguments{
  11 \item{idmc_model}{idmc\_model object as returned by \code{\link{Model}}}
  12 \item{par}{model parameters values}
  13 \item{var}{starting point}
  14 \item{period}{cycle period}
  15 \item{eps}{error criterion}
  16 \item{max.iter}{max number of iterations}
  17 }
  18 \description{
  19 Find periodic cycles by Newton method
  20 }
  21 \details{
  22 Find periodic cycles by Newton method.
  23
  24 Convergence criterion is \code{eps} with max-norm.
  25 }
  26 \value{
  27         If a valid cycle is found, a list with components:
  28         \item{result}{one sample cycle point}
  29         \item{eigvals}{modulus of jacobian eigenvalues associated with the cycle}
  30
  31   If a valid cycle isn't found, returns \code{NULL}.
  32 }
  33 \author{
  34 Antonio, Fabio Di Narzo
  35 }
  36 \keyword{ misc }
  37 \seealso{
  38 \code{\link{Model}}
  39 }
  40 \examples{
  41 model <- Model(exModelFile('logistic'))
  42 cycles_find(model, 3.25, 0.5, 2, 1e-6)
  43 }