reference.xml 355 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105
  1. <?xml version="1.0" standalone="yes"?>
  2. <library-reference id="odeint_reference"><title>odeint Reference</title><header name="boost/numeric/odeint/integrate/check_adapter.hpp">
  3. <namespace name="boost">
  4. <namespace name="numeric">
  5. <namespace name="odeint">
  6. <class name="checked_observer"><template>
  7. <template-type-parameter name="Observer"/>
  8. <template-type-parameter name="Checker"/>
  9. </template><purpose>Adapter to combine observer and checker. </purpose><typedef name="observer_type"><type>Observer</type></typedef>
  10. <typedef name="checker_type"><type>Checker</type></typedef>
  11. <method-group name="public member functions">
  12. <method name="operator()" cv="const"><type>void</type><template>
  13. <template-type-parameter name="State"/>
  14. <template-type-parameter name="Time"/>
  15. </template><parameter name="state"><paramtype>const State &amp;</paramtype></parameter><parameter name="t"><paramtype>Time</paramtype></parameter></method>
  16. </method-group>
  17. <constructor><parameter name="observer"><paramtype>observer_type &amp;</paramtype></parameter><parameter name="checker"><paramtype>checker_type &amp;</paramtype></parameter></constructor>
  18. </class><class name="checked_stepper"><template>
  19. <template-type-parameter name="Stepper"/>
  20. <template-type-parameter name="Checker"/>
  21. <template-type-parameter name="StepperCategory"><default>typename base_tag&lt;typename Stepper::stepper_category&gt;::type</default></template-type-parameter>
  22. </template></class><class-specialization name="checked_stepper"><template>
  23. <template-type-parameter name="ControlledStepper"/>
  24. <template-type-parameter name="Checker"/>
  25. </template><specialization><template-arg>ControlledStepper</template-arg><template-arg>Checker</template-arg><template-arg>controlled_stepper_tag</template-arg></specialization><purpose>Adapter to combine controlled stepper and checker. </purpose><typedef name="stepper_type"><type>ControlledStepper</type></typedef>
  26. <typedef name="checker_type"><type>Checker</type></typedef>
  27. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  28. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  29. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  30. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  31. <method-group name="public member functions">
  32. <method name="try_step"><type>controlled_step_result</type><template>
  33. <template-type-parameter name="System"/>
  34. <template-type-parameter name="StateInOut"/>
  35. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="state"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter><purpose>forward of the do_step method </purpose></method>
  36. </method-group>
  37. <constructor><parameter name="stepper"><paramtype>stepper_type &amp;</paramtype></parameter><parameter name="checker"><paramtype>checker_type &amp;</paramtype></parameter><purpose>Construct the checked_stepper. </purpose></constructor>
  38. </class-specialization><class-specialization name="checked_stepper"><template>
  39. <template-type-parameter name="DenseOutStepper"/>
  40. <template-type-parameter name="Checker"/>
  41. </template><specialization><template-arg>DenseOutStepper</template-arg><template-arg>Checker</template-arg><template-arg>dense_output_stepper_tag</template-arg></specialization><purpose>Adapter to combine dense out stepper and checker. </purpose><typedef name="stepper_type"><type>DenseOutStepper</type></typedef>
  42. <typedef name="checker_type"><type>Checker</type></typedef>
  43. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  44. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  45. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  46. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  47. <method-group name="public member functions">
  48. <method name="do_step"><type>std::pair&lt; time_type, time_type &gt;</type><template>
  49. <template-type-parameter name="System"/>
  50. </template><parameter name="system"><paramtype>System</paramtype></parameter></method>
  51. <method name="initialize"><type>void</type><template>
  52. <template-type-parameter name="StateType"/>
  53. </template><parameter name="x0"><paramtype>const StateType &amp;</paramtype></parameter><parameter name="t0"><paramtype>time_type</paramtype></parameter><parameter name="dt0"><paramtype>time_type</paramtype></parameter></method>
  54. <method name="calc_state" cv="const"><type>void</type><template>
  55. <template-type-parameter name="StateOut"/>
  56. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype></parameter></method>
  57. <method name="calc_state" cv="const"><type>void</type><template>
  58. <template-type-parameter name="StateOut"/>
  59. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>const StateOut &amp;</paramtype></parameter></method>
  60. <method name="current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  61. <method name="current_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  62. <method name="previous_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  63. <method name="previous_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  64. <method name="current_time_step" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  65. </method-group>
  66. <constructor><parameter name="stepper"><paramtype>stepper_type &amp;</paramtype></parameter><parameter name="checker"><paramtype>checker_type &amp;</paramtype></parameter><purpose>Construct the checked_stepper. </purpose></constructor>
  67. </class-specialization><class-specialization name="checked_stepper"><template>
  68. <template-type-parameter name="Stepper"/>
  69. <template-type-parameter name="Checker"/>
  70. </template><specialization><template-arg>Stepper</template-arg><template-arg>Checker</template-arg><template-arg>stepper_tag</template-arg></specialization><purpose>Adapter to combine basic stepper and checker. </purpose><typedef name="stepper_type"><type>Stepper</type></typedef>
  71. <typedef name="checker_type"><type>Checker</type></typedef>
  72. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  73. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  74. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  75. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  76. <method-group name="public member functions">
  77. <method name="do_step"><type>void</type><template>
  78. <template-type-parameter name="System"/>
  79. <template-type-parameter name="StateInOut"/>
  80. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="state"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>const time_type</paramtype></parameter><parameter name="dt"><paramtype>const time_type</paramtype></parameter><purpose>forward of the do_step method </purpose></method>
  81. </method-group>
  82. <constructor><parameter name="stepper"><paramtype>stepper_type &amp;</paramtype></parameter><parameter name="checker"><paramtype>checker_type &amp;</paramtype></parameter><purpose>Construct the checked_stepper. </purpose></constructor>
  83. </class-specialization>
  84. </namespace>
  85. </namespace>
  86. </namespace>
  87. </header>
  88. <header name="boost/numeric/odeint/integrate/integrate.hpp">
  89. <namespace name="boost">
  90. <namespace name="numeric">
  91. <namespace name="odeint">
  92. <function name="integrate"><type>boost::enable_if&lt; typename has_value_type&lt; State &gt;::type, size_t &gt;::type</type><template>
  93. <template-type-parameter name="System"/>
  94. <template-type-parameter name="State"/>
  95. <template-type-parameter name="Time"/>
  96. <template-type-parameter name="Observer"/>
  97. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial state. </para></description></parameter><parameter name="start_time"><paramtype>Time</paramtype><description><para>Start time of the integration. </para></description></parameter><parameter name="end_time"><paramtype>Time</paramtype><description><para>End time of the integration. </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>Initial step size, will be adjusted during the integration. </para></description></parameter><parameter name="observer"><paramtype>Observer</paramtype><description><para>Observer that will be called after each time step. </para></description></parameter><purpose>Integrates the ODE. </purpose><description><para>Integrates the ODE given by system from start_time to end_time starting with start_state as initial condition and dt as initial time step. This function uses a dense output dopri5 stepper and performs an adaptive integration with step size control, thus dt changes during the integration. This method uses standard error bounds of 1E-6. After each step, the observer is called.</para><para><note><para>A second version of this function template exists which explicitly expects the value type as template parameter, i.e. integrate&lt; double &gt;( sys , x , t0 , t1 , dt , obs );</para>
  98. </note>
  99. </para></description><returns><para>The number of steps performed. </para>
  100. </returns></function>
  101. <function name="integrate"><type>size_t</type><template>
  102. <template-type-parameter name="Value"/>
  103. <template-type-parameter name="System"/>
  104. <template-type-parameter name="State"/>
  105. <template-type-parameter name="Time"/>
  106. <template-type-parameter name="Observer"/>
  107. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter></function>
  108. <function name="integrate"><type>size_t</type><template>
  109. <template-type-parameter name="System"/>
  110. <template-type-parameter name="State"/>
  111. <template-type-parameter name="Time"/>
  112. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial state. </para></description></parameter><parameter name="start_time"><paramtype>Time</paramtype><description><para>Start time of the integration. </para></description></parameter><parameter name="end_time"><paramtype>Time</paramtype><description><para>End time of the integration. </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>Initial step size, will be adjusted during the integration. </para></description></parameter><purpose>Integrates the ODE without observer calls. </purpose><description><para>Integrates the ODE given by system from start_time to end_time starting with start_state as initial condition and dt as initial time step. This function uses a dense output dopri5 stepper and performs an adaptive integration with step size control, thus dt changes during the integration. This method uses standard error bounds of 1E-6. No observer is called.</para><para><note><para>A second version of this function template exists which explicitly expects the value type as template parameter, i.e. integrate&lt; double &gt;( sys , x , t0 , t1 , dt );</para>
  113. </note>
  114. </para></description><returns><para>The number of steps performed. </para>
  115. </returns></function>
  116. <function name="integrate"><type>size_t</type><template>
  117. <template-type-parameter name="Value"/>
  118. <template-type-parameter name="System"/>
  119. <template-type-parameter name="State"/>
  120. <template-type-parameter name="Time"/>
  121. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter></function>
  122. </namespace>
  123. </namespace>
  124. </namespace>
  125. </header>
  126. <header name="boost/numeric/odeint/integrate/integrate_adaptive.hpp">
  127. <namespace name="boost">
  128. <namespace name="numeric">
  129. <namespace name="odeint">
  130. <function name="integrate_adaptive"><type>size_t</type><template>
  131. <template-type-parameter name="Stepper"/>
  132. <template-type-parameter name="System"/>
  133. <template-type-parameter name="State"/>
  134. <template-type-parameter name="Time"/>
  135. <template-type-parameter name="Observer"/>
  136. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to be used for numerical integration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>Function/Functor defining the rhs of the ODE. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial condition x0. </para></description></parameter><parameter name="start_time"><paramtype>Time</paramtype><description><para>The initial time t0. </para></description></parameter><parameter name="end_time"><paramtype>Time</paramtype><description><para>The final integration time tend. </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>The time step between observer calls, <emphasis>not</emphasis> necessarily the time step of the integration. </para></description></parameter><parameter name="observer"><paramtype>Observer</paramtype><description><para>Function/Functor called at equidistant time intervals. </para></description></parameter><purpose>Integrates the ODE with adaptive step size. </purpose><description><para>This function integrates the ODE given by system with the given stepper. The observer is called after each step. If the stepper has no error control, the step size remains constant and the observer is called at equidistant time points t0+n*dt. If the stepper is a ControlledStepper, the step size is adjusted and the observer is called in non-equidistant intervals.</para><para>
  137. </para></description><returns><para>The number of steps performed. </para>
  138. </returns></function>
  139. <function name="integrate_adaptive"><type>size_t</type><template>
  140. <template-type-parameter name="Stepper"/>
  141. <template-type-parameter name="System"/>
  142. <template-type-parameter name="State"/>
  143. <template-type-parameter name="Time"/>
  144. <template-type-parameter name="Observer"/>
  145. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  146. <function name="integrate_adaptive"><type>size_t</type><template>
  147. <template-type-parameter name="Stepper"/>
  148. <template-type-parameter name="System"/>
  149. <template-type-parameter name="State"/>
  150. <template-type-parameter name="Time"/>
  151. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><purpose>integrate_adaptive without an observer. </purpose></function>
  152. <function name="integrate_adaptive"><type>size_t</type><template>
  153. <template-type-parameter name="Stepper"/>
  154. <template-type-parameter name="System"/>
  155. <template-type-parameter name="State"/>
  156. <template-type-parameter name="Time"/>
  157. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  158. </namespace>
  159. </namespace>
  160. </namespace>
  161. </header>
  162. <header name="boost/numeric/odeint/integrate/integrate_const.hpp">
  163. <namespace name="boost">
  164. <namespace name="numeric">
  165. <namespace name="odeint">
  166. <function name="integrate_const"><type>size_t</type><template>
  167. <template-type-parameter name="Stepper"/>
  168. <template-type-parameter name="System"/>
  169. <template-type-parameter name="State"/>
  170. <template-type-parameter name="Time"/>
  171. <template-type-parameter name="Observer"/>
  172. <template-type-parameter name="StepOverflowChecker"/>
  173. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to be used for numerical integration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>Function/Functor defining the rhs of the ODE. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial condition x0. </para></description></parameter><parameter name="start_time"><paramtype>Time</paramtype><description><para>The initial time t0. </para></description></parameter><parameter name="end_time"><paramtype>Time</paramtype><description><para>The final integration time tend. </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>The time step between observer calls, <emphasis>not</emphasis> necessarily the time step of the integration. </para></description></parameter><parameter name="observer"><paramtype>Observer</paramtype><description><para>[optional] Function/Functor called at equidistant time intervals. </para></description></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype><description><para>[optional] Functor to check for step count overflows, if no checker is provided, no exception is thrown. </para></description></parameter><purpose>Integrates the ODE with constant step size. </purpose><description><para>Integrates the ODE defined by system using the given stepper. This method ensures that the observer is called at constant intervals dt. If the Stepper is a normal stepper without step size control, dt is also used for the numerical scheme. If a ControlledStepper is provided, the algorithm might reduce the step size to meet the error bounds, but it is ensured that the observer is always called at equidistant time points t0 + n*dt. If a DenseOutputStepper is used, the step size also may vary and the dense output is used to call the observer at equidistant time points. If a <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname> is provided as StepOverflowChecker, a no_progress_error is thrown if too many steps (default: 500) are performed without progress, i.e. in between observer calls. If no checker is provided, no such overflow check is performed.</para><para>
  174. </para></description><returns><para>The number of steps performed. </para>
  175. </returns></function>
  176. <function name="integrate_const"><type>size_t</type><template>
  177. <template-type-parameter name="Stepper"/>
  178. <template-type-parameter name="System"/>
  179. <template-type-parameter name="State"/>
  180. <template-type-parameter name="Time"/>
  181. <template-type-parameter name="Observer"/>
  182. <template-type-parameter name="StepOverflowChecker"/>
  183. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  184. <function name="integrate_const"><type>size_t</type><template>
  185. <template-type-parameter name="Stepper"/>
  186. <template-type-parameter name="System"/>
  187. <template-type-parameter name="State"/>
  188. <template-type-parameter name="Time"/>
  189. <template-type-parameter name="Observer"/>
  190. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>integrate_const without step overflow checker </purpose></function>
  191. <function name="integrate_const"><type>size_t</type><template>
  192. <template-type-parameter name="Stepper"/>
  193. <template-type-parameter name="System"/>
  194. <template-type-parameter name="State"/>
  195. <template-type-parameter name="Time"/>
  196. <template-type-parameter name="Observer"/>
  197. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  198. <function name="integrate_const"><type>size_t</type><template>
  199. <template-type-parameter name="Stepper"/>
  200. <template-type-parameter name="System"/>
  201. <template-type-parameter name="State"/>
  202. <template-type-parameter name="Time"/>
  203. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><purpose>integrate_const without observer calls </purpose></function>
  204. <function name="integrate_const"><type>size_t</type><template>
  205. <template-type-parameter name="Stepper"/>
  206. <template-type-parameter name="System"/>
  207. <template-type-parameter name="State"/>
  208. <template-type-parameter name="Time"/>
  209. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="end_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  210. </namespace>
  211. </namespace>
  212. </namespace>
  213. </header>
  214. <header name="boost/numeric/odeint/integrate/integrate_n_steps.hpp">
  215. <namespace name="boost">
  216. <namespace name="numeric">
  217. <namespace name="odeint">
  218. <function name="integrate_n_steps"><type>Time</type><template>
  219. <template-type-parameter name="Stepper"/>
  220. <template-type-parameter name="System"/>
  221. <template-type-parameter name="State"/>
  222. <template-type-parameter name="Time"/>
  223. <template-type-parameter name="Observer"/>
  224. <template-type-parameter name="StepOverflowChecker"/>
  225. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter></function>
  226. <function name="integrate_n_steps"><type>Time</type><template>
  227. <template-type-parameter name="Stepper"/>
  228. <template-type-parameter name="System"/>
  229. <template-type-parameter name="State"/>
  230. <template-type-parameter name="Time"/>
  231. <template-type-parameter name="Observer"/>
  232. <template-type-parameter name="StepOverflowChecker"/>
  233. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  234. <function name="integrate_n_steps"><type>Time</type><template>
  235. <template-type-parameter name="Stepper"/>
  236. <template-type-parameter name="System"/>
  237. <template-type-parameter name="State"/>
  238. <template-type-parameter name="Time"/>
  239. <template-type-parameter name="Observer"/>
  240. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to be used for numerical integration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>Function/Functor defining the rhs of the ODE. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial condition x0. </para></description></parameter><parameter name="start_time"><paramtype>Time</paramtype><description><para>The initial time t0. </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>The time step between observer calls, <emphasis>not</emphasis> necessarily the time step of the integration. </para></description></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype><description><para>Number of steps to be performed </para></description></parameter><parameter name="observer"><paramtype>Observer</paramtype><description><para>Function/Functor called at equidistant time intervals. </para></description></parameter><purpose>The same function as above, but without checker. </purpose><description><para>Integrates the ODE with constant step size.</para><para>This function is similar to integrate_const. The observer is called at equidistant time intervals t0 + n*dt. If the Stepper is a normal stepper without step size control, dt is also used for the numerical scheme. If a ControlledStepper is provided, the algorithm might reduce the step size to meet the error bounds, but it is ensured that the observer is always called at equidistant time points t0 + n*dt. If a DenseOutputStepper is used, the step size also may vary and the dense output is used to call the observer at equidistant time points. The final integration time is always t0 + num_of_steps*dt. If a <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname> is provided as StepOverflowChecker, a no_progress_errror is thrown if too many steps (default: 500) are performed without progress, i.e. in between observer calls. If no checker is provided, no such overflow check is performed.</para><para>
  241. </para></description><returns><para>The number of steps performed. </para>
  242. </returns></function>
  243. <function name="integrate_n_steps"><type>Time</type><template>
  244. <template-type-parameter name="Stepper"/>
  245. <template-type-parameter name="System"/>
  246. <template-type-parameter name="State"/>
  247. <template-type-parameter name="Time"/>
  248. <template-type-parameter name="Observer"/>
  249. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  250. <function name="integrate_n_steps"><type>Time</type><template>
  251. <template-type-parameter name="Stepper"/>
  252. <template-type-parameter name="System"/>
  253. <template-type-parameter name="State"/>
  254. <template-type-parameter name="Time"/>
  255. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter><purpose>The same function as above, but without observer calls. </purpose></function>
  256. <function name="integrate_n_steps"><type>Time</type><template>
  257. <template-type-parameter name="Stepper"/>
  258. <template-type-parameter name="System"/>
  259. <template-type-parameter name="State"/>
  260. <template-type-parameter name="Time"/>
  261. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="start_time"><paramtype>Time</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  262. </namespace>
  263. </namespace>
  264. </namespace>
  265. </header>
  266. <header name="boost/numeric/odeint/integrate/integrate_times.hpp">
  267. <namespace name="boost">
  268. <namespace name="numeric">
  269. <namespace name="odeint">
  270. <function name="integrate_times"><type>size_t</type><template>
  271. <template-type-parameter name="Stepper"/>
  272. <template-type-parameter name="System"/>
  273. <template-type-parameter name="State"/>
  274. <template-type-parameter name="TimeIterator"/>
  275. <template-type-parameter name="Time"/>
  276. <template-type-parameter name="Observer"/>
  277. <template-type-parameter name="StepOverflowChecker"/>
  278. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="times_start"><paramtype>TimeIterator</paramtype></parameter><parameter name="times_end"><paramtype>TimeIterator</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter></function>
  279. <function name="integrate_times"><type>size_t</type><template>
  280. <template-type-parameter name="Stepper"/>
  281. <template-type-parameter name="System"/>
  282. <template-type-parameter name="State"/>
  283. <template-type-parameter name="TimeIterator"/>
  284. <template-type-parameter name="Time"/>
  285. <template-type-parameter name="Observer"/>
  286. <template-type-parameter name="StepOverflowChecker"/>
  287. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="times_start"><paramtype>TimeIterator</paramtype></parameter><parameter name="times_end"><paramtype>TimeIterator</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  288. <function name="integrate_times"><type>size_t</type><template>
  289. <template-type-parameter name="Stepper"/>
  290. <template-type-parameter name="System"/>
  291. <template-type-parameter name="State"/>
  292. <template-type-parameter name="TimeRange"/>
  293. <template-type-parameter name="Time"/>
  294. <template-type-parameter name="Observer"/>
  295. <template-type-parameter name="StepOverflowChecker"/>
  296. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="times"><paramtype>const TimeRange &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter><purpose>The same function as above, but with the observation times given as range. </purpose></function>
  297. <function name="integrate_times"><type>size_t</type><template>
  298. <template-type-parameter name="Stepper"/>
  299. <template-type-parameter name="System"/>
  300. <template-type-parameter name="State"/>
  301. <template-type-parameter name="TimeRange"/>
  302. <template-type-parameter name="Time"/>
  303. <template-type-parameter name="Observer"/>
  304. <template-type-parameter name="StepOverflowChecker"/>
  305. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="times"><paramtype>const TimeRange &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><parameter name="checker"><paramtype>StepOverflowChecker</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  306. <function name="integrate_times"><type>size_t</type><template>
  307. <template-type-parameter name="Stepper"/>
  308. <template-type-parameter name="System"/>
  309. <template-type-parameter name="State"/>
  310. <template-type-parameter name="TimeIterator"/>
  311. <template-type-parameter name="Time"/>
  312. <template-type-parameter name="Observer"/>
  313. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to be used for numerical integration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>Function/Functor defining the rhs of the ODE. </para></description></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype><description><para>The initial condition x0. </para></description></parameter><parameter name="times_start"><paramtype>TimeIterator</paramtype><description><para>Iterator to the start time </para></description></parameter><parameter name="times_end"><paramtype>TimeIterator</paramtype><description><para>Iterator to the end time </para></description></parameter><parameter name="dt"><paramtype>Time</paramtype><description><para>The time step between observer calls, <emphasis>not</emphasis> necessarily the time step of the integration. </para></description></parameter><parameter name="observer"><paramtype>Observer</paramtype><description><para>Function/Functor called at equidistant time intervals. </para></description></parameter><purpose>Integrates the ODE with observer calls at given time points. </purpose><description><para>Integrates the ODE given by system using the given stepper. This function does observer calls at the subsequent time points given by the range times_start, times_end. If the stepper has not step size control, the step size might be reduced occasionally to ensure observer calls exactly at the time points from the given sequence. If the stepper is a ControlledStepper, the step size is adjusted to meet the error bounds, but also might be reduced occasionally to ensure correct observer calls. If a DenseOutputStepper is provided, the dense output functionality is used to call the observer at the given times. The end time of the integration is always *(end_time-1). If a <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname> is provided as StepOverflowChecker, a no_progress_error is thrown if too many steps (default: 500) are performed without progress, i.e. in between observer calls. If no checker is provided, no such overflow check is performed.</para><para>
  314. </para></description><returns><para>The number of steps performed. </para>
  315. </returns></function>
  316. <function name="integrate_times"><type>size_t</type><template>
  317. <template-type-parameter name="Stepper"/>
  318. <template-type-parameter name="System"/>
  319. <template-type-parameter name="State"/>
  320. <template-type-parameter name="TimeIterator"/>
  321. <template-type-parameter name="Time"/>
  322. <template-type-parameter name="Observer"/>
  323. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="times_start"><paramtype>TimeIterator</paramtype></parameter><parameter name="times_end"><paramtype>TimeIterator</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  324. <function name="integrate_times"><type>size_t</type><template>
  325. <template-type-parameter name="Stepper"/>
  326. <template-type-parameter name="System"/>
  327. <template-type-parameter name="State"/>
  328. <template-type-parameter name="TimeRange"/>
  329. <template-type-parameter name="Time"/>
  330. <template-type-parameter name="Observer"/>
  331. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>State &amp;</paramtype></parameter><parameter name="times"><paramtype>const TimeRange &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>The same function as above, but with the observation times given as range. </purpose></function>
  332. <function name="integrate_times"><type>size_t</type><template>
  333. <template-type-parameter name="Stepper"/>
  334. <template-type-parameter name="System"/>
  335. <template-type-parameter name="State"/>
  336. <template-type-parameter name="TimeRange"/>
  337. <template-type-parameter name="Time"/>
  338. <template-type-parameter name="Observer"/>
  339. </template><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="start_state"><paramtype>const State &amp;</paramtype></parameter><parameter name="times"><paramtype>const TimeRange &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter><parameter name="observer"><paramtype>Observer</paramtype></parameter><purpose>Solves the forwarding problem, can be called with Boost.Range as start_state. </purpose></function>
  340. </namespace>
  341. </namespace>
  342. </namespace>
  343. </header>
  344. <header name="boost/numeric/odeint/integrate/max_step_checker.hpp">
  345. <namespace name="boost">
  346. <namespace name="numeric">
  347. <namespace name="odeint">
  348. <class name="failed_step_checker"><inherit access="public">boost::numeric::odeint::max_step_checker</inherit><purpose>A class for performing overflow checks on the failed step count in step size adjustments. </purpose><description><para>Used internally within the dense output stepper and integrate routines. </para></description><method-group name="public member functions">
  349. <method name="operator()"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Increases the counter and performs the iteration check. </purpose></method>
  350. <method name="reset"><type>void</type><purpose>Resets the <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname> by setting the internal counter to 0. </purpose></method>
  351. </method-group>
  352. <constructor><parameter name="max_steps"><paramtype>const int</paramtype><default>500</default></parameter><purpose>Construct the <classname alt="boost::numeric::odeint::failed_step_checker">failed_step_checker</classname>. max_steps is the maximal number of iterations allowed before runtime_error is thrown. </purpose></constructor>
  353. </class><class name="max_step_checker"><purpose>A class for performing overflow checks on the step count in integrate functions. </purpose><description><para>Provide an instance of this class to integrate functions if you want to throw a runtime error if too many steps are performed without progress during the integrate routine. </para></description><method-group name="public member functions">
  354. <method name="reset"><type>void</type><purpose>Resets the <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname> by setting the internal counter to 0. </purpose></method>
  355. <method name="operator()"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Increases the counter and performs the iteration check. </purpose></method>
  356. </method-group>
  357. <constructor><parameter name="max_steps"><paramtype>const int</paramtype><default>500</default></parameter><purpose>Construct the <classname alt="boost::numeric::odeint::max_step_checker">max_step_checker</classname>. max_steps is the maximal number of iterations allowed before runtime_error is thrown. </purpose></constructor>
  358. </class>
  359. </namespace>
  360. </namespace>
  361. </namespace>
  362. </header>
  363. <header name="boost/numeric/odeint/iterator/adaptive_iterator.hpp">
  364. <namespace name="boost">
  365. <namespace name="numeric">
  366. <namespace name="odeint">
  367. <class name="adaptive_iterator"><template>
  368. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  369. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  370. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  371. </template><purpose>ODE Iterator with adaptive step size. The value type of this iterator is the state type of the stepper. </purpose><description><para>Implements an iterator representing the solution of an ODE from t_start to t_end evaluated at steps with an adaptive step size dt. After each iteration the iterator dereferences to the state x at the next time t+dt where dt is controlled by the stepper. This iterator can be used with ControlledSteppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_adaptive routine.</para><para><classname alt="boost::numeric::odeint::adaptive_iterator">adaptive_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.</para><para>
  372. </para></description><method-group name="public member functions">
  373. </method-group>
  374. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>time_type</paramtype></parameter><parameter name="t_end"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  375. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  376. </class>
  377. <function name="make_adaptive_iterator_begin"><type><classname>adaptive_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  378. <template-type-parameter name="Stepper"/>
  379. <template-type-parameter name="System"/>
  380. <template-type-parameter name="State"/>
  381. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::adaptive_iterator">adaptive_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  382. </para></description><returns><para>The adaptive iterator. </para>
  383. </returns></function>
  384. <function name="make_adaptive_iterator_end"><type><classname>adaptive_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  385. <template-type-parameter name="Stepper"/>
  386. <template-type-parameter name="System"/>
  387. <template-type-parameter name="State"/>
  388. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::adaptive_iterator">adaptive_iterator</classname>. Constructs a end iterator. </purpose><description><para>
  389. </para></description><returns><para>The adaptive iterator. </para>
  390. </returns></function>
  391. <function name="make_adaptive_range"><type>std::pair&lt; <classname>adaptive_iterator</classname>&lt; Stepper, System, State &gt;, <classname>adaptive_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  392. <template-type-parameter name="Stepper"/>
  393. <template-type-parameter name="System"/>
  394. <template-type-parameter name="State"/>
  395. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of adaptive iterators. A range is here a pair of <classname alt="boost::numeric::odeint::adaptive_iterator">adaptive_iterator</classname>. </purpose><description><para>
  396. </para></description><returns><para>The adaptive range. </para>
  397. </returns></function>
  398. </namespace>
  399. </namespace>
  400. </namespace>
  401. </header>
  402. <header name="boost/numeric/odeint/iterator/adaptive_time_iterator.hpp">
  403. <namespace name="boost">
  404. <namespace name="numeric">
  405. <namespace name="odeint">
  406. <class name="adaptive_time_iterator"><template>
  407. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  408. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  409. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  410. </template><purpose>ODE Iterator with adaptive step size. The value type of this iterator is a std::pair containing state and time. </purpose><description><para>Implements an iterator representing the solution of an ODE from t_start to t_end evaluated at steps with an adaptive step size dt. After each iteration the iterator dereferences to a pair containing state and time at the next time point t+dt where dt is controlled by the stepper. This iterator can be used with ControlledSteppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_adaptive routine.</para><para><classname alt="boost::numeric::odeint::adaptive_iterator">adaptive_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is a std::pair of state and time of the stepper.</para><para>
  411. </para></description><method-group name="public member functions">
  412. </method-group>
  413. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>time_type</paramtype></parameter><parameter name="t_end"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  414. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  415. </class>
  416. <function name="make_adaptive_time_iterator_begin"><type><classname>adaptive_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  417. <template-type-parameter name="Stepper"/>
  418. <template-type-parameter name="System"/>
  419. <template-type-parameter name="State"/>
  420. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::adaptive_time_iterator">adaptive_time_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::adaptive_time_iterator">adaptive_time_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  421. </para></description><returns><para>The adaptive time iterator. </para>
  422. </returns></function>
  423. <function name="make_adaptive_time_iterator_end"><type><classname>adaptive_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  424. <template-type-parameter name="Stepper"/>
  425. <template-type-parameter name="System"/>
  426. <template-type-parameter name="State"/>
  427. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::adaptive_time_iterator">adaptive_time_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::adaptive_time_iterator">adaptive_time_iterator</classname>. Constructs a end iterator. </purpose><description><para>
  428. </para></description><returns><para>The adaptive time iterator. </para>
  429. </returns></function>
  430. <function name="make_adaptive_time_range"><type>std::pair&lt; <classname>adaptive_time_iterator</classname>&lt; Stepper, System, State &gt;, <classname>adaptive_time_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  431. <template-type-parameter name="Stepper"/>
  432. <template-type-parameter name="System"/>
  433. <template-type-parameter name="State"/>
  434. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::adaptive_time_iterator">adaptive_time_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of adaptive time iterators. A range is here a pair of adaptive_time_iterators. </purpose><description><para>
  435. </para></description><returns><para>The adaptive time range. </para>
  436. </returns></function>
  437. </namespace>
  438. </namespace>
  439. </namespace>
  440. </header>
  441. <header name="boost/numeric/odeint/iterator/const_step_iterator.hpp">
  442. <namespace name="boost">
  443. <namespace name="numeric">
  444. <namespace name="odeint">
  445. <class name="const_step_iterator"><template>
  446. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  447. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  448. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  449. </template><purpose>ODE Iterator with constant step size. The value type of this iterator is the state type of the stepper. </purpose><description><para>Implements an iterator representing the solution of an ODE from t_start to t_end evaluated at steps with constant step size dt. After each iteration the iterator dereferences to the state x at the next time t+dt. This iterator can be used with Steppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_const routine.</para><para><classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.</para><para>
  450. </para></description><method-group name="public member functions">
  451. </method-group>
  452. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>time_type</paramtype></parameter><parameter name="t_end"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  453. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  454. </class>
  455. <function name="make_const_step_iterator_begin"><type><classname>const_step_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  456. <template-type-parameter name="Stepper"/>
  457. <template-type-parameter name="System"/>
  458. <template-type-parameter name="State"/>
  459. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  460. </para></description><returns><para>The const step iterator. </para>
  461. </returns></function>
  462. <function name="make_const_step_iterator_end"><type><classname>const_step_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  463. <template-type-parameter name="Stepper"/>
  464. <template-type-parameter name="System"/>
  465. <template-type-parameter name="State"/>
  466. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. Constructs a end iterator. </purpose><description><para>
  467. </para></description><returns><para>The <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. </para>
  468. </returns></function>
  469. <function name="make_const_step_range"><type>std::pair&lt; <classname>const_step_iterator</classname>&lt; Stepper, System, State &gt;, <classname>const_step_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  470. <template-type-parameter name="Stepper"/>
  471. <template-type-parameter name="System"/>
  472. <template-type-parameter name="State"/>
  473. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of const step iterators. A range is here a pair of <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. </purpose><description><para>
  474. </para></description><returns><para>The const step range. </para>
  475. </returns></function>
  476. </namespace>
  477. </namespace>
  478. </namespace>
  479. </header>
  480. <header name="boost/numeric/odeint/iterator/const_step_time_iterator.hpp">
  481. <namespace name="boost">
  482. <namespace name="numeric">
  483. <namespace name="odeint">
  484. <class name="const_step_time_iterator"><template>
  485. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  486. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  487. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  488. </template><purpose>ODE Iterator with constant step size. The value type of this iterator is a std::pair containing state and time. </purpose><description><para>Implements an iterator representing the solution of an ODE from t_start to t_end evaluated at steps with constant step size dt. After each iteration the iterator dereferences to a pair containing state and time at the next time point t+dt.. This iterator can be used with Steppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_const routine.</para><para><classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is a pair with the state type and time type of the stepper.</para><para>
  489. </para></description><method-group name="public member functions">
  490. </method-group>
  491. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>time_type</paramtype></parameter><parameter name="t_end"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  492. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  493. </class>
  494. <function name="make_const_step_time_iterator_begin"><type><classname>const_step_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  495. <template-type-parameter name="Stepper"/>
  496. <template-type-parameter name="System"/>
  497. <template-type-parameter name="State"/>
  498. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  499. </para></description><returns><para>The const step time iterator. </para>
  500. </returns></function>
  501. <function name="make_const_step_time_iterator_end"><type><classname>const_step_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  502. <template-type-parameter name="Stepper"/>
  503. <template-type-parameter name="System"/>
  504. <template-type-parameter name="State"/>
  505. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname>. Constructs a end iterator. </purpose><description><para>
  506. </para></description><returns><para>The const step time iterator. </para>
  507. </returns></function>
  508. <function name="make_const_step_time_range"><type>std::pair&lt; <classname>const_step_time_iterator</classname>&lt; Stepper, System, State &gt;, <classname>const_step_time_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  509. <template-type-parameter name="Stepper"/>
  510. <template-type-parameter name="System"/>
  511. <template-type-parameter name="State"/>
  512. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype></parameter><parameter name="t_end"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The end time, at which the iteration should stop. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname>. A range is here a pair of <classname alt="boost::numeric::odeint::const_step_time_iterator">const_step_time_iterator</classname>. </purpose><description><para>
  513. </para></description><returns><para>The const step time range. </para>
  514. </returns></function>
  515. </namespace>
  516. </namespace>
  517. </namespace>
  518. </header>
  519. <header name="boost/numeric/odeint/iterator/n_step_iterator.hpp">
  520. <namespace name="boost">
  521. <namespace name="numeric">
  522. <namespace name="odeint">
  523. <class name="n_step_iterator"><template>
  524. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  525. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  526. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  527. </template><purpose>ODE Iterator with constant step size. The value type of this iterator is the state type of the stepper. </purpose><description><para>Implements an iterator representing the solution of an ODE starting from t with n steps and a constant step size dt. After each iteration the iterator dereferences to the state x at the next time t+dt. This iterator can be used with Steppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_n_steps routine.</para><para><classname alt="boost::numeric::odeint::n_step_iterator">n_step_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.</para><para>
  528. </para></description><method-group name="public member functions">
  529. </method-group>
  530. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter></constructor>
  531. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  532. </class>
  533. <function name="make_n_step_iterator_begin"><type><classname>n_step_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  534. <template-type-parameter name="Stepper"/>
  535. <template-type-parameter name="System"/>
  536. <template-type-parameter name="State"/>
  537. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype><description><para>The number of steps to be executed. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::n_step_iterator">n_step_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  538. </para></description><returns><para>The n-step iterator. </para>
  539. </returns></function>
  540. <function name="make_n_step_iterator_end"><type><classname>n_step_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  541. <template-type-parameter name="Stepper"/>
  542. <template-type-parameter name="System"/>
  543. <template-type-parameter name="State"/>
  544. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::n_step_iterator">n_step_iterator</classname>. Constructs an end iterator. </purpose><description><para>
  545. </para></description><returns><para>The <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. </para>
  546. </returns></function>
  547. <function name="make_n_step_range"><type>std::pair&lt; <classname>n_step_iterator</classname>&lt; Stepper, System, State &gt;, <classname>n_step_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  548. <template-type-parameter name="Stepper"/>
  549. <template-type-parameter name="System"/>
  550. <template-type-parameter name="State"/>
  551. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype><description><para>The number of steps to be executed. </para></description></parameter><purpose>Factory function to construct a single pass range of n-step iterators. A range is here a pair of <classname alt="boost::numeric::odeint::n_step_iterator">n_step_iterator</classname>. </purpose><description><para>
  552. </para></description><returns><para>The n-step range. </para>
  553. </returns></function>
  554. </namespace>
  555. </namespace>
  556. </namespace>
  557. </header>
  558. <header name="boost/numeric/odeint/iterator/n_step_time_iterator.hpp">
  559. <namespace name="boost">
  560. <namespace name="numeric">
  561. <namespace name="odeint">
  562. <class name="n_step_time_iterator"><template>
  563. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  564. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  565. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  566. </template><purpose>ODE Iterator with constant step size. The value type of this iterator is a std::pair containing state and time. </purpose><description><para>Implements an iterator representing the solution of an ODE starting from t with n steps and a constant step size dt. After each iteration the iterator dereferences to a pair of state and time at the next time t+dt. This iterator can be used with Steppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_n_steps routine.</para><para><classname alt="boost::numeric::odeint::n_step_time_iterator">n_step_time_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is pair of state and time.</para><para>
  567. </para></description><method-group name="public member functions">
  568. </method-group>
  569. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype></parameter></constructor>
  570. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  571. </class>
  572. <function name="make_n_step_time_iterator_begin"><type><classname>n_step_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  573. <template-type-parameter name="Stepper"/>
  574. <template-type-parameter name="System"/>
  575. <template-type-parameter name="State"/>
  576. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype><description><para>The number of steps to be executed. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::n_step_time_iterator">n_step_time_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  577. </para></description><returns><para>The n-step iterator. </para>
  578. </returns></function>
  579. <function name="make_n_step_time_iterator_end"><type><classname>n_step_time_iterator</classname>&lt; Stepper, System, State &gt;</type><template>
  580. <template-type-parameter name="Stepper"/>
  581. <template-type-parameter name="System"/>
  582. <template-type-parameter name="State"/>
  583. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::n_step_time_iterator">n_step_time_iterator</classname>. Constructs an end iterator. </purpose><description><para>
  584. </para></description><returns><para>The <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname>. </para>
  585. </returns></function>
  586. <function name="make_n_step_time_range"><type>std::pair&lt; <classname>n_step_time_iterator</classname>&lt; Stepper, System, State &gt;, <classname>n_step_time_iterator</classname>&lt; Stepper, System, State &gt; &gt;</type><template>
  587. <template-type-parameter name="Stepper"/>
  588. <template-type-parameter name="System"/>
  589. <template-type-parameter name="State"/>
  590. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><parameter name="num_of_steps"><paramtype>size_t</paramtype><description><para>The number of steps to be executed. </para></description></parameter><purpose>Factory function to construct a single pass range of n-step iterators. A range is here a pair of <classname alt="boost::numeric::odeint::n_step_time_iterator">n_step_time_iterator</classname>. </purpose><description><para>
  591. </para></description><returns><para>The n-step range. </para>
  592. </returns></function>
  593. </namespace>
  594. </namespace>
  595. </namespace>
  596. </header>
  597. <header name="boost/numeric/odeint/iterator/times_iterator.hpp">
  598. <namespace name="boost">
  599. <namespace name="numeric">
  600. <namespace name="odeint">
  601. <class name="times_iterator"><template>
  602. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  603. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  604. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  605. <template-type-parameter name="TimeIterator"><purpose><para>The iterator type for the sequence of time points. </para></purpose></template-type-parameter>
  606. </template><purpose>ODE Iterator with given evaluation points. The value type of this iterator is the state type of the stepper. </purpose><description><para>Implements an iterator representing the solution of an ODE from *t_start to *t_end evaluated at time points given by the sequence t_start to t_end. t_start and t_end are iterators representing a sequence of time points where the solution of the ODE should be evaluated. After each iteration the iterator dereferences to the state x at the next time *t_start++ until t_end is reached. This iterator can be used with Steppers, ControlledSteppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_times routine.</para><para><classname alt="boost::numeric::odeint::times_iterator">times_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.</para><para>
  607. </para></description><method-group name="public member functions">
  608. </method-group>
  609. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  610. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  611. </class>
  612. <function name="make_times_iterator_begin"><type><classname>times_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;</type><template>
  613. <template-type-parameter name="Stepper"/>
  614. <template-type-parameter name="System"/>
  615. <template-type-parameter name="State"/>
  616. <template-type-parameter name="TimeIterator"/>
  617. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype><description><para>Begin iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype><description><para>End iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::times_iterator">times_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  618. </para></description><returns><para>The times iterator. </para>
  619. </returns></function>
  620. <function name="make_times_iterator_end"><type><classname>times_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;</type><template>
  621. <template-type-parameter name="TimeIterator"/>
  622. <template-type-parameter name="Stepper"/>
  623. <template-type-parameter name="System"/>
  624. <template-type-parameter name="State"/>
  625. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::times_iterator">times_iterator</classname>. Constructs an end iterator. </purpose><description><para>
  626. This function needs the TimeIterator type specifically defined as a template parameter. </para></description><returns><para>The times iterator.</para>
  627. </returns></function>
  628. <function name="make_times_range"><type>std::pair&lt; <classname>times_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;, <classname>times_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt; &gt;</type><template>
  629. <template-type-parameter name="Stepper"/>
  630. <template-type-parameter name="System"/>
  631. <template-type-parameter name="State"/>
  632. <template-type-parameter name="TimeIterator"/>
  633. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype><description><para>Begin iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype><description><para>End iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of times iterators. A range is here a pair of <classname alt="boost::numeric::odeint::times_iterator">times_iterator</classname>. </purpose><description><para>
  634. </para></description><returns><para>The times iterator range. </para>
  635. </returns></function>
  636. </namespace>
  637. </namespace>
  638. </namespace>
  639. </header>
  640. <header name="boost/numeric/odeint/iterator/times_time_iterator.hpp">
  641. <namespace name="boost">
  642. <namespace name="numeric">
  643. <namespace name="odeint">
  644. <class name="times_time_iterator"><template>
  645. <template-type-parameter name="Stepper"><purpose><para>The stepper type which should be used during the iteration. </para></purpose></template-type-parameter>
  646. <template-type-parameter name="System"><purpose><para>The type of the system function (ODE) which should be solved. </para></purpose></template-type-parameter>
  647. <template-type-parameter name="State"><purpose><para>The state type of the ODE. </para></purpose></template-type-parameter>
  648. <template-type-parameter name="TimeIterator"><purpose><para>The iterator type for the sequence of time points. </para></purpose></template-type-parameter>
  649. </template><purpose>ODE Iterator with given evaluation points. The value type of this iterator is a std::pair containing state and time. </purpose><description><para>Implements an iterator representing the solution of an ODE from *t_start to *t_end evaluated at time points given by the sequence t_start to t_end. t_start and t_end are iterators representing a sequence of time points where the solution of the ODE should be evaluated. After each iteration the iterator dereferences to a pair with the state and the time at the next evaluation point *t_start++ until t_end is reached. This iterator can be used with Steppers, ControlledSteppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_times routine.</para><para><classname alt="boost::numeric::odeint::times_time_iterator">times_time_iterator</classname> is a model of single-pass iterator.</para><para>The value type of this iterator is a pair of state and time type.</para><para>
  650. </para></description><method-group name="public member functions">
  651. </method-group>
  652. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></constructor>
  653. <constructor><parameter name="stepper"><paramtype>Stepper</paramtype></parameter><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="s"><paramtype>State &amp;</paramtype></parameter></constructor>
  654. </class>
  655. <function name="make_times_time_iterator_begin"><type><classname>times_time_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;</type><template>
  656. <template-type-parameter name="Stepper"/>
  657. <template-type-parameter name="System"/>
  658. <template-type-parameter name="State"/>
  659. <template-type-parameter name="TimeIterator"/>
  660. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype><description><para>Begin iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype><description><para>End iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::times_time_iterator">times_time_iterator</classname>. Constructs a begin iterator. </purpose><description><para>
  661. </para></description><returns><para>The times_time iterator. </para>
  662. </returns></function>
  663. <function name="make_times_time_iterator_end"><type><classname>times_time_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;</type><template>
  664. <template-type-parameter name="TimeIterator"/>
  665. <template-type-parameter name="Stepper"/>
  666. <template-type-parameter name="System"/>
  667. <template-type-parameter name="State"/>
  668. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> stores a reference of s and changes its value during the iteration. </para></description></parameter><purpose>Factory function for <classname alt="boost::numeric::odeint::times_time_iterator">times_time_iterator</classname>. Constructs an end iterator. </purpose><description><para>
  669. This function needs the TimeIterator type specifically defined as a template parameter. </para></description><returns><para>The times_time iterator.</para>
  670. </returns></function>
  671. <function name="make_times_time_range"><type>std::pair&lt; <classname>times_time_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt;, <classname>times_time_iterator</classname>&lt; Stepper, System, State, TimeIterator &gt; &gt;</type><template>
  672. <template-type-parameter name="Stepper"/>
  673. <template-type-parameter name="System"/>
  674. <template-type-parameter name="State"/>
  675. <template-type-parameter name="TimeIterator"/>
  676. </template><parameter name="stepper"><paramtype>Stepper</paramtype><description><para>The stepper to use during the iteration. </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function (ODE) to solve. </para></description></parameter><parameter name="x"><paramtype>State &amp;</paramtype><description><para>The initial state. <classname alt="boost::numeric::odeint::const_step_iterator">const_step_iterator</classname> store a reference of s and changes its value during the iteration. </para></description></parameter><parameter name="t_start"><paramtype>TimeIterator</paramtype><description><para>Begin iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="t_end"><paramtype>TimeIterator</paramtype><description><para>End iterator of the sequence of evaluation time points. </para></description></parameter><parameter name="dt"><paramtype>typename traits::time_type&lt; Stepper &gt;::type</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Factory function to construct a single pass range of times_time iterators. A range is here a pair of <classname alt="boost::numeric::odeint::times_iterator">times_iterator</classname>. </purpose><description><para>
  677. </para></description><returns><para>The times_time iterator range. </para>
  678. </returns></function>
  679. </namespace>
  680. </namespace>
  681. </namespace>
  682. </header>
  683. <header name="boost/numeric/odeint/stepper/adams_bashforth.hpp">
  684. <namespace name="boost">
  685. <namespace name="numeric">
  686. <namespace name="odeint">
  687. <class name="adams_bashforth"><template>
  688. <template-nontype-parameter name="Steps"><type>size_t</type><purpose><para>The number of steps (maximal 8). </para></purpose></template-nontype-parameter>
  689. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  690. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  691. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  692. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  693. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  694. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  695. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  696. <template-type-parameter name="InitializingStepper"><default><classname alt="boost::numeric::odeint::extrapolation_stepper">extrapolation_stepper</classname>&lt; order_helper&lt;Steps&gt;::value, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</default><purpose><para>The stepper for the first two steps. </para></purpose></template-type-parameter>
  697. </template><inherit access="public">algebra_stepper_base&lt; Algebra, Operations &gt;</inherit><purpose>The Adams-Bashforth multistep algorithm. </purpose><description><para>The Adams-Bashforth method is a multi-step algorithm with configurable step number. The step number is specified as template parameter Steps and it then uses the result from the previous Steps steps. See also <ulink url="http://en.wikipedia.org/wiki/Linear_multistep_method">en.wikipedia.org/wiki/Linear_multistep_method</ulink>. Currently, a maximum of Steps=8 is supported. The method is explicit and fulfills the Stepper concept. Step size control or continuous output are not provided.</para><para>This class derives from algebra_base and inherits its interface via CRTP (current recurring template pattern). For more details see algebra_stepper_base.</para><para>
  698. </para></description><typedef name="state_type"><type>State</type></typedef>
  699. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  700. <typedef name="value_type"><type>Value</type></typedef>
  701. <typedef name="deriv_type"><type>Deriv</type></typedef>
  702. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  703. <typedef name="time_type"><type>Time</type></typedef>
  704. <typedef name="resizer_type"><type>Resizer</type></typedef>
  705. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  706. <typedef name="initializing_stepper_type"><type>InitializingStepper</type></typedef>
  707. <typedef name="algebra_stepper_base_type"><type>algebra_stepper_base&lt; Algebra, Operations &gt;</type></typedef>
  708. <typedef name="algebra_type"><type>algebra_stepper_base_type::algebra_type</type></typedef>
  709. <typedef name="operations_type"><type>algebra_stepper_base_type::operations_type</type></typedef>
  710. <typedef name="order_type"><type>unsigned short</type></typedef>
  711. <typedef name="step_storage_type"><type><emphasis>unspecified</emphasis></type></typedef>
  712. <data-member name="steps" specifiers="static"><type>const size_t</type></data-member>
  713. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  714. <method-group name="public member functions">
  715. <method name="order" cv="const"><type>order_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the order of the algorithm, which is equal to the number of steps. </purpose><description><para>
  716. </para></description><returns><para>order of the method. </para>
  717. </returns></method>
  718. <method name="do_step"><type>void</type><template>
  719. <template-type-parameter name="System"/>
  720. <template-type-parameter name="StateInOut"/>
  721. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. After calling do_step the result is updated in x. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. It transforms the result in-place. </purpose><description><para>
  722. </para></description></method>
  723. <method name="do_step"><type>void</type><template>
  724. <template-type-parameter name="System"/>
  725. <template-type-parameter name="StateInOut"/>
  726. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut. </purpose></method>
  727. <method name="do_step"><type>void</type><template>
  728. <template-type-parameter name="System"/>
  729. <template-type-parameter name="StateIn"/>
  730. <template-type-parameter name="StateOut"/>
  731. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>The method performs one step with the stepper passed by Stepper. The state of the ODE is updated out-of-place. </purpose><description><para>
  732. </para></description></method>
  733. <method name="do_step"><type>void</type><template>
  734. <template-type-parameter name="System"/>
  735. <template-type-parameter name="StateIn"/>
  736. <template-type-parameter name="StateOut"/>
  737. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>const StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as StateOut. </purpose></method>
  738. <method name="adjust_size"><type>void</type><template>
  739. <template-type-parameter name="StateType"/>
  740. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  741. </para></description></method>
  742. <method name="step_storage" cv="const"><type>const step_storage_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the storage of intermediate results. </purpose><description><para>
  743. </para></description><returns><para>The storage of intermediate results. </para>
  744. </returns></method>
  745. <method name="step_storage"><type>step_storage_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the storage of intermediate results. </purpose><description><para>
  746. </para></description><returns><para>The storage of intermediate results. </para>
  747. </returns></method>
  748. <method name="initialize"><type>void</type><template>
  749. <template-type-parameter name="ExplicitStepper"/>
  750. <template-type-parameter name="System"/>
  751. <template-type-parameter name="StateIn"/>
  752. </template><parameter name="explicit_stepper"><paramtype>ExplicitStepper</paramtype><description><para>the stepper used to fill the buffer of previous step results </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. After calling do_step the result is updated in x. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>Initialized the stepper. Does Steps-1 steps with the explicit_stepper to fill the buffer. </purpose><description><para>
  753. </para></description></method>
  754. <method name="initialize"><type>void</type><template>
  755. <template-type-parameter name="System"/>
  756. <template-type-parameter name="StateIn"/>
  757. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateIn &amp;</paramtype><description><para>The initial state of the ODE which should be solved, updated in this method. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The initial value of the time, updated in this method. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>Initialized the stepper. Does Steps-1 steps with an internal instance of InitializingStepper to fill the buffer. </purpose><description><para><note><para>The state x and time t are updated to the values after Steps-1 initial steps. </para>
  758. </note>
  759. </para></description></method>
  760. <method name="reset"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Resets the internal buffer of the stepper. </purpose></method>
  761. <method name="is_initialized" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns true if the stepper has been initialized. </purpose><description><para>
  762. </para></description><returns><para>bool true if stepper is initialized, false otherwise </para>
  763. </returns></method>
  764. <method name="initializing_stepper" cv="const"><type>const initializing_stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the internal initializing stepper instance. </purpose><description><para>
  765. </para></description><returns><para>initializing_stepper </para>
  766. </returns></method>
  767. <method name="initializing_stepper"><type>initializing_stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the internal initializing stepper instance. </purpose><description><para>
  768. </para></description><returns><para>initializing_stepper </para>
  769. </returns></method>
  770. </method-group>
  771. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::adams_bashforth">adams_bashforth</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  772. </para></description></constructor>
  773. <method-group name="private member functions">
  774. <method name="do_step_impl"><type>void</type><template>
  775. <template-type-parameter name="System"/>
  776. <template-type-parameter name="StateIn"/>
  777. <template-type-parameter name="StateOut"/>
  778. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  779. <method name="resize_impl"><type>bool</type><template>
  780. <template-type-parameter name="StateIn"/>
  781. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  782. </method-group>
  783. </class><struct name="order_helper"><template>
  784. <template-nontype-parameter name="N"><type>int</type></template-nontype-parameter>
  785. </template><inherit access="public">boost::mpl::max::type&lt; mpl::eval_if&lt; mpl::equal_to&lt; mpl::modulus&lt; int_&lt; N &gt;, int_&lt; 2 &gt; &gt;, int_&lt; 0 &gt; &gt;, int_&lt; N &gt;, int_&lt; N+1 &gt; &gt;::type, int_&lt; 4 &gt; &gt;</inherit></struct>
  786. </namespace>
  787. </namespace>
  788. </namespace>
  789. </header>
  790. <header name="boost/numeric/odeint/stepper/adams_bashforth_moulton.hpp">
  791. <namespace name="boost">
  792. <namespace name="numeric">
  793. <namespace name="odeint">
  794. <class name="adams_bashforth_moulton"><template>
  795. <template-nontype-parameter name="Steps"><type>size_t</type><purpose><para>The number of steps (maximal 8). </para></purpose></template-nontype-parameter>
  796. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  797. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  798. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  799. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  800. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  801. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  802. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  803. <template-type-parameter name="InitializingStepper"><default><classname alt="boost::numeric::odeint::runge_kutta4">runge_kutta4</classname>&lt; State , Value , Deriv , Time , Algebra , Operations, Resizer &gt;</default><purpose><para>The stepper for the first two steps. </para></purpose></template-type-parameter>
  804. </template><purpose>The Adams-Bashforth-Moulton multistep algorithm. </purpose><description><para>The Adams-Bashforth method is a multi-step predictor-corrector algorithm with configurable step number. The step number is specified as template parameter Steps and it then uses the result from the previous Steps steps. See also <ulink url="http://en.wikipedia.org/wiki/Linear_multistep_method">en.wikipedia.org/wiki/Linear_multistep_method</ulink>. Currently, a maximum of Steps=8 is supported. The method is explicit and fulfills the Stepper concept. Step size control or continuous output are not provided.</para><para>This class derives from algebra_base and inherits its interface via CRTP (current recurring template pattern). For more details see algebra_stepper_base.</para><para>
  805. </para></description><typedef name="state_type"><type>State</type></typedef>
  806. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  807. <typedef name="value_type"><type>Value</type></typedef>
  808. <typedef name="deriv_type"><type>Deriv</type></typedef>
  809. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  810. <typedef name="time_type"><type>Time</type></typedef>
  811. <typedef name="algebra_type"><type>Algebra</type></typedef>
  812. <typedef name="operations_type"><type>Operations</type></typedef>
  813. <typedef name="resizer_type"><type>Resizer</type></typedef>
  814. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  815. <typedef name="initializing_stepper_type"><type>InitializingStepper</type></typedef>
  816. <typedef name="order_type"><type>unsigned short</type></typedef>
  817. <data-member name="steps" specifiers="static"><type>const size_t</type></data-member>
  818. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  819. <method-group name="public member functions">
  820. <method name="order" cv="const"><type>order_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the order of the algorithm, which is equal to the number of steps+1. </purpose><description><para>
  821. </para></description><returns><para>order of the method. </para>
  822. </returns></method>
  823. <method name="do_step"><type>void</type><template>
  824. <template-type-parameter name="System"/>
  825. <template-type-parameter name="StateInOut"/>
  826. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. After calling do_step the result is updated in x. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. It transforms the result in-place. </purpose><description><para>
  827. </para></description></method>
  828. <method name="do_step"><type>void</type><template>
  829. <template-type-parameter name="System"/>
  830. <template-type-parameter name="StateInOut"/>
  831. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as StateInOut. </purpose></method>
  832. <method name="do_step"><type>void</type><template>
  833. <template-type-parameter name="System"/>
  834. <template-type-parameter name="StateIn"/>
  835. <template-type-parameter name="StateOut"/>
  836. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>const StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>The method performs one step with the stepper passed by Stepper. The state of the ODE is updated out-of-place. </purpose><description><para>
  837. </para></description></method>
  838. <method name="do_step"><type>void</type><template>
  839. <template-type-parameter name="System"/>
  840. <template-type-parameter name="StateIn"/>
  841. <template-type-parameter name="StateOut"/>
  842. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be called with Boost.Range as StateOut. </purpose></method>
  843. <method name="adjust_size"><type>void</type><template>
  844. <template-type-parameter name="StateType"/>
  845. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  846. </para></description></method>
  847. <method name="initialize"><type>void</type><template>
  848. <template-type-parameter name="ExplicitStepper"/>
  849. <template-type-parameter name="System"/>
  850. <template-type-parameter name="StateIn"/>
  851. </template><parameter name="explicit_stepper"><paramtype>ExplicitStepper</paramtype><description><para>the stepper used to fill the buffer of previous step results </para></description></parameter><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateIn &amp;</paramtype><description><para>The initial state of the ODE which should be solved, updated after in this method. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The initial time, updated in this method. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>Initialized the stepper. Does Steps-1 steps with the explicit_stepper to fill the buffer. </purpose><description><para><note><para>The state x and time t are updated to the values after Steps-1 initial steps. </para>
  852. </note>
  853. </para></description></method>
  854. <method name="initialize"><type>void</type><template>
  855. <template-type-parameter name="System"/>
  856. <template-type-parameter name="StateIn"/>
  857. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. After calling do_step the result is updated in x. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>Initialized the stepper. Does Steps-1 steps using the standard initializing stepper of the underlying <classname alt="boost::numeric::odeint::adams_bashforth">adams_bashforth</classname> stepper. </purpose><description><para>
  858. </para></description></method>
  859. <method name="reset"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Resets the internal buffers of the stepper. </purpose></method>
  860. </method-group>
  861. <constructor><parameter name=""><paramtype>void</paramtype></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::adams_bashforth">adams_bashforth</classname> class. </purpose></constructor>
  862. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><description><para>A copy of algebra is made and stored. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::adams_bashforth">adams_bashforth</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  863. </para></description></constructor>
  864. <method-group name="private member functions">
  865. <method name="do_step_impl1"><type>void</type><template>
  866. <template-type-parameter name="System"/>
  867. <template-type-parameter name="StateInOut"/>
  868. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  869. <method name="do_step_impl2"><type>void</type><template>
  870. <template-type-parameter name="System"/>
  871. <template-type-parameter name="StateIn"/>
  872. <template-type-parameter name="StateInOut"/>
  873. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>StateIn const &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  874. <method name="resize_impl"><type>bool</type><template>
  875. <template-type-parameter name="StateIn"/>
  876. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  877. </method-group>
  878. </class>
  879. </namespace>
  880. </namespace>
  881. </namespace>
  882. </header>
  883. <header name="boost/numeric/odeint/stepper/adams_moulton.hpp">
  884. <namespace name="boost">
  885. <namespace name="numeric">
  886. <namespace name="odeint">
  887. <class name="adams_moulton"><template>
  888. <template-nontype-parameter name="Steps"><type>size_t</type></template-nontype-parameter>
  889. <template-type-parameter name="State"/>
  890. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  891. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  892. <template-type-parameter name="Time"><default>Value</default></template-type-parameter>
  893. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  894. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default></template-type-parameter>
  895. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  896. </template><typedef name="state_type"><type>State</type></typedef>
  897. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  898. <typedef name="value_type"><type>Value</type></typedef>
  899. <typedef name="deriv_type"><type>Deriv</type></typedef>
  900. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  901. <typedef name="time_type"><type>Time</type></typedef>
  902. <typedef name="algebra_type"><type>Algebra</type></typedef>
  903. <typedef name="operations_type"><type>Operations</type></typedef>
  904. <typedef name="resizer_type"><type>Resizer</type></typedef>
  905. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  906. <typedef name="stepper_type"><type>adams_moulton&lt; Steps, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</type></typedef>
  907. <typedef name="order_type"><type>unsigned short</type></typedef>
  908. <typedef name="step_storage_type"><type><emphasis>unspecified</emphasis></type></typedef>
  909. <data-member name="steps" specifiers="static"><type>const size_t</type></data-member>
  910. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  911. <method-group name="public member functions">
  912. <method name="order" cv="const"><type>order_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  913. <method name="do_step"><type>void</type><template>
  914. <template-type-parameter name="System"/>
  915. <template-type-parameter name="StateInOut"/>
  916. <template-type-parameter name="StateIn"/>
  917. <template-type-parameter name="ABBuf"/>
  918. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="pred"><paramtype>StateIn const &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="buf"><paramtype>const ABBuf &amp;</paramtype></parameter></method>
  919. <method name="do_step"><type>void</type><template>
  920. <template-type-parameter name="System"/>
  921. <template-type-parameter name="StateInOut"/>
  922. <template-type-parameter name="StateIn"/>
  923. <template-type-parameter name="ABBuf"/>
  924. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype></parameter><parameter name="pred"><paramtype>StateIn const &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="buf"><paramtype>const ABBuf &amp;</paramtype></parameter></method>
  925. <method name="do_step"><type>void</type><template>
  926. <template-type-parameter name="System"/>
  927. <template-type-parameter name="StateIn"/>
  928. <template-type-parameter name="PredIn"/>
  929. <template-type-parameter name="StateOut"/>
  930. <template-type-parameter name="ABBuf"/>
  931. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="pred"><paramtype>const PredIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="buf"><paramtype>const ABBuf &amp;</paramtype></parameter></method>
  932. <method name="do_step"><type>void</type><template>
  933. <template-type-parameter name="System"/>
  934. <template-type-parameter name="StateIn"/>
  935. <template-type-parameter name="PredIn"/>
  936. <template-type-parameter name="StateOut"/>
  937. <template-type-parameter name="ABBuf"/>
  938. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="pred"><paramtype>const PredIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>const StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="buf"><paramtype>const ABBuf &amp;</paramtype></parameter></method>
  939. <method name="adjust_size"><type>void</type><template>
  940. <template-type-parameter name="StateType"/>
  941. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  942. <method name="algebra"><type>algebra_type &amp;</type></method>
  943. <method name="algebra" cv="const"><type>const algebra_type &amp;</type></method>
  944. </method-group>
  945. <constructor/>
  946. <constructor><parameter name="algebra"><paramtype>algebra_type &amp;</paramtype></parameter></constructor>
  947. <copy-assignment><type>adams_moulton &amp;</type><parameter name="stepper"><paramtype>const adams_moulton &amp;</paramtype></parameter></copy-assignment>
  948. <method-group name="private member functions">
  949. <method name="do_step_impl"><type>void</type><template>
  950. <template-type-parameter name="System"/>
  951. <template-type-parameter name="StateIn"/>
  952. <template-type-parameter name="PredIn"/>
  953. <template-type-parameter name="StateOut"/>
  954. <template-type-parameter name="ABBuf"/>
  955. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="pred"><paramtype>const PredIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="buf"><paramtype>const ABBuf &amp;</paramtype></parameter></method>
  956. <method name="resize_impl"><type>bool</type><template>
  957. <template-type-parameter name="StateIn"/>
  958. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  959. </method-group>
  960. </class>
  961. </namespace>
  962. </namespace>
  963. </namespace>
  964. </header>
  965. <header name="boost/numeric/odeint/stepper/adaptive_adams_bashforth_moulton.hpp">
  966. <namespace name="boost">
  967. <namespace name="numeric">
  968. <namespace name="odeint">
  969. <class name="adaptive_adams_bashforth_moulton"><template>
  970. <template-nontype-parameter name="Steps"><type>size_t</type></template-nontype-parameter>
  971. <template-type-parameter name="State"/>
  972. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  973. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  974. <template-type-parameter name="Time"><default>Value</default></template-type-parameter>
  975. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  976. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default></template-type-parameter>
  977. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  978. </template><inherit access="public">algebra_stepper_base&lt; Algebra, Operations &gt;</inherit><typedef name="order_type"><type>unsigned short</type></typedef>
  979. <typedef name="state_type"><type>State</type></typedef>
  980. <typedef name="value_type"><type>Value</type></typedef>
  981. <typedef name="deriv_type"><type>Deriv</type></typedef>
  982. <typedef name="time_type"><type>Time</type></typedef>
  983. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  984. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  985. <typedef name="algebra_stepper_base_type"><type>algebra_stepper_base&lt; Algebra, Operations &gt;</type></typedef>
  986. <typedef name="algebra_type"><type>algebra_stepper_base_type::algebra_type</type></typedef>
  987. <typedef name="operations_type"><type>algebra_stepper_base_type::operations_type</type></typedef>
  988. <typedef name="resizer_type"><type>Resizer</type></typedef>
  989. <typedef name="stepper_category"><type>error_stepper_tag</type></typedef>
  990. <typedef name="coeff_type"><type><emphasis>unspecified</emphasis></type></typedef>
  991. <typedef name="stepper_type"><type>adaptive_adams_bashforth_moulton&lt; Steps, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</type></typedef>
  992. <data-member name="steps" specifiers="static"><type>const size_t</type></data-member>
  993. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  994. <method-group name="public member functions">
  995. <method name="order" cv="const"><type>order_type</type></method>
  996. <method name="stepper_order" cv="const"><type>order_type</type></method>
  997. <method name="error_order" cv="const"><type>order_type</type></method>
  998. <method name="do_step"><type>void</type><template>
  999. <template-type-parameter name="System"/>
  1000. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1001. <method name="do_step"><type>void</type><template>
  1002. <template-type-parameter name="System"/>
  1003. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1004. <method name="do_step"><type>void</type><template>
  1005. <template-type-parameter name="System"/>
  1006. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>state_type &amp;</paramtype></parameter></method>
  1007. <method name="do_step"><type>void</type><template>
  1008. <template-type-parameter name="System"/>
  1009. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>state_type &amp;</paramtype></parameter></method>
  1010. <method name="initialize"><type>void</type><template>
  1011. <template-type-parameter name="ExplicitStepper"/>
  1012. <template-type-parameter name="System"/>
  1013. </template><parameter name="stepper"><paramtype>ExplicitStepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1014. <method name="initialize"><type>void</type><template>
  1015. <template-type-parameter name="System"/>
  1016. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1017. <method name="do_step_impl"><type>void</type><template>
  1018. <template-type-parameter name="System"/>
  1019. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter><parameter name="xerr"><paramtype>state_type &amp;</paramtype></parameter></method>
  1020. <method name="coeff" cv="const"><type>const coeff_type &amp;</type></method>
  1021. <method name="coeff"><type>coeff_type &amp;</type></method>
  1022. <method name="reset"><type>void</type></method>
  1023. <method name="dxdt" cv="const"><type>const deriv_type &amp;</type></method>
  1024. </method-group>
  1025. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default></parameter></constructor>
  1026. <method-group name="private member functions">
  1027. <method name="resize_dxdt_impl"><type>bool</type><template>
  1028. <template-type-parameter name="StateType"/>
  1029. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1030. <method name="resize_xnew_impl"><type>bool</type><template>
  1031. <template-type-parameter name="StateType"/>
  1032. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1033. <method name="resize_xerr_impl"><type>bool</type><template>
  1034. <template-type-parameter name="StateType"/>
  1035. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1036. </method-group>
  1037. </class>
  1038. </namespace>
  1039. </namespace>
  1040. </namespace>
  1041. </header>
  1042. <header name="boost/numeric/odeint/stepper/bulirsch_stoer.hpp">
  1043. <namespace name="boost">
  1044. <namespace name="numeric">
  1045. <namespace name="odeint">
  1046. <class name="bulirsch_stoer"><template>
  1047. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  1048. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  1049. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  1050. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  1051. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1052. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1053. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1054. </template><purpose>The Bulirsch-Stoer algorithm. </purpose><description><para>The Bulirsch-Stoer is a controlled stepper that adjusts both step size and order of the method. The algorithm uses the modified midpoint and a polynomial extrapolation compute the solution.</para><para>
  1055. </para></description><typedef name="state_type"><type>State</type></typedef>
  1056. <typedef name="value_type"><type>Value</type></typedef>
  1057. <typedef name="deriv_type"><type>Deriv</type></typedef>
  1058. <typedef name="time_type"><type>Time</type></typedef>
  1059. <typedef name="algebra_type"><type>Algebra</type></typedef>
  1060. <typedef name="operations_type"><type>Operations</type></typedef>
  1061. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1062. <data-member name="m_k_max" specifiers="static"><type>const size_t</type></data-member>
  1063. <method-group name="public member functions">
  1064. <method name="try_step"><type>controlled_step_result</type><template>
  1065. <template-type-parameter name="System"/>
  1066. <template-type-parameter name="StateInOut"/>
  1067. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed. Also, the internal order of the stepper is adjusted if required.</para><para>
  1068. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1069. </returns></method>
  1070. <method name="try_step"><type>controlled_step_result</type><template>
  1071. <template-type-parameter name="System"/>
  1072. <template-type-parameter name="StateInOut"/>
  1073. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter><purpose>Second version to solve the forwarding problem, can be used with Boost.Range as StateInOut. </purpose></method>
  1074. <method name="try_step"><type>controlled_step_result</type><template>
  1075. <template-type-parameter name="System"/>
  1076. <template-type-parameter name="StateInOut"/>
  1077. <template-type-parameter name="DerivIn"/>
  1078. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed. Also, the internal order of the stepper is adjusted if required.</para><para>
  1079. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1080. </returns></method>
  1081. <method name="try_step"><type>boost::disable_if&lt; boost::is_same&lt; StateIn, time_type &gt;, controlled_step_result &gt;::type</type><template>
  1082. <template-type-parameter name="System"/>
  1083. <template-type-parameter name="StateIn"/>
  1084. <template-type-parameter name="StateOut"/>
  1085. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para><note><para>This method is disabled if state_type=time_type to avoid ambiguity.</para>
  1086. </note>
  1087. This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed. Also, the internal order of the stepper is adjusted if required.</para><para>
  1088. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1089. </returns></method>
  1090. <method name="try_step"><type>controlled_step_result</type><template>
  1091. <template-type-parameter name="System"/>
  1092. <template-type-parameter name="StateIn"/>
  1093. <template-type-parameter name="DerivIn"/>
  1094. <template-type-parameter name="StateOut"/>
  1095. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed. Also, the internal order of the stepper is adjusted if required.</para><para>
  1096. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1097. </returns></method>
  1098. <method name="reset"><type>void</type><purpose>Resets the internal state of the stepper. </purpose></method>
  1099. <method name="adjust_size"><type>void</type><template>
  1100. <template-type-parameter name="StateIn"/>
  1101. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1102. </para></description></method>
  1103. </method-group>
  1104. <constructor><parameter name="eps_abs"><paramtype>value_type</paramtype><default>1E-6</default><description><para>Absolute tolerance level. </para></description></parameter><parameter name="eps_rel"><paramtype>value_type</paramtype><default>1E-6</default><description><para>Relative tolerance level. </para></description></parameter><parameter name="factor_x"><paramtype>value_type</paramtype><default>1.0</default><description><para>Factor for the weight of the state. </para></description></parameter><parameter name="factor_dxdt"><paramtype>value_type</paramtype><default>1.0</default><description><para>Factor for the weight of the derivative. </para></description></parameter><parameter name="max_dt"><paramtype>time_type</paramtype><default>static_cast&lt; time_type &gt;(0)</default></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::bulirsch_stoer">bulirsch_stoer</classname> class, including initialization of the error bounds. </purpose><description><para>
  1105. </para></description></constructor>
  1106. <method-group name="private member functions">
  1107. <method name="resize_m_dxdt"><type>bool</type><template>
  1108. <template-type-parameter name="StateIn"/>
  1109. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1110. <method name="resize_m_xnew"><type>bool</type><template>
  1111. <template-type-parameter name="StateIn"/>
  1112. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1113. <method name="resize_impl"><type>bool</type><template>
  1114. <template-type-parameter name="StateIn"/>
  1115. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1116. <method name="try_step_v1"><type>controlled_step_result</type><template>
  1117. <template-type-parameter name="System"/>
  1118. <template-type-parameter name="StateInOut"/>
  1119. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1120. <method name="extrapolate"><type>void</type><template>
  1121. <template-type-parameter name="StateInOut"/>
  1122. </template><parameter name="k"><paramtype>size_t</paramtype></parameter><parameter name="table"><paramtype>state_table_type &amp;</paramtype></parameter><parameter name="coeff"><paramtype>const value_matrix &amp;</paramtype></parameter><parameter name="xest"><paramtype>StateInOut &amp;</paramtype></parameter></method>
  1123. <method name="calc_h_opt" cv="const"><type>time_type</type><parameter name="h"><paramtype>time_type</paramtype></parameter><parameter name="error"><paramtype>value_type</paramtype></parameter><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1124. <method name="set_k_opt"><type>controlled_step_result</type><parameter name="k"><paramtype>size_t</paramtype></parameter><parameter name="work"><paramtype>const inv_time_vector &amp;</paramtype></parameter><parameter name="h_opt"><paramtype>const time_vector &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1125. <method name="in_convergence_window" cv="const"><type>bool</type><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1126. <method name="should_reject" cv="const"><type>bool</type><parameter name="error"><paramtype>value_type</paramtype></parameter><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1127. </method-group>
  1128. </class>
  1129. </namespace>
  1130. </namespace>
  1131. </namespace>
  1132. </header>
  1133. <header name="boost/numeric/odeint/stepper/bulirsch_stoer_dense_out.hpp">
  1134. <namespace name="boost">
  1135. <namespace name="numeric">
  1136. <namespace name="odeint">
  1137. <class name="bulirsch_stoer_dense_out"><template>
  1138. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  1139. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  1140. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  1141. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  1142. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1143. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1144. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1145. </template><purpose>The Bulirsch-Stoer algorithm. </purpose><description><para>The Bulirsch-Stoer is a controlled stepper that adjusts both step size and order of the method. The algorithm uses the modified midpoint and a polynomial extrapolation compute the solution. This class also provides dense output facility.</para><para>
  1146. </para></description><typedef name="state_type"><type>State</type></typedef>
  1147. <typedef name="value_type"><type>Value</type></typedef>
  1148. <typedef name="deriv_type"><type>Deriv</type></typedef>
  1149. <typedef name="time_type"><type>Time</type></typedef>
  1150. <typedef name="algebra_type"><type>Algebra</type></typedef>
  1151. <typedef name="operations_type"><type>Operations</type></typedef>
  1152. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1153. <typedef name="stepper_category"><type>dense_output_stepper_tag</type></typedef>
  1154. <data-member name="m_k_max" specifiers="static"><type>const size_t</type></data-member>
  1155. <method-group name="public member functions">
  1156. <method name="try_step"><type>controlled_step_result</type><template>
  1157. <template-type-parameter name="System"/>
  1158. <template-type-parameter name="StateIn"/>
  1159. <template-type-parameter name="DerivIn"/>
  1160. <template-type-parameter name="StateOut"/>
  1161. <template-type-parameter name="DerivOut"/>
  1162. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dxdt_new"><paramtype>DerivOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed. Also, the internal order of the stepper is adjusted if required.</para><para>
  1163. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1164. </returns></method>
  1165. <method name="initialize"><type>void</type><template>
  1166. <template-type-parameter name="StateType"/>
  1167. </template><parameter name="x0"><paramtype>const StateType &amp;</paramtype><description><para>The initial state. </para></description></parameter><parameter name="t0"><paramtype>const time_type &amp;</paramtype><description><para>The initial time. </para></description></parameter><parameter name="dt0"><paramtype>const time_type &amp;</paramtype><description><para>The initial time step. </para></description></parameter><purpose>Initializes the dense output stepper. </purpose><description><para>
  1168. </para></description></method>
  1169. <method name="do_step"><type>std::pair&lt; time_type, time_type &gt;</type><template>
  1170. <template-type-parameter name="System"/>
  1171. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><purpose>Does one time step. This is the main method that should be used to integrate an ODE with this stepper. </purpose><description><para><note><para>initialize has to be called before using this method to set the initial conditions x,t and the stepsize. </para>
  1172. </note>
  1173. </para></description><returns><para>Pair with start and end time of the integration step. </para>
  1174. </returns></method>
  1175. <method name="calc_state" cv="const"><type>void</type><template>
  1176. <template-type-parameter name="StateOut"/>
  1177. </template><parameter name="t"><paramtype>time_type</paramtype><description><para>The time at which the solution should be calculated, has to be in the current time interval. </para></description></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype><description><para>The output variable where the result is written into. </para></description></parameter><purpose>Calculates the solution at an intermediate point within the last step. </purpose><description><para>
  1178. </para></description></method>
  1179. <method name="current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current state of the solution. </purpose><description><para>
  1180. </para></description><returns><para>The current state of the solution x(t). </para>
  1181. </returns></method>
  1182. <method name="current_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current time of the solution. </purpose><description><para>
  1183. </para></description><returns><para>The current time of the solution t. </para>
  1184. </returns></method>
  1185. <method name="previous_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the last state of the solution. </purpose><description><para>
  1186. </para></description><returns><para>The last state of the solution x(t-dt). </para>
  1187. </returns></method>
  1188. <method name="previous_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the last time of the solution. </purpose><description><para>
  1189. </para></description><returns><para>The last time of the solution t-dt. </para>
  1190. </returns></method>
  1191. <method name="current_time_step" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current step size. </purpose><description><para>
  1192. </para></description><returns><para>The current step size. </para>
  1193. </returns></method>
  1194. <method name="reset"><type>void</type><purpose>Resets the internal state of the stepper. </purpose></method>
  1195. <method name="adjust_size"><type>void</type><template>
  1196. <template-type-parameter name="StateIn"/>
  1197. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1198. </para></description></method>
  1199. </method-group>
  1200. <constructor><parameter name="eps_abs"><paramtype>value_type</paramtype><default>1E-6</default><description><para>Absolute tolerance level. </para></description></parameter><parameter name="eps_rel"><paramtype>value_type</paramtype><default>1E-6</default><description><para>Relative tolerance level. </para></description></parameter><parameter name="factor_x"><paramtype>value_type</paramtype><default>1.0</default><description><para>Factor for the weight of the state. </para></description></parameter><parameter name="factor_dxdt"><paramtype>value_type</paramtype><default>1.0</default><description><para>Factor for the weight of the derivative. </para></description></parameter><parameter name="max_dt"><paramtype>time_type</paramtype><default>static_cast&lt; time_type &gt;(0)</default></parameter><parameter name="control_interpolation"><paramtype>bool</paramtype><default>false</default><description><para>Set true to additionally control the error of the interpolation. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::bulirsch_stoer">bulirsch_stoer</classname> class, including initialization of the error bounds. </purpose><description><para>
  1201. </para></description></constructor>
  1202. <method-group name="private member functions">
  1203. <method name="extrapolate"><type>void</type><template>
  1204. <template-type-parameter name="StateInOut"/>
  1205. <template-type-parameter name="StateVector"/>
  1206. </template><parameter name="k"><paramtype>size_t</paramtype></parameter><parameter name="table"><paramtype>StateVector &amp;</paramtype></parameter><parameter name="coeff"><paramtype>const value_matrix &amp;</paramtype></parameter><parameter name="xest"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="order_start_index"><paramtype>size_t</paramtype><default>0</default></parameter></method>
  1207. <method name="extrapolate_dense_out"><type>void</type><template>
  1208. <template-type-parameter name="StateVector"/>
  1209. </template><parameter name="k"><paramtype>size_t</paramtype></parameter><parameter name="table"><paramtype>StateVector &amp;</paramtype></parameter><parameter name="coeff"><paramtype>const value_matrix &amp;</paramtype></parameter><parameter name="order_start_index"><paramtype>size_t</paramtype><default>0</default></parameter></method>
  1210. <method name="calc_h_opt" cv="const"><type>time_type</type><parameter name="h"><paramtype>time_type</paramtype></parameter><parameter name="error"><paramtype>value_type</paramtype></parameter><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1211. <method name="in_convergence_window" cv="const"><type>bool</type><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1212. <method name="should_reject" cv="const"><type>bool</type><parameter name="error"><paramtype>value_type</paramtype></parameter><parameter name="k"><paramtype>size_t</paramtype></parameter></method>
  1213. <method name="prepare_dense_output"><type>value_type</type><template>
  1214. <template-type-parameter name="StateIn1"/>
  1215. <template-type-parameter name="DerivIn1"/>
  1216. <template-type-parameter name="StateIn2"/>
  1217. <template-type-parameter name="DerivIn2"/>
  1218. </template><parameter name="k"><paramtype>int</paramtype></parameter><parameter name="x_start"><paramtype>const StateIn1 &amp;</paramtype></parameter><parameter name="dxdt_start"><paramtype>const DerivIn1 &amp;</paramtype></parameter><parameter name=""><paramtype>const StateIn2 &amp;</paramtype></parameter><parameter name=""><paramtype>const DerivIn2 &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1219. <method name="calculate_finite_difference"><type>void</type><template>
  1220. <template-type-parameter name="DerivIn"/>
  1221. </template><parameter name="j"><paramtype>size_t</paramtype></parameter><parameter name="kappa"><paramtype>size_t</paramtype></parameter><parameter name="fac"><paramtype>value_type</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter></method>
  1222. <method name="do_interpolation" cv="const"><type>void</type><template>
  1223. <template-type-parameter name="StateOut"/>
  1224. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter></method>
  1225. <method name="resize_impl"><type>bool</type><template>
  1226. <template-type-parameter name="StateIn"/>
  1227. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1228. <method name="get_current_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1229. <method name="get_current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1230. <method name="get_old_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1231. <method name="get_old_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1232. <method name="get_current_deriv"><type>deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1233. <method name="get_current_deriv" cv="const"><type>const deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1234. <method name="get_old_deriv"><type>deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1235. <method name="get_old_deriv" cv="const"><type>const deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1236. <method name="toggle_current_state"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1237. </method-group>
  1238. </class>
  1239. </namespace>
  1240. </namespace>
  1241. </namespace>
  1242. </header>
  1243. <header name="boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton.hpp">
  1244. <namespace name="boost">
  1245. <namespace name="numeric">
  1246. <namespace name="odeint">
  1247. <class name="controlled_adams_bashforth_moulton"><template>
  1248. <template-type-parameter name="ErrorStepper"/>
  1249. <template-type-parameter name="StepAdjuster"><default>detail::pid_step_adjuster&lt; typename ErrorStepper::state_type, typename ErrorStepper::value_type, typename ErrorStepper::deriv_type, typename ErrorStepper::time_type, typename ErrorStepper::algebra_type, typename ErrorStepper::operations_type, detail::H211PI &gt;</default></template-type-parameter>
  1250. <template-type-parameter name="OrderAdjuster"><default>default_order_adjuster&lt; ErrorStepper::order_value, typename ErrorStepper::state_type, typename ErrorStepper::value_type, typename ErrorStepper::algebra_type &gt;</default></template-type-parameter>
  1251. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  1252. </template><typedef name="stepper_type"><type>ErrorStepper</type></typedef>
  1253. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  1254. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  1255. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  1256. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  1257. <typedef name="algebra_type"><type>stepper_type::algebra_type</type></typedef>
  1258. <typedef name="operations_type"><type>stepper_type::operations_type</type></typedef>
  1259. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1260. <typedef name="step_adjuster_type"><type>StepAdjuster</type></typedef>
  1261. <typedef name="order_adjuster_type"><type>OrderAdjuster</type></typedef>
  1262. <typedef name="stepper_category"><type>controlled_stepper_tag</type></typedef>
  1263. <typedef name="wrapped_state_type"><type>stepper_type::wrapped_state_type</type></typedef>
  1264. <typedef name="wrapped_deriv_type"><type>stepper_type::wrapped_deriv_type</type></typedef>
  1265. <typedef name="error_storage_type"><type>boost::array&lt; wrapped_state_type, 4 &gt;</type></typedef>
  1266. <typedef name="coeff_type"><type>stepper_type::coeff_type</type></typedef>
  1267. <typedef name="controlled_stepper_type"><type>controlled_adams_bashforth_moulton&lt; ErrorStepper, StepAdjuster, OrderAdjuster, Resizer &gt;</type></typedef>
  1268. <data-member name="order_value" specifiers="static"><type>const stepper_type::order_type</type></data-member>
  1269. <method-group name="public member functions">
  1270. <method name="initialize"><type>void</type><template>
  1271. <template-type-parameter name="ExplicitStepper"/>
  1272. <template-type-parameter name="System"/>
  1273. </template><parameter name="stepper"><paramtype>ExplicitStepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1274. <method name="initialize"><type>void</type><template>
  1275. <template-type-parameter name="System"/>
  1276. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1277. <method name="initialize_controlled"><type>void</type><template>
  1278. <template-type-parameter name="ExplicitStepper"/>
  1279. <template-type-parameter name="System"/>
  1280. </template><parameter name="stepper"><paramtype>ExplicitStepper</paramtype></parameter><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1281. <method name="try_step"><type>controlled_step_result</type><template>
  1282. <template-type-parameter name="System"/>
  1283. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inOut"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1284. <method name="try_step"><type>controlled_step_result</type><template>
  1285. <template-type-parameter name="System"/>
  1286. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="out"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1287. <method name="reset"><type>void</type></method>
  1288. </method-group>
  1289. <constructor><parameter name="step_adjuster"><paramtype>step_adjuster_type</paramtype><default>step_adjuster_type()</default></parameter></constructor>
  1290. <method-group name="private member functions">
  1291. <method name="resize_dxdt_impl"><type>bool</type><template>
  1292. <template-type-parameter name="StateType"/>
  1293. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1294. <method name="resize_xerr_impl"><type>bool</type><template>
  1295. <template-type-parameter name="StateType"/>
  1296. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1297. <method name="resize_xnew_impl"><type>bool</type><template>
  1298. <template-type-parameter name="StateType"/>
  1299. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1300. </method-group>
  1301. </class><class name="default_order_adjuster"><template>
  1302. <template-nontype-parameter name="MaxOrder"><type>size_t</type></template-nontype-parameter>
  1303. <template-type-parameter name="State"/>
  1304. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  1305. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  1306. </template><typedef name="state_type"><type>State</type></typedef>
  1307. <typedef name="value_type"><type>Value</type></typedef>
  1308. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  1309. <typedef name="algebra_type"><type>Algebra</type></typedef>
  1310. <method-group name="public member functions">
  1311. <method name="adjust_order"><type>size_t</type><parameter name="order"><paramtype>size_t</paramtype></parameter><parameter name="init"><paramtype>size_t</paramtype></parameter><parameter name="xerr"><paramtype>boost::array&lt; wrapped_state_type, 4 &gt; &amp;</paramtype></parameter></method>
  1312. </method-group>
  1313. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default></parameter></constructor>
  1314. </class>
  1315. </namespace>
  1316. </namespace>
  1317. </namespace>
  1318. </header>
  1319. <header name="boost/numeric/odeint/stepper/controlled_runge_kutta.hpp">
  1320. <namespace name="boost">
  1321. <namespace name="numeric">
  1322. <namespace name="odeint">
  1323. <class name="controlled_runge_kutta"><template>
  1324. <template-type-parameter name="ErrorStepper"/>
  1325. <template-type-parameter name="ErrorChecker"><default><classname alt="boost::numeric::odeint::default_error_checker">default_error_checker</classname>&lt; typename ErrorStepper::value_type , typename ErrorStepper::algebra_type , typename ErrorStepper::operations_type &gt;</default></template-type-parameter>
  1326. <template-type-parameter name="StepAdjuster"><default>default_step_adjuster&lt; typename ErrorStepper::value_type , typename ErrorStepper::time_type &gt;</default></template-type-parameter>
  1327. <template-type-parameter name="Resizer"><default>typename ErrorStepper::resizer_type</default></template-type-parameter>
  1328. <template-type-parameter name="ErrorStepperCategory"><default>typename ErrorStepper::stepper_category</default></template-type-parameter>
  1329. </template></class><class-specialization name="controlled_runge_kutta"><template>
  1330. <template-type-parameter name="ErrorStepper"><purpose><para>The stepper type with error estimation, has to fulfill the ErrorStepper concept. </para></purpose></template-type-parameter>
  1331. <template-type-parameter name="ErrorChecker"><purpose><para>The error checker </para></purpose></template-type-parameter>
  1332. <template-type-parameter name="StepAdjuster"/>
  1333. <template-type-parameter name="Resizer"><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1334. </template><specialization><template-arg>ErrorStepper</template-arg><template-arg>ErrorChecker</template-arg><template-arg>StepAdjuster</template-arg><template-arg>Resizer</template-arg><template-arg>explicit_error_stepper_fsal_tag</template-arg></specialization><purpose>Implements step size control for Runge-Kutta FSAL steppers with error estimation. </purpose><description><para>This class implements the step size control for FSAL Runge-Kutta steppers with error estimation.</para><para>
  1335. </para></description><typedef name="stepper_type"><type>ErrorStepper</type></typedef>
  1336. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  1337. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  1338. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  1339. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  1340. <typedef name="algebra_type"><type>stepper_type::algebra_type</type></typedef>
  1341. <typedef name="operations_type"><type>stepper_type::operations_type</type></typedef>
  1342. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1343. <typedef name="error_checker_type"><type>ErrorChecker</type></typedef>
  1344. <typedef name="step_adjuster_type"><type>StepAdjuster</type></typedef>
  1345. <typedef name="stepper_category"><type>explicit_controlled_stepper_fsal_tag</type></typedef>
  1346. <method-group name="public member functions">
  1347. <method name="try_step"><type>controlled_step_result</type><template>
  1348. <template-type-parameter name="System"/>
  1349. <template-type-parameter name="StateInOut"/>
  1350. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1351. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1352. </returns></method>
  1353. <method name="try_step"><type>controlled_step_result</type><template>
  1354. <template-type-parameter name="System"/>
  1355. <template-type-parameter name="StateInOut"/>
  1356. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. Can be a boost range. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. Solves the forwarding problem and allows for using boost range as state_type. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1357. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1358. </returns></method>
  1359. <method name="try_step"><type>boost::disable_if&lt; boost::is_same&lt; StateIn, time_type &gt;, controlled_step_result &gt;::type</type><template>
  1360. <template-type-parameter name="System"/>
  1361. <template-type-parameter name="StateIn"/>
  1362. <template-type-parameter name="StateOut"/>
  1363. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para><note><para>This method is disabled if state_type=time_type to avoid ambiguity.</para>
  1364. </note>
  1365. This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1366. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1367. </returns></method>
  1368. <method name="try_step"><type>controlled_step_result</type><template>
  1369. <template-type-parameter name="System"/>
  1370. <template-type-parameter name="StateInOut"/>
  1371. <template-type-parameter name="DerivInOut"/>
  1372. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="dxdt"><paramtype>DerivInOut &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1373. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1374. </returns></method>
  1375. <method name="try_step"><type>controlled_step_result</type><template>
  1376. <template-type-parameter name="System"/>
  1377. <template-type-parameter name="StateIn"/>
  1378. <template-type-parameter name="DerivIn"/>
  1379. <template-type-parameter name="StateOut"/>
  1380. <template-type-parameter name="DerivOut"/>
  1381. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="dxdt_in"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dxdt_out"><paramtype>DerivOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1382. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1383. </returns></method>
  1384. <method name="reset"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Resets the internal state of the underlying FSAL stepper. </purpose></method>
  1385. <method name="initialize"><type>void</type><template>
  1386. <template-type-parameter name="DerivIn"/>
  1387. </template><parameter name="deriv"><paramtype>const DerivIn &amp;</paramtype><description><para>The initial derivative of the ODE. </para></description></parameter><purpose>Initializes the internal state storing an internal copy of the derivative. </purpose><description><para>
  1388. </para></description></method>
  1389. <method name="initialize"><type>void</type><template>
  1390. <template-type-parameter name="System"/>
  1391. <template-type-parameter name="StateIn"/>
  1392. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>The initial state of the ODE which should be solved. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The initial time. </para></description></parameter><purpose>Initializes the internal state storing an internal copy of the derivative. </purpose><description><para>
  1393. </para></description></method>
  1394. <method name="is_initialized" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns true if the stepper has been initialized, false otherwise. </purpose><description><para>
  1395. </para></description><returns><para>true, if the stepper has been initialized, false otherwise. </para>
  1396. </returns></method>
  1397. <method name="adjust_size"><type>void</type><template>
  1398. <template-type-parameter name="StateType"/>
  1399. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1400. </para></description></method>
  1401. <method name="stepper"><type>stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the instance of the underlying stepper. </purpose><description><para>
  1402. </para></description><returns><para>The instance of the underlying stepper. </para>
  1403. </returns></method>
  1404. <method name="stepper" cv="const"><type>const stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the instance of the underlying stepper. </purpose><description><para>
  1405. </para></description><returns><para>The instance of the underlying stepper. </para>
  1406. </returns></method>
  1407. </method-group>
  1408. <constructor><parameter name="error_checker"><paramtype>const error_checker_type &amp;</paramtype><default>error_checker_type()</default><description><para>An instance of the error checker. </para></description></parameter><parameter name="step_adjuster"><paramtype>const step_adjuster_type &amp;</paramtype><default>step_adjuster_type()</default></parameter><parameter name="stepper"><paramtype>const stepper_type &amp;</paramtype><default>stepper_type()</default><description><para>An instance of the underlying stepper. </para></description></parameter><purpose>Constructs the controlled Runge-Kutta stepper. </purpose><description><para>
  1409. </para></description></constructor>
  1410. <method-group name="private member functions">
  1411. <method name="resize_m_xerr_impl"><type>bool</type><template>
  1412. <template-type-parameter name="StateIn"/>
  1413. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1414. <method name="resize_m_dxdt_impl"><type>bool</type><template>
  1415. <template-type-parameter name="StateIn"/>
  1416. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1417. <method name="resize_m_dxdt_new_impl"><type>bool</type><template>
  1418. <template-type-parameter name="StateIn"/>
  1419. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1420. <method name="resize_m_xnew_impl"><type>bool</type><template>
  1421. <template-type-parameter name="StateIn"/>
  1422. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1423. <method name="try_step_v1"><type>controlled_step_result</type><template>
  1424. <template-type-parameter name="System"/>
  1425. <template-type-parameter name="StateInOut"/>
  1426. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1427. </method-group>
  1428. </class-specialization><class-specialization name="controlled_runge_kutta"><template>
  1429. <template-type-parameter name="ErrorStepper"><purpose><para>The stepper type with error estimation, has to fulfill the ErrorStepper concept. </para></purpose></template-type-parameter>
  1430. <template-type-parameter name="ErrorChecker"><purpose><para>The error checker </para></purpose></template-type-parameter>
  1431. <template-type-parameter name="StepAdjuster"/>
  1432. <template-type-parameter name="Resizer"><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1433. </template><specialization><template-arg>ErrorStepper</template-arg><template-arg>ErrorChecker</template-arg><template-arg>StepAdjuster</template-arg><template-arg>Resizer</template-arg><template-arg>explicit_error_stepper_tag</template-arg></specialization><purpose>Implements step size control for Runge-Kutta steppers with error estimation. </purpose><description><para>This class implements the step size control for standard Runge-Kutta steppers with error estimation.</para><para>
  1434. </para></description><typedef name="stepper_type"><type>ErrorStepper</type></typedef>
  1435. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  1436. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  1437. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  1438. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  1439. <typedef name="algebra_type"><type>stepper_type::algebra_type</type></typedef>
  1440. <typedef name="operations_type"><type>stepper_type::operations_type</type></typedef>
  1441. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1442. <typedef name="error_checker_type"><type>ErrorChecker</type></typedef>
  1443. <typedef name="step_adjuster_type"><type>StepAdjuster</type></typedef>
  1444. <typedef name="stepper_category"><type>explicit_controlled_stepper_tag</type></typedef>
  1445. <method-group name="public member functions">
  1446. <method name="try_step"><type>controlled_step_result</type><template>
  1447. <template-type-parameter name="System"/>
  1448. <template-type-parameter name="StateInOut"/>
  1449. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1450. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1451. </returns></method>
  1452. <method name="try_step"><type>controlled_step_result</type><template>
  1453. <template-type-parameter name="System"/>
  1454. <template-type-parameter name="StateInOut"/>
  1455. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. Can be a boost range. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. Solves the forwarding problem and allows for using boost range as state_type. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1456. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1457. </returns></method>
  1458. <method name="try_step"><type>controlled_step_result</type><template>
  1459. <template-type-parameter name="System"/>
  1460. <template-type-parameter name="StateInOut"/>
  1461. <template-type-parameter name="DerivIn"/>
  1462. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. Overwritten if the step is successful. </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1463. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1464. </returns></method>
  1465. <method name="try_step"><type>boost::disable_if&lt; boost::is_same&lt; StateIn, time_type &gt;, controlled_step_result &gt;::type</type><template>
  1466. <template-type-parameter name="System"/>
  1467. <template-type-parameter name="StateIn"/>
  1468. <template-type-parameter name="StateOut"/>
  1469. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para><note><para>This method is disabled if state_type=time_type to avoid ambiguity.</para>
  1470. </note>
  1471. This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1472. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1473. </returns></method>
  1474. <method name="try_step"><type>controlled_step_result</type><template>
  1475. <template-type-parameter name="System"/>
  1476. <template-type-parameter name="StateIn"/>
  1477. <template-type-parameter name="DerivIn"/>
  1478. <template-type-parameter name="StateOut"/>
  1479. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of state. </para></description></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype><description><para>The value of the time. Updated if the step is successful. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>Used to store the result of the step. </para></description></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype><description><para>The step size. Updated. </para></description></parameter><purpose>Tries to perform one step. </purpose><description><para>This method tries to do one step with step size dt. If the error estimate is to large, the step is rejected and the method returns fail and the step size dt is reduced. If the error estimate is acceptably small, the step is performed, success is returned and dt might be increased to make the steps as large as possible. This method also updates t if a step is performed.</para><para>
  1480. </para></description><returns><para>success if the step was accepted, fail otherwise. </para>
  1481. </returns></method>
  1482. <method name="adjust_size"><type>void</type><template>
  1483. <template-type-parameter name="StateType"/>
  1484. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1485. </para></description></method>
  1486. <method name="stepper"><type>stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the instance of the underlying stepper. </purpose><description><para>
  1487. </para></description><returns><para>The instance of the underlying stepper. </para>
  1488. </returns></method>
  1489. <method name="stepper" cv="const"><type>const stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the instance of the underlying stepper. </purpose><description><para>
  1490. </para></description><returns><para>The instance of the underlying stepper. </para>
  1491. </returns></method>
  1492. </method-group>
  1493. <constructor><parameter name="error_checker"><paramtype>const error_checker_type &amp;</paramtype><default>error_checker_type()</default><description><para>An instance of the error checker. </para></description></parameter><parameter name="step_adjuster"><paramtype>const step_adjuster_type &amp;</paramtype><default>step_adjuster_type()</default></parameter><parameter name="stepper"><paramtype>const stepper_type &amp;</paramtype><default>stepper_type()</default><description><para>An instance of the underlying stepper. </para></description></parameter><purpose>Constructs the controlled Runge-Kutta stepper. </purpose><description><para>
  1494. </para></description></constructor>
  1495. <method-group name="private member functions">
  1496. <method name="try_step_v1"><type>controlled_step_result</type><template>
  1497. <template-type-parameter name="System"/>
  1498. <template-type-parameter name="StateInOut"/>
  1499. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  1500. <method name="resize_m_xerr_impl"><type>bool</type><template>
  1501. <template-type-parameter name="StateIn"/>
  1502. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1503. <method name="resize_m_dxdt_impl"><type>bool</type><template>
  1504. <template-type-parameter name="StateIn"/>
  1505. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1506. <method name="resize_m_xnew_impl"><type>bool</type><template>
  1507. <template-type-parameter name="StateIn"/>
  1508. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1509. </method-group>
  1510. </class-specialization><class name="default_error_checker"><template>
  1511. <template-type-parameter name="Value"><purpose><para>The value type. </para></purpose></template-type-parameter>
  1512. <template-type-parameter name="Algebra"><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1513. <template-type-parameter name="Operations"><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1514. </template><purpose>The default error checker to be used with Runge-Kutta error steppers. </purpose><description><para>This class provides the default mechanism to compare the error estimates reported by Runge-Kutta error steppers with user defined error bounds. It is used by the controlled_runge_kutta steppers.</para><para>
  1515. </para></description><typedef name="value_type"><type>Value</type></typedef>
  1516. <typedef name="algebra_type"><type>Algebra</type></typedef>
  1517. <typedef name="operations_type"><type>Operations</type></typedef>
  1518. <method-group name="public member functions">
  1519. <method name="error" cv="const"><type>value_type</type><template>
  1520. <template-type-parameter name="State"/>
  1521. <template-type-parameter name="Deriv"/>
  1522. <template-type-parameter name="Err"/>
  1523. <template-type-parameter name="Time"/>
  1524. </template><parameter name="x_old"><paramtype>const State &amp;</paramtype></parameter><parameter name="dxdt_old"><paramtype>const Deriv &amp;</paramtype></parameter><parameter name="x_err"><paramtype>Err &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter></method>
  1525. <method name="error" cv="const"><type>value_type</type><template>
  1526. <template-type-parameter name="State"/>
  1527. <template-type-parameter name="Deriv"/>
  1528. <template-type-parameter name="Err"/>
  1529. <template-type-parameter name="Time"/>
  1530. </template><parameter name="algebra"><paramtype>algebra_type &amp;</paramtype></parameter><parameter name="x_old"><paramtype>const State &amp;</paramtype></parameter><parameter name="dxdt_old"><paramtype>const Deriv &amp;</paramtype></parameter><parameter name="x_err"><paramtype>Err &amp;</paramtype></parameter><parameter name="dt"><paramtype>Time</paramtype></parameter></method>
  1531. </method-group>
  1532. <constructor><parameter name="eps_abs"><paramtype>value_type</paramtype><default>static_cast&lt; value_type &gt;(1.0e-6)</default></parameter><parameter name="eps_rel"><paramtype>value_type</paramtype><default>static_cast&lt; value_type &gt;(1.0e-6)</default></parameter><parameter name="a_x"><paramtype>value_type</paramtype><default>static_cast&lt; value_type &gt;(1)</default></parameter><parameter name="a_dxdt"><paramtype>value_type</paramtype><default>static_cast&lt; value_type &gt;(1)</default></parameter></constructor>
  1533. </class><class name="default_step_adjuster"><template>
  1534. <template-type-parameter name="Value"/>
  1535. <template-type-parameter name="Time"/>
  1536. </template><typedef name="time_type"><type>Time</type></typedef>
  1537. <typedef name="value_type"><type>Value</type></typedef>
  1538. <method-group name="public member functions">
  1539. <method name="decrease_step" cv="const"><type>time_type</type><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="error"><paramtype>const value_type</paramtype></parameter><parameter name="error_order"><paramtype>const int</paramtype></parameter></method>
  1540. <method name="increase_step" cv="const"><type>time_type</type><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="error"><paramtype>value_type</paramtype></parameter><parameter name="stepper_order"><paramtype>const int</paramtype></parameter></method>
  1541. <method name="check_step_size_limit"><type>bool</type><parameter name="dt"><paramtype>const time_type</paramtype></parameter></method>
  1542. <method name="get_max_dt"><type>time_type</type></method>
  1543. </method-group>
  1544. <constructor><parameter name="max_dt"><paramtype>const time_type</paramtype><default>static_cast&lt; time_type &gt;(0)</default></parameter></constructor>
  1545. </class>
  1546. </namespace>
  1547. </namespace>
  1548. </namespace>
  1549. </header>
  1550. <header name="boost/numeric/odeint/stepper/controlled_step_result.hpp">
  1551. <namespace name="boost">
  1552. <namespace name="numeric">
  1553. <namespace name="odeint">
  1554. <enum name="controlled_step_result"><enumvalue name="success"><description><para>The trial step was successful, hence the state and the time have been advanced. </para></description></enumvalue><enumvalue name="fail"><description><para>The step was not successful and might possibly be repeated with a small step size. </para></description></enumvalue><purpose>Enum representing the return values of the controlled steppers. </purpose></enum>
  1555. </namespace>
  1556. </namespace>
  1557. </namespace>
  1558. </header>
  1559. <header name="boost/numeric/odeint/stepper/dense_output_runge_kutta.hpp">
  1560. <namespace name="boost">
  1561. <namespace name="numeric">
  1562. <namespace name="odeint">
  1563. <class name="dense_output_runge_kutta"><template>
  1564. <template-type-parameter name="Stepper"/>
  1565. <template-type-parameter name="StepperCategory"><default>typename Stepper::stepper_category</default></template-type-parameter>
  1566. </template></class><class-specialization name="dense_output_runge_kutta"><template>
  1567. <template-type-parameter name="Stepper"><purpose><para>The stepper type of the underlying algorithm. </para></purpose></template-type-parameter>
  1568. </template><specialization><template-arg>Stepper</template-arg><template-arg>explicit_controlled_stepper_fsal_tag</template-arg></specialization><purpose>The class representing dense-output Runge-Kutta steppers with FSAL property. </purpose><description><para>The interface is the same as for <classname alt="boost::numeric::odeint::dense_output_runge_kutta&lt; Stepper, stepper_tag &gt;">dense_output_runge_kutta&lt; Stepper , stepper_tag &gt;</classname>. This class provides dense output functionality based on methods with step size controlled</para><para>
  1569. </para></description><typedef name="controlled_stepper_type"><type>Stepper</type></typedef>
  1570. <typedef name="stepper_type"><type>controlled_stepper_type::stepper_type</type></typedef>
  1571. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  1572. <typedef name="wrapped_state_type"><type>stepper_type::wrapped_state_type</type></typedef>
  1573. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  1574. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  1575. <typedef name="wrapped_deriv_type"><type>stepper_type::wrapped_deriv_type</type></typedef>
  1576. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  1577. <typedef name="algebra_type"><type>stepper_type::algebra_type</type></typedef>
  1578. <typedef name="operations_type"><type>stepper_type::operations_type</type></typedef>
  1579. <typedef name="resizer_type"><type>stepper_type::resizer_type</type></typedef>
  1580. <typedef name="stepper_category"><type>dense_output_stepper_tag</type></typedef>
  1581. <typedef name="dense_output_stepper_type"><type>dense_output_runge_kutta&lt; Stepper &gt;</type></typedef>
  1582. <method-group name="public member functions">
  1583. <method name="initialize"><type>void</type><template>
  1584. <template-type-parameter name="StateType"/>
  1585. </template><parameter name="x0"><paramtype>const StateType &amp;</paramtype></parameter><parameter name="t0"><paramtype>time_type</paramtype></parameter><parameter name="dt0"><paramtype>time_type</paramtype></parameter></method>
  1586. <method name="do_step"><type>std::pair&lt; time_type, time_type &gt;</type><template>
  1587. <template-type-parameter name="System"/>
  1588. </template><parameter name="system"><paramtype>System</paramtype></parameter></method>
  1589. <method name="calc_state" cv="const"><type>void</type><template>
  1590. <template-type-parameter name="StateOut"/>
  1591. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype></parameter></method>
  1592. <method name="calc_state" cv="const"><type>void</type><template>
  1593. <template-type-parameter name="StateOut"/>
  1594. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>const StateOut &amp;</paramtype></parameter></method>
  1595. <method name="resize"><type>bool</type><template>
  1596. <template-type-parameter name="StateIn"/>
  1597. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1598. <method name="adjust_size"><type>void</type><template>
  1599. <template-type-parameter name="StateType"/>
  1600. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1601. <method name="current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1602. <method name="current_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1603. <method name="previous_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1604. <method name="previous_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1605. <method name="current_time_step" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1606. </method-group>
  1607. <constructor><parameter name="stepper"><paramtype>const controlled_stepper_type &amp;</paramtype><default>controlled_stepper_type()</default></parameter></constructor>
  1608. <method-group name="private member functions">
  1609. <method name="get_current_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1610. <method name="get_current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1611. <method name="get_old_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1612. <method name="get_old_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1613. <method name="get_current_deriv"><type>deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1614. <method name="get_current_deriv" cv="const"><type>const deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1615. <method name="get_old_deriv"><type>deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1616. <method name="get_old_deriv" cv="const"><type>const deriv_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1617. <method name="toggle_current_state"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1618. </method-group>
  1619. </class-specialization><class-specialization name="dense_output_runge_kutta"><template>
  1620. <template-type-parameter name="Stepper"><purpose><para>The stepper type of the underlying algorithm. </para></purpose></template-type-parameter>
  1621. </template><specialization><template-arg>Stepper</template-arg><template-arg>stepper_tag</template-arg></specialization><purpose>The class representing dense-output Runge-Kutta steppers. </purpose><description><para><note><para>In this stepper, the initialize method has to be called before using the do_step method.</para>
  1622. </note>
  1623. The dense-output functionality allows to interpolate the solution between subsequent integration points using intermediate results obtained during the computation. This version works based on a normal stepper without step-size control.</para><para>
  1624. </para></description><typedef name="stepper_type"><type>Stepper</type></typedef>
  1625. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  1626. <typedef name="wrapped_state_type"><type>stepper_type::wrapped_state_type</type></typedef>
  1627. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  1628. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  1629. <typedef name="wrapped_deriv_type"><type>stepper_type::wrapped_deriv_type</type></typedef>
  1630. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  1631. <typedef name="algebra_type"><type>stepper_type::algebra_type</type></typedef>
  1632. <typedef name="operations_type"><type>stepper_type::operations_type</type></typedef>
  1633. <typedef name="resizer_type"><type>stepper_type::resizer_type</type></typedef>
  1634. <typedef name="stepper_category"><type>dense_output_stepper_tag</type></typedef>
  1635. <typedef name="dense_output_stepper_type"><type>dense_output_runge_kutta&lt; Stepper &gt;</type></typedef>
  1636. <method-group name="public member functions">
  1637. <method name="initialize"><type>void</type><template>
  1638. <template-type-parameter name="StateType"/>
  1639. </template><parameter name="x0"><paramtype>const StateType &amp;</paramtype><description><para>The initial state of the ODE which should be solved. </para></description></parameter><parameter name="t0"><paramtype>time_type</paramtype><description><para>The initial time, at which the step should be performed. </para></description></parameter><parameter name="dt0"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>Initializes the stepper. Has to be called before do_step can be used to set the initial conditions and the step size. </purpose><description><para>
  1640. </para></description></method>
  1641. <method name="do_step"><type>std::pair&lt; time_type, time_type &gt;</type><template>
  1642. <template-type-parameter name="System"/>
  1643. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Simple System concept. </para></description></parameter><purpose>Does one time step. </purpose><description><para><note><para>initialize has to be called before using this method to set the initial conditions x,t and the stepsize. </para>
  1644. </note>
  1645. </para></description><returns><para>Pair with start and end time of the integration step. </para>
  1646. </returns></method>
  1647. <method name="calc_state" cv="const"><type>void</type><template>
  1648. <template-type-parameter name="StateOut"/>
  1649. </template><parameter name="t"><paramtype>time_type</paramtype><description><para>The time at which the solution should be calculated, has to be in the current time interval. </para></description></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype><description><para>The output variable where the result is written into. </para></description></parameter><purpose>Calculates the solution at an intermediate point. </purpose><description><para>
  1650. </para></description></method>
  1651. <method name="calc_state" cv="const"><type>void</type><template>
  1652. <template-type-parameter name="StateOut"/>
  1653. </template><parameter name="t"><paramtype>time_type</paramtype><description><para>The time at which the solution should be calculated, has to be in the current time interval. </para></description></parameter><parameter name="x"><paramtype>const StateOut &amp;</paramtype><description><para>The output variable where the result is written into, can be a boost range. </para></description></parameter><purpose>Calculates the solution at an intermediate point. Solves the forwarding problem. </purpose><description><para>
  1654. </para></description></method>
  1655. <method name="adjust_size"><type>void</type><template>
  1656. <template-type-parameter name="StateType"/>
  1657. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1658. </para></description></method>
  1659. <method name="current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current state of the solution. </purpose><description><para>
  1660. </para></description><returns><para>The current state of the solution x(t). </para>
  1661. </returns></method>
  1662. <method name="current_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current time of the solution. </purpose><description><para>
  1663. </para></description><returns><para>The current time of the solution t. </para>
  1664. </returns></method>
  1665. <method name="previous_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the last state of the solution. </purpose><description><para>
  1666. </para></description><returns><para>The last state of the solution x(t-dt). </para>
  1667. </returns></method>
  1668. <method name="previous_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the last time of the solution. </purpose><description><para>
  1669. </para></description><returns><para>The last time of the solution t-dt. </para>
  1670. </returns></method>
  1671. <method name="current_time_step" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Returns the current time step. </purpose><description><para>
  1672. </para></description><returns><para>dt. </para>
  1673. </returns></method>
  1674. </method-group>
  1675. <constructor><parameter name="stepper"><paramtype>const stepper_type &amp;</paramtype><default>stepper_type()</default><description><para>An instance of the underlying stepper. </para></description></parameter><purpose>Constructs the dense_output_runge_kutta class. An instance of the underlying stepper can be provided. </purpose><description><para>
  1676. </para></description></constructor>
  1677. <method-group name="private member functions">
  1678. <method name="get_current_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1679. <method name="get_current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1680. <method name="get_old_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1681. <method name="get_old_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1682. <method name="toggle_current_state"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  1683. <method name="resize_impl"><type>bool</type><template>
  1684. <template-type-parameter name="StateIn"/>
  1685. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1686. </method-group>
  1687. </class-specialization>
  1688. </namespace>
  1689. </namespace>
  1690. </namespace>
  1691. </header>
  1692. <header name="boost/numeric/odeint/stepper/euler.hpp">
  1693. <namespace name="boost">
  1694. <namespace name="numeric">
  1695. <namespace name="odeint">
  1696. <class name="euler"><template>
  1697. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  1698. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  1699. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  1700. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  1701. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1702. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1703. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1704. </template><inherit access="public">explicit_stepper_base</inherit><purpose>An implementation of the Euler method. </purpose><description><para>The Euler method is a very simply solver for ordinary differential equations. This method should not be used for real applications. It is only useful for demonstration purposes. Step size control is not provided but trivial continuous output is available.</para><para>This class derives from explicit_stepper_base and inherits its interface via CRTP (current recurring template pattern), see explicit_stepper_base</para><para>
  1705. </para></description><typedef name="stepper_base_type"><type>explicit_stepper_base&lt; <classname>euler</classname>&lt; ... &gt;,... &gt;</type></typedef>
  1706. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  1707. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  1708. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  1709. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  1710. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  1711. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  1712. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  1713. <method-group name="public member functions">
  1714. <method name="do_step_impl"><type>void</type><template>
  1715. <template-type-parameter name="System"/>
  1716. <template-type-parameter name="StateIn"/>
  1717. <template-type-parameter name="DerivIn"/>
  1718. <template-type-parameter name="StateOut"/>
  1719. </template><parameter name=""><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name=""><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out of place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  1720. </para></description></method>
  1721. <method name="calc_state" cv="const"><type>void</type><template>
  1722. <template-type-parameter name="StateOut"/>
  1723. <template-type-parameter name="StateIn1"/>
  1724. <template-type-parameter name="StateIn2"/>
  1725. </template><parameter name="x"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="old_state"><paramtype>const StateIn1 &amp;</paramtype></parameter><parameter name="t_old"><paramtype>time_type</paramtype></parameter><parameter name=""><paramtype>const StateIn2 &amp;</paramtype></parameter><parameter name=""><paramtype>time_type</paramtype></parameter><purpose>This method is used for continuous output and it calculates the state <computeroutput>x</computeroutput> at a time <computeroutput>t</computeroutput> from the knowledge of two states <computeroutput>old_state</computeroutput> and <computeroutput>current_state</computeroutput> at time points <computeroutput>t_old</computeroutput> and <computeroutput>t_new</computeroutput>. </purpose></method>
  1726. <method name="adjust_size"><type>void</type><template>
  1727. <template-type-parameter name="StateType"/>
  1728. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1729. </para></description></method>
  1730. </method-group>
  1731. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the euler class. This constructor can be used as a default constructor of the algebra has a default constructor. </purpose><description><para>
  1732. </para></description></constructor>
  1733. </class>
  1734. </namespace>
  1735. </namespace>
  1736. </namespace>
  1737. </header>
  1738. <header name="boost/numeric/odeint/stepper/explicit_error_generic_rk.hpp">
  1739. <namespace name="boost">
  1740. <namespace name="numeric">
  1741. <namespace name="odeint">
  1742. <class name="explicit_error_generic_rk"><template>
  1743. <template-nontype-parameter name="StageCount"><type>size_t</type><purpose><para>The number of stages of the Runge-Kutta algorithm. </para></purpose></template-nontype-parameter>
  1744. <template-nontype-parameter name="Order"><type>size_t</type><purpose><para>The order of a stepper if the stepper is used without error estimation. </para></purpose></template-nontype-parameter>
  1745. <template-nontype-parameter name="StepperOrder"><type>size_t</type><purpose><para>The order of a step if the stepper is used with error estimation. Usually Order and StepperOrder have the same value. </para></purpose></template-nontype-parameter>
  1746. <template-nontype-parameter name="ErrorOrder"><type>size_t</type><purpose><para>The order of the error step if the stepper is used with error estimation. </para></purpose></template-nontype-parameter>
  1747. <template-type-parameter name="State"><purpose><para>The type representing the state of the ODE. </para></purpose></template-type-parameter>
  1748. <template-type-parameter name="Value"><default>double</default><purpose><para>The floating point type which is used in the computations. </para></purpose></template-type-parameter>
  1749. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  1750. <template-type-parameter name="Time"><default>Value</default><purpose><para>The type representing the independent variable - the time - of the ODE. </para></purpose></template-type-parameter>
  1751. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1752. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1753. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1754. </template><inherit access="public">explicit_error_stepper_base</inherit><purpose>A generic implementation of explicit Runge-Kutta algorithms with error estimation. This class is as a base class for all explicit Runge-Kutta steppers with error estimation. </purpose><description><para>This class implements the explicit Runge-Kutta algorithms with error estimation in a generic way. The Butcher tableau is passed to the stepper which constructs the stepper scheme with the help of a template-metaprogramming algorithm. ToDo : Add example!</para><para>This class derives explicit_error_stepper_base which provides the stepper interface.</para><para>
  1755. </para></description><typedef name="stepper_base_type"><type>explicit_stepper_base&lt; ... &gt;</type></typedef>
  1756. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  1757. <typedef name="wrapped_state_type"><type>stepper_base_type::wrapped_state_type</type></typedef>
  1758. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  1759. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  1760. <typedef name="wrapped_deriv_type"><type>stepper_base_type::wrapped_deriv_type</type></typedef>
  1761. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  1762. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  1763. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  1764. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  1765. <typedef name="rk_algorithm_type"><type><emphasis>unspecified</emphasis></type></typedef>
  1766. <typedef name="coef_a_type"><type>rk_algorithm_type::coef_a_type</type></typedef>
  1767. <typedef name="coef_b_type"><type>rk_algorithm_type::coef_b_type</type></typedef>
  1768. <typedef name="coef_c_type"><type>rk_algorithm_type::coef_c_type</type></typedef>
  1769. <data-member name="stage_count" specifiers="static"><type>const size_t</type></data-member>
  1770. <method-group name="public member functions">
  1771. <method name="do_step_impl"><type>void</type><template>
  1772. <template-type-parameter name="System"/>
  1773. <template-type-parameter name="StateIn"/>
  1774. <template-type-parameter name="DerivIn"/>
  1775. <template-type-parameter name="StateOut"/>
  1776. <template-type-parameter name="Err"/>
  1777. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype><description><para>The result of the error estimation is written in xerr. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Futhermore, an estimation of the error is stored in <computeroutput>xerr</computeroutput>. <computeroutput>do_step_impl</computeroutput> is used by explicit_error_stepper_base. </purpose><description><para>
  1778. </para></description></method>
  1779. <method name="do_step_impl"><type>void</type><template>
  1780. <template-type-parameter name="System"/>
  1781. <template-type-parameter name="StateIn"/>
  1782. <template-type-parameter name="DerivIn"/>
  1783. <template-type-parameter name="StateOut"/>
  1784. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  1785. </para></description></method>
  1786. <method name="adjust_size"><type>void</type><template>
  1787. <template-type-parameter name="StateIn"/>
  1788. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1789. </para></description></method>
  1790. </method-group>
  1791. <constructor><parameter name="a"><paramtype>const coef_a_type &amp;</paramtype><description><para>Triangular matrix of parameters b in the Butcher tableau. </para></description></parameter><parameter name="b"><paramtype>const coef_b_type &amp;</paramtype><description><para>Last row of the butcher tableau. </para></description></parameter><parameter name="b2"><paramtype>const coef_b_type &amp;</paramtype><description><para>Parameters for lower-order evaluation to estimate the error. </para></description></parameter><parameter name="c"><paramtype>const coef_c_type &amp;</paramtype><description><para>Parameters to calculate the time points in the Butcher tableau. </para></description></parameter><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the explicit_error_generik_rk class with the given parameters a, b, b2 and c. See examples section for details on the coefficients. </purpose><description><para>
  1792. </para></description></constructor>
  1793. <method-group name="private member functions">
  1794. <method name="resize_impl"><type>bool</type><template>
  1795. <template-type-parameter name="StateIn"/>
  1796. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1797. </method-group>
  1798. </class>
  1799. </namespace>
  1800. </namespace>
  1801. </namespace>
  1802. </header>
  1803. <header name="boost/numeric/odeint/stepper/explicit_generic_rk.hpp">
  1804. <namespace name="boost">
  1805. <namespace name="numeric">
  1806. <namespace name="odeint">
  1807. <class name="explicit_generic_rk"><template>
  1808. <template-nontype-parameter name="StageCount"><type>size_t</type><purpose><para>The number of stages of the Runge-Kutta algorithm. </para></purpose></template-nontype-parameter>
  1809. <template-nontype-parameter name="Order"><type>size_t</type><purpose><para>The order of the stepper. </para></purpose></template-nontype-parameter>
  1810. <template-type-parameter name="State"><purpose><para>The type representing the state of the ODE. </para></purpose></template-type-parameter>
  1811. <template-type-parameter name="Value"><purpose><para>The floating point type which is used in the computations. </para></purpose></template-type-parameter>
  1812. <template-type-parameter name="Deriv"/>
  1813. <template-type-parameter name="Time"><purpose><para>The type representing the independent variable - the time - of the ODE. </para></purpose></template-type-parameter>
  1814. <template-type-parameter name="Algebra"><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  1815. <template-type-parameter name="Operations"><purpose><para>The operations type. </para></purpose></template-type-parameter>
  1816. <template-type-parameter name="Resizer"><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  1817. </template><inherit access="public">explicit_stepper_base</inherit><purpose>A generic implementation of explicit Runge-Kutta algorithms. This class is as a base class for all explicit Runge-Kutta steppers. </purpose><description><para>This class implements the explicit Runge-Kutta algorithms without error estimation in a generic way. The Butcher tableau is passed to the stepper which constructs the stepper scheme with the help of a template-metaprogramming algorithm. ToDo : Add example!</para><para>This class derives explicit_stepper_base which provides the stepper interface.</para><para>
  1818. </para></description><typedef name="stepper_base_type"><type>explicit_stepper_base&lt; ... &gt;</type></typedef>
  1819. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  1820. <typedef name="wrapped_state_type"><type>stepper_base_type::wrapped_state_type</type></typedef>
  1821. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  1822. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  1823. <typedef name="wrapped_deriv_type"><type>stepper_base_type::wrapped_deriv_type</type></typedef>
  1824. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  1825. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  1826. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  1827. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  1828. <typedef name="rk_algorithm_type"><type><emphasis>unspecified</emphasis></type></typedef>
  1829. <typedef name="coef_a_type"><type>rk_algorithm_type::coef_a_type</type></typedef>
  1830. <typedef name="coef_b_type"><type>rk_algorithm_type::coef_b_type</type></typedef>
  1831. <typedef name="coef_c_type"><type>rk_algorithm_type::coef_c_type</type></typedef>
  1832. <method-group name="public member functions">
  1833. <method name="do_step_impl"><type>void</type><template>
  1834. <template-type-parameter name="System"/>
  1835. <template-type-parameter name="StateIn"/>
  1836. <template-type-parameter name="DerivIn"/>
  1837. <template-type-parameter name="StateOut"/>
  1838. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out of place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  1839. </para></description></method>
  1840. <method name="adjust_size"><type>void</type><template>
  1841. <template-type-parameter name="StateIn"/>
  1842. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  1843. </para></description></method>
  1844. </method-group>
  1845. <constructor><parameter name="a"><paramtype>const coef_a_type &amp;</paramtype><description><para>Triangular matrix of parameters b in the Butcher tableau. </para></description></parameter><parameter name="b"><paramtype>const coef_b_type &amp;</paramtype><description><para>Last row of the butcher tableau. </para></description></parameter><parameter name="c"><paramtype>const coef_c_type &amp;</paramtype><description><para>Parameters to calculate the time points in the Butcher tableau. </para></description></parameter><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::explicit_generic_rk">explicit_generic_rk</classname> class. See examples section for details on the coefficients. </purpose><description><para>
  1846. </para></description></constructor>
  1847. <method-group name="private member functions">
  1848. <method name="resize_impl"><type>bool</type><template>
  1849. <template-type-parameter name="StateIn"/>
  1850. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1851. </method-group>
  1852. </class>
  1853. </namespace>
  1854. </namespace>
  1855. </namespace>
  1856. </header>
  1857. <header name="boost/numeric/odeint/stepper/extrapolation_stepper.hpp">
  1858. <namespace name="boost">
  1859. <namespace name="numeric">
  1860. <namespace name="odeint">
  1861. <class name="extrapolation_stepper"><template>
  1862. <template-nontype-parameter name="Order"><type>unsigned short</type></template-nontype-parameter>
  1863. <template-type-parameter name="State"/>
  1864. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  1865. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  1866. <template-type-parameter name="Time"><default>Value</default></template-type-parameter>
  1867. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  1868. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default></template-type-parameter>
  1869. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  1870. </template><inherit access="public">explicit_error_stepper_base</inherit><purpose>Extrapolation stepper with configurable order, and error estimation. </purpose><description><para>The extrapolation stepper is a stepper with error estimation and configurable order. The order is given as template parameter and needs to be an <emphasis>odd</emphasis> number. The stepper is based on several executions of the modified midpoint method and a Richardson extrapolation. This is essentially the same technique as for <classname alt="boost::numeric::odeint::bulirsch_stoer">bulirsch_stoer</classname>, but without the variable order.</para><para><note><para>The Order parameter has to be an even number greater 2. </para>
  1871. </note>
  1872. </para></description><typedef name="stepper_base_type"><type>explicit_error_stepper_base&lt; <classname>extrapolation_stepper</classname>&lt; ... &gt;,... &gt;</type></typedef>
  1873. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  1874. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  1875. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  1876. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  1877. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  1878. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  1879. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  1880. <typedef name="order_type"><type>unsigned short</type></typedef>
  1881. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  1882. <data-member name="stepper_order_value" specifiers="static"><type>const order_type</type></data-member>
  1883. <data-member name="error_order_value" specifiers="static"><type>const order_type</type></data-member>
  1884. <data-member name="m_k_max" specifiers="static"><type>const size_t</type></data-member>
  1885. <method-group name="private member functions">
  1886. <method name="BOOST_STATIC_ASSERT_MSG"><type/><parameter name=""><paramtype>((Order % 2)==0) &amp;&amp;(Order &gt; 2)</paramtype></parameter><parameter name=""><paramtype>"extrapolation_stepper requires even Order larger than 2"</paramtype></parameter></method>
  1887. <method name="resize_impl"><type>bool</type><template>
  1888. <template-type-parameter name="StateIn"/>
  1889. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1890. <method name="resize_m_xout"><type>bool</type><template>
  1891. <template-type-parameter name="StateIn"/>
  1892. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1893. <method name="extrapolate"><type>void</type><template>
  1894. <template-type-parameter name="StateInOut"/>
  1895. </template><parameter name="k"><paramtype>size_t</paramtype></parameter><parameter name="table"><paramtype>state_table_type &amp;</paramtype></parameter><parameter name="coeff"><paramtype>const value_matrix &amp;</paramtype></parameter><parameter name="xest"><paramtype>StateInOut &amp;</paramtype></parameter></method>
  1896. </method-group>
  1897. <method-group name="public member functions">
  1898. <method name="do_step_impl"><type>void</type><template>
  1899. <template-type-parameter name="System"/>
  1900. <template-type-parameter name="StateIn"/>
  1901. <template-type-parameter name="DerivIn"/>
  1902. <template-type-parameter name="StateOut"/>
  1903. <template-type-parameter name="Err"/>
  1904. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype></parameter></method>
  1905. <method name="do_step_impl_io"><type>void</type><template>
  1906. <template-type-parameter name="System"/>
  1907. <template-type-parameter name="StateInOut"/>
  1908. <template-type-parameter name="DerivIn"/>
  1909. <template-type-parameter name="Err"/>
  1910. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inout"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype></parameter></method>
  1911. <method name="do_step_impl"><type>void</type><template>
  1912. <template-type-parameter name="System"/>
  1913. <template-type-parameter name="StateIn"/>
  1914. <template-type-parameter name="DerivIn"/>
  1915. <template-type-parameter name="StateOut"/>
  1916. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1917. <method name="do_step_impl_io"><type>void</type><template>
  1918. <template-type-parameter name="System"/>
  1919. <template-type-parameter name="StateInOut"/>
  1920. <template-type-parameter name="DerivIn"/>
  1921. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="inout"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1922. <method name="do_step_dxdt_impl"><type>void</type><template>
  1923. <template-type-parameter name="System"/>
  1924. <template-type-parameter name="StateInOut"/>
  1925. <template-type-parameter name="DerivIn"/>
  1926. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1927. <method name="do_step_dxdt_impl"><type>void</type><template>
  1928. <template-type-parameter name="System"/>
  1929. <template-type-parameter name="StateIn"/>
  1930. <template-type-parameter name="DerivIn"/>
  1931. <template-type-parameter name="StateOut"/>
  1932. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1933. <method name="adjust_size"><type>void</type><template>
  1934. <template-type-parameter name="StateIn"/>
  1935. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1936. </method-group>
  1937. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default></parameter></constructor>
  1938. </class>
  1939. </namespace>
  1940. </namespace>
  1941. </namespace>
  1942. </header>
  1943. <header name="boost/numeric/odeint/stepper/generation.hpp">
  1944. </header>
  1945. <header name="boost/numeric/odeint/stepper/implicit_euler.hpp">
  1946. <namespace name="boost">
  1947. <namespace name="numeric">
  1948. <namespace name="odeint">
  1949. <class name="implicit_euler"><template>
  1950. <template-type-parameter name="ValueType"/>
  1951. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  1952. </template><typedef name="value_type"><type>ValueType</type></typedef>
  1953. <typedef name="time_type"><type>value_type</type></typedef>
  1954. <typedef name="state_type"><type>boost::numeric::ublas::vector&lt; value_type &gt;</type></typedef>
  1955. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  1956. <typedef name="deriv_type"><type>state_type</type></typedef>
  1957. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  1958. <typedef name="matrix_type"><type>boost::numeric::ublas::matrix&lt; value_type &gt;</type></typedef>
  1959. <typedef name="wrapped_matrix_type"><type>state_wrapper&lt; matrix_type &gt;</type></typedef>
  1960. <typedef name="pmatrix_type"><type>boost::numeric::ublas::permutation_matrix&lt; size_t &gt;</type></typedef>
  1961. <typedef name="wrapped_pmatrix_type"><type>state_wrapper&lt; pmatrix_type &gt;</type></typedef>
  1962. <typedef name="resizer_type"><type>Resizer</type></typedef>
  1963. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  1964. <typedef name="stepper_type"><type>implicit_euler&lt; ValueType, Resizer &gt;</type></typedef>
  1965. <method-group name="public member functions">
  1966. <method name="do_step"><type>void</type><template>
  1967. <template-type-parameter name="System"/>
  1968. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  1969. <method name="adjust_size"><type>void</type><template>
  1970. <template-type-parameter name="StateType"/>
  1971. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  1972. </method-group>
  1973. <constructor><parameter name="epsilon"><paramtype>value_type</paramtype><default>1E-6</default></parameter></constructor>
  1974. <method-group name="private member functions">
  1975. <method name="resize_impl"><type>bool</type><template>
  1976. <template-type-parameter name="StateIn"/>
  1977. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  1978. <method name="solve"><type>void</type><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="m"><paramtype>matrix_type &amp;</paramtype></parameter></method>
  1979. </method-group>
  1980. </class>
  1981. </namespace>
  1982. </namespace>
  1983. </namespace>
  1984. </header>
  1985. <header name="boost/numeric/odeint/stepper/modified_midpoint.hpp">
  1986. <namespace name="boost">
  1987. <namespace name="numeric">
  1988. <namespace name="odeint">
  1989. <class name="modified_midpoint"><template>
  1990. <template-type-parameter name="State"/>
  1991. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  1992. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  1993. <template-type-parameter name="Time"><default>Value</default></template-type-parameter>
  1994. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  1995. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default></template-type-parameter>
  1996. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  1997. </template><inherit access="public">explicit_stepper_base</inherit><description><para>Implementation of the modified midpoint method with a configurable number of intermediate steps. This class is used by the Bulirsch-Stoer algorithm and is not meant for direct usage. </para></description><typedef name="stepper_base_type"><type>explicit_stepper_base&lt; <classname>modified_midpoint</classname>&lt; State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;, 2, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</type></typedef>
  1998. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  1999. <typedef name="wrapped_state_type"><type>stepper_base_type::wrapped_state_type</type></typedef>
  2000. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2001. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2002. <typedef name="wrapped_deriv_type"><type>stepper_base_type::wrapped_deriv_type</type></typedef>
  2003. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2004. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2005. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2006. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2007. <typedef name="stepper_type"><type>stepper_base_type::stepper_type</type></typedef>
  2008. <method-group name="public member functions">
  2009. <method name="do_step_impl"><type>void</type><template>
  2010. <template-type-parameter name="System"/>
  2011. <template-type-parameter name="StateIn"/>
  2012. <template-type-parameter name="DerivIn"/>
  2013. <template-type-parameter name="StateOut"/>
  2014. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  2015. <method name="set_steps"><type>void</type><parameter name="steps"><paramtype>unsigned short</paramtype></parameter></method>
  2016. <method name="steps" cv="const"><type>unsigned short</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2017. <method name="adjust_size"><type>void</type><template>
  2018. <template-type-parameter name="StateIn"/>
  2019. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2020. </method-group>
  2021. <constructor><parameter name="steps"><paramtype>unsigned short</paramtype><default>2</default></parameter><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default></parameter></constructor>
  2022. <method-group name="private member functions">
  2023. <method name="resize_impl"><type>bool</type><template>
  2024. <template-type-parameter name="StateIn"/>
  2025. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2026. </method-group>
  2027. </class><class name="modified_midpoint_dense_out"><template>
  2028. <template-type-parameter name="State"/>
  2029. <template-type-parameter name="Value"><default>double</default></template-type-parameter>
  2030. <template-type-parameter name="Deriv"><default>State</default></template-type-parameter>
  2031. <template-type-parameter name="Time"><default>Value</default></template-type-parameter>
  2032. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default></template-type-parameter>
  2033. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default></template-type-parameter>
  2034. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  2035. </template><description><para>Implementation of the modified midpoint method with a configurable number of intermediate steps. This class is used by the dense output Bulirsch-Stoer algorithm and is not meant for direct usage. <note><para>This stepper is for internal use only and does not meet any stepper concept. </para>
  2036. </note>
  2037. </para></description><typedef name="state_type"><type>State</type></typedef>
  2038. <typedef name="value_type"><type>Value</type></typedef>
  2039. <typedef name="deriv_type"><type>Deriv</type></typedef>
  2040. <typedef name="time_type"><type>Time</type></typedef>
  2041. <typedef name="algebra_type"><type>Algebra</type></typedef>
  2042. <typedef name="operations_type"><type>Operations</type></typedef>
  2043. <typedef name="resizer_type"><type>Resizer</type></typedef>
  2044. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  2045. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  2046. <typedef name="stepper_type"><type><classname>modified_midpoint_dense_out</classname>&lt; State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</type></typedef>
  2047. <typedef name="deriv_table_type"><type>std::vector&lt; wrapped_deriv_type &gt;</type></typedef>
  2048. <method-group name="public member functions">
  2049. <method name="do_step"><type>void</type><template>
  2050. <template-type-parameter name="System"/>
  2051. <template-type-parameter name="StateIn"/>
  2052. <template-type-parameter name="DerivIn"/>
  2053. <template-type-parameter name="StateOut"/>
  2054. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="x_mp"><paramtype>state_type &amp;</paramtype></parameter><parameter name="derivs"><paramtype>deriv_table_type &amp;</paramtype></parameter></method>
  2055. <method name="set_steps"><type>void</type><parameter name="steps"><paramtype>unsigned short</paramtype></parameter></method>
  2056. <method name="steps" cv="const"><type>unsigned short</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2057. <method name="resize"><type>bool</type><template>
  2058. <template-type-parameter name="StateIn"/>
  2059. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2060. <method name="adjust_size"><type>void</type><template>
  2061. <template-type-parameter name="StateIn"/>
  2062. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2063. </method-group>
  2064. <constructor><parameter name="steps"><paramtype>unsigned short</paramtype><default>2</default></parameter><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default></parameter></constructor>
  2065. </class>
  2066. </namespace>
  2067. </namespace>
  2068. </namespace>
  2069. </header>
  2070. <header name="boost/numeric/odeint/stepper/rosenbrock4.hpp">
  2071. <namespace name="boost">
  2072. <namespace name="numeric">
  2073. <namespace name="odeint">
  2074. <struct name="default_rosenbrock_coefficients"><template>
  2075. <template-type-parameter name="Value"/>
  2076. </template><typedef name="value_type"><type>Value</type></typedef>
  2077. <typedef name="order_type"><type>unsigned short</type></typedef>
  2078. <data-member name="gamma"><type>const value_type</type></data-member>
  2079. <data-member name="d1"><type>const value_type</type></data-member>
  2080. <data-member name="d2"><type>const value_type</type></data-member>
  2081. <data-member name="d3"><type>const value_type</type></data-member>
  2082. <data-member name="d4"><type>const value_type</type></data-member>
  2083. <data-member name="c2"><type>const value_type</type></data-member>
  2084. <data-member name="c3"><type>const value_type</type></data-member>
  2085. <data-member name="c4"><type>const value_type</type></data-member>
  2086. <data-member name="c21"><type>const value_type</type></data-member>
  2087. <data-member name="a21"><type>const value_type</type></data-member>
  2088. <data-member name="c31"><type>const value_type</type></data-member>
  2089. <data-member name="c32"><type>const value_type</type></data-member>
  2090. <data-member name="a31"><type>const value_type</type></data-member>
  2091. <data-member name="a32"><type>const value_type</type></data-member>
  2092. <data-member name="c41"><type>const value_type</type></data-member>
  2093. <data-member name="c42"><type>const value_type</type></data-member>
  2094. <data-member name="c43"><type>const value_type</type></data-member>
  2095. <data-member name="a41"><type>const value_type</type></data-member>
  2096. <data-member name="a42"><type>const value_type</type></data-member>
  2097. <data-member name="a43"><type>const value_type</type></data-member>
  2098. <data-member name="c51"><type>const value_type</type></data-member>
  2099. <data-member name="c52"><type>const value_type</type></data-member>
  2100. <data-member name="c53"><type>const value_type</type></data-member>
  2101. <data-member name="c54"><type>const value_type</type></data-member>
  2102. <data-member name="a51"><type>const value_type</type></data-member>
  2103. <data-member name="a52"><type>const value_type</type></data-member>
  2104. <data-member name="a53"><type>const value_type</type></data-member>
  2105. <data-member name="a54"><type>const value_type</type></data-member>
  2106. <data-member name="c61"><type>const value_type</type></data-member>
  2107. <data-member name="c62"><type>const value_type</type></data-member>
  2108. <data-member name="c63"><type>const value_type</type></data-member>
  2109. <data-member name="c64"><type>const value_type</type></data-member>
  2110. <data-member name="c65"><type>const value_type</type></data-member>
  2111. <data-member name="d21"><type>const value_type</type></data-member>
  2112. <data-member name="d22"><type>const value_type</type></data-member>
  2113. <data-member name="d23"><type>const value_type</type></data-member>
  2114. <data-member name="d24"><type>const value_type</type></data-member>
  2115. <data-member name="d25"><type>const value_type</type></data-member>
  2116. <data-member name="d31"><type>const value_type</type></data-member>
  2117. <data-member name="d32"><type>const value_type</type></data-member>
  2118. <data-member name="d33"><type>const value_type</type></data-member>
  2119. <data-member name="d34"><type>const value_type</type></data-member>
  2120. <data-member name="d35"><type>const value_type</type></data-member>
  2121. <data-member name="stepper_order" specifiers="static"><type>const order_type</type></data-member>
  2122. <data-member name="error_order" specifiers="static"><type>const order_type</type></data-member>
  2123. <method-group name="public member functions">
  2124. </method-group>
  2125. <constructor><parameter name=""><paramtype>void</paramtype></parameter></constructor>
  2126. </struct><class name="rosenbrock4"><template>
  2127. <template-type-parameter name="Value"/>
  2128. <template-type-parameter name="Coefficients"><default>default_rosenbrock_coefficients&lt; Value &gt;</default></template-type-parameter>
  2129. <template-type-parameter name="Resizer"><default>initially_resizer</default></template-type-parameter>
  2130. </template><typedef name="value_type"><type>Value</type></typedef>
  2131. <typedef name="state_type"><type>boost::numeric::ublas::vector&lt; value_type &gt;</type></typedef>
  2132. <typedef name="deriv_type"><type>state_type</type></typedef>
  2133. <typedef name="time_type"><type>value_type</type></typedef>
  2134. <typedef name="matrix_type"><type>boost::numeric::ublas::matrix&lt; value_type &gt;</type></typedef>
  2135. <typedef name="pmatrix_type"><type>boost::numeric::ublas::permutation_matrix&lt; size_t &gt;</type></typedef>
  2136. <typedef name="resizer_type"><type>Resizer</type></typedef>
  2137. <typedef name="rosenbrock_coefficients"><type>Coefficients</type></typedef>
  2138. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  2139. <typedef name="order_type"><type>unsigned short</type></typedef>
  2140. <typedef name="wrapped_state_type"><type>state_wrapper&lt; state_type &gt;</type></typedef>
  2141. <typedef name="wrapped_deriv_type"><type>state_wrapper&lt; deriv_type &gt;</type></typedef>
  2142. <typedef name="wrapped_matrix_type"><type>state_wrapper&lt; matrix_type &gt;</type></typedef>
  2143. <typedef name="wrapped_pmatrix_type"><type>state_wrapper&lt; pmatrix_type &gt;</type></typedef>
  2144. <typedef name="stepper_type"><type>rosenbrock4&lt; Value, Coefficients, Resizer &gt;</type></typedef>
  2145. <data-member name="stepper_order" specifiers="static"><type>const order_type</type></data-member>
  2146. <data-member name="error_order" specifiers="static"><type>const order_type</type></data-member>
  2147. <method-group name="public member functions">
  2148. <method name="order" cv="const"><type>order_type</type></method>
  2149. <method name="do_step"><type>void</type><template>
  2150. <template-type-parameter name="System"/>
  2151. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="xout"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>state_type &amp;</paramtype></parameter></method>
  2152. <method name="do_step"><type>void</type><template>
  2153. <template-type-parameter name="System"/>
  2154. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter><parameter name="xerr"><paramtype>state_type &amp;</paramtype></parameter></method>
  2155. <method name="do_step"><type>void</type><template>
  2156. <template-type-parameter name="System"/>
  2157. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="xout"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  2158. <method name="do_step"><type>void</type><template>
  2159. <template-type-parameter name="System"/>
  2160. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  2161. <method name="prepare_dense_output"><type>void</type></method>
  2162. <method name="calc_state"><type>void</type><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="x_old"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t_old"><paramtype>time_type</paramtype></parameter><parameter name="x_new"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t_new"><paramtype>time_type</paramtype></parameter></method>
  2163. <method name="adjust_size"><type>void</type><template>
  2164. <template-type-parameter name="StateType"/>
  2165. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  2166. </method-group>
  2167. <constructor><parameter name=""><paramtype>void</paramtype></parameter></constructor>
  2168. <method-group name="protected member functions">
  2169. <method name="resize_impl"><type>bool</type><template>
  2170. <template-type-parameter name="StateIn"/>
  2171. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2172. <method name="resize_x_err"><type>bool</type><template>
  2173. <template-type-parameter name="StateIn"/>
  2174. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2175. </method-group>
  2176. </class>
  2177. </namespace>
  2178. </namespace>
  2179. </namespace>
  2180. </header>
  2181. <header name="boost/numeric/odeint/stepper/rosenbrock4_controller.hpp">
  2182. <namespace name="boost">
  2183. <namespace name="numeric">
  2184. <namespace name="odeint">
  2185. <class name="rosenbrock4_controller"><template>
  2186. <template-type-parameter name="Stepper"/>
  2187. </template><typedef name="stepper_type"><type>Stepper</type></typedef>
  2188. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  2189. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  2190. <typedef name="wrapped_state_type"><type>stepper_type::wrapped_state_type</type></typedef>
  2191. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  2192. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  2193. <typedef name="wrapped_deriv_type"><type>stepper_type::wrapped_deriv_type</type></typedef>
  2194. <typedef name="resizer_type"><type>stepper_type::resizer_type</type></typedef>
  2195. <typedef name="stepper_category"><type>controlled_stepper_tag</type></typedef>
  2196. <typedef name="controller_type"><type>rosenbrock4_controller&lt; Stepper &gt;</type></typedef>
  2197. <method-group name="public member functions">
  2198. <method name="error"><type>value_type</type><parameter name="x"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="xold"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="xerr"><paramtype>const state_type &amp;</paramtype></parameter></method>
  2199. <method name="last_error" cv="const"><type>value_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2200. <method name="try_step"><type>boost::numeric::odeint::controlled_step_result</type><template>
  2201. <template-type-parameter name="System"/>
  2202. </template><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  2203. <method name="try_step"><type>boost::numeric::odeint::controlled_step_result</type><template>
  2204. <template-type-parameter name="System"/>
  2205. </template><parameter name="sys"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>const state_type &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type &amp;</paramtype></parameter><parameter name="xout"><paramtype>state_type &amp;</paramtype></parameter><parameter name="dt"><paramtype>time_type &amp;</paramtype></parameter></method>
  2206. <method name="adjust_size"><type>void</type><template>
  2207. <template-type-parameter name="StateType"/>
  2208. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  2209. <method name="stepper"><type>stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2210. <method name="stepper" cv="const"><type>const stepper_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2211. </method-group>
  2212. <constructor><parameter name="atol"><paramtype>value_type</paramtype><default>1.0e-6</default></parameter><parameter name="rtol"><paramtype>value_type</paramtype><default>1.0e-6</default></parameter><parameter name="stepper"><paramtype>const stepper_type &amp;</paramtype><default>stepper_type()</default></parameter></constructor>
  2213. <constructor><parameter name="atol"><paramtype>value_type</paramtype></parameter><parameter name="rtol"><paramtype>value_type</paramtype></parameter><parameter name="max_dt"><paramtype>time_type</paramtype></parameter><parameter name="stepper"><paramtype>const stepper_type &amp;</paramtype><default>stepper_type()</default></parameter></constructor>
  2214. <method-group name="protected member functions">
  2215. <method name="resize_m_xerr"><type>bool</type><template>
  2216. <template-type-parameter name="StateIn"/>
  2217. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2218. <method name="resize_m_xnew"><type>bool</type><template>
  2219. <template-type-parameter name="StateIn"/>
  2220. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2221. </method-group>
  2222. </class>
  2223. </namespace>
  2224. </namespace>
  2225. </namespace>
  2226. </header>
  2227. <header name="boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp">
  2228. <namespace name="boost">
  2229. <namespace name="numeric">
  2230. <namespace name="odeint">
  2231. <class name="rosenbrock4_dense_output"><template>
  2232. <template-type-parameter name="ControlledStepper"/>
  2233. </template><typedef name="controlled_stepper_type"><type>ControlledStepper</type></typedef>
  2234. <typedef name="unwrapped_controlled_stepper_type"><type>unwrap_reference&lt; controlled_stepper_type &gt;::type</type></typedef>
  2235. <typedef name="stepper_type"><type>unwrapped_controlled_stepper_type::stepper_type</type></typedef>
  2236. <typedef name="value_type"><type>stepper_type::value_type</type></typedef>
  2237. <typedef name="state_type"><type>stepper_type::state_type</type></typedef>
  2238. <typedef name="wrapped_state_type"><type>stepper_type::wrapped_state_type</type></typedef>
  2239. <typedef name="time_type"><type>stepper_type::time_type</type></typedef>
  2240. <typedef name="deriv_type"><type>stepper_type::deriv_type</type></typedef>
  2241. <typedef name="wrapped_deriv_type"><type>stepper_type::wrapped_deriv_type</type></typedef>
  2242. <typedef name="resizer_type"><type>stepper_type::resizer_type</type></typedef>
  2243. <typedef name="stepper_category"><type>dense_output_stepper_tag</type></typedef>
  2244. <typedef name="dense_output_stepper_type"><type>rosenbrock4_dense_output&lt; ControlledStepper &gt;</type></typedef>
  2245. <method-group name="public member functions">
  2246. <method name="initialize"><type>void</type><template>
  2247. <template-type-parameter name="StateType"/>
  2248. </template><parameter name="x0"><paramtype>const StateType &amp;</paramtype></parameter><parameter name="t0"><paramtype>time_type</paramtype></parameter><parameter name="dt0"><paramtype>time_type</paramtype></parameter></method>
  2249. <method name="do_step"><type>std::pair&lt; time_type, time_type &gt;</type><template>
  2250. <template-type-parameter name="System"/>
  2251. </template><parameter name="system"><paramtype>System</paramtype></parameter></method>
  2252. <method name="calc_state"><type>void</type><template>
  2253. <template-type-parameter name="StateOut"/>
  2254. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype></parameter></method>
  2255. <method name="calc_state"><type>void</type><template>
  2256. <template-type-parameter name="StateOut"/>
  2257. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>const StateOut &amp;</paramtype></parameter></method>
  2258. <method name="adjust_size"><type>void</type><template>
  2259. <template-type-parameter name="StateType"/>
  2260. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype></parameter></method>
  2261. <method name="current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2262. <method name="current_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2263. <method name="previous_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2264. <method name="previous_time" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2265. <method name="current_time_step" cv="const"><type>time_type</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2266. </method-group>
  2267. <constructor><parameter name="stepper"><paramtype>const controlled_stepper_type &amp;</paramtype><default>controlled_stepper_type()</default></parameter></constructor>
  2268. <method-group name="private member functions">
  2269. <method name="get_current_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2270. <method name="get_current_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2271. <method name="get_old_state"><type>state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2272. <method name="get_old_state" cv="const"><type>const state_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2273. <method name="toggle_current_state"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2274. <method name="resize_impl"><type>bool</type><template>
  2275. <template-type-parameter name="StateIn"/>
  2276. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2277. </method-group>
  2278. </class>
  2279. </namespace>
  2280. </namespace>
  2281. </namespace>
  2282. </header>
  2283. <header name="boost/numeric/odeint/stepper/runge_kutta4.hpp">
  2284. <namespace name="boost">
  2285. <namespace name="numeric">
  2286. <namespace name="odeint">
  2287. <class name="runge_kutta4"><template>
  2288. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2289. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2290. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2291. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2292. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2293. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2294. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2295. </template><inherit access="public">boost::numeric::odeint::explicit_generic_rk&lt; StageCount, Order, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</inherit><purpose>The classical Runge-Kutta stepper of fourth order. </purpose><description><para>The Runge-Kutta method of fourth order is one standard method for solving ordinary differential equations and is widely used, see also <ulink url="http://en.wikipedia.org/wiki/Runge%E2%80%93Kutta_methods">en.wikipedia.org/wiki/Runge-Kutta_methods</ulink> The method is explicit and fulfills the Stepper concept. Step size control or continuous output are not provided.</para><para>This class derives from explicit_stepper_base and inherits its interface via CRTP (current recurring template pattern). Furthermore, it derivs from <classname alt="boost::numeric::odeint::explicit_generic_rk">explicit_generic_rk</classname> which is a generic Runge-Kutta algorithm. For more details see explicit_stepper_base and <classname alt="boost::numeric::odeint::explicit_generic_rk">explicit_generic_rk</classname>.</para><para>
  2296. </para></description><typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2297. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2298. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2299. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2300. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2301. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2302. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2303. <method-group name="public member functions">
  2304. <method name="do_step_impl"><type>void</type><template>
  2305. <template-type-parameter name="System"/>
  2306. <template-type-parameter name="StateIn"/>
  2307. <template-type-parameter name="DerivIn"/>
  2308. <template-type-parameter name="StateOut"/>
  2309. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out of place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2310. </para></description></method>
  2311. <method name="adjust_size"><type>void</type><template>
  2312. <template-type-parameter name="StateIn"/>
  2313. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2314. </para></description></method>
  2315. </method-group>
  2316. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::runge_kutta4">runge_kutta4</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2317. </para></description></constructor>
  2318. </class>
  2319. </namespace>
  2320. </namespace>
  2321. </namespace>
  2322. </header>
  2323. <header name="boost/numeric/odeint/stepper/runge_kutta4_classic.hpp">
  2324. <namespace name="boost">
  2325. <namespace name="numeric">
  2326. <namespace name="odeint">
  2327. <class name="runge_kutta4_classic"><template>
  2328. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2329. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2330. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2331. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2332. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2333. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2334. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2335. </template><inherit access="public">explicit_stepper_base</inherit><purpose>The classical Runge-Kutta stepper of fourth order. </purpose><description><para>The Runge-Kutta method of fourth order is one standard method for solving ordinary differential equations and is widely used, see also <ulink url="http://en.wikipedia.org/wiki/Runge%E2%80%93Kutta_methods">en.wikipedia.org/wiki/Runge-Kutta_methods</ulink> The method is explicit and fulfills the Stepper concept. Step size control or continuous output are not provided. This class implements the method directly, hence the generic Runge-Kutta algorithm is not used.</para><para>This class derives from explicit_stepper_base and inherits its interface via CRTP (current recurring template pattern). For more details see explicit_stepper_base.</para><para>
  2336. </para></description><typedef name="stepper_base_type"><type>explicit_stepper_base&lt; <classname>runge_kutta4_classic</classname>&lt; ... &gt;,... &gt;</type></typedef>
  2337. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2338. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2339. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2340. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2341. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2342. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2343. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2344. <method-group name="public member functions">
  2345. <method name="do_step_impl"><type>void</type><template>
  2346. <template-type-parameter name="System"/>
  2347. <template-type-parameter name="StateIn"/>
  2348. <template-type-parameter name="DerivIn"/>
  2349. <template-type-parameter name="StateOut"/>
  2350. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out of place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2351. </para></description></method>
  2352. <method name="adjust_size"><type>void</type><template>
  2353. <template-type-parameter name="StateType"/>
  2354. </template><parameter name="x"><paramtype>const StateType &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2355. </para></description></method>
  2356. </method-group>
  2357. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::runge_kutta4_classic">runge_kutta4_classic</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2358. </para></description></constructor>
  2359. <method-group name="private member functions">
  2360. <method name="resize_impl"><type>bool</type><template>
  2361. <template-type-parameter name="StateIn"/>
  2362. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2363. </method-group>
  2364. </class>
  2365. </namespace>
  2366. </namespace>
  2367. </namespace>
  2368. </header>
  2369. <header name="boost/numeric/odeint/stepper/runge_kutta_cash_karp54.hpp">
  2370. <namespace name="boost">
  2371. <namespace name="numeric">
  2372. <namespace name="odeint">
  2373. <class name="runge_kutta_cash_karp54"><template>
  2374. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2375. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2376. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2377. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2378. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2379. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2380. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2381. </template><inherit access="public">boost::numeric::odeint::explicit_error_generic_rk&lt; StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</inherit><purpose>The Runge-Kutta Cash-Karp method. </purpose><description><para>The Runge-Kutta Cash-Karp method is one of the standard methods for solving ordinary differential equations, see <ulink url="http://en.wikipedia.org/wiki/Cash%E2%80%93Karp_methods">en.wikipedia.org/wiki/Cash-Karp_methods</ulink>. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is not available for this method.</para><para>This class derives from explicit_error_stepper_base and inherits its interface via CRTP (current recurring template pattern). Furthermore, it derivs from <classname alt="boost::numeric::odeint::explicit_error_generic_rk">explicit_error_generic_rk</classname> which is a generic Runge-Kutta algorithm with error estimation. For more details see explicit_error_stepper_base and <classname alt="boost::numeric::odeint::explicit_error_generic_rk">explicit_error_generic_rk</classname>.</para><para>
  2382. </para></description><typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2383. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2384. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2385. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2386. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2387. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2388. <typedef name="resizer_typ"><type>stepper_base_type::resizer_type</type></typedef>
  2389. <method-group name="public member functions">
  2390. <method name="do_step_impl"><type>void</type><template>
  2391. <template-type-parameter name="System"/>
  2392. <template-type-parameter name="StateIn"/>
  2393. <template-type-parameter name="DerivIn"/>
  2394. <template-type-parameter name="StateOut"/>
  2395. <template-type-parameter name="Err"/>
  2396. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype><description><para>The result of the error estimation is written in xerr. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Futhermore, an estimation of the error is stored in <computeroutput>xerr</computeroutput>. <computeroutput>do_step_impl</computeroutput> is used by explicit_error_stepper_base. </purpose><description><para>
  2397. </para></description></method>
  2398. <method name="do_step_impl"><type>void</type><template>
  2399. <template-type-parameter name="System"/>
  2400. <template-type-parameter name="StateIn"/>
  2401. <template-type-parameter name="DerivIn"/>
  2402. <template-type-parameter name="StateOut"/>
  2403. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2404. </para></description></method>
  2405. <method name="adjust_size"><type>void</type><template>
  2406. <template-type-parameter name="StateIn"/>
  2407. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2408. </para></description></method>
  2409. </method-group>
  2410. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::runge_kutta_cash_karp54">runge_kutta_cash_karp54</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2411. </para></description></constructor>
  2412. </class>
  2413. </namespace>
  2414. </namespace>
  2415. </namespace>
  2416. </header>
  2417. <header name="boost/numeric/odeint/stepper/runge_kutta_cash_karp54_classic.hpp">
  2418. <namespace name="boost">
  2419. <namespace name="numeric">
  2420. <namespace name="odeint">
  2421. <class name="runge_kutta_cash_karp54_classic"><template>
  2422. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2423. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2424. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2425. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2426. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2427. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2428. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2429. </template><inherit access="public">explicit_error_stepper_base</inherit><purpose>The Runge-Kutta Cash-Karp method implemented without the generic Runge-Kutta algorithm. </purpose><description><para>The Runge-Kutta Cash-Karp method is one of the standard methods for solving ordinary differential equations, see <ulink url="http://en.wikipedia.org/wiki/Cash%E2%80%93Karp_method">en.wikipedia.org/wiki/Cash-Karp_method</ulink>. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is not available for this method.</para><para>This class derives from explicit_error_stepper_base and inherits its interface via CRTP (current recurring template pattern). This class implements the method directly, hence the generic Runge-Kutta algorithm is not used.</para><para>
  2430. </para></description><typedef name="stepper_base_type"><type>explicit_error_stepper_base&lt; <classname>runge_kutta_cash_karp54_classic</classname>&lt; ... &gt;,... &gt;</type></typedef>
  2431. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2432. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2433. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2434. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2435. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2436. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2437. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2438. <method-group name="public member functions">
  2439. <method name="do_step_impl"><type>void</type><template>
  2440. <template-type-parameter name="System"/>
  2441. <template-type-parameter name="StateIn"/>
  2442. <template-type-parameter name="DerivIn"/>
  2443. <template-type-parameter name="StateOut"/>
  2444. <template-type-parameter name="Err"/>
  2445. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype><description><para>The result of the error estimation is written in xerr. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. </purpose><description><para>The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Futhermore, an estimation of the error is stored in <computeroutput>xerr</computeroutput>. Access to this step functionality is provided by explicit_error_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly.</para><para>
  2446. </para></description></method>
  2447. <method name="do_step_impl"><type>void</type><template>
  2448. <template-type-parameter name="System"/>
  2449. <template-type-parameter name="StateIn"/>
  2450. <template-type-parameter name="DerivIn"/>
  2451. <template-type-parameter name="StateOut"/>
  2452. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_error_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2453. </para></description></method>
  2454. <method name="adjust_size"><type>void</type><template>
  2455. <template-type-parameter name="StateIn"/>
  2456. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2457. </para></description></method>
  2458. </method-group>
  2459. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::runge_kutta_cash_karp54_classic">runge_kutta_cash_karp54_classic</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2460. </para></description></constructor>
  2461. <method-group name="private member functions">
  2462. <method name="resize_impl"><type>bool</type><template>
  2463. <template-type-parameter name="StateIn"/>
  2464. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2465. </method-group>
  2466. </class>
  2467. </namespace>
  2468. </namespace>
  2469. </namespace>
  2470. </header>
  2471. <header name="boost/numeric/odeint/stepper/runge_kutta_dopri5.hpp">
  2472. <namespace name="boost">
  2473. <namespace name="numeric">
  2474. <namespace name="odeint">
  2475. <class name="runge_kutta_dopri5"><template>
  2476. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2477. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2478. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2479. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2480. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2481. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2482. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2483. </template><inherit access="public">explicit_error_stepper_fsal_base</inherit><purpose>The Runge-Kutta Dormand-Prince 5 method. </purpose><description><para>The Runge-Kutta Dormand-Prince 5 method is a very popular method for solving ODEs, see <ulink url=""/>. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is available which make this method favourable for many applications.</para><para>This class derives from explicit_error_stepper_fsal_base and inherits its interface via CRTP (current recurring template pattern). The method possesses the FSAL (first-same-as-last) property. See explicit_error_stepper_fsal_base for more details.</para><para>
  2484. </para></description><typedef name="stepper_base_type"><type>explicit_error_stepper_fsal_base&lt; <classname>runge_kutta_dopri5</classname>&lt; ... &gt;,... &gt;</type></typedef>
  2485. <typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2486. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2487. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2488. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2489. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2490. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2491. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2492. <method-group name="public member functions">
  2493. <method name="do_step_impl"><type>void</type><template>
  2494. <template-type-parameter name="System"/>
  2495. <template-type-parameter name="StateIn"/>
  2496. <template-type-parameter name="DerivIn"/>
  2497. <template-type-parameter name="StateOut"/>
  2498. <template-type-parameter name="DerivOut"/>
  2499. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt_in"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. dxdt_in is not modified by this method </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dxdt_out"><paramtype>DerivOut &amp;</paramtype><description><para>The result of the new derivative at time t+dt. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt_in</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Furthermore, the derivative is update out-of-place, hence the input is assumed to be in <computeroutput>dxdt_in</computeroutput> and the output in <computeroutput>dxdt_out</computeroutput>. Access to this step functionality is provided by explicit_error_stepper_fsal_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2500. </para></description></method>
  2501. <method name="do_step_impl"><type>void</type><template>
  2502. <template-type-parameter name="System"/>
  2503. <template-type-parameter name="StateIn"/>
  2504. <template-type-parameter name="DerivIn"/>
  2505. <template-type-parameter name="StateOut"/>
  2506. <template-type-parameter name="DerivOut"/>
  2507. <template-type-parameter name="Err"/>
  2508. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt_in"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. dxdt_in is not modified by this method </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dxdt_out"><paramtype>DerivOut &amp;</paramtype><description><para>The result of the new derivative at time t+dt. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype><description><para>An estimation of the error. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt_in</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Furthermore, the derivative is update out-of-place, hence the input is assumed to be in <computeroutput>dxdt_in</computeroutput> and the output in <computeroutput>dxdt_out</computeroutput>. Access to this step functionality is provided by explicit_error_stepper_fsal_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. An estimation of the error is calculated. </purpose><description><para>
  2509. </para></description></method>
  2510. <method name="calc_state" cv="const"><type>void</type><template>
  2511. <template-type-parameter name="StateOut"/>
  2512. <template-type-parameter name="StateIn1"/>
  2513. <template-type-parameter name="DerivIn1"/>
  2514. <template-type-parameter name="StateIn2"/>
  2515. <template-type-parameter name="DerivIn2"/>
  2516. </template><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="x"><paramtype>StateOut &amp;</paramtype></parameter><parameter name="x_old"><paramtype>const StateIn1 &amp;</paramtype></parameter><parameter name="deriv_old"><paramtype>const DerivIn1 &amp;</paramtype></parameter><parameter name="t_old"><paramtype>time_type</paramtype></parameter><parameter name=""><paramtype>const StateIn2 &amp;</paramtype></parameter><parameter name="deriv_new"><paramtype>const DerivIn2 &amp;</paramtype></parameter><parameter name="t_new"><paramtype>time_type</paramtype></parameter><purpose>This method is used for continuous output and it calculates the state <computeroutput>x</computeroutput> at a time <computeroutput>t</computeroutput> from the knowledge of two states <computeroutput>old_state</computeroutput> and <computeroutput>current_state</computeroutput> at time points <computeroutput>t_old</computeroutput> and <computeroutput>t_new</computeroutput>. It also uses internal variables to calculate the result. Hence this method must be called after two successful <computeroutput>do_step</computeroutput> calls. </purpose></method>
  2517. <method name="adjust_size"><type>void</type><template>
  2518. <template-type-parameter name="StateIn"/>
  2519. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2520. </para></description></method>
  2521. </method-group>
  2522. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::runge_kutta_dopri5">runge_kutta_dopri5</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2523. </para></description></constructor>
  2524. <method-group name="private member functions">
  2525. <method name="resize_k_x_tmp_impl"><type>bool</type><template>
  2526. <template-type-parameter name="StateIn"/>
  2527. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2528. <method name="resize_dxdt_tmp_impl"><type>bool</type><template>
  2529. <template-type-parameter name="StateIn"/>
  2530. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2531. </method-group>
  2532. </class>
  2533. </namespace>
  2534. </namespace>
  2535. </namespace>
  2536. </header>
  2537. <header name="boost/numeric/odeint/stepper/runge_kutta_fehlberg78.hpp">
  2538. <namespace name="boost">
  2539. <namespace name="numeric">
  2540. <namespace name="odeint">
  2541. <class name="runge_kutta_fehlberg78"><template>
  2542. <template-type-parameter name="State"><purpose><para>The state type. </para></purpose></template-type-parameter>
  2543. <template-type-parameter name="Value"><default>double</default><purpose><para>The value type. </para></purpose></template-type-parameter>
  2544. <template-type-parameter name="Deriv"><default>State</default><purpose><para>The type representing the time derivative of the state. </para></purpose></template-type-parameter>
  2545. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2546. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; State &gt;::algebra_type</default><purpose><para>The algebra type. </para></purpose></template-type-parameter>
  2547. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; State &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2548. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2549. </template><inherit access="public">boost::numeric::odeint::explicit_error_generic_rk&lt; StageCount, Order, StepperOrder, ErrorOrder, State, Value, Deriv, Time, Algebra, Operations, Resizer &gt;</inherit><purpose>The Runge-Kutta Fehlberg 78 method. </purpose><description><para>The Runge-Kutta Fehlberg 78 method is a standard method for high-precision applications. The method is explicit and fulfills the Error Stepper concept. Step size control is provided but continuous output is not available for this method.</para><para>This class derives from explicit_error_stepper_base and inherits its interface via CRTP (current recurring template pattern). Furthermore, it derivs from <classname alt="boost::numeric::odeint::explicit_error_generic_rk">explicit_error_generic_rk</classname> which is a generic Runge-Kutta algorithm with error estimation. For more details see explicit_error_stepper_base and <classname alt="boost::numeric::odeint::explicit_error_generic_rk">explicit_error_generic_rk</classname>.</para><para>
  2550. </para></description><typedef name="state_type"><type>stepper_base_type::state_type</type></typedef>
  2551. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2552. <typedef name="deriv_type"><type>stepper_base_type::deriv_type</type></typedef>
  2553. <typedef name="time_type"><type>stepper_base_type::time_type</type></typedef>
  2554. <typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2555. <typedef name="operations_type"><type>stepper_base_type::operations_type</type></typedef>
  2556. <typedef name="resizer_type"><type>stepper_base_type::resizer_type</type></typedef>
  2557. <method-group name="public member functions">
  2558. <method name="do_step_impl"><type>void</type><template>
  2559. <template-type-parameter name="System"/>
  2560. <template-type-parameter name="StateIn"/>
  2561. <template-type-parameter name="DerivIn"/>
  2562. <template-type-parameter name="StateOut"/>
  2563. <template-type-parameter name="Err"/>
  2564. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><parameter name="xerr"><paramtype>Err &amp;</paramtype><description><para>The result of the error estimation is written in xerr. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Futhermore, an estimation of the error is stored in <computeroutput>xerr</computeroutput>. <computeroutput>do_step_impl</computeroutput> is used by explicit_error_stepper_base. </purpose><description><para>
  2565. </para></description></method>
  2566. <method name="do_step_impl"><type>void</type><template>
  2567. <template-type-parameter name="System"/>
  2568. <template-type-parameter name="StateIn"/>
  2569. <template-type-parameter name="DerivIn"/>
  2570. <template-type-parameter name="StateOut"/>
  2571. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ODE. It must fulfill the Simple System concept. </para></description></parameter><parameter name="in"><paramtype>const StateIn &amp;</paramtype><description><para>The state of the ODE which should be solved. in is not modified in this method </para></description></parameter><parameter name="dxdt"><paramtype>const DerivIn &amp;</paramtype><description><para>The derivative of x at t. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="out"><paramtype>StateOut &amp;</paramtype><description><para>The result of the step is written in out. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. The derivative <computeroutput>dxdt</computeroutput> of <computeroutput>in</computeroutput> at the time <computeroutput>t</computeroutput> is passed to the method. The result is updated out-of-place, hence the input is in <computeroutput>in</computeroutput> and the output in <computeroutput>out</computeroutput>. Access to this step functionality is provided by explicit_stepper_base and <computeroutput>do_step_impl</computeroutput> should not be called directly. </purpose><description><para>
  2572. </para></description></method>
  2573. <method name="adjust_size"><type>void</type><template>
  2574. <template-type-parameter name="StateIn"/>
  2575. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2576. </para></description></method>
  2577. </method-group>
  2578. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the runge_kutta_cash_fehlberg78 class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2579. </para></description></constructor>
  2580. </class>
  2581. </namespace>
  2582. </namespace>
  2583. </namespace>
  2584. </header>
  2585. <header name="boost/numeric/odeint/stepper/stepper_categories.hpp">
  2586. <namespace name="boost">
  2587. <namespace name="numeric">
  2588. <namespace name="odeint">
  2589. <struct name="base_tag"><template>
  2590. <template-type-parameter name="tag"/>
  2591. </template></struct><struct-specialization name="base_tag"><template>
  2592. </template><specialization><template-arg>controlled_stepper_tag</template-arg></specialization><typedef name="type"><type>controlled_stepper_tag</type></typedef>
  2593. </struct-specialization><struct-specialization name="base_tag"><template>
  2594. </template><specialization><template-arg>dense_output_stepper_tag</template-arg></specialization><typedef name="type"><type>dense_output_stepper_tag</type></typedef>
  2595. </struct-specialization><struct-specialization name="base_tag"><template>
  2596. </template><specialization><template-arg>error_stepper_tag</template-arg></specialization><typedef name="type"><type>stepper_tag</type></typedef>
  2597. </struct-specialization><struct-specialization name="base_tag"><template>
  2598. </template><specialization><template-arg>explicit_controlled_stepper_fsal_tag</template-arg></specialization><typedef name="type"><type>controlled_stepper_tag</type></typedef>
  2599. </struct-specialization><struct-specialization name="base_tag"><template>
  2600. </template><specialization><template-arg>explicit_controlled_stepper_tag</template-arg></specialization><typedef name="type"><type>controlled_stepper_tag</type></typedef>
  2601. </struct-specialization><struct-specialization name="base_tag"><template>
  2602. </template><specialization><template-arg>explicit_error_stepper_fsal_tag</template-arg></specialization><typedef name="type"><type>stepper_tag</type></typedef>
  2603. </struct-specialization><struct-specialization name="base_tag"><template>
  2604. </template><specialization><template-arg>explicit_error_stepper_tag</template-arg></specialization><typedef name="type"><type>stepper_tag</type></typedef>
  2605. </struct-specialization><struct-specialization name="base_tag"><template>
  2606. </template><specialization><template-arg>stepper_tag</template-arg></specialization><typedef name="type"><type>stepper_tag</type></typedef>
  2607. </struct-specialization><struct name="controlled_stepper_tag"/><struct name="dense_output_stepper_tag"/><struct name="error_stepper_tag"><inherit access="public">boost::numeric::odeint::stepper_tag</inherit></struct><struct name="explicit_controlled_stepper_fsal_tag"><inherit access="public">boost::numeric::odeint::controlled_stepper_tag</inherit></struct><struct name="explicit_controlled_stepper_tag"><inherit access="public">boost::numeric::odeint::controlled_stepper_tag</inherit></struct><struct name="explicit_error_stepper_fsal_tag"><inherit access="public">boost::numeric::odeint::error_stepper_tag</inherit></struct><struct name="explicit_error_stepper_tag"><inherit access="public">boost::numeric::odeint::error_stepper_tag</inherit></struct><struct name="stepper_tag"/>
  2608. </namespace>
  2609. </namespace>
  2610. </namespace>
  2611. </header>
  2612. <header name="boost/numeric/odeint/stepper/symplectic_euler.hpp">
  2613. <namespace name="boost">
  2614. <namespace name="numeric">
  2615. <namespace name="odeint">
  2616. <class name="symplectic_euler"><template>
  2617. <template-type-parameter name="Coor"><purpose><para>The type representing the coordinates q. </para></purpose></template-type-parameter>
  2618. <template-type-parameter name="Momentum"><default>Coor</default><purpose><para>The type representing the coordinates p. </para></purpose></template-type-parameter>
  2619. <template-type-parameter name="Value"><default>double</default><purpose><para>The basic value type. Should be something like float, double or a high-precision type. </para></purpose></template-type-parameter>
  2620. <template-type-parameter name="CoorDeriv"><default>Coor</default><purpose><para>The type representing the time derivative of the coordinate dq/dt. </para></purpose></template-type-parameter>
  2621. <template-type-parameter name="MomentumDeriv"><default>Coor</default></template-type-parameter>
  2622. <template-type-parameter name="Time"><default>Value</default><purpose><para>The type representing the time t. </para></purpose></template-type-parameter>
  2623. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; Coor &gt;::algebra_type</default><purpose><para>The algebra. </para></purpose></template-type-parameter>
  2624. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; Coor &gt;::operations_type</default><purpose><para>The operations. </para></purpose></template-type-parameter>
  2625. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy. </para></purpose></template-type-parameter>
  2626. </template><inherit access="public">symplectic_nystroem_stepper_base</inherit><purpose>Implementation of the symplectic Euler method. </purpose><description><para>The method is of first order and has one stage. It is described HERE.</para><para>
  2627. </para></description><typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2628. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2629. <method-group name="public member functions">
  2630. </method-group>
  2631. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::symplectic_euler">symplectic_euler</classname>. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2632. </para></description></constructor>
  2633. </class>
  2634. </namespace>
  2635. </namespace>
  2636. </namespace>
  2637. </header>
  2638. <header name="boost/numeric/odeint/stepper/symplectic_rkn_sb3a_m4_mclachlan.hpp">
  2639. <namespace name="boost">
  2640. <namespace name="numeric">
  2641. <namespace name="odeint">
  2642. <class name="symplectic_rkn_sb3a_m4_mclachlan"><template>
  2643. <template-type-parameter name="Coor"><purpose><para>The type representing the coordinates q. </para></purpose></template-type-parameter>
  2644. <template-type-parameter name="Momentum"><default>Coor</default><purpose><para>The type representing the coordinates p. </para></purpose></template-type-parameter>
  2645. <template-type-parameter name="Value"><default>double</default><purpose><para>The basic value type. Should be something like float, double or a high-precision type. </para></purpose></template-type-parameter>
  2646. <template-type-parameter name="CoorDeriv"><default>Coor</default><purpose><para>The type representing the time derivative of the coordinate dq/dt. </para></purpose></template-type-parameter>
  2647. <template-type-parameter name="MomentumDeriv"><default>Coor</default></template-type-parameter>
  2648. <template-type-parameter name="Time"><default>Value</default><purpose><para>The type representing the time t. </para></purpose></template-type-parameter>
  2649. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; Coor &gt;::algebra_type</default><purpose><para>The algebra. </para></purpose></template-type-parameter>
  2650. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; Coor &gt;::operations_type</default><purpose><para>The operations. </para></purpose></template-type-parameter>
  2651. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy. </para></purpose></template-type-parameter>
  2652. </template><inherit access="public">symplectic_nystroem_stepper_base</inherit><purpose>Implementation of the symmetric B3A Runge-Kutta Nystroem method of fifth order. </purpose><description><para>The method is of fourth order and has five stages. It is described HERE. This method can be used with multiprecision types since the coefficients are defined analytically.</para><para>ToDo: add reference to paper.</para><para>
  2653. </para></description><typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2654. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2655. <method-group name="public member functions">
  2656. </method-group>
  2657. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::symplectic_rkn_sb3a_m4_mclachlan">symplectic_rkn_sb3a_m4_mclachlan</classname>. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2658. </para></description></constructor>
  2659. </class>
  2660. </namespace>
  2661. </namespace>
  2662. </namespace>
  2663. </header>
  2664. <header name="boost/numeric/odeint/stepper/symplectic_rkn_sb3a_mclachlan.hpp">
  2665. <namespace name="boost">
  2666. <namespace name="numeric">
  2667. <namespace name="odeint">
  2668. <class name="symplectic_rkn_sb3a_mclachlan"><template>
  2669. <template-type-parameter name="Coor"><purpose><para>The type representing the coordinates q. </para></purpose></template-type-parameter>
  2670. <template-type-parameter name="Momentum"><default>Coor</default><purpose><para>The type representing the coordinates p. </para></purpose></template-type-parameter>
  2671. <template-type-parameter name="Value"><default>double</default><purpose><para>The basic value type. Should be something like float, double or a high-precision type. </para></purpose></template-type-parameter>
  2672. <template-type-parameter name="CoorDeriv"><default>Coor</default><purpose><para>The type representing the time derivative of the coordinate dq/dt. </para></purpose></template-type-parameter>
  2673. <template-type-parameter name="MomentumDeriv"><default>Coor</default></template-type-parameter>
  2674. <template-type-parameter name="Time"><default>Value</default><purpose><para>The type representing the time t. </para></purpose></template-type-parameter>
  2675. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; Coor &gt;::algebra_type</default><purpose><para>The algebra. </para></purpose></template-type-parameter>
  2676. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; Coor &gt;::operations_type</default><purpose><para>The operations. </para></purpose></template-type-parameter>
  2677. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy. </para></purpose></template-type-parameter>
  2678. </template><inherit access="public">symplectic_nystroem_stepper_base</inherit><purpose>Implement of the symmetric B3A method of Runge-Kutta-Nystroem method of sixth order. </purpose><description><para>The method is of fourth order and has six stages. It is described HERE. This method cannot be used with multiprecision types since the coefficients are not defined analytically.</para><para>ToDo Add reference to the paper.</para><para>
  2679. </para></description><typedef name="algebra_type"><type>stepper_base_type::algebra_type</type></typedef>
  2680. <typedef name="value_type"><type>stepper_base_type::value_type</type></typedef>
  2681. <method-group name="public member functions">
  2682. </method-group>
  2683. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored inside explicit_stepper_base. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::symplectic_rkn_sb3a_mclachlan">symplectic_rkn_sb3a_mclachlan</classname>. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2684. </para></description></constructor>
  2685. </class>
  2686. </namespace>
  2687. </namespace>
  2688. </namespace>
  2689. </header>
  2690. <header name="boost/numeric/odeint/stepper/velocity_verlet.hpp">
  2691. <namespace name="boost">
  2692. <namespace name="numeric">
  2693. <namespace name="odeint">
  2694. <class name="velocity_verlet"><template>
  2695. <template-type-parameter name="Coor"><purpose><para>The type representing the coordinates. </para></purpose></template-type-parameter>
  2696. <template-type-parameter name="Velocity"><default>Coor</default><purpose><para>The type representing the velocities. </para></purpose></template-type-parameter>
  2697. <template-type-parameter name="Value"><default>double</default><purpose><para>The type value type. </para></purpose></template-type-parameter>
  2698. <template-type-parameter name="Acceleration"><default>Coor</default><purpose><para>The type representing the acceleration. </para></purpose></template-type-parameter>
  2699. <template-type-parameter name="Time"><default>Value</default><purpose><para>The time representing the independent variable - the time. </para></purpose></template-type-parameter>
  2700. <template-type-parameter name="TimeSq"><default>Time</default><purpose><para>The time representing the square of the time. </para></purpose></template-type-parameter>
  2701. <template-type-parameter name="Algebra"><default>typename algebra_dispatcher&lt; Coor &gt;::algebra_type</default><purpose><para>The algebra. </para></purpose></template-type-parameter>
  2702. <template-type-parameter name="Operations"><default>typename operations_dispatcher&lt; Coor &gt;::operations_type</default><purpose><para>The operations type. </para></purpose></template-type-parameter>
  2703. <template-type-parameter name="Resizer"><default>initially_resizer</default><purpose><para>The resizer policy type. </para></purpose></template-type-parameter>
  2704. </template><inherit access="public">algebra_stepper_base&lt; Algebra, Operations &gt;</inherit><purpose>The Velocity-Verlet algorithm. </purpose><description><para><ulink url="http://en.wikipedia.org/wiki/Verlet_integration">The Velocity-Verlet algorithm</ulink> is a method for simulation of molecular dynamics systems. It solves the ODE a=f(r,v',t) where r are the coordinates, v are the velocities and a are the accelerations, hence v = dr/dt, a=dv/dt.</para><para>
  2705. </para></description><typedef name="algebra_stepper_base_type"><type>algebra_stepper_base&lt; Algebra, Operations &gt;</type></typedef>
  2706. <typedef name="algebra_type"><type>algebra_stepper_base_type::algebra_type</type></typedef>
  2707. <typedef name="operations_type"><type>algebra_stepper_base_type::operations_type</type></typedef>
  2708. <typedef name="coor_type"><type>Coor</type></typedef>
  2709. <typedef name="velocity_type"><type>Velocity</type></typedef>
  2710. <typedef name="acceleration_type"><type>Acceleration</type></typedef>
  2711. <typedef name="state_type"><type>std::pair&lt; coor_type, velocity_type &gt;</type></typedef>
  2712. <typedef name="deriv_type"><type>std::pair&lt; velocity_type, acceleration_type &gt;</type></typedef>
  2713. <typedef name="wrapped_acceleration_type"><type>state_wrapper&lt; acceleration_type &gt;</type></typedef>
  2714. <typedef name="value_type"><type>Value</type></typedef>
  2715. <typedef name="time_type"><type>Time</type></typedef>
  2716. <typedef name="time_square_type"><type>TimeSq</type></typedef>
  2717. <typedef name="resizer_type"><type>Resizer</type></typedef>
  2718. <typedef name="stepper_category"><type>stepper_tag</type></typedef>
  2719. <typedef name="order_type"><type>unsigned short</type></typedef>
  2720. <data-member name="order_value" specifiers="static"><type>const order_type</type></data-member>
  2721. <method-group name="public member functions">
  2722. <method name="order" cv="const"><type>order_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para>
  2723. </para></description><returns><para>Returns the order of the stepper. </para>
  2724. </returns></method>
  2725. <method name="do_step"><type>void</type><template>
  2726. <template-type-parameter name="System"/>
  2727. <template-type-parameter name="StateInOut"/>
  2728. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Second Order System concept. </para></description></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. The state is pair of Coor and Velocity. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. It transforms the result in-place. </purpose><description><para>It can be used like <programlisting language="c++">pair&lt; coordinates , velocities &gt; state;
  2729. stepper.do_step( sys , x , t , dt );
  2730. </programlisting></para><para>
  2731. </para></description></method>
  2732. <method name="do_step"><type>void</type><template>
  2733. <template-type-parameter name="System"/>
  2734. <template-type-parameter name="StateInOut"/>
  2735. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Second Order System concept. </para></description></parameter><parameter name="x"><paramtype>const StateInOut &amp;</paramtype><description><para>The state of the ODE which should be solved. The state is pair of Coor and Velocity. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. It transforms the result in-place. </purpose><description><para>It can be used like <programlisting language="c++">pair&lt; coordinates , velocities &gt; state;
  2736. stepper.do_step( sys , x , t , dt );
  2737. </programlisting></para><para>
  2738. </para></description></method>
  2739. <method name="do_step"><type>void</type><template>
  2740. <template-type-parameter name="System"/>
  2741. <template-type-parameter name="CoorIn"/>
  2742. <template-type-parameter name="VelocityIn"/>
  2743. <template-type-parameter name="AccelerationIn"/>
  2744. <template-type-parameter name="CoorOut"/>
  2745. <template-type-parameter name="VelocityOut"/>
  2746. <template-type-parameter name="AccelerationOut"/>
  2747. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function to solve, hence the r.h.s. of the ordinary differential equation. It must fulfill the Second Order System concept. </para></description></parameter><parameter name="qin"><paramtype>CoorIn const &amp;</paramtype></parameter><parameter name="pin"><paramtype>VelocityIn const &amp;</paramtype></parameter><parameter name="ain"><paramtype>AccelerationIn const &amp;</paramtype></parameter><parameter name="qout"><paramtype>CoorOut &amp;</paramtype></parameter><parameter name="pout"><paramtype>VelocityOut &amp;</paramtype></parameter><parameter name="aout"><paramtype>AccelerationOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The value of the time, at which the step should be performed. </para></description></parameter><parameter name="dt"><paramtype>time_type</paramtype><description><para>The step size. </para></description></parameter><purpose>This method performs one step. It transforms the result in-place. Additionally to the other methods the coordinates, velocities and accelerations are passed directly to do_step and they are transformed out-of-place. </purpose><description><para>It can be used like <programlisting language="c++">coordinates qin , qout;
  2748. velocities pin , pout;
  2749. accelerations ain, aout;
  2750. stepper.do_step( sys , qin , pin , ain , qout , pout , aout , t , dt );
  2751. </programlisting></para><para>
  2752. </para></description></method>
  2753. <method name="adjust_size"><type>void</type><template>
  2754. <template-type-parameter name="StateIn"/>
  2755. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype><description><para>A state from which the size of the temporaries to be resized is deduced. </para></description></parameter><purpose>Adjust the size of all temporaries in the stepper manually. </purpose><description><para>
  2756. </para></description></method>
  2757. <method name="reset"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><purpose>Resets the internal state of this stepper. After calling this method it is safe to use all <computeroutput>do_step</computeroutput> method without explicitly initializing the stepper. </purpose></method>
  2758. <method name="initialize"><type>void</type><template>
  2759. <template-type-parameter name="AccelerationIn"/>
  2760. </template><parameter name="ain"><paramtype>const AccelerationIn &amp;</paramtype></parameter><purpose>Initializes the internal state of the stepper. </purpose><description><para>
  2761. </para></description></method>
  2762. <method name="initialize"><type>void</type><template>
  2763. <template-type-parameter name="System"/>
  2764. <template-type-parameter name="CoorIn"/>
  2765. <template-type-parameter name="VelocityIn"/>
  2766. </template><parameter name="system"><paramtype>System</paramtype><description><para>The system function for the next calls of <computeroutput>do_step</computeroutput>. </para></description></parameter><parameter name="qin"><paramtype>const CoorIn &amp;</paramtype><description><para>The current coordinates of the ODE. </para></description></parameter><parameter name="pin"><paramtype>const VelocityIn &amp;</paramtype><description><para>The current velocities of the ODE. </para></description></parameter><parameter name="t"><paramtype>time_type</paramtype><description><para>The current time of the ODE. </para></description></parameter><purpose>Initializes the internal state of the stepper. </purpose><description><para>This method is equivalent to <programlisting language="c++">Acceleration a;
  2767. system( qin , pin , a , t );
  2768. stepper.initialize( a );
  2769. </programlisting></para><para>
  2770. </para></description></method>
  2771. <method name="is_initialized" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para>
  2772. </para></description><returns><para>Returns if the stepper is initialized. </para>
  2773. </returns></method>
  2774. </method-group>
  2775. <constructor><parameter name="algebra"><paramtype>const algebra_type &amp;</paramtype><default>algebra_type()</default><description><para>A copy of algebra is made and stored. </para></description></parameter><purpose>Constructs the <classname alt="boost::numeric::odeint::velocity_verlet">velocity_verlet</classname> class. This constructor can be used as a default constructor if the algebra has a default constructor. </purpose><description><para>
  2776. </para></description></constructor>
  2777. <method-group name="private member functions">
  2778. <method name="initialize_acc"><type>void</type><template>
  2779. <template-type-parameter name="System"/>
  2780. <template-type-parameter name="CoorIn"/>
  2781. <template-type-parameter name="VelocityIn"/>
  2782. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="qin"><paramtype>const CoorIn &amp;</paramtype></parameter><parameter name="pin"><paramtype>const VelocityIn &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter></method>
  2783. <method name="do_step_v1"><type>void</type><template>
  2784. <template-type-parameter name="System"/>
  2785. <template-type-parameter name="StateInOut"/>
  2786. </template><parameter name="system"><paramtype>System</paramtype></parameter><parameter name="x"><paramtype>StateInOut &amp;</paramtype></parameter><parameter name="t"><paramtype>time_type</paramtype></parameter><parameter name="dt"><paramtype>time_type</paramtype></parameter></method>
  2787. <method name="resize_impl"><type>bool</type><template>
  2788. <template-type-parameter name="StateIn"/>
  2789. </template><parameter name="x"><paramtype>const StateIn &amp;</paramtype></parameter></method>
  2790. <method name="get_current_acc"><type>acceleration_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2791. <method name="get_current_acc" cv="const"><type>const acceleration_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2792. <method name="get_old_acc"><type>acceleration_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2793. <method name="get_old_acc" cv="const"><type>const acceleration_type &amp;</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2794. <method name="toggle_current_acc"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
  2795. </method-group>
  2796. </class>
  2797. </namespace>
  2798. </namespace>
  2799. </namespace>
  2800. </header>
  2801. </library-reference>