]> gitweb.factorcode.org Git - factor.git/blob - extra/math/runge-kutta/runge-kutta-docs.factor
math.runge-kutta: fix help-lint.
[factor.git] / extra / math / runge-kutta / runge-kutta-docs.factor
1 USING: help.markup help.syntax kernel ;
2 IN: math.runge-kutta 
3
4 HELP: <runge-kutta-4>
5 { $values { "dxn..n/dt" object } { "delta" object } { "initial-state" object } { "t-limit" object } { "seq" object } }
6 { $description "Simple runge-kutta implementation for generating 4th-order approximated solutions for a set of first order differential equations" }
7 { $examples
8     "A lorenz attractor is a popular system to model with this: "
9     { $code "USING: math.runge-kutta math.runge-kutta.examples ;" "lorenz." }
10     "note that the produced chart is a 2 dimensional representation of a 3 dimensional solution. "
11     "Similarly, the rabinovich-fabrikant system (stable alpha-gamma limit cycle): "
12     { $code "USING: math.runge-kutta math.runge-kutta.examples ;" "rabinovich-fabrikant." }
13 } ;
14