module-mat2.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: mat2</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Module: mat2</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">2x2 Matrix</div>
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line3">line 3</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Methods</h3>
  31. <h4 class="name" id=".add"><span class="type-signature">(static) </span>add<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  32. <div class="description">
  33. Adds two mat2's
  34. </div>
  35. <h5>Parameters:</h5>
  36. <table class="params">
  37. <thead>
  38. <tr>
  39. <th>Name</th>
  40. <th>Type</th>
  41. <th class="last">Description</th>
  42. </tr>
  43. </thead>
  44. <tbody>
  45. <tr>
  46. <td class="name"><code>out</code></td>
  47. <td class="type">
  48. <span class="param-type">mat2</span>
  49. </td>
  50. <td class="description last">the receiving matrix</td>
  51. </tr>
  52. <tr>
  53. <td class="name"><code>a</code></td>
  54. <td class="type">
  55. <span class="param-type">mat2</span>
  56. </td>
  57. <td class="description last">the first operand</td>
  58. </tr>
  59. <tr>
  60. <td class="name"><code>b</code></td>
  61. <td class="type">
  62. <span class="param-type">mat2</span>
  63. </td>
  64. <td class="description last">the second operand</td>
  65. </tr>
  66. </tbody>
  67. </table>
  68. <dl class="details">
  69. <dt class="tag-source">Source:</dt>
  70. <dd class="tag-source"><ul class="dummy"><li>
  71. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line321">line 321</a>
  72. </li></ul></dd>
  73. </dl>
  74. <h5>Returns:</h5>
  75. <div class="param-desc">
  76. out
  77. </div>
  78. <dl>
  79. <dt>
  80. Type
  81. </dt>
  82. <dd>
  83. <span class="param-type">mat2</span>
  84. </dd>
  85. </dl>
  86. <h4 class="name" id=".adjoint"><span class="type-signature">(static) </span>adjoint<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  87. <div class="description">
  88. Calculates the adjugate of a mat2
  89. </div>
  90. <h5>Parameters:</h5>
  91. <table class="params">
  92. <thead>
  93. <tr>
  94. <th>Name</th>
  95. <th>Type</th>
  96. <th class="last">Description</th>
  97. </tr>
  98. </thead>
  99. <tbody>
  100. <tr>
  101. <td class="name"><code>out</code></td>
  102. <td class="type">
  103. <span class="param-type">mat2</span>
  104. </td>
  105. <td class="description last">the receiving matrix</td>
  106. </tr>
  107. <tr>
  108. <td class="name"><code>a</code></td>
  109. <td class="type">
  110. <span class="param-type">mat2</span>
  111. </td>
  112. <td class="description last">the source matrix</td>
  113. </tr>
  114. </tbody>
  115. </table>
  116. <dl class="details">
  117. <dt class="tag-source">Source:</dt>
  118. <dd class="tag-source"><ul class="dummy"><li>
  119. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line161">line 161</a>
  120. </li></ul></dd>
  121. </dl>
  122. <h5>Returns:</h5>
  123. <div class="param-desc">
  124. out
  125. </div>
  126. <dl>
  127. <dt>
  128. Type
  129. </dt>
  130. <dd>
  131. <span class="param-type">mat2</span>
  132. </dd>
  133. </dl>
  134. <h4 class="name" id=".clone"><span class="type-signature">(static) </span>clone<span class="signature">(a)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  135. <div class="description">
  136. Creates a new mat2 initialized with values from an existing matrix
  137. </div>
  138. <h5>Parameters:</h5>
  139. <table class="params">
  140. <thead>
  141. <tr>
  142. <th>Name</th>
  143. <th>Type</th>
  144. <th class="last">Description</th>
  145. </tr>
  146. </thead>
  147. <tbody>
  148. <tr>
  149. <td class="name"><code>a</code></td>
  150. <td class="type">
  151. <span class="param-type">mat2</span>
  152. </td>
  153. <td class="description last">matrix to clone</td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <dl class="details">
  158. <dt class="tag-source">Source:</dt>
  159. <dd class="tag-source"><ul class="dummy"><li>
  160. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line30">line 30</a>
  161. </li></ul></dd>
  162. </dl>
  163. <h5>Returns:</h5>
  164. <div class="param-desc">
  165. a new 2x2 matrix
  166. </div>
  167. <dl>
  168. <dt>
  169. Type
  170. </dt>
  171. <dd>
  172. <span class="param-type">mat2</span>
  173. </dd>
  174. </dl>
  175. <h4 class="name" id=".copy"><span class="type-signature">(static) </span>copy<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  176. <div class="description">
  177. Copy the values from one mat2 to another
  178. </div>
  179. <h5>Parameters:</h5>
  180. <table class="params">
  181. <thead>
  182. <tr>
  183. <th>Name</th>
  184. <th>Type</th>
  185. <th class="last">Description</th>
  186. </tr>
  187. </thead>
  188. <tbody>
  189. <tr>
  190. <td class="name"><code>out</code></td>
  191. <td class="type">
  192. <span class="param-type">mat2</span>
  193. </td>
  194. <td class="description last">the receiving matrix</td>
  195. </tr>
  196. <tr>
  197. <td class="name"><code>a</code></td>
  198. <td class="type">
  199. <span class="param-type">mat2</span>
  200. </td>
  201. <td class="description last">the source matrix</td>
  202. </tr>
  203. </tbody>
  204. </table>
  205. <dl class="details">
  206. <dt class="tag-source">Source:</dt>
  207. <dd class="tag-source"><ul class="dummy"><li>
  208. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line46">line 46</a>
  209. </li></ul></dd>
  210. </dl>
  211. <h5>Returns:</h5>
  212. <div class="param-desc">
  213. out
  214. </div>
  215. <dl>
  216. <dt>
  217. Type
  218. </dt>
  219. <dd>
  220. <span class="param-type">mat2</span>
  221. </dd>
  222. </dl>
  223. <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  224. <div class="description">
  225. Creates a new identity mat2
  226. </div>
  227. <dl class="details">
  228. <dt class="tag-source">Source:</dt>
  229. <dd class="tag-source"><ul class="dummy"><li>
  230. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line13">line 13</a>
  231. </li></ul></dd>
  232. </dl>
  233. <h5>Returns:</h5>
  234. <div class="param-desc">
  235. a new 2x2 matrix
  236. </div>
  237. <dl>
  238. <dt>
  239. Type
  240. </dt>
  241. <dd>
  242. <span class="param-type">mat2</span>
  243. </dd>
  244. </dl>
  245. <h4 class="name" id=".determinant"><span class="type-signature">(static) </span>determinant<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
  246. <div class="description">
  247. Calculates the determinant of a mat2
  248. </div>
  249. <h5>Parameters:</h5>
  250. <table class="params">
  251. <thead>
  252. <tr>
  253. <th>Name</th>
  254. <th>Type</th>
  255. <th class="last">Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td class="name"><code>a</code></td>
  261. <td class="type">
  262. <span class="param-type">mat2</span>
  263. </td>
  264. <td class="description last">the source matrix</td>
  265. </tr>
  266. </tbody>
  267. </table>
  268. <dl class="details">
  269. <dt class="tag-source">Source:</dt>
  270. <dd class="tag-source"><ul class="dummy"><li>
  271. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line178">line 178</a>
  272. </li></ul></dd>
  273. </dl>
  274. <h5>Returns:</h5>
  275. <div class="param-desc">
  276. determinant of a
  277. </div>
  278. <dl>
  279. <dt>
  280. Type
  281. </dt>
  282. <dd>
  283. <span class="param-type">Number</span>
  284. </dd>
  285. </dl>
  286. <h4 class="name" id=".equals"><span class="type-signature">(static) </span>equals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
  287. <div class="description">
  288. Returns whether or not the matrices have approximately the same elements in the same position.
  289. </div>
  290. <h5>Parameters:</h5>
  291. <table class="params">
  292. <thead>
  293. <tr>
  294. <th>Name</th>
  295. <th>Type</th>
  296. <th class="last">Description</th>
  297. </tr>
  298. </thead>
  299. <tbody>
  300. <tr>
  301. <td class="name"><code>a</code></td>
  302. <td class="type">
  303. <span class="param-type">mat2</span>
  304. </td>
  305. <td class="description last">The first matrix.</td>
  306. </tr>
  307. <tr>
  308. <td class="name"><code>b</code></td>
  309. <td class="type">
  310. <span class="param-type">mat2</span>
  311. </td>
  312. <td class="description last">The second matrix.</td>
  313. </tr>
  314. </tbody>
  315. </table>
  316. <dl class="details">
  317. <dt class="tag-source">Source:</dt>
  318. <dd class="tag-source"><ul class="dummy"><li>
  319. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line363">line 363</a>
  320. </li></ul></dd>
  321. </dl>
  322. <h5>Returns:</h5>
  323. <div class="param-desc">
  324. True if the matrices are equal, false otherwise.
  325. </div>
  326. <dl>
  327. <dt>
  328. Type
  329. </dt>
  330. <dd>
  331. <span class="param-type">Boolean</span>
  332. </dd>
  333. </dl>
  334. <h4 class="name" id=".exactEquals"><span class="type-signature">(static) </span>exactEquals<span class="signature">(a, b)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
  335. <div class="description">
  336. Returns whether or not the matrices have exactly the same elements in the same position (when compared with ===)
  337. </div>
  338. <h5>Parameters:</h5>
  339. <table class="params">
  340. <thead>
  341. <tr>
  342. <th>Name</th>
  343. <th>Type</th>
  344. <th class="last">Description</th>
  345. </tr>
  346. </thead>
  347. <tbody>
  348. <tr>
  349. <td class="name"><code>a</code></td>
  350. <td class="type">
  351. <span class="param-type">mat2</span>
  352. </td>
  353. <td class="description last">The first matrix.</td>
  354. </tr>
  355. <tr>
  356. <td class="name"><code>b</code></td>
  357. <td class="type">
  358. <span class="param-type">mat2</span>
  359. </td>
  360. <td class="description last">The second matrix.</td>
  361. </tr>
  362. </tbody>
  363. </table>
  364. <dl class="details">
  365. <dt class="tag-source">Source:</dt>
  366. <dd class="tag-source"><ul class="dummy"><li>
  367. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line352">line 352</a>
  368. </li></ul></dd>
  369. </dl>
  370. <h5>Returns:</h5>
  371. <div class="param-desc">
  372. True if the matrices are equal, false otherwise.
  373. </div>
  374. <dl>
  375. <dt>
  376. Type
  377. </dt>
  378. <dd>
  379. <span class="param-type">Boolean</span>
  380. </dd>
  381. </dl>
  382. <h4 class="name" id=".frob"><span class="type-signature">(static) </span>frob<span class="signature">(a)</span><span class="type-signature"> &rarr; {Number}</span></h4>
  383. <div class="description">
  384. Returns Frobenius norm of a mat2
  385. </div>
  386. <h5>Parameters:</h5>
  387. <table class="params">
  388. <thead>
  389. <tr>
  390. <th>Name</th>
  391. <th>Type</th>
  392. <th class="last">Description</th>
  393. </tr>
  394. </thead>
  395. <tbody>
  396. <tr>
  397. <td class="name"><code>a</code></td>
  398. <td class="type">
  399. <span class="param-type">mat2</span>
  400. </td>
  401. <td class="description last">the matrix to calculate Frobenius norm of</td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <dl class="details">
  406. <dt class="tag-source">Source:</dt>
  407. <dd class="tag-source"><ul class="dummy"><li>
  408. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line293">line 293</a>
  409. </li></ul></dd>
  410. </dl>
  411. <h5>Returns:</h5>
  412. <div class="param-desc">
  413. Frobenius norm
  414. </div>
  415. <dl>
  416. <dt>
  417. Type
  418. </dt>
  419. <dd>
  420. <span class="param-type">Number</span>
  421. </dd>
  422. </dl>
  423. <h4 class="name" id=".fromRotation"><span class="type-signature">(static) </span>fromRotation<span class="signature">(out, rad)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  424. <div class="description">
  425. Creates a matrix from a given angle
  426. This is equivalent to (but much faster than):
  427. mat2.identity(dest);
  428. mat2.rotate(dest, dest, rad);
  429. </div>
  430. <h5>Parameters:</h5>
  431. <table class="params">
  432. <thead>
  433. <tr>
  434. <th>Name</th>
  435. <th>Type</th>
  436. <th class="last">Description</th>
  437. </tr>
  438. </thead>
  439. <tbody>
  440. <tr>
  441. <td class="name"><code>out</code></td>
  442. <td class="type">
  443. <span class="param-type">mat2</span>
  444. </td>
  445. <td class="description last">mat2 receiving operation result</td>
  446. </tr>
  447. <tr>
  448. <td class="name"><code>rad</code></td>
  449. <td class="type">
  450. <span class="param-type">Number</span>
  451. </td>
  452. <td class="description last">the angle to rotate the matrix by</td>
  453. </tr>
  454. </tbody>
  455. </table>
  456. <dl class="details">
  457. <dt class="tag-source">Source:</dt>
  458. <dd class="tag-source"><ul class="dummy"><li>
  459. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line248">line 248</a>
  460. </li></ul></dd>
  461. </dl>
  462. <h5>Returns:</h5>
  463. <div class="param-desc">
  464. out
  465. </div>
  466. <dl>
  467. <dt>
  468. Type
  469. </dt>
  470. <dd>
  471. <span class="param-type">mat2</span>
  472. </dd>
  473. </dl>
  474. <h4 class="name" id=".fromScaling"><span class="type-signature">(static) </span>fromScaling<span class="signature">(out, v)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  475. <div class="description">
  476. Creates a matrix from a vector scaling
  477. This is equivalent to (but much faster than):
  478. mat2.identity(dest);
  479. mat2.scale(dest, dest, vec);
  480. </div>
  481. <h5>Parameters:</h5>
  482. <table class="params">
  483. <thead>
  484. <tr>
  485. <th>Name</th>
  486. <th>Type</th>
  487. <th class="last">Description</th>
  488. </tr>
  489. </thead>
  490. <tbody>
  491. <tr>
  492. <td class="name"><code>out</code></td>
  493. <td class="type">
  494. <span class="param-type">mat2</span>
  495. </td>
  496. <td class="description last">mat2 receiving operation result</td>
  497. </tr>
  498. <tr>
  499. <td class="name"><code>v</code></td>
  500. <td class="type">
  501. <span class="param-type">vec2</span>
  502. </td>
  503. <td class="description last">Scaling vector</td>
  504. </tr>
  505. </tbody>
  506. </table>
  507. <dl class="details">
  508. <dt class="tag-source">Source:</dt>
  509. <dd class="tag-source"><ul class="dummy"><li>
  510. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line269">line 269</a>
  511. </li></ul></dd>
  512. </dl>
  513. <h5>Returns:</h5>
  514. <div class="param-desc">
  515. out
  516. </div>
  517. <dl>
  518. <dt>
  519. Type
  520. </dt>
  521. <dd>
  522. <span class="param-type">mat2</span>
  523. </dd>
  524. </dl>
  525. <h4 class="name" id=".fromValues"><span class="type-signature">(static) </span>fromValues<span class="signature">(m00, m01, m10, m11)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  526. <div class="description">
  527. Create a new mat2 with the given values
  528. </div>
  529. <h5>Parameters:</h5>
  530. <table class="params">
  531. <thead>
  532. <tr>
  533. <th>Name</th>
  534. <th>Type</th>
  535. <th class="last">Description</th>
  536. </tr>
  537. </thead>
  538. <tbody>
  539. <tr>
  540. <td class="name"><code>m00</code></td>
  541. <td class="type">
  542. <span class="param-type">Number</span>
  543. </td>
  544. <td class="description last">Component in column 0, row 0 position (index 0)</td>
  545. </tr>
  546. <tr>
  547. <td class="name"><code>m01</code></td>
  548. <td class="type">
  549. <span class="param-type">Number</span>
  550. </td>
  551. <td class="description last">Component in column 0, row 1 position (index 1)</td>
  552. </tr>
  553. <tr>
  554. <td class="name"><code>m10</code></td>
  555. <td class="type">
  556. <span class="param-type">Number</span>
  557. </td>
  558. <td class="description last">Component in column 1, row 0 position (index 2)</td>
  559. </tr>
  560. <tr>
  561. <td class="name"><code>m11</code></td>
  562. <td class="type">
  563. <span class="param-type">Number</span>
  564. </td>
  565. <td class="description last">Component in column 1, row 1 position (index 3)</td>
  566. </tr>
  567. </tbody>
  568. </table>
  569. <dl class="details">
  570. <dt class="tag-source">Source:</dt>
  571. <dd class="tag-source"><ul class="dummy"><li>
  572. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line77">line 77</a>
  573. </li></ul></dd>
  574. </dl>
  575. <h5>Returns:</h5>
  576. <div class="param-desc">
  577. out A new 2x2 matrix
  578. </div>
  579. <dl>
  580. <dt>
  581. Type
  582. </dt>
  583. <dd>
  584. <span class="param-type">mat2</span>
  585. </dd>
  586. </dl>
  587. <h4 class="name" id=".identity"><span class="type-signature">(static) </span>identity<span class="signature">(out)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  588. <div class="description">
  589. Set a mat2 to the identity matrix
  590. </div>
  591. <h5>Parameters:</h5>
  592. <table class="params">
  593. <thead>
  594. <tr>
  595. <th>Name</th>
  596. <th>Type</th>
  597. <th class="last">Description</th>
  598. </tr>
  599. </thead>
  600. <tbody>
  601. <tr>
  602. <td class="name"><code>out</code></td>
  603. <td class="type">
  604. <span class="param-type">mat2</span>
  605. </td>
  606. <td class="description last">the receiving matrix</td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. <dl class="details">
  611. <dt class="tag-source">Source:</dt>
  612. <dd class="tag-source"><ul class="dummy"><li>
  613. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line60">line 60</a>
  614. </li></ul></dd>
  615. </dl>
  616. <h5>Returns:</h5>
  617. <div class="param-desc">
  618. out
  619. </div>
  620. <dl>
  621. <dt>
  622. Type
  623. </dt>
  624. <dd>
  625. <span class="param-type">mat2</span>
  626. </dd>
  627. </dl>
  628. <h4 class="name" id=".invert"><span class="type-signature">(static) </span>invert<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  629. <div class="description">
  630. Inverts a mat2
  631. </div>
  632. <h5>Parameters:</h5>
  633. <table class="params">
  634. <thead>
  635. <tr>
  636. <th>Name</th>
  637. <th>Type</th>
  638. <th class="last">Description</th>
  639. </tr>
  640. </thead>
  641. <tbody>
  642. <tr>
  643. <td class="name"><code>out</code></td>
  644. <td class="type">
  645. <span class="param-type">mat2</span>
  646. </td>
  647. <td class="description last">the receiving matrix</td>
  648. </tr>
  649. <tr>
  650. <td class="name"><code>a</code></td>
  651. <td class="type">
  652. <span class="param-type">mat2</span>
  653. </td>
  654. <td class="description last">the source matrix</td>
  655. </tr>
  656. </tbody>
  657. </table>
  658. <dl class="details">
  659. <dt class="tag-source">Source:</dt>
  660. <dd class="tag-source"><ul class="dummy"><li>
  661. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line135">line 135</a>
  662. </li></ul></dd>
  663. </dl>
  664. <h5>Returns:</h5>
  665. <div class="param-desc">
  666. out
  667. </div>
  668. <dl>
  669. <dt>
  670. Type
  671. </dt>
  672. <dd>
  673. <span class="param-type">mat2</span>
  674. </dd>
  675. </dl>
  676. <h4 class="name" id=".LDU"><span class="type-signature">(static) </span>LDU<span class="signature">(L, D, U, a)</span><span class="type-signature"></span></h4>
  677. <div class="description">
  678. Returns L, D and U matrices (Lower triangular, Diagonal and Upper triangular) by factorizing the input matrix
  679. </div>
  680. <h5>Parameters:</h5>
  681. <table class="params">
  682. <thead>
  683. <tr>
  684. <th>Name</th>
  685. <th>Type</th>
  686. <th class="last">Description</th>
  687. </tr>
  688. </thead>
  689. <tbody>
  690. <tr>
  691. <td class="name"><code>L</code></td>
  692. <td class="type">
  693. <span class="param-type">mat2</span>
  694. </td>
  695. <td class="description last">the lower triangular matrix</td>
  696. </tr>
  697. <tr>
  698. <td class="name"><code>D</code></td>
  699. <td class="type">
  700. <span class="param-type">mat2</span>
  701. </td>
  702. <td class="description last">the diagonal matrix</td>
  703. </tr>
  704. <tr>
  705. <td class="name"><code>U</code></td>
  706. <td class="type">
  707. <span class="param-type">mat2</span>
  708. </td>
  709. <td class="description last">the upper triangular matrix</td>
  710. </tr>
  711. <tr>
  712. <td class="name"><code>a</code></td>
  713. <td class="type">
  714. <span class="param-type">mat2</span>
  715. </td>
  716. <td class="description last">the input matrix to factorize</td>
  717. </tr>
  718. </tbody>
  719. </table>
  720. <dl class="details">
  721. <dt class="tag-source">Source:</dt>
  722. <dd class="tag-source"><ul class="dummy"><li>
  723. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line305">line 305</a>
  724. </li></ul></dd>
  725. </dl>
  726. <h4 class="name" id=".mul"><span class="type-signature">(static) </span>mul<span class="signature">()</span><span class="type-signature"></span></h4>
  727. <div class="description">
  728. Alias for mat2.multiply
  729. </div>
  730. <dl class="details">
  731. <dt class="tag-source">Source:</dt>
  732. <dd class="tag-source"><ul class="dummy"><li>
  733. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line409">line 409</a>
  734. </li></ul></dd>
  735. </dl>
  736. <h4 class="name" id=".multiply"><span class="type-signature">(static) </span>multiply<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  737. <div class="description">
  738. Multiplies two mat2's
  739. </div>
  740. <h5>Parameters:</h5>
  741. <table class="params">
  742. <thead>
  743. <tr>
  744. <th>Name</th>
  745. <th>Type</th>
  746. <th class="last">Description</th>
  747. </tr>
  748. </thead>
  749. <tbody>
  750. <tr>
  751. <td class="name"><code>out</code></td>
  752. <td class="type">
  753. <span class="param-type">mat2</span>
  754. </td>
  755. <td class="description last">the receiving matrix</td>
  756. </tr>
  757. <tr>
  758. <td class="name"><code>a</code></td>
  759. <td class="type">
  760. <span class="param-type">mat2</span>
  761. </td>
  762. <td class="description last">the first operand</td>
  763. </tr>
  764. <tr>
  765. <td class="name"><code>b</code></td>
  766. <td class="type">
  767. <span class="param-type">mat2</span>
  768. </td>
  769. <td class="description last">the second operand</td>
  770. </tr>
  771. </tbody>
  772. </table>
  773. <dl class="details">
  774. <dt class="tag-source">Source:</dt>
  775. <dd class="tag-source"><ul class="dummy"><li>
  776. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line190">line 190</a>
  777. </li></ul></dd>
  778. </dl>
  779. <h5>Returns:</h5>
  780. <div class="param-desc">
  781. out
  782. </div>
  783. <dl>
  784. <dt>
  785. Type
  786. </dt>
  787. <dd>
  788. <span class="param-type">mat2</span>
  789. </dd>
  790. </dl>
  791. <h4 class="name" id=".multiplyScalar"><span class="type-signature">(static) </span>multiplyScalar<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  792. <div class="description">
  793. Multiply each element of the matrix by a scalar.
  794. </div>
  795. <h5>Parameters:</h5>
  796. <table class="params">
  797. <thead>
  798. <tr>
  799. <th>Name</th>
  800. <th>Type</th>
  801. <th class="last">Description</th>
  802. </tr>
  803. </thead>
  804. <tbody>
  805. <tr>
  806. <td class="name"><code>out</code></td>
  807. <td class="type">
  808. <span class="param-type">mat2</span>
  809. </td>
  810. <td class="description last">the receiving matrix</td>
  811. </tr>
  812. <tr>
  813. <td class="name"><code>a</code></td>
  814. <td class="type">
  815. <span class="param-type">mat2</span>
  816. </td>
  817. <td class="description last">the matrix to scale</td>
  818. </tr>
  819. <tr>
  820. <td class="name"><code>b</code></td>
  821. <td class="type">
  822. <span class="param-type">Number</span>
  823. </td>
  824. <td class="description last">amount to scale the matrix's elements by</td>
  825. </tr>
  826. </tbody>
  827. </table>
  828. <dl class="details">
  829. <dt class="tag-source">Source:</dt>
  830. <dd class="tag-source"><ul class="dummy"><li>
  831. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line380">line 380</a>
  832. </li></ul></dd>
  833. </dl>
  834. <h5>Returns:</h5>
  835. <div class="param-desc">
  836. out
  837. </div>
  838. <dl>
  839. <dt>
  840. Type
  841. </dt>
  842. <dd>
  843. <span class="param-type">mat2</span>
  844. </dd>
  845. </dl>
  846. <h4 class="name" id=".multiplyScalarAndAdd"><span class="type-signature">(static) </span>multiplyScalarAndAdd<span class="signature">(out, a, b, scale)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  847. <div class="description">
  848. Adds two mat2's after multiplying each element of the second operand by a scalar value.
  849. </div>
  850. <h5>Parameters:</h5>
  851. <table class="params">
  852. <thead>
  853. <tr>
  854. <th>Name</th>
  855. <th>Type</th>
  856. <th class="last">Description</th>
  857. </tr>
  858. </thead>
  859. <tbody>
  860. <tr>
  861. <td class="name"><code>out</code></td>
  862. <td class="type">
  863. <span class="param-type">mat2</span>
  864. </td>
  865. <td class="description last">the receiving vector</td>
  866. </tr>
  867. <tr>
  868. <td class="name"><code>a</code></td>
  869. <td class="type">
  870. <span class="param-type">mat2</span>
  871. </td>
  872. <td class="description last">the first operand</td>
  873. </tr>
  874. <tr>
  875. <td class="name"><code>b</code></td>
  876. <td class="type">
  877. <span class="param-type">mat2</span>
  878. </td>
  879. <td class="description last">the second operand</td>
  880. </tr>
  881. <tr>
  882. <td class="name"><code>scale</code></td>
  883. <td class="type">
  884. <span class="param-type">Number</span>
  885. </td>
  886. <td class="description last">the amount to scale b's elements by before adding</td>
  887. </tr>
  888. </tbody>
  889. </table>
  890. <dl class="details">
  891. <dt class="tag-source">Source:</dt>
  892. <dd class="tag-source"><ul class="dummy"><li>
  893. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line397">line 397</a>
  894. </li></ul></dd>
  895. </dl>
  896. <h5>Returns:</h5>
  897. <div class="param-desc">
  898. out
  899. </div>
  900. <dl>
  901. <dt>
  902. Type
  903. </dt>
  904. <dd>
  905. <span class="param-type">mat2</span>
  906. </dd>
  907. </dl>
  908. <h4 class="name" id=".rotate"><span class="type-signature">(static) </span>rotate<span class="signature">(out, a, rad)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  909. <div class="description">
  910. Rotates a mat2 by the given angle
  911. </div>
  912. <h5>Parameters:</h5>
  913. <table class="params">
  914. <thead>
  915. <tr>
  916. <th>Name</th>
  917. <th>Type</th>
  918. <th class="last">Description</th>
  919. </tr>
  920. </thead>
  921. <tbody>
  922. <tr>
  923. <td class="name"><code>out</code></td>
  924. <td class="type">
  925. <span class="param-type">mat2</span>
  926. </td>
  927. <td class="description last">the receiving matrix</td>
  928. </tr>
  929. <tr>
  930. <td class="name"><code>a</code></td>
  931. <td class="type">
  932. <span class="param-type">mat2</span>
  933. </td>
  934. <td class="description last">the matrix to rotate</td>
  935. </tr>
  936. <tr>
  937. <td class="name"><code>rad</code></td>
  938. <td class="type">
  939. <span class="param-type">Number</span>
  940. </td>
  941. <td class="description last">the angle to rotate the matrix by</td>
  942. </tr>
  943. </tbody>
  944. </table>
  945. <dl class="details">
  946. <dt class="tag-source">Source:</dt>
  947. <dd class="tag-source"><ul class="dummy"><li>
  948. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line208">line 208</a>
  949. </li></ul></dd>
  950. </dl>
  951. <h5>Returns:</h5>
  952. <div class="param-desc">
  953. out
  954. </div>
  955. <dl>
  956. <dt>
  957. Type
  958. </dt>
  959. <dd>
  960. <span class="param-type">mat2</span>
  961. </dd>
  962. </dl>
  963. <h4 class="name" id=".scale"><span class="type-signature">(static) </span>scale<span class="signature">(out, a, v)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  964. <div class="description">
  965. Scales the mat2 by the dimensions in the given vec2
  966. </div>
  967. <h5>Parameters:</h5>
  968. <table class="params">
  969. <thead>
  970. <tr>
  971. <th>Name</th>
  972. <th>Type</th>
  973. <th class="last">Description</th>
  974. </tr>
  975. </thead>
  976. <tbody>
  977. <tr>
  978. <td class="name"><code>out</code></td>
  979. <td class="type">
  980. <span class="param-type">mat2</span>
  981. </td>
  982. <td class="description last">the receiving matrix</td>
  983. </tr>
  984. <tr>
  985. <td class="name"><code>a</code></td>
  986. <td class="type">
  987. <span class="param-type">mat2</span>
  988. </td>
  989. <td class="description last">the matrix to rotate</td>
  990. </tr>
  991. <tr>
  992. <td class="name"><code>v</code></td>
  993. <td class="type">
  994. <span class="param-type">vec2</span>
  995. </td>
  996. <td class="description last">the vec2 to scale the matrix by</td>
  997. </tr>
  998. </tbody>
  999. </table>
  1000. <dl class="details">
  1001. <dt class="tag-source">Source:</dt>
  1002. <dd class="tag-source"><ul class="dummy"><li>
  1003. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line227">line 227</a>
  1004. </li></ul></dd>
  1005. </dl>
  1006. <h5>Returns:</h5>
  1007. <div class="param-desc">
  1008. out
  1009. </div>
  1010. <dl>
  1011. <dt>
  1012. Type
  1013. </dt>
  1014. <dd>
  1015. <span class="param-type">mat2</span>
  1016. </dd>
  1017. </dl>
  1018. <h4 class="name" id=".set"><span class="type-signature">(static) </span>set<span class="signature">(out, m00, m01, m10, m11)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  1019. <div class="description">
  1020. Set the components of a mat2 to the given values
  1021. </div>
  1022. <h5>Parameters:</h5>
  1023. <table class="params">
  1024. <thead>
  1025. <tr>
  1026. <th>Name</th>
  1027. <th>Type</th>
  1028. <th class="last">Description</th>
  1029. </tr>
  1030. </thead>
  1031. <tbody>
  1032. <tr>
  1033. <td class="name"><code>out</code></td>
  1034. <td class="type">
  1035. <span class="param-type">mat2</span>
  1036. </td>
  1037. <td class="description last">the receiving matrix</td>
  1038. </tr>
  1039. <tr>
  1040. <td class="name"><code>m00</code></td>
  1041. <td class="type">
  1042. <span class="param-type">Number</span>
  1043. </td>
  1044. <td class="description last">Component in column 0, row 0 position (index 0)</td>
  1045. </tr>
  1046. <tr>
  1047. <td class="name"><code>m01</code></td>
  1048. <td class="type">
  1049. <span class="param-type">Number</span>
  1050. </td>
  1051. <td class="description last">Component in column 0, row 1 position (index 1)</td>
  1052. </tr>
  1053. <tr>
  1054. <td class="name"><code>m10</code></td>
  1055. <td class="type">
  1056. <span class="param-type">Number</span>
  1057. </td>
  1058. <td class="description last">Component in column 1, row 0 position (index 2)</td>
  1059. </tr>
  1060. <tr>
  1061. <td class="name"><code>m11</code></td>
  1062. <td class="type">
  1063. <span class="param-type">Number</span>
  1064. </td>
  1065. <td class="description last">Component in column 1, row 1 position (index 3)</td>
  1066. </tr>
  1067. </tbody>
  1068. </table>
  1069. <dl class="details">
  1070. <dt class="tag-source">Source:</dt>
  1071. <dd class="tag-source"><ul class="dummy"><li>
  1072. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line96">line 96</a>
  1073. </li></ul></dd>
  1074. </dl>
  1075. <h5>Returns:</h5>
  1076. <div class="param-desc">
  1077. out
  1078. </div>
  1079. <dl>
  1080. <dt>
  1081. Type
  1082. </dt>
  1083. <dd>
  1084. <span class="param-type">mat2</span>
  1085. </dd>
  1086. </dl>
  1087. <h4 class="name" id=".str"><span class="type-signature">(static) </span>str<span class="signature">(a)</span><span class="type-signature"> &rarr; {String}</span></h4>
  1088. <div class="description">
  1089. Returns a string representation of a mat2
  1090. </div>
  1091. <h5>Parameters:</h5>
  1092. <table class="params">
  1093. <thead>
  1094. <tr>
  1095. <th>Name</th>
  1096. <th>Type</th>
  1097. <th class="last">Description</th>
  1098. </tr>
  1099. </thead>
  1100. <tbody>
  1101. <tr>
  1102. <td class="name"><code>a</code></td>
  1103. <td class="type">
  1104. <span class="param-type">mat2</span>
  1105. </td>
  1106. <td class="description last">matrix to represent as a string</td>
  1107. </tr>
  1108. </tbody>
  1109. </table>
  1110. <dl class="details">
  1111. <dt class="tag-source">Source:</dt>
  1112. <dd class="tag-source"><ul class="dummy"><li>
  1113. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line283">line 283</a>
  1114. </li></ul></dd>
  1115. </dl>
  1116. <h5>Returns:</h5>
  1117. <div class="param-desc">
  1118. string representation of the matrix
  1119. </div>
  1120. <dl>
  1121. <dt>
  1122. Type
  1123. </dt>
  1124. <dd>
  1125. <span class="param-type">String</span>
  1126. </dd>
  1127. </dl>
  1128. <h4 class="name" id=".sub"><span class="type-signature">(static) </span>sub<span class="signature">()</span><span class="type-signature"></span></h4>
  1129. <div class="description">
  1130. Alias for mat2.subtract
  1131. </div>
  1132. <dl class="details">
  1133. <dt class="tag-source">Source:</dt>
  1134. <dd class="tag-source"><ul class="dummy"><li>
  1135. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line415">line 415</a>
  1136. </li></ul></dd>
  1137. </dl>
  1138. <h4 class="name" id=".subtract"><span class="type-signature">(static) </span>subtract<span class="signature">(out, a, b)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  1139. <div class="description">
  1140. Subtracts matrix b from matrix a
  1141. </div>
  1142. <h5>Parameters:</h5>
  1143. <table class="params">
  1144. <thead>
  1145. <tr>
  1146. <th>Name</th>
  1147. <th>Type</th>
  1148. <th class="last">Description</th>
  1149. </tr>
  1150. </thead>
  1151. <tbody>
  1152. <tr>
  1153. <td class="name"><code>out</code></td>
  1154. <td class="type">
  1155. <span class="param-type">mat2</span>
  1156. </td>
  1157. <td class="description last">the receiving matrix</td>
  1158. </tr>
  1159. <tr>
  1160. <td class="name"><code>a</code></td>
  1161. <td class="type">
  1162. <span class="param-type">mat2</span>
  1163. </td>
  1164. <td class="description last">the first operand</td>
  1165. </tr>
  1166. <tr>
  1167. <td class="name"><code>b</code></td>
  1168. <td class="type">
  1169. <span class="param-type">mat2</span>
  1170. </td>
  1171. <td class="description last">the second operand</td>
  1172. </tr>
  1173. </tbody>
  1174. </table>
  1175. <dl class="details">
  1176. <dt class="tag-source">Source:</dt>
  1177. <dd class="tag-source"><ul class="dummy"><li>
  1178. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line337">line 337</a>
  1179. </li></ul></dd>
  1180. </dl>
  1181. <h5>Returns:</h5>
  1182. <div class="param-desc">
  1183. out
  1184. </div>
  1185. <dl>
  1186. <dt>
  1187. Type
  1188. </dt>
  1189. <dd>
  1190. <span class="param-type">mat2</span>
  1191. </dd>
  1192. </dl>
  1193. <h4 class="name" id=".transpose"><span class="type-signature">(static) </span>transpose<span class="signature">(out, a)</span><span class="type-signature"> &rarr; {mat2}</span></h4>
  1194. <div class="description">
  1195. Transpose the values of a mat2
  1196. </div>
  1197. <h5>Parameters:</h5>
  1198. <table class="params">
  1199. <thead>
  1200. <tr>
  1201. <th>Name</th>
  1202. <th>Type</th>
  1203. <th class="last">Description</th>
  1204. </tr>
  1205. </thead>
  1206. <tbody>
  1207. <tr>
  1208. <td class="name"><code>out</code></td>
  1209. <td class="type">
  1210. <span class="param-type">mat2</span>
  1211. </td>
  1212. <td class="description last">the receiving matrix</td>
  1213. </tr>
  1214. <tr>
  1215. <td class="name"><code>a</code></td>
  1216. <td class="type">
  1217. <span class="param-type">mat2</span>
  1218. </td>
  1219. <td class="description last">the source matrix</td>
  1220. </tr>
  1221. </tbody>
  1222. </table>
  1223. <dl class="details">
  1224. <dt class="tag-source">Source:</dt>
  1225. <dd class="tag-source"><ul class="dummy"><li>
  1226. <a href="mat2.js.html">mat2.js</a>, <a href="mat2.js.html#line111">line 111</a>
  1227. </li></ul></dd>
  1228. </dl>
  1229. <h5>Returns:</h5>
  1230. <div class="param-desc">
  1231. out
  1232. </div>
  1233. <dl>
  1234. <dt>
  1235. Type
  1236. </dt>
  1237. <dd>
  1238. <span class="param-type">mat2</span>
  1239. </dd>
  1240. </dl>
  1241. </article>
  1242. </section>
  1243. </div>
  1244. <nav>
  1245. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-glMatrix.html">glMatrix</a></li><li><a href="module-mat2.html">mat2</a></li><li><a href="module-mat2d.html">mat2d</a></li><li><a href="module-mat3.html">mat3</a></li><li><a href="module-mat4.html">mat4</a></li><li><a href="module-quat.html">quat</a></li><li><a href="module-quat2.html">quat2</a></li><li><a href="module-vec2.html">vec2</a></li><li><a href="module-vec3.html">vec3</a></li><li><a href="module-vec4.html">vec4</a></li></ul>
  1246. </nav>
  1247. <br class="clear">
  1248. <footer>
  1249. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jul 13 2018 11:51:33 GMT+0200 (W. Europe Daylight Time)
  1250. </footer>
  1251. <script> prettyPrint(); </script>
  1252. <script src="scripts/linenumber.js"> </script>
  1253. </body>
  1254. </html>