| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071 |
- <?xml version="1.0" encoding="utf-8" ?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <!-- This file is generated by Nim. -->
- <html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>system</title>
- <!-- Google fonts -->
- <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
- <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
- <!-- Favicon -->
- <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
- <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
- <!-- JS -->
- <script type="text/javascript" src="dochack.js?v=2.3.1"></script>
- </head>
- <body>
- <div class="document" id="documentId">
- <div class="container">
- <h1 class="title">system</h1>
- <div class="row">
- <div class="three columns">
- <div class="theme-select-wrapper">
- <label for="theme-select">Theme: </label>
- <select id="theme-select" onchange="setTheme(this.value)">
- <option value="auto">🌗 Match OS</option>
- <option value="dark">🌑 Dark</option>
- <option value="light">🌕 Light</option>
- </select>
- </div>
- <div id="global-links">
- <ul class="simple-boot">
- <li><a href="manual.html">Manual</a></li>
- <li><a href="lib.html">Standard library</a></li>
- <li> <a id="indexLink" href="theindex.html">Index</a></li>
- <li><a href="compiler/theindex.html">Compiler docs</a></li>
- <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
- <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
- </ul>
- </div>
- <div id="searchInputDiv">
- Search: <input type="search" id="searchInput"
- oninput="search()" />
- </div>
-
- <ul class="simple simple-toc" id="toc-list">
- <li><a class="reference" id="system-module_toc" href="#system-module">System module</a></li>
- <ul class="simple"><li><a class="reference" id="system-module-strings-and-characters_toc" href="#system-module-strings-and-characters">Strings and characters</a></li>
- <li><a class="reference" id="system-module-seqs_toc" href="#system-module-seqs">Seqs</a></li>
- <li><a class="reference" id="system-module-sets_toc" href="#system-module-sets">Sets</a></li>
- <li><a class="reference" id="system-module-numbers_toc" href="#system-module-numbers">Numbers</a></li>
- <li><a class="reference" id="system-module-ordinals_toc" href="#system-module-ordinals">Ordinals</a></li>
- <li><a class="reference" id="system-module-misc_toc" href="#system-module-misc">Misc</a></li>
- </ul><li>
- <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#ptr" title="ptr[T] {.magic: Pointer.}">`ptr`</a></li>
- <li><a class="reference" href="#ref" title="ref[T] {.magic: Pointer.}">`ref`</a></li>
- <li><a class="reference" href="#static" title="static[T] {.magic: "Static".}">`static`</a></li>
- <li><a class="reference" href="#type" title="type[T] {.magic: "Type".}">`type`</a></li>
- <li><a class="reference" href="#AllocStats" title="AllocStats = object">AllocStats</a></li>
- <li><a class="reference" href="#any" title="any {.deprecated: "Deprecated since v1.5; Use auto instead.".} = distinct auto">any</a></li>
- <li><a class="reference" href="#array" title="array[I; T] {.magic: "Array".}">array</a></li>
- <li><a class="reference" href="#auto" title="auto {.magic: Expr.}">auto</a></li>
- <li><a class="reference" href="#BackwardsIndex" title="BackwardsIndex = distinct int">BackwardsIndex</a></li>
- <li><a class="reference" href="#bool" title="bool {.magic: "Bool".} = enum
- false = 0, true = 1">bool</a></li>
- <li><a class="reference" href="#byte" title="byte = uint8">byte</a></li>
- <li><a class="reference" href="#CatchableError" title="CatchableError = object of Exception">CatchableError</a></li>
- <li><a class="reference" href="#char" title="char {.magic: Char.}">char</a></li>
- <li><a class="reference" href="#cstring" title="cstring {.magic: Cstring.}">cstring</a></li>
- <li><a class="reference" href="#Defect" title="Defect = object of Exception">Defect</a></li>
- <li><a class="reference" href="#Endianness" title="Endianness = enum
- littleEndian, bigEndian">Endianness</a></li>
- <li><a class="reference" href="#Exception" title="Exception {.compilerproc, magic: "Exception".} = object of RootObj
- parent*: ref Exception ## Parent exception (can be used as a stack).
- name*: cstring ## The exception's name is its Nim identifier.
- ## This field is filled automatically in the
- ## `raise` statement.
- msg* {.exportc: "message".}: string ## The exception's message. Not
- ## providing an exception message
- ## is bad style.
- when defined(js):
- trace*: string
- else:
- trace*: seq[StackTraceEntry]">Exception</a></li>
- <li><a class="reference" href="#float" title="float {.magic: Float.}">float</a></li>
- <li><a class="reference" href="#float32" title="float32 {.magic: Float32.}">float32</a></li>
- <li><a class="reference" href="#float64" title="float64 {.magic: Float.}">float64</a></li>
- <li><a class="reference" href="#ForeignCell" title="ForeignCell = object
- data*: pointer">ForeignCell</a></li>
- <li><a class="reference" href="#ForLoopStmt" title="ForLoopStmt {.compilerproc.} = object">ForLoopStmt</a></li>
- <li><a class="reference" href="#GC_Strategy" title="GC_Strategy = enum
- gcThroughput, ## optimize for throughput
- gcResponsiveness, ## optimize for responsiveness (default)
- gcOptimizeTime, ## optimize for speed
- gcOptimizeSpace ## optimize for memory footprint">GC_Strategy</a></li>
- <li><a class="reference" href="#HSlice" title="HSlice[T; U] = object
- a*: T ## The lower bound (inclusive).
- b*: U ## The upper bound (inclusive).">HSlice</a></li>
- <li><a class="reference" href="#int" title="int {.magic: Int.}">int</a></li>
- <li><a class="reference" href="#int8" title="int8 {.magic: Int8.}">int8</a></li>
- <li><a class="reference" href="#int16" title="int16 {.magic: Int16.}">int16</a></li>
- <li><a class="reference" href="#int32" title="int32 {.magic: Int32.}">int32</a></li>
- <li><a class="reference" href="#int64" title="int64 {.magic: Int64.}">int64</a></li>
- <li><a class="reference" href="#iterable" title="iterable[T] {.magic: IterableType.}">iterable</a></li>
- <li><a class="reference" href="#JsRoot" title="JsRoot = ref object of RootObj">JsRoot</a></li>
- <li><a class="reference" href="#lent" title="lent[T] {.magic: "BuiltinType".}">lent</a></li>
- <li><a class="reference" href="#Natural" title="Natural = range[0 .. high(int)]">Natural</a></li>
- <li><a class="reference" href="#NimNode" title="NimNode {.magic: "PNimrodNode".} = ref NimNodeObj">NimNode</a></li>
- <li><a class="reference" href="#NimSeqV2" title="NimSeqV2[T] = object">NimSeqV2</a></li>
- <li><a class="reference" href="#openArray" title="openArray[T] {.magic: "OpenArray".}">openArray</a></li>
- <li><a class="reference" href="#Ordinal" title="Ordinal[T] {.magic: Ordinal.}">Ordinal</a></li>
- <li><a class="reference" href="#owned" title="owned[T] {.magic: "BuiltinType".}">owned</a></li>
- <li><a class="reference" href="#PFrame" title="PFrame = ptr TFrame">PFrame</a></li>
- <li><a class="reference" href="#pointer" title="pointer {.magic: Pointer.}">pointer</a></li>
- <li><a class="reference" href="#Positive" title="Positive = range[1 .. high(int)]">Positive</a></li>
- <li><a class="reference" href="#range" title="range[T] {.magic: "Range".}">range</a></li>
- <li><a class="reference" href="#RootEffect" title="RootEffect {.compilerproc.} = object of RootObj">RootEffect</a></li>
- <li><a class="reference" href="#RootObj" title="RootObj {.compilerproc, inheritable.} = object">RootObj</a></li>
- <li><a class="reference" href="#RootRef" title="RootRef = ref RootObj">RootRef</a></li>
- <li><a class="reference" href="#seq" title="seq[T] {.magic: "Seq".}">seq</a></li>
- <li><a class="reference" href="#set" title="set[T] {.magic: "Set".}">set</a></li>
- <li><a class="reference" href="#sink" title="sink[T] {.magic: "BuiltinType".}">sink</a></li>
- <li><a class="reference" href="#Slice" title="Slice[T] = HSlice[T, T]">Slice</a></li>
- <li><a class="reference" href="#SomeFloat" title="SomeFloat = float | float32 | float64">SomeFloat</a></li>
- <li><a class="reference" href="#SomeInteger" title="SomeInteger = SomeSignedInt | SomeUnsignedInt">SomeInteger</a></li>
- <li><a class="reference" href="#SomeNumber" title="SomeNumber = SomeInteger | SomeFloat">SomeNumber</a></li>
- <li><a class="reference" href="#SomeOrdinal" title="SomeOrdinal = int | int8 | int16 | int32 | int64 | bool | enum | uint | uint8 |
- uint16 |
- uint32 |
- uint64">SomeOrdinal</a></li>
- <li><a class="reference" href="#SomeSignedInt" title="SomeSignedInt = int | int8 | int16 | int32 | int64">SomeSignedInt</a></li>
- <li><a class="reference" href="#SomeUnsignedInt" title="SomeUnsignedInt = uint | uint8 | uint16 | uint32 | uint64">SomeUnsignedInt</a></li>
- <li><a class="reference" href="#StackTraceEntry" title="StackTraceEntry = object
- procname*: cstring ## Name of the proc that is currently executing.
- line*: int ## Line number of the proc that is currently executing.
- filename*: cstring ## Filename of the proc that is currently executing.
- when NimStackTraceMsgs:
- frameMsg*: string ## When a stacktrace is generated in a given frame and
- ## rendered at a later time, we should ensure the stacktrace
- ## data isn't invalidated; any pointer into PFrame is
- ## subject to being invalidated so shouldn't be stored.
- when defined(nimStackTraceOverride):
- programCounter*: uint ## Program counter - will be used to get the rest of the info,
- ## when `$` is called on this type. We can't use
- ## "cuintptr_t" in here.
- procnameStr*, filenameStr*: string ## GC-ed alternatives to "procname" and "filename"">StackTraceEntry</a></li>
- <li><a class="reference" href="#string" title="string {.magic: String.}">string</a></li>
- <li><a class="reference" href="#TFrame" title="TFrame {.importc, nodecl, final.} = object
- prev*: PFrame ## Previous frame; used for chaining the call stack.
- procname*: cstring ## Name of the proc that is currently executing.
- line*: int ## Line number of the proc that is currently executing.
- filename*: cstring ## Filename of the proc that is currently executing.
- len*: int16 ## Length of the inspectable slots.
- calldepth*: int16 ## Used for max call depth checking.
- when NimStackTraceMsgs:
- frameMsgLen*: int ## end position in frameMsgBuf for this frame.">TFrame</a></li>
- <li><a class="reference" href="#typed" title="typed {.magic: Stmt.}">typed</a></li>
- <li><a class="reference" href="#typedesc" title="typedesc {.magic: TypeDesc.}">typedesc</a></li>
- <li><a class="reference" href="#TypeOfMode" title="TypeOfMode = enum
- typeOfProc, ## Prefer the interpretation that means `x` is a proc call.
- typeOfIter ## Prefer the interpretation that means `x` is an iterator call.">TypeOfMode</a></li>
- <li><a class="reference" href="#uint" title="uint {.magic: UInt.}">uint</a></li>
- <li><a class="reference" href="#uint8" title="uint8 {.magic: UInt8.}">uint8</a></li>
- <li><a class="reference" href="#uint16" title="uint16 {.magic: UInt16.}">uint16</a></li>
- <li><a class="reference" href="#uint32" title="uint32 {.magic: UInt32.}">uint32</a></li>
- <li><a class="reference" href="#uint64" title="uint64 {.magic: UInt64.}">uint64</a></li>
- <li><a class="reference" href="#UncheckedArray" title="UncheckedArray[T] {.magic: "UncheckedArray".}">UncheckedArray</a></li>
- <li><a class="reference" href="#untyped" title="untyped {.magic: Expr.}">untyped</a></li>
- <li><a class="reference" href="#varargs" title="varargs[T] {.magic: "Varargs".}">varargs</a></li>
- <li><a class="reference" href="#void" title="void {.magic: "VoidType".}">void</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#8" id="58">Vars</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#errorMessageWriter" title="errorMessageWriter: (proc (msg: string) {.tags: [WriteIOEffect], gcsafe, nimcall.})">errorMessageWriter</a></li>
- <li><a class="reference" href="#globalRaiseHook" title="globalRaiseHook: proc (e: ref Exception): bool {.nimcall, gcsafe.}">globalRaiseHook</a></li>
- <li><a class="reference" href="#localRaiseHook" title="localRaiseHook {.threadvar.}: proc (e: ref Exception): bool {.nimcall, gcsafe.}">localRaiseHook</a></li>
- <li><a class="reference" href="#nimThreadDestructionHandlers" title="nimThreadDestructionHandlers {.threadvar.}: seq[
- proc () {.closure, gcsafe, raises: [].}]">nimThreadDestructionHandlers</a></li>
- <li><a class="reference" href="#onUnhandledException" title="onUnhandledException: (proc (errorMsg: string) {.nimcall, gcsafe.})">onUnhandledException</a></li>
- <li><a class="reference" href="#outOfMemHook" title="outOfMemHook: proc () {.nimcall, tags: [], gcsafe, raises: [].}">outOfMemHook</a></li>
- <li><a class="reference" href="#programResult" title="programResult {.compilerproc, exportc: "nim_program_result".}: int">programResult</a></li>
- <li><a class="reference" href="#unhandledExceptionHook" title="unhandledExceptionHook: proc (e: ref Exception) {.nimcall, tags: [], gcsafe,
- raises: [].}">unhandledExceptionHook</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#9" id="59">Lets</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#nimvm" title="nimvm {.magic: "Nimvm", compileTime.}: bool = false">nimvm</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#10" id="60">Consts</a></summary>
- <ul class="simple simple-toc-section">
- <li><a class="reference" href="#appType" title="appType {.magic: "AppType".}: string = """>appType</a></li>
- <li><a class="reference" href="#CompileDate" title="CompileDate {.magic: "CompileDate".}: string = "0000-00-00"">CompileDate</a></li>
- <li><a class="reference" href="#CompileTime" title="CompileTime {.magic: "CompileTime".}: string = "00:00:00"">CompileTime</a></li>
- <li><a class="reference" href="#cpuEndian" title="cpuEndian {.magic: "CpuEndian".}: Endianness = littleEndian">cpuEndian</a></li>
- <li><a class="reference" href="#hostCPU" title="hostCPU {.magic: "HostCPU".}: string = """>hostCPU</a></li>
- <li><a class="reference" href="#hostOS" title="hostOS {.magic: "HostOS".}: string = """>hostOS</a></li>
- <li><a class="reference" href="#Inf" title="Inf = 0x7FF0000000000000'f64">Inf</a></li>
- <li><a class="reference" href="#isMainModule" title="isMainModule {.magic: "IsMainModule".}: bool = false">isMainModule</a></li>
- <li><a class="reference" href="#NaN" title="NaN = 0x7FF7FFFFFFFFFFFF'f64">NaN</a></li>
- <li><a class="reference" href="#NegInf" title="NegInf = 0xFFF0000000000000'f64">NegInf</a></li>
- <li><a class="reference" href="#NimMajor" title="NimMajor {.intdefine.}: int = 2">NimMajor</a></li>
- <li><a class="reference" href="#NimMinor" title="NimMinor {.intdefine.}: int = 3">NimMinor</a></li>
- <li><a class="reference" href="#NimPatch" title="NimPatch {.intdefine.}: int = 1">NimPatch</a></li>
- <li><a class="reference" href="#NimVersion" title="NimVersion: string = "2.3.1"">NimVersion</a></li>
- <li><a class="reference" href="#off" title="off = false">off</a></li>
- <li><a class="reference" href="#on" title="on = true">on</a></li>
- <li><a class="reference" href="#QuitFailure" title="QuitFailure = 1">QuitFailure</a></li>
- <li><a class="reference" href="#QuitSuccess" title="QuitSuccess = 0">QuitSuccess</a></li>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">%%
- <li><a class="reference" href="#%25%25%2Cint%2Cint" title="`%%`(x, y: int): int">`%%`(x, y: int): int</a></li>
- <li><a class="reference" href="#%25%25%2Cint8%2Cint8" title="`%%`(x, y: int8): int8">`%%`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%25%25%2Cint16%2Cint16" title="`%%`(x, y: int16): int16">`%%`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%25%25%2Cint32%2Cint32" title="`%%`(x, y: int32): int32">`%%`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%25%25%2Cint64%2Cint64" title="`%%`(x, y: int64): int64">`%%`(x, y: int64): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">&
- <li><a class="reference" href="#%26%2Cchar%2Cchar" title="`&`(x, y: char): string">`&`(x, y: char): string</a></li>
- <li><a class="reference" href="#%26%2Cstring%2Cstring" title="`&`(x, y: string): string">`&`(x, y: string): string</a></li>
- <li><a class="reference" href="#%26%2Cchar%2Cstring" title="`&`(x: char; y: string): string">`&`(x: char; y: string): string</a></li>
- <li><a class="reference" href="#%26%2Cstring%2Cchar" title="`&`(x: string; y: char): string">`&`(x: string; y: char): string</a></li>
- <li><a class="reference" href="#%26%2Csinkseq%5BT%5D%2Csinkseq%5BT%5D" title="`&`[T](x, y: sink seq[T]): seq[T]">`&`[T](x, y: sink seq[T]): seq[T]</a></li>
- <li><a class="reference" href="#%26%2Csinkseq%5BT%5D%2CsinkT" title="`&`[T](x: sink seq[T]; y: sink T): seq[T]">`&`[T](x: sink seq[T]; y: sink T): seq[T]</a></li>
- <li><a class="reference" href="#%26%2CsinkT%2Csinkseq%5BT%5D" title="`&`[T](x: sink T; y: sink seq[T]): seq[T]">`&`[T](x: sink T; y: sink seq[T]): seq[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">&=
- <li><a class="reference" href="#%26%3D%2Cstring%2Cstring" title="`&=`(x: var string; y: string)">`&=`(x: var string; y: string)</a></li>
- </ul>
- <ul class="simple nested-toc-section">*
- <li><a class="reference" href="#%2A%2Cfloat%2Cfloat" title="`*`(x, y: float): float">`*`(x, y: float): float</a></li>
- <li><a class="reference" href="#%2A%2Cfloat32%2Cfloat32" title="`*`(x, y: float32): float32">`*`(x, y: float32): float32</a></li>
- <li><a class="reference" href="#%2A%2Cint%2Cint" title="`*`(x, y: int): int">`*`(x, y: int): int</a></li>
- <li><a class="reference" href="#%2A%2Cint8%2Cint8" title="`*`(x, y: int8): int8">`*`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%2A%2Cint16%2Cint16" title="`*`(x, y: int16): int16">`*`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%2A%2Cint32%2Cint32" title="`*`(x, y: int32): int32">`*`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%2A%2Cint64%2Cint64" title="`*`(x, y: int64): int64">`*`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#%2A%2Cuint%2Cuint" title="`*`(x, y: uint): uint">`*`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#%2A%2Cuint8%2Cuint8" title="`*`(x, y: uint8): uint8">`*`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#%2A%2Cuint16%2Cuint16" title="`*`(x, y: uint16): uint16">`*`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#%2A%2Cuint32%2Cuint32" title="`*`(x, y: uint32): uint32">`*`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#%2A%2Cuint64%2Cuint64" title="`*`(x, y: uint64): uint64">`*`(x, y: uint64): uint64</a></li>
- <li><a class="reference" href="#%2A%2Cset%5BT%5D%2Cset%5BT%5D" title="`*`[T](x, y: set[T]): set[T]">`*`[T](x, y: set[T]): set[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">*%
- <li><a class="reference" href="#%2A%25%2Cint%2Cint" title="`*%`(x, y: int): int">`*%`(x, y: int): int</a></li>
- <li><a class="reference" href="#%2A%25%2Cint8%2Cint8" title="`*%`(x, y: int8): int8">`*%`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%2A%25%2Cint16%2Cint16" title="`*%`(x, y: int16): int16">`*%`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%2A%25%2Cint32%2Cint32" title="`*%`(x, y: int32): int32">`*%`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%2A%25%2Cint64%2Cint64" title="`*%`(x, y: int64): int64">`*%`(x, y: int64): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">*=
- <li><a class="reference" href="#%2A%3D%2CT%2CT_2" title="`*=`[T: float | float32 | float64](x: var T; y: T)">`*=`[T: float | float32 | float64](x: var T; y: T)</a></li>
- <li><a class="reference" href="#%2A%3D%2CT%2CT" title="`*=`[T: SomeInteger](x: var T; y: T)">`*=`[T: SomeInteger](x: var T; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">+
- <li><a class="reference" href="#%2B%2Cfloat%2Cfloat" title="`+`(x, y: float): float">`+`(x, y: float): float</a></li>
- <li><a class="reference" href="#%2B%2Cfloat32%2Cfloat32" title="`+`(x, y: float32): float32">`+`(x, y: float32): float32</a></li>
- <li><a class="reference" href="#%2B%2Cint%2Cint" title="`+`(x, y: int): int">`+`(x, y: int): int</a></li>
- <li><a class="reference" href="#%2B%2Cint8%2Cint8" title="`+`(x, y: int8): int8">`+`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%2B%2Cint16%2Cint16" title="`+`(x, y: int16): int16">`+`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%2B%2Cint32%2Cint32" title="`+`(x, y: int32): int32">`+`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%2B%2Cint64%2Cint64" title="`+`(x, y: int64): int64">`+`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#%2B%2Cuint%2Cuint" title="`+`(x, y: uint): uint">`+`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#%2B%2Cuint8%2Cuint8" title="`+`(x, y: uint8): uint8">`+`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#%2B%2Cuint16%2Cuint16" title="`+`(x, y: uint16): uint16">`+`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#%2B%2Cuint32%2Cuint32" title="`+`(x, y: uint32): uint32">`+`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#%2B%2Cuint64%2Cuint64" title="`+`(x, y: uint64): uint64">`+`(x, y: uint64): uint64</a></li>
- <li><a class="reference" href="#%2B%2Cfloat" title="`+`(x: float): float">`+`(x: float): float</a></li>
- <li><a class="reference" href="#%2B%2Cfloat32" title="`+`(x: float32): float32">`+`(x: float32): float32</a></li>
- <li><a class="reference" href="#%2B%2Cint" title="`+`(x: int): int">`+`(x: int): int</a></li>
- <li><a class="reference" href="#%2B%2Cint8" title="`+`(x: int8): int8">`+`(x: int8): int8</a></li>
- <li><a class="reference" href="#%2B%2Cint16" title="`+`(x: int16): int16">`+`(x: int16): int16</a></li>
- <li><a class="reference" href="#%2B%2Cint32" title="`+`(x: int32): int32">`+`(x: int32): int32</a></li>
- <li><a class="reference" href="#%2B%2Cint64" title="`+`(x: int64): int64">`+`(x: int64): int64</a></li>
- <li><a class="reference" href="#%2B%2Cset%5BT%5D%2Cset%5BT%5D" title="`+`[T](x, y: set[T]): set[T]">`+`[T](x, y: set[T]): set[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">+%
- <li><a class="reference" href="#%2B%25%2Cint%2Cint" title="`+%`(x, y: int): int">`+%`(x, y: int): int</a></li>
- <li><a class="reference" href="#%2B%25%2Cint8%2Cint8" title="`+%`(x, y: int8): int8">`+%`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%2B%25%2Cint16%2Cint16" title="`+%`(x, y: int16): int16">`+%`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%2B%25%2Cint32%2Cint32" title="`+%`(x, y: int32): int32">`+%`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%2B%25%2Cint64%2Cint64" title="`+%`(x, y: int64): int64">`+%`(x, y: int64): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">+=
- <li><a class="reference" href="#%2B%3D%2CT%2CT_2" title="`+=`[T: float | float32 | float64](x: var T; y: T)">`+=`[T: float | float32 | float64](x: var T; y: T)</a></li>
- <li><a class="reference" href="#%2B%3D%2CT%2CT" title="`+=`[T: SomeInteger](x: var T; y: T)">`+=`[T: SomeInteger](x: var T; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">-
- <li><a class="reference" href="#-%2CAllocStats%2CAllocStats" title="`-`(a, b: AllocStats): AllocStats">`-`(a, b: AllocStats): AllocStats</a></li>
- <li><a class="reference" href="#-%2Cfloat%2Cfloat" title="`-`(x, y: float): float">`-`(x, y: float): float</a></li>
- <li><a class="reference" href="#-%2Cfloat32%2Cfloat32" title="`-`(x, y: float32): float32">`-`(x, y: float32): float32</a></li>
- <li><a class="reference" href="#-%2Cint%2Cint" title="`-`(x, y: int): int">`-`(x, y: int): int</a></li>
- <li><a class="reference" href="#-%2Cint8%2Cint8" title="`-`(x, y: int8): int8">`-`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#-%2Cint16%2Cint16" title="`-`(x, y: int16): int16">`-`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#-%2Cint32%2Cint32" title="`-`(x, y: int32): int32">`-`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#-%2Cint64%2Cint64" title="`-`(x, y: int64): int64">`-`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#-%2Cuint%2Cuint" title="`-`(x, y: uint): uint">`-`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#-%2Cuint8%2Cuint8" title="`-`(x, y: uint8): uint8">`-`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#-%2Cuint16%2Cuint16" title="`-`(x, y: uint16): uint16">`-`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#-%2Cuint32%2Cuint32" title="`-`(x, y: uint32): uint32">`-`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#-%2Cuint64%2Cuint64" title="`-`(x, y: uint64): uint64">`-`(x, y: uint64): uint64</a></li>
- <li><a class="reference" href="#-%2Cfloat" title="`-`(x: float): float">`-`(x: float): float</a></li>
- <li><a class="reference" href="#-%2Cfloat32" title="`-`(x: float32): float32">`-`(x: float32): float32</a></li>
- <li><a class="reference" href="#-%2Cint" title="`-`(x: int): int">`-`(x: int): int</a></li>
- <li><a class="reference" href="#-%2Cint8" title="`-`(x: int8): int8">`-`(x: int8): int8</a></li>
- <li><a class="reference" href="#-%2Cint16" title="`-`(x: int16): int16">`-`(x: int16): int16</a></li>
- <li><a class="reference" href="#-%2Cint32" title="`-`(x: int32): int32">`-`(x: int32): int32</a></li>
- <li><a class="reference" href="#-%2Cint64" title="`-`(x: int64): int64">`-`(x: int64): int64</a></li>
- <li><a class="reference" href="#-%2Cset%5BT%5D%2Cset%5BT%5D" title="`-`[T](x, y: set[T]): set[T]">`-`[T](x, y: set[T]): set[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">-%
- <li><a class="reference" href="#-%25%2Cint%2Cint" title="`-%`(x, y: int): int">`-%`(x, y: int): int</a></li>
- <li><a class="reference" href="#-%25%2Cint8%2Cint8" title="`-%`(x, y: int8): int8">`-%`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#-%25%2Cint16%2Cint16" title="`-%`(x, y: int16): int16">`-%`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#-%25%2Cint32%2Cint32" title="`-%`(x, y: int32): int32">`-%`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#-%25%2Cint64%2Cint64" title="`-%`(x, y: int64): int64">`-%`(x, y: int64): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">-=
- <li><a class="reference" href="#-%3D%2CT%2CT_2" title="`-=`[T: float | float32 | float64](x: var T; y: T)">`-=`[T: float | float32 | float64](x: var T; y: T)</a></li>
- <li><a class="reference" href="#-%3D%2CT%2CT" title="`-=`[T: SomeInteger](x: var T; y: T)">`-=`[T: SomeInteger](x: var T; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">..
- <li><a class="reference" href="#..%2CsinkT%2CsinkU" title="`..`[T, U](a: sink T; b: sink U): HSlice[T, U]">`..`[T, U](a: sink T; b: sink U): HSlice[T, U]</a></li>
- <li><a class="reference" href="#..%2CsinkT" title="`..`[T](b: sink T): HSlice[int, T]">`..`[T](b: sink T): HSlice[int, T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">/
- <li><a class="reference" href="#%2F%2Cfloat%2Cfloat" title="`/`(x, y: float): float">`/`(x, y: float): float</a></li>
- <li><a class="reference" href="#%2F%2Cfloat32%2Cfloat32" title="`/`(x, y: float32): float32">`/`(x, y: float32): float32</a></li>
- <li><a class="reference" href="#%2F%2Cint%2Cint" title="`/`(x, y: int): float">`/`(x, y: int): float</a></li>
- </ul>
- <ul class="simple nested-toc-section">/%
- <li><a class="reference" href="#%2F%25%2Cint%2Cint" title="`/%`(x, y: int): int">`/%`(x, y: int): int</a></li>
- <li><a class="reference" href="#%2F%25%2Cint8%2Cint8" title="`/%`(x, y: int8): int8">`/%`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#%2F%25%2Cint16%2Cint16" title="`/%`(x, y: int16): int16">`/%`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#%2F%25%2Cint32%2Cint32" title="`/%`(x, y: int32): int32">`/%`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#%2F%25%2Cint64%2Cint64" title="`/%`(x, y: int64): int64">`/%`(x, y: int64): int64</a></li>
- </ul>
- <ul class="simple nested-toc-section">/=
- <li><a class="reference" href="#%2F%3D%2Cfloat64%2Cfloat64" title="`/=`(x: var float64; y: float64)">`/=`(x: var float64; y: float64)</a></li>
- <li><a class="reference" href="#%2F%3D%2CT%2CT" title="`/=`[T: float | float32](x: var T; y: T)">`/=`[T: float | float32](x: var T; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section"><
- <li><a class="reference" href="#%3C%2Cbool%2Cbool" title="`<`(x, y: bool): bool">`<`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#%3C%2Cchar%2Cchar" title="`<`(x, y: char): bool">`<`(x, y: char): bool</a></li>
- <li><a class="reference" href="#%3C%2Cfloat%2Cfloat" title="`<`(x, y: float): bool">`<`(x, y: float): bool</a></li>
- <li><a class="reference" href="#%3C%2Cfloat32%2Cfloat32" title="`<`(x, y: float32): bool">`<`(x, y: float32): bool</a></li>
- <li><a class="reference" href="#%3C%2Cint%2Cint" title="`<`(x, y: int): bool">`<`(x, y: int): bool</a></li>
- <li><a class="reference" href="#%3C%2Cint8%2Cint8" title="`<`(x, y: int8): bool">`<`(x, y: int8): bool</a></li>
- <li><a class="reference" href="#%3C%2Cint16%2Cint16" title="`<`(x, y: int16): bool">`<`(x, y: int16): bool</a></li>
- <li><a class="reference" href="#%3C%2Cint32%2Cint32" title="`<`(x, y: int32): bool">`<`(x, y: int32): bool</a></li>
- <li><a class="reference" href="#%3C%2Cint64%2Cint64" title="`<`(x, y: int64): bool">`<`(x, y: int64): bool</a></li>
- <li><a class="reference" href="#%3C%2Cpointer%2Cpointer" title="`<`(x, y: pointer): bool">`<`(x, y: pointer): bool</a></li>
- <li><a class="reference" href="#%3C%2Cstring%2Cstring" title="`<`(x, y: string): bool">`<`(x, y: string): bool</a></li>
- <li><a class="reference" href="#%3C%2Cuint%2Cuint" title="`<`(x, y: uint): bool">`<`(x, y: uint): bool</a></li>
- <li><a class="reference" href="#%3C%2Cuint8%2Cuint8" title="`<`(x, y: uint8): bool">`<`(x, y: uint8): bool</a></li>
- <li><a class="reference" href="#%3C%2Cuint16%2Cuint16" title="`<`(x, y: uint16): bool">`<`(x, y: uint16): bool</a></li>
- <li><a class="reference" href="#%3C%2Cuint32%2Cuint32" title="`<`(x, y: uint32): bool">`<`(x, y: uint32): bool</a></li>
- <li><a class="reference" href="#%3C%2Cuint64%2Cuint64" title="`<`(x, y: uint64): bool">`<`(x, y: uint64): bool</a></li>
- <li><a class="reference" href="#%3C%2CEnum%2CEnum" title="`<`[Enum: enum](x, y: Enum): bool">`<`[Enum: enum](x, y: Enum): bool</a></li>
- <li><a class="reference" href="#%3C%2CT%2CT" title="`<`[T: tuple](x, y: T): bool">`<`[T: tuple](x, y: T): bool</a></li>
- <li><a class="reference" href="#%3C%2Cptr.T%2Cptr.T" title="`<`[T](x, y: ptr T): bool">`<`[T](x, y: ptr T): bool</a></li>
- <li><a class="reference" href="#%3C%2Cref.T%2Cref.T" title="`<`[T](x, y: ref T): bool">`<`[T](x, y: ref T): bool</a></li>
- <li><a class="reference" href="#%3C%2Cset%5BT%5D%2Cset%5BT%5D" title="`<`[T](x, y: set[T]): bool">`<`[T](x, y: set[T]): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section"><%
- <li><a class="reference" href="#%3C%25%2Cint%2Cint" title="`<%`(x, y: int): bool">`<%`(x, y: int): bool</a></li>
- <li><a class="reference" href="#%3C%25%2Cint8%2Cint8" title="`<%`(x, y: int8): bool">`<%`(x, y: int8): bool</a></li>
- <li><a class="reference" href="#%3C%25%2Cint16%2Cint16" title="`<%`(x, y: int16): bool">`<%`(x, y: int16): bool</a></li>
- <li><a class="reference" href="#%3C%25%2Cint32%2Cint32" title="`<%`(x, y: int32): bool">`<%`(x, y: int32): bool</a></li>
- <li><a class="reference" href="#%3C%25%2Cint64%2Cint64" title="`<%`(x, y: int64): bool">`<%`(x, y: int64): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section"><=
- <li><a class="reference" href="#%3C%3D%2Cbool%2Cbool" title="`<=`(x, y: bool): bool">`<=`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cchar%2Cchar" title="`<=`(x, y: char): bool">`<=`(x, y: char): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cfloat%2Cfloat" title="`<=`(x, y: float): bool">`<=`(x, y: float): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cfloat32%2Cfloat32" title="`<=`(x, y: float32): bool">`<=`(x, y: float32): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cint%2Cint" title="`<=`(x, y: int): bool">`<=`(x, y: int): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cint8%2Cint8" title="`<=`(x, y: int8): bool">`<=`(x, y: int8): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cint16%2Cint16" title="`<=`(x, y: int16): bool">`<=`(x, y: int16): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cint32%2Cint32" title="`<=`(x, y: int32): bool">`<=`(x, y: int32): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cint64%2Cint64" title="`<=`(x, y: int64): bool">`<=`(x, y: int64): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cpointer%2Cpointer" title="`<=`(x, y: pointer): bool">`<=`(x, y: pointer): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cstring%2Cstring" title="`<=`(x, y: string): bool">`<=`(x, y: string): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cuint%2Cuint" title="`<=`(x, y: uint): bool">`<=`(x, y: uint): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cuint8%2Cuint8" title="`<=`(x, y: uint8): bool">`<=`(x, y: uint8): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cuint16%2Cuint16" title="`<=`(x, y: uint16): bool">`<=`(x, y: uint16): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cuint32%2Cuint32" title="`<=`(x, y: uint32): bool">`<=`(x, y: uint32): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cuint64%2Cuint64" title="`<=`(x, y: uint64): bool">`<=`(x, y: uint64): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2CEnum%2CEnum" title="`<=`[Enum: enum](x, y: Enum): bool">`<=`[Enum: enum](x, y: Enum): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2CT%2CT" title="`<=`[T: tuple](x, y: T): bool">`<=`[T: tuple](x, y: T): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cref.T%2Cref.T" title="`<=`[T](x, y: ref T): bool">`<=`[T](x, y: ref T): bool</a></li>
- <li><a class="reference" href="#%3C%3D%2Cset%5BT%5D%2Cset%5BT%5D" title="`<=`[T](x, y: set[T]): bool">`<=`[T](x, y: set[T]): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section"><=%
- <li><a class="reference" href="#%3C%3D%25%2Cint%2Cint" title="`<=%`(x, y: int): bool">`<=%`(x, y: int): bool</a></li>
- <li><a class="reference" href="#%3C%3D%25%2Cint8%2Cint8" title="`<=%`(x, y: int8): bool">`<=%`(x, y: int8): bool</a></li>
- <li><a class="reference" href="#%3C%3D%25%2Cint16%2Cint16" title="`<=%`(x, y: int16): bool">`<=%`(x, y: int16): bool</a></li>
- <li><a class="reference" href="#%3C%3D%25%2Cint32%2Cint32" title="`<=%`(x, y: int32): bool">`<=%`(x, y: int32): bool</a></li>
- <li><a class="reference" href="#%3C%3D%25%2Cint64%2Cint64" title="`<=%`(x, y: int64): bool">`<=%`(x, y: int64): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">=
- <li><a class="reference" href="#%3D%2CT%2CT" title="`=`[T](dest: var T; src: T)">`=`[T](dest: var T; src: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">==
- <li><a class="reference" href="#%3D%3D%2Cbool%2Cbool" title="`==`(x, y: bool): bool">`==`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cchar%2Cchar" title="`==`(x, y: char): bool">`==`(x, y: char): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Ccstring%2Ccstring" title="`==`(x, y: cstring): bool">`==`(x, y: cstring): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cfloat%2Cfloat" title="`==`(x, y: float): bool">`==`(x, y: float): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cfloat32%2Cfloat32" title="`==`(x, y: float32): bool">`==`(x, y: float32): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cint%2Cint" title="`==`(x, y: int): bool">`==`(x, y: int): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cint8%2Cint8" title="`==`(x, y: int8): bool">`==`(x, y: int8): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cint16%2Cint16" title="`==`(x, y: int16): bool">`==`(x, y: int16): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cint32%2Cint32" title="`==`(x, y: int32): bool">`==`(x, y: int32): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cint64%2Cint64" title="`==`(x, y: int64): bool">`==`(x, y: int64): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cpointer%2Cpointer" title="`==`(x, y: pointer): bool">`==`(x, y: pointer): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cstring%2Cstring" title="`==`(x, y: string): bool">`==`(x, y: string): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cuint%2Cuint" title="`==`(x, y: uint): bool">`==`(x, y: uint): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cuint8%2Cuint8" title="`==`(x, y: uint8): bool">`==`(x, y: uint8): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cuint16%2Cuint16" title="`==`(x, y: uint16): bool">`==`(x, y: uint16): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cuint32%2Cuint32" title="`==`(x, y: uint32): bool">`==`(x, y: uint32): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cuint64%2Cuint64" title="`==`(x, y: uint64): bool">`==`(x, y: uint64): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2CEnum%2CEnum" title="`==`[Enum: enum](x, y: Enum): bool">`==`[Enum: enum](x, y: Enum): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Carray%5BI%2CT%5D%2Carray%5BI%2CT%5D" title="`==`[I, T](x, y: array[I, T]): bool">`==`[I, T](x, y: array[I, T]): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2CT%2CT" title="`==`[T: proc | iterator](x, y: T): bool">`==`[T: proc | iterator](x, y: T): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2CT%2CT_2" title="`==`[T: tuple | object](x, y: T): bool">`==`[T: tuple | object](x, y: T): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2CopenArray%5BT%5D%2CopenArray%5BT%5D" title="`==`[T](x, y: openArray[T]): bool">`==`[T](x, y: openArray[T]): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cptr.T%2Cptr.T" title="`==`[T](x, y: ptr T): bool">`==`[T](x, y: ptr T): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cref.T%2Cref.T" title="`==`[T](x, y: ref T): bool">`==`[T](x, y: ref T): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cseq%5BT%5D%2Cseq%5BT%5D" title="`==`[T](x, y: seq[T]): bool">`==`[T](x, y: seq[T]): bool</a></li>
- <li><a class="reference" href="#%3D%3D%2Cset%5BT%5D%2Cset%5BT%5D" title="`==`[T](x, y: set[T]): bool">`==`[T](x, y: set[T]): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">=copy
- <li><a class="reference" href="#%3Dcopy%2CT%2CT" title="`=copy`[T](dest: var T; src: T)">`=copy`[T](dest: var T; src: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">=destroy
- <li><a class="reference" href="#%3Ddestroy%2Cstring" title="`=destroy`(x: string)">`=destroy`(x: string)</a></li>
- <li><a class="reference" href="#%3Ddestroy%2Cref.T" title="`=destroy`[T](x: ref T)">`=destroy`[T](x: ref T)</a></li>
- <li><a class="reference" href="#%3Ddestroy%2Cseq%5BT%5D" title="`=destroy`[T](x: seq[T])">`=destroy`[T](x: seq[T])</a></li>
- <li><a class="reference" href="#%3Ddestroy%2CT" title="`=destroy`[T](x: var T)">`=destroy`[T](x: var T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">=dup
- <li><a class="reference" href="#%3Ddup%2CT" title="`=dup`[T](x: T): T">`=dup`[T](x: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">=sink
- <li><a class="reference" href="#%3Dsink%2CT%2CT" title="`=sink`[T](x: var T; y: T)">`=sink`[T](x: var T; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">=trace
- <li><a class="reference" href="#%3Dtrace%2CT%2Cpointer" title="`=trace`[T](x: var T; env: pointer)">`=trace`[T](x: var T; env: pointer)</a></li>
- </ul>
- <ul class="simple nested-toc-section">=wasMoved
- <li><a class="reference" href="#%3DwasMoved%2CT" title="`=wasMoved`[T](obj: var T)">`=wasMoved`[T](obj: var T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">@
- <li><a class="reference" href="#%40%2Csinkarray%5BIDX%2CT%5D" title="`@`[IDX, T](a: sink array[IDX, T]): seq[T]">`@`[IDX, T](a: sink array[IDX, T]): seq[T]</a></li>
- <li><a class="reference" href="#%40%2CopenArray%5BT%5D" title="`@`[T](a: openArray[T]): seq[T]">`@`[T](a: openArray[T]): seq[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">[]
- <li><a class="reference" href="#%5B%5D%2Cstring%2CBackwardsIndex" title="`[]`(s: string; i: BackwardsIndex): char">`[]`(s: string; i: BackwardsIndex): char</a></li>
- <li><a class="reference" href="#%5B%5D%2Cstring%2CBackwardsIndex_2" title="`[]`(s: var string; i: BackwardsIndex): var char">`[]`(s: var string; i: BackwardsIndex): var char</a></li>
- <li><a class="reference" href="#%5B%5D%2CT%2CI" title="`[]`[I: Ordinal; T](a: T; i: I): T">`[]`[I: Ordinal; T](a: T; i: I): T</a></li>
- <li><a class="reference" href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D" title="`[]`[Idx, T; U, V: Ordinal](a: array[Idx, T]; x: HSlice[U, V]): seq[T]">`[]`[Idx, T; U, V: Ordinal](a: array[Idx, T]; x: HSlice[U, V]): seq[T]</a></li>
- <li><a class="reference" href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex" title="`[]`[Idx, T](a: array[Idx, T]; i: BackwardsIndex): T">`[]`[Idx, T](a: array[Idx, T]; i: BackwardsIndex): T</a></li>
- <li><a class="reference" href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex_2" title="`[]`[Idx, T](a: var array[Idx, T]; i: BackwardsIndex): var T">`[]`[Idx, T](a: var array[Idx, T]; i: BackwardsIndex): var T</a></li>
- <li><a class="reference" href="#%5B%5D%2Cstring%2CHSlice%5BT%3A%20Ordinal%2CU%3A%20Ordinal%5D" title="`[]`[T, U: Ordinal](s: string; x: HSlice[T, U]): string">`[]`[T, U: Ordinal](s: string; x: HSlice[T, U]): string</a></li>
- <li><a class="reference" href="#%5B%5D%2CopenArray%5BT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D" title="`[]`[T; U, V: Ordinal](s: openArray[T]; x: HSlice[U, V]): seq[T]">`[]`[T; U, V: Ordinal](s: openArray[T]; x: HSlice[U, V]): seq[T]</a></li>
- <li><a class="reference" href="#%5B%5D%2CopenArray%5BT%5D%2CBackwardsIndex" title="`[]`[T](s: openArray[T]; i: BackwardsIndex): T">`[]`[T](s: openArray[T]; i: BackwardsIndex): T</a></li>
- <li><a class="reference" href="#%5B%5D%2CopenArray%5BT%5D%2CBackwardsIndex_2" title="`[]`[T](s: var openArray[T]; i: BackwardsIndex): var T">`[]`[T](s: var openArray[T]; i: BackwardsIndex): var T</a></li>
- </ul>
- <ul class="simple nested-toc-section">[]=
- <li><a class="reference" href="#%5B%5D%3D%2Cstring%2CBackwardsIndex%2Cchar" title="`[]=`(s: var string; i: BackwardsIndex; x: char)">`[]=`(s: var string; i: BackwardsIndex; x: char)</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2CT%2CI%2CsinkS" title="`[]=`[I: Ordinal; T, S](a: T; i: I; x: sink S)">`[]=`[I: Ordinal; T, S](a: T; i: I; x: sink S)</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2Carray%5BIdx%2CT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D%2CopenArray%5BT%5D" title="`[]=`[Idx, T; U, V: Ordinal](a: var array[Idx, T]; x: HSlice[U, V];
- b: openArray[T])">`[]=`[Idx, T; U, V: Ordinal](a: var array[Idx, T]; x: HSlice[U, V];
- b: openArray[T])</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex%2CT" title="`[]=`[Idx, T](a: var array[Idx, T]; i: BackwardsIndex; x: T)">`[]=`[Idx, T](a: var array[Idx, T]; i: BackwardsIndex; x: T)</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2Cstring%2CHSlice%5BT%3A%20Ordinal%2CU%3A%20Ordinal%5D%2Cstring" title="`[]=`[T, U: Ordinal](s: var string; x: HSlice[T, U]; b: string)">`[]=`[T, U: Ordinal](s: var string; x: HSlice[T, U]; b: string)</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2Cseq%5BT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D%2CopenArray%5BT%5D" title="`[]=`[T; U, V: Ordinal](s: var seq[T]; x: HSlice[U, V]; b: openArray[T])">`[]=`[T; U, V: Ordinal](s: var seq[T]; x: HSlice[U, V]; b: openArray[T])</a></li>
- <li><a class="reference" href="#%5B%5D%3D%2CopenArray%5BT%5D%2CBackwardsIndex%2CT" title="`[]=`[T](s: var openArray[T]; i: BackwardsIndex; x: T)">`[]=`[T](s: var openArray[T]; i: BackwardsIndex; x: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">abs
- <li><a class="reference" href="#abs%2Cint" title="abs(x: int): int">abs(x: int): int</a></li>
- <li><a class="reference" href="#abs%2Cint8" title="abs(x: int8): int8">abs(x: int8): int8</a></li>
- <li><a class="reference" href="#abs%2Cint16" title="abs(x: int16): int16">abs(x: int16): int16</a></li>
- <li><a class="reference" href="#abs%2Cint32" title="abs(x: int32): int32">abs(x: int32): int32</a></li>
- <li><a class="reference" href="#abs%2Cint64" title="abs(x: int64): int64">abs(x: int64): int64</a></li>
- <li><a class="reference" href="#abs%2CT" title="abs[T: float64 | float32](x: T): T">abs[T: float64 | float32](x: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">add
- <li><a class="reference" href="#add%2Ccstring%2Ccstring" title="add(x: var cstring; y: cstring)">add(x: var cstring; y: cstring)</a></li>
- <li><a class="reference" href="#add%2Cstring%2Cchar" title="add(x: var string; y: char)">add(x: var string; y: char)</a></li>
- <li><a class="reference" href="#add%2Cstring%2Ccstring" title="add(x: var string; y: cstring)">add(x: var string; y: cstring)</a></li>
- <li><a class="reference" href="#add%2Cstring%2Cstring" title="add(x: var string; y: string)">add(x: var string; y: string)</a></li>
- <li><a class="reference" href="#add%2Cseq%5BT%5D%2CopenArray%5BT%5D" title="add[T](x: var seq[T]; y: openArray[T])">add[T](x: var seq[T]; y: openArray[T])</a></li>
- <li><a class="reference" href="#add%2Cseq%5BT%5D%2CsinkT" title="add[T](x: var seq[T]; y: sink T)">add[T](x: var seq[T]; y: sink T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">addEscapedChar
- <li><a class="reference" href="#addEscapedChar%2Cstring%2Cchar" title="addEscapedChar(s: var string; c: char)">addEscapedChar(s: var string; c: char)</a></li>
- </ul>
- <ul class="simple nested-toc-section">addQuoted
- <li><a class="reference" href="#addQuoted%2Cstring%2CT" title="addQuoted[T](s: var string; x: T)">addQuoted[T](s: var string; x: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">addr
- <li><a class="reference" href="#addr%2CT" title="`addr`[T](x: T): ptr T">`addr`[T](x: T): ptr T</a></li>
- </ul>
- <ul class="simple nested-toc-section">alignof
- <li><a class="reference" href="#alignof%2Ctypedesc" title="alignof(x: typedesc): int">alignof(x: typedesc): int</a></li>
- <li><a class="reference" href="#alignof%2CT" title="alignof[T](x: T): int">alignof[T](x: T): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">alloc0Impl
- <li><a class="reference" href="#alloc0Impl%2CNatural" title="alloc0Impl(size: Natural): pointer">alloc0Impl(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocCStringArray
- <li><a class="reference" href="#allocCStringArray%2CopenArray%5Bstring%5D" title="allocCStringArray(a: openArray[string]): cstringArray">allocCStringArray(a: openArray[string]): cstringArray</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocImpl
- <li><a class="reference" href="#allocImpl%2CNatural" title="allocImpl(size: Natural): pointer">allocImpl(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocShared0Impl
- <li><a class="reference" href="#allocShared0Impl%2CNatural" title="allocShared0Impl(size: Natural): pointer">allocShared0Impl(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocSharedImpl
- <li><a class="reference" href="#allocSharedImpl%2CNatural" title="allocSharedImpl(size: Natural): pointer">allocSharedImpl(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">and
- <li><a class="reference" href="#and%2Ctypedesc%2Ctypedesc" title="`and`(a, b: typedesc): typedesc">`and`(a, b: typedesc): typedesc</a></li>
- <li><a class="reference" href="#and%2Cbool%2Cbool" title="`and`(x, y: bool): bool">`and`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#and%2Cint%2Cint" title="`and`(x, y: int): int">`and`(x, y: int): int</a></li>
- <li><a class="reference" href="#and%2Cint8%2Cint8" title="`and`(x, y: int8): int8">`and`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#and%2Cint16%2Cint16" title="`and`(x, y: int16): int16">`and`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#and%2Cint32%2Cint32" title="`and`(x, y: int32): int32">`and`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#and%2Cint64%2Cint64" title="`and`(x, y: int64): int64">`and`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#and%2Cuint%2Cuint" title="`and`(x, y: uint): uint">`and`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#and%2Cuint8%2Cuint8" title="`and`(x, y: uint8): uint8">`and`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#and%2Cuint16%2Cuint16" title="`and`(x, y: uint16): uint16">`and`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#and%2Cuint32%2Cuint32" title="`and`(x, y: uint32): uint32">`and`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#and%2Cuint64%2Cuint64" title="`and`(x, y: uint64): uint64">`and`(x, y: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">arrayWith
- <li><a class="reference" href="#arrayWith%2CT%2Cstaticint" title="arrayWith[T](y: T; size: static int): array[size, T]">arrayWith[T](y: T; size: static int): array[size, T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">arrayWithDefault
- <li><a class="reference" href="#arrayWithDefault%2Cstaticint" title="arrayWithDefault[T](size: static int): array[size, T]">arrayWithDefault[T](size: static int): array[size, T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">ashr
- <li><a class="reference" href="#ashr%2Cint8%2CSomeInteger" title="ashr(x: int8; y: SomeInteger): int8">ashr(x: int8; y: SomeInteger): int8</a></li>
- <li><a class="reference" href="#ashr%2Cint16%2CSomeInteger" title="ashr(x: int16; y: SomeInteger): int16">ashr(x: int16; y: SomeInteger): int16</a></li>
- <li><a class="reference" href="#ashr%2Cint32%2CSomeInteger" title="ashr(x: int32; y: SomeInteger): int32">ashr(x: int32; y: SomeInteger): int32</a></li>
- <li><a class="reference" href="#ashr%2Cint64%2CSomeInteger" title="ashr(x: int64; y: SomeInteger): int64">ashr(x: int64; y: SomeInteger): int64</a></li>
- <li><a class="reference" href="#ashr%2Cint%2CSomeInteger" title="ashr(x: int; y: SomeInteger): int">ashr(x: int; y: SomeInteger): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">astToStr
- <li><a class="reference" href="#astToStr%2CT" title="astToStr[T](x: T): string">astToStr[T](x: T): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">capacity
- <li><a class="reference" href="#capacity%2Cstring" title="capacity(self: string): int">capacity(self: string): int</a></li>
- <li><a class="reference" href="#capacity%2Cseq%5BT%5D" title="capacity[T](self: seq[T]): int">capacity[T](self: seq[T]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">card
- <li><a class="reference" href="#card%2Cset%5BT%5D" title="card[T](x: set[T]): int">card[T](x: set[T]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">chr
- <li><a class="reference" href="#chr%2Crange%5B%5D" title="chr(u: range[0 .. 255]): char">chr(u: range[0 .. 255]): char</a></li>
- </ul>
- <ul class="simple nested-toc-section">clamp
- <li><a class="reference" href="#clamp%2CT%2CT%2CT" title="clamp[T](x, a, b: T): T">clamp[T](x, a, b: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">cmp
- <li><a class="reference" href="#cmp%2Cstring%2Cstring" title="cmp(x, y: string): int">cmp(x, y: string): int</a></li>
- <li><a class="reference" href="#cmp%2CT%2CT" title="cmp[T](x, y: T): int">cmp[T](x, y: T): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">cmpMem
- <li><a class="reference" href="#cmpMem%2Cpointer%2Cpointer%2CNatural" title="cmpMem(a, b: pointer; size: Natural): int">cmpMem(a, b: pointer; size: Natural): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">compileOption
- <li><a class="reference" href="#compileOption%2Cstring%2Cstring" title="compileOption(option, arg: string): bool">compileOption(option, arg: string): bool</a></li>
- <li><a class="reference" href="#compileOption%2Cstring" title="compileOption(option: string): bool">compileOption(option: string): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">compiles
- <li><a class="reference" href="#compiles%2Cuntyped" title="compiles(x: untyped): bool">compiles(x: untyped): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">contains
- <li><a class="reference" href="#contains%2CopenArray%5BT%5D%2CT" title="contains[T](a: openArray[T]; item: T): bool">contains[T](a: openArray[T]; item: T): bool</a></li>
- <li><a class="reference" href="#contains%2Cset%5BT%5D%2CT" title="contains[T](x: set[T]; y: T): bool">contains[T](x: set[T]; y: T): bool</a></li>
- <li><a class="reference" href="#contains%2CHSlice%5BU%2CV%5D%2CW" title="contains[U, V, W](s: HSlice[U, V]; value: W): bool">contains[U, V, W](s: HSlice[U, V]; value: W): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">copyMem
- <li><a class="reference" href="#copyMem%2Cpointer%2Cpointer%2CNatural" title="copyMem(dest, source: pointer; size: Natural)">copyMem(dest, source: pointer; size: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">create
- <li><a class="reference" href="#create%2Ctypedesc" title="create(T: typedesc; size = 1.Positive): ptr T:type">create(T: typedesc; size = 1.Positive): ptr T:type</a></li>
- </ul>
- <ul class="simple nested-toc-section">createShared
- <li><a class="reference" href="#createShared%2Ctypedesc" title="createShared(T: typedesc; size = 1.Positive): ptr T:type">createShared(T: typedesc; size = 1.Positive): ptr T:type</a></li>
- </ul>
- <ul class="simple nested-toc-section">createSharedU
- <li><a class="reference" href="#createSharedU%2Ctypedesc" title="createSharedU(T: typedesc; size = 1.Positive): ptr T:type">createSharedU(T: typedesc; size = 1.Positive): ptr T:type</a></li>
- </ul>
- <ul class="simple nested-toc-section">createU
- <li><a class="reference" href="#createU%2Ctypedesc" title="createU(T: typedesc; size = 1.Positive): ptr T:type">createU(T: typedesc; size = 1.Positive): ptr T:type</a></li>
- </ul>
- <ul class="simple nested-toc-section">cstringArrayToSeq
- <li><a class="reference" href="#cstringArrayToSeq%2CcstringArray" title="cstringArrayToSeq(a: cstringArray): seq[string]">cstringArrayToSeq(a: cstringArray): seq[string]</a></li>
- <li><a class="reference" href="#cstringArrayToSeq%2CcstringArray%2CNatural" title="cstringArrayToSeq(a: cstringArray; len: Natural): seq[string]">cstringArrayToSeq(a: cstringArray; len: Natural): seq[string]</a></li>
- </ul>
- <ul class="simple nested-toc-section">dealloc
- <li><a class="reference" href="#dealloc%2Cpointer" title="dealloc(p: pointer)">dealloc(p: pointer)</a></li>
- </ul>
- <ul class="simple nested-toc-section">deallocCStringArray
- <li><a class="reference" href="#deallocCStringArray%2CcstringArray" title="deallocCStringArray(a: cstringArray)">deallocCStringArray(a: cstringArray)</a></li>
- </ul>
- <ul class="simple nested-toc-section">deallocImpl
- <li><a class="reference" href="#deallocImpl%2Cpointer" title="deallocImpl(p: pointer)">deallocImpl(p: pointer)</a></li>
- </ul>
- <ul class="simple nested-toc-section">deallocShared
- <li><a class="reference" href="#deallocShared%2Cpointer" title="deallocShared(p: pointer)">deallocShared(p: pointer)</a></li>
- </ul>
- <ul class="simple nested-toc-section">deallocSharedImpl
- <li><a class="reference" href="#deallocSharedImpl%2Cpointer" title="deallocSharedImpl(p: pointer)">deallocSharedImpl(p: pointer)</a></li>
- </ul>
- <ul class="simple nested-toc-section">debugEcho
- <li><a class="reference" href="#debugEcho%2Cvarargs%5Btyped%2C%5D" title="debugEcho(x: varargs[typed, `$`])">debugEcho(x: varargs[typed, `$`])</a></li>
- </ul>
- <ul class="simple nested-toc-section">dec
- <li><a class="reference" href="#dec%2CT%2CV" title="dec[T, V: Ordinal](x: var T; y: V = 1)">dec[T, V: Ordinal](x: var T; y: V = 1)</a></li>
- </ul>
- <ul class="simple nested-toc-section">declared
- <li><a class="reference" href="#declared%2Cuntyped" title="declared(x: untyped): bool">declared(x: untyped): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">declaredInScope
- <li><a class="reference" href="#declaredInScope%2Cuntyped" title="declaredInScope(x: untyped): bool">declaredInScope(x: untyped): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">deepCopy
- <li><a class="reference" href="#deepCopy%2C%2CT" title="deepCopy[T](x: out T; y: T)">deepCopy[T](x: out T; y: T)</a></li>
- <li><a class="reference" href="#deepCopy%2CT" title="deepCopy[T](y: T): T">deepCopy[T](y: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">default
- <li><a class="reference" href="#default%2Ctypedesc%5BT%5D" title="default[T](_: typedesc[T]): T">default[T](_: typedesc[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">defined
- <li><a class="reference" href="#defined%2Cuntyped" title="defined(x: untyped): bool">defined(x: untyped): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">del
- <li><a class="reference" href="#del%2Cseq%5BT%5D%2CNatural" title="del[T](x: var seq[T]; i: Natural)">del[T](x: var seq[T]; i: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">delete
- <li><a class="reference" href="#delete%2Cseq%5BT%5D%2CNatural" title="delete[T](x: var seq[T]; i: Natural)">delete[T](x: var seq[T]; i: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">dispose
- <li><a class="reference" href="#dispose%2CForeignCell" title="dispose(x: ForeignCell)">dispose(x: ForeignCell)</a></li>
- </ul>
- <ul class="simple nested-toc-section">div
- <li><a class="reference" href="#div%2Cint%2Cint" title="`div`(x, y: int): int">`div`(x, y: int): int</a></li>
- <li><a class="reference" href="#div%2Cint8%2Cint8" title="`div`(x, y: int8): int8">`div`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#div%2Cint16%2Cint16" title="`div`(x, y: int16): int16">`div`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#div%2Cint32%2Cint32" title="`div`(x, y: int32): int32">`div`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#div%2Cint64%2Cint64" title="`div`(x, y: int64): int64">`div`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#div%2Cuint%2Cuint" title="`div`(x, y: uint): uint">`div`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#div%2Cuint8%2Cuint8" title="`div`(x, y: uint8): uint8">`div`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#div%2Cuint16%2Cuint16" title="`div`(x, y: uint16): uint16">`div`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#div%2Cuint32%2Cuint32" title="`div`(x, y: uint32): uint32">`div`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#div%2Cuint64%2Cuint64" title="`div`(x, y: uint64): uint64">`div`(x, y: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">echo
- <li><a class="reference" href="#echo%2Cvarargs%5Btyped%2C%5D" title="echo(x: varargs[typed, `$`])">echo(x: varargs[typed, `$`])</a></li>
- </ul>
- <ul class="simple nested-toc-section">ensureMove
- <li><a class="reference" href="#ensureMove%2CT" title="ensureMove[T](x: T): T">ensureMove[T](x: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">equalMem
- <li><a class="reference" href="#equalMem%2Cpointer%2Cpointer%2CNatural" title="equalMem(a, b: pointer; size: Natural): bool">equalMem(a, b: pointer; size: Natural): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">excl
- <li><a class="reference" href="#excl%2Cset%5BT%5D%2CT" title="excl[T](x: var set[T]; y: T)">excl[T](x: var set[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">find
- <li><a class="reference" href="#find%2CT%2CS" title="find[T, S](a: T; item: S): int">find[T, S](a: T; item: S): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">finished
- <li><a class="reference" href="#finished%2CT" title="finished[T: iterator {.closure.}](x: T): bool">finished[T: iterator {.closure.}](x: T): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">freeShared
- <li><a class="reference" href="#freeShared%2Cptr.T" title="freeShared[T](p: ptr T)">freeShared[T](p: ptr T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_disableMarkAndSweep
- <li><a class="reference" href="#GC_disableMarkAndSweep" title="GC_disableMarkAndSweep()">GC_disableMarkAndSweep()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_disableOrc
- <li><a class="reference" href="#GC_disableOrc" title="GC_disableOrc()">GC_disableOrc()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_enableMarkAndSweep
- <li><a class="reference" href="#GC_enableMarkAndSweep" title="GC_enableMarkAndSweep()">GC_enableMarkAndSweep()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_enableOrc
- <li><a class="reference" href="#GC_enableOrc" title="GC_enableOrc()">GC_enableOrc()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_fullCollect
- <li><a class="reference" href="#GC_fullCollect" title="GC_fullCollect()">GC_fullCollect()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_getStatistics
- <li><a class="reference" href="#GC_getStatistics" title="GC_getStatistics(): string">GC_getStatistics(): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_partialCollect
- <li><a class="reference" href="#GC_partialCollect%2Cint" title="GC_partialCollect(limit: int)">GC_partialCollect(limit: int)</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_prepareOrc
- <li><a class="reference" href="#GC_prepareOrc" title="GC_prepareOrc(): int">GC_prepareOrc(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_ref
- <li><a class="reference" href="#GC_ref%2Cref.T" title="GC_ref[T](x: ref T)">GC_ref[T](x: ref T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_runOrc
- <li><a class="reference" href="#GC_runOrc" title="GC_runOrc()">GC_runOrc()</a></li>
- </ul>
- <ul class="simple nested-toc-section">GC_unref
- <li><a class="reference" href="#GC_unref%2Cref.T" title="GC_unref[T](x: ref T)">GC_unref[T](x: ref T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">getAllocStats
- <li><a class="reference" href="#getAllocStats" title="getAllocStats(): AllocStats">getAllocStats(): AllocStats</a></li>
- </ul>
- <ul class="simple nested-toc-section">getCurrentException
- <li><a class="reference" href="#getCurrentException" title="getCurrentException(): ref Exception">getCurrentException(): ref Exception</a></li>
- </ul>
- <ul class="simple nested-toc-section">getCurrentExceptionMsg
- <li><a class="reference" href="#getCurrentExceptionMsg" title="getCurrentExceptionMsg(): string">getCurrentExceptionMsg(): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">getFrame
- <li><a class="reference" href="#getFrame" title="getFrame(): PFrame">getFrame(): PFrame</a></li>
- </ul>
- <ul class="simple nested-toc-section">getFrameState
- <li><a class="reference" href="#getFrameState" title="getFrameState(): FrameState">getFrameState(): FrameState</a></li>
- </ul>
- <ul class="simple nested-toc-section">getFreeMem
- <li><a class="reference" href="#getFreeMem" title="getFreeMem(): int">getFreeMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getFreeSharedMem
- <li><a class="reference" href="#getFreeSharedMem" title="getFreeSharedMem(): int">getFreeSharedMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getMaxMem
- <li><a class="reference" href="#getMaxMem" title="getMaxMem(): int">getMaxMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getOccupiedMem
- <li><a class="reference" href="#getOccupiedMem" title="getOccupiedMem(): int">getOccupiedMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getOccupiedSharedMem
- <li><a class="reference" href="#getOccupiedSharedMem" title="getOccupiedSharedMem(): int">getOccupiedSharedMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getStackTrace
- <li><a class="reference" href="#getStackTrace" title="getStackTrace(): string">getStackTrace(): string</a></li>
- <li><a class="reference" href="#getStackTrace%2Cref.Exception" title="getStackTrace(e: ref Exception): string">getStackTrace(e: ref Exception): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">getStackTraceEntries
- <li><a class="reference" href="#getStackTraceEntries" title="getStackTraceEntries(): seq[StackTraceEntry]">getStackTraceEntries(): seq[StackTraceEntry]</a></li>
- <li><a class="reference" href="#getStackTraceEntries%2Cref.Exception" title="getStackTraceEntries(e: ref Exception): lent seq[StackTraceEntry]">getStackTraceEntries(e: ref Exception): lent seq[StackTraceEntry]</a></li>
- </ul>
- <ul class="simple nested-toc-section">getThreadId
- <li><a class="reference" href="#getThreadId" title="getThreadId(): int">getThreadId(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getTotalMem
- <li><a class="reference" href="#getTotalMem" title="getTotalMem(): int">getTotalMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getTotalSharedMem
- <li><a class="reference" href="#getTotalSharedMem" title="getTotalSharedMem(): int">getTotalSharedMem(): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">getTypeInfo
- <li><a class="reference" href="#getTypeInfo%2CT" title="getTypeInfo[T](x: T): pointer">getTypeInfo[T](x: T): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">gorge
- <li><a class="reference" href="#gorge%2Cstring%2Cstring%2Cstring" title="gorge(command: string; input = ""; cache = ""): string">gorge(command: string; input = ""; cache = ""): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">gorgeEx
- <li><a class="reference" href="#gorgeEx%2Cstring%2Cstring%2Cstring" title="gorgeEx(command: string; input = ""; cache = ""): tuple[output: string,
- exitCode: int]">gorgeEx(command: string; input = ""; cache = ""): tuple[output: string,
- exitCode: int]</a></li>
- </ul>
- <ul class="simple nested-toc-section">grow
- <li><a class="reference" href="#grow%2Cseq%5BT%5D%2CNatural%2CT" title="grow[T](x: var seq[T]; newLen: Natural; value: T)">grow[T](x: var seq[T]; newLen: Natural; value: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">high
- <li><a class="reference" href="#high%2Ctypedesc%5BSomeFloat%5D" title="high(T: typedesc[SomeFloat]): T:type">high(T: typedesc[SomeFloat]): T:type</a></li>
- <li><a class="reference" href="#high%2Ccstring" title="high(x: cstring): int">high(x: cstring): int</a></li>
- <li><a class="reference" href="#high%2Cstring" title="high(x: string): int">high(x: string): int</a></li>
- <li><a class="reference" href="#high%2Carray%5BI%2CT%5D" title="high[I, T](x: array[I, T]): I">high[I, T](x: array[I, T]): I</a></li>
- <li><a class="reference" href="#high%2Ctypedesc%5Barray%5BI%2CT%5D%5D" title="high[I, T](x: typedesc[array[I, T]]): I">high[I, T](x: typedesc[array[I, T]]): I</a></li>
- <li><a class="reference" href="#high%2CT" title="high[T: Ordinal | enum | range](x: T): T">high[T: Ordinal | enum | range](x: T): T</a></li>
- <li><a class="reference" href="#high%2Ctypedesc%5BT%5D" title="high[T: Ordinal | enum | range](x: typedesc[T]): T">high[T: Ordinal | enum | range](x: typedesc[T]): T</a></li>
- <li><a class="reference" href="#high%2CopenArray%5BT%5D" title="high[T](x: openArray[T]): int">high[T](x: openArray[T]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">inc
- <li><a class="reference" href="#inc%2CT%2CV" title="inc[T, V: Ordinal](x: var T; y: V = 1)">inc[T, V: Ordinal](x: var T; y: V = 1)</a></li>
- </ul>
- <ul class="simple nested-toc-section">incl
- <li><a class="reference" href="#incl%2Cset%5BT%5D%2CT" title="incl[T](x: var set[T]; y: T)">incl[T](x: var set[T]; y: T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">insert
- <li><a class="reference" href="#insert%2Cstring%2Cstring" title="insert(x: var string; item: string; i = 0.Natural)">insert(x: var string; item: string; i = 0.Natural)</a></li>
- <li><a class="reference" href="#insert%2Cseq%5BT%5D%2CsinkT" title="insert[T](x: var seq[T]; item: sink T; i = 0.Natural)">insert[T](x: var seq[T]; item: sink T; i = 0.Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">instantiationInfo
- <li><a class="reference" href="#instantiationInfo%2Cint" title="instantiationInfo(index = -1; fullPaths = false): tuple[filename: string,
- line: int, column: int]">instantiationInfo(index = -1; fullPaths = false): tuple[filename: string,
- line: int, column: int]</a></li>
- </ul>
- <ul class="simple nested-toc-section">is
- <li><a class="reference" href="#is%2CT%2CS" title="`is`[T, S](x: T; y: S): bool">`is`[T, S](x: T; y: S): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">isNil
- <li><a class="reference" href="#isNil%2Ccstring" title="isNil(x: cstring): bool">isNil(x: cstring): bool</a></li>
- <li><a class="reference" href="#isNil%2Cpointer" title="isNil(x: pointer): bool">isNil(x: pointer): bool</a></li>
- <li><a class="reference" href="#isNil%2CT" title="isNil[T: proc | iterator {.closure.}](x: T): bool">isNil[T: proc | iterator {.closure.}](x: T): bool</a></li>
- <li><a class="reference" href="#isNil%2Cptr.T" title="isNil[T](x: ptr T): bool">isNil[T](x: ptr T): bool</a></li>
- <li><a class="reference" href="#isNil%2Cref.T" title="isNil[T](x: ref T): bool">isNil[T](x: ref T): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">isNotForeign
- <li><a class="reference" href="#isNotForeign%2CForeignCell" title="isNotForeign(x: ForeignCell): bool">isNotForeign(x: ForeignCell): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">isUniqueRef
- <li><a class="reference" href="#isUniqueRef%2Cref.T" title="isUniqueRef[T](x: ref T): bool">isUniqueRef[T](x: ref T): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">iterToProc
- <li><a class="reference" href="#iterToProc%2Ctyped%2Ctypedesc%2Cuntyped" title="iterToProc(iter: typed; envType: typedesc; procName: untyped)">iterToProc(iter: typed; envType: typedesc; procName: untyped)</a></li>
- </ul>
- <ul class="simple nested-toc-section">len
- <li><a class="reference" href="#len" title="len(x: (type array) | array): int">len(x: (type array) | array): int</a></li>
- <li><a class="reference" href="#len%2Ccstring" title="len(x: cstring): int">len(x: cstring): int</a></li>
- <li><a class="reference" href="#len%2Cstring" title="len(x: string): int">len(x: string): int</a></li>
- <li><a class="reference" href="#len%2Cseq%5BT%5D" title="len[T](x: seq[T]): int">len[T](x: seq[T]): int</a></li>
- <li><a class="reference" href="#len%2Cset%5BT%5D" title="len[T](x: set[T]): int">len[T](x: set[T]): int</a></li>
- <li><a class="reference" href="#len%2CTOpenArray" title="len[TOpenArray: openArray | varargs](x: TOpenArray): int">len[TOpenArray: openArray | varargs](x: TOpenArray): int</a></li>
- <li><a class="reference" href="#len%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D" title="len[U: Ordinal; V: Ordinal](x: HSlice[U, V]): int">len[U: Ordinal; V: Ordinal](x: HSlice[U, V]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">locals
- <li><a class="reference" href="#locals" title="locals(): RootObj">locals(): RootObj</a></li>
- </ul>
- <ul class="simple nested-toc-section">low
- <li><a class="reference" href="#low%2Ctypedesc%5BSomeFloat%5D" title="low(T: typedesc[SomeFloat]): T:type">low(T: typedesc[SomeFloat]): T:type</a></li>
- <li><a class="reference" href="#low%2Ccstring" title="low(x: cstring): int">low(x: cstring): int</a></li>
- <li><a class="reference" href="#low%2Cstring" title="low(x: string): int">low(x: string): int</a></li>
- <li><a class="reference" href="#low%2Carray%5BI%2CT%5D" title="low[I, T](x: array[I, T]): I">low[I, T](x: array[I, T]): I</a></li>
- <li><a class="reference" href="#low%2Ctypedesc%5Barray%5BI%2CT%5D%5D" title="low[I, T](x: typedesc[array[I, T]]): I">low[I, T](x: typedesc[array[I, T]]): I</a></li>
- <li><a class="reference" href="#low%2CT" title="low[T: Ordinal | enum | range](x: T): T">low[T: Ordinal | enum | range](x: T): T</a></li>
- <li><a class="reference" href="#low%2Ctypedesc%5BT%5D" title="low[T: Ordinal | enum | range](x: typedesc[T]): T">low[T: Ordinal | enum | range](x: typedesc[T]): T</a></li>
- <li><a class="reference" href="#low%2CopenArray%5BT%5D" title="low[T](x: openArray[T]): int">low[T](x: openArray[T]): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">max
- <li><a class="reference" href="#max%2Cfloat32%2Cfloat32" title="max(x, y: float32): float32">max(x, y: float32): float32</a></li>
- <li><a class="reference" href="#max%2Cfloat64%2Cfloat64" title="max(x, y: float64): float64">max(x, y: float64): float64</a></li>
- <li><a class="reference" href="#max%2Cint%2Cint" title="max(x, y: int): int">max(x, y: int): int</a></li>
- <li><a class="reference" href="#max%2Cint8%2Cint8" title="max(x, y: int8): int8">max(x, y: int8): int8</a></li>
- <li><a class="reference" href="#max%2Cint16%2Cint16" title="max(x, y: int16): int16">max(x, y: int16): int16</a></li>
- <li><a class="reference" href="#max%2Cint32%2Cint32" title="max(x, y: int32): int32">max(x, y: int32): int32</a></li>
- <li><a class="reference" href="#max%2Cint64%2Cint64" title="max(x, y: int64): int64">max(x, y: int64): int64</a></li>
- <li><a class="reference" href="#max%2CT%2CT" title="max[T: not SomeFloat](x, y: T): T">max[T: not SomeFloat](x, y: T): T</a></li>
- <li><a class="reference" href="#max%2CopenArray%5BT%5D" title="max[T](x: openArray[T]): T">max[T](x: openArray[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">min
- <li><a class="reference" href="#min%2Cfloat32%2Cfloat32" title="min(x, y: float32): float32">min(x, y: float32): float32</a></li>
- <li><a class="reference" href="#min%2Cfloat64%2Cfloat64" title="min(x, y: float64): float64">min(x, y: float64): float64</a></li>
- <li><a class="reference" href="#min%2Cint%2Cint" title="min(x, y: int): int">min(x, y: int): int</a></li>
- <li><a class="reference" href="#min%2Cint8%2Cint8" title="min(x, y: int8): int8">min(x, y: int8): int8</a></li>
- <li><a class="reference" href="#min%2Cint16%2Cint16" title="min(x, y: int16): int16">min(x, y: int16): int16</a></li>
- <li><a class="reference" href="#min%2Cint32%2Cint32" title="min(x, y: int32): int32">min(x, y: int32): int32</a></li>
- <li><a class="reference" href="#min%2Cint64%2Cint64" title="min(x, y: int64): int64">min(x, y: int64): int64</a></li>
- <li><a class="reference" href="#min%2CT%2CT" title="min[T: not SomeFloat](x, y: T): T">min[T: not SomeFloat](x, y: T): T</a></li>
- <li><a class="reference" href="#min%2CopenArray%5BT%5D" title="min[T](x: openArray[T]): T">min[T](x: openArray[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">mod
- <li><a class="reference" href="#mod%2Cint%2Cint" title="`mod`(x, y: int): int">`mod`(x, y: int): int</a></li>
- <li><a class="reference" href="#mod%2Cint8%2Cint8" title="`mod`(x, y: int8): int8">`mod`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#mod%2Cint16%2Cint16" title="`mod`(x, y: int16): int16">`mod`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#mod%2Cint32%2Cint32" title="`mod`(x, y: int32): int32">`mod`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#mod%2Cint64%2Cint64" title="`mod`(x, y: int64): int64">`mod`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#mod%2Cuint%2Cuint" title="`mod`(x, y: uint): uint">`mod`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#mod%2Cuint8%2Cuint8" title="`mod`(x, y: uint8): uint8">`mod`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#mod%2Cuint16%2Cuint16" title="`mod`(x, y: uint16): uint16">`mod`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#mod%2Cuint32%2Cuint32" title="`mod`(x, y: uint32): uint32">`mod`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#mod%2Cuint64%2Cuint64" title="`mod`(x, y: uint64): uint64">`mod`(x, y: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">move
- <li><a class="reference" href="#move%2CT" title="move[T](x: var T): T">move[T](x: var T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">moveMem
- <li><a class="reference" href="#moveMem%2Cpointer%2Cpointer%2CNatural" title="moveMem(dest, source: pointer; size: Natural)">moveMem(dest, source: pointer; size: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">new
- <li><a class="reference" href="#new%2Ctypedesc" title="new(t: typedesc): auto">new(t: typedesc): auto</a></li>
- <li><a class="reference" href="#new%2Cref.T" title="new[T](a: var ref T)">new[T](a: var ref T)</a></li>
- <li><a class="reference" href="#new%2Cref.T%2Cproc%28ref.T%29" title="new[T](a: var ref T; finalizer: proc (x: ref T) {.nimcall.})">new[T](a: var ref T; finalizer: proc (x: ref T) {.nimcall.})</a></li>
- <li><a class="reference" href="#new%2Cref.T%2Cproc%28T%29" title="new[T](a: var ref T; finalizer: proc (x: T) {.nimcall.})">new[T](a: var ref T; finalizer: proc (x: T) {.nimcall.})</a></li>
- </ul>
- <ul class="simple nested-toc-section">newSeq
- <li><a class="reference" href="#newSeq" title="newSeq[T](len = 0.Natural): seq[T]">newSeq[T](len = 0.Natural): seq[T]</a></li>
- <li><a class="reference" href="#newSeq%2Cseq%5BT%5D%2CNatural" title="newSeq[T](s: var seq[T]; len: Natural)">newSeq[T](s: var seq[T]; len: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">newSeqOfCap
- <li><a class="reference" href="#newSeqOfCap%2CNatural" title="newSeqOfCap[T](cap: Natural): seq[T]">newSeqOfCap[T](cap: Natural): seq[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">newSeqUninit
- <li><a class="reference" href="#newSeqUninit%2CNatural" title="newSeqUninit[T](len: Natural): seq[T]">newSeqUninit[T](len: Natural): seq[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">newSeqUninitialized
- <li><a class="reference" href="#newSeqUninitialized%2CNatural" title="newSeqUninitialized[T: SomeNumber](len: Natural): seq[T]">newSeqUninitialized[T: SomeNumber](len: Natural): seq[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">newString
- <li><a class="reference" href="#newString%2CNatural" title="newString(len: Natural): string">newString(len: Natural): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">newStringOfCap
- <li><a class="reference" href="#newStringOfCap%2CNatural" title="newStringOfCap(cap: Natural): string">newStringOfCap(cap: Natural): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">newStringUninit
- <li><a class="reference" href="#newStringUninit%2CNatural" title="newStringUninit(len: Natural): string">newStringUninit(len: Natural): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">not
- <li><a class="reference" href="#not%2Ctypedesc" title="`not`(a: typedesc): typedesc">`not`(a: typedesc): typedesc</a></li>
- <li><a class="reference" href="#not%2Cbool" title="`not`(x: bool): bool">`not`(x: bool): bool</a></li>
- <li><a class="reference" href="#not%2Cint" title="`not`(x: int): int">`not`(x: int): int</a></li>
- <li><a class="reference" href="#not%2Cint8" title="`not`(x: int8): int8">`not`(x: int8): int8</a></li>
- <li><a class="reference" href="#not%2Cint16" title="`not`(x: int16): int16">`not`(x: int16): int16</a></li>
- <li><a class="reference" href="#not%2Cint32" title="`not`(x: int32): int32">`not`(x: int32): int32</a></li>
- <li><a class="reference" href="#not%2Cint64" title="`not`(x: int64): int64">`not`(x: int64): int64</a></li>
- <li><a class="reference" href="#not%2Cuint" title="`not`(x: uint): uint">`not`(x: uint): uint</a></li>
- <li><a class="reference" href="#not%2Cuint8" title="`not`(x: uint8): uint8">`not`(x: uint8): uint8</a></li>
- <li><a class="reference" href="#not%2Cuint16" title="`not`(x: uint16): uint16">`not`(x: uint16): uint16</a></li>
- <li><a class="reference" href="#not%2Cuint32" title="`not`(x: uint32): uint32">`not`(x: uint32): uint32</a></li>
- <li><a class="reference" href="#not%2Cuint64" title="`not`(x: uint64): uint64">`not`(x: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">of
- <li><a class="reference" href="#of%2CT%2Ctypedesc%5BS%5D" title="`of`[T, S](x: T; y: typedesc[S]): bool">`of`[T, S](x: T; y: typedesc[S]): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">onThreadDestruction
- <li><a class="reference" href="#onThreadDestruction%2Cproc%29" title="onThreadDestruction(handler: proc () {.closure, gcsafe, raises: [].})">onThreadDestruction(handler: proc () {.closure, gcsafe, raises: [].})</a></li>
- </ul>
- <ul class="simple nested-toc-section">or
- <li><a class="reference" href="#or%2Ctypedesc%2Ctypedesc" title="`or`(a, b: typedesc): typedesc">`or`(a, b: typedesc): typedesc</a></li>
- <li><a class="reference" href="#or%2Cbool%2Cbool" title="`or`(x, y: bool): bool">`or`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#or%2Cint%2Cint" title="`or`(x, y: int): int">`or`(x, y: int): int</a></li>
- <li><a class="reference" href="#or%2Cint8%2Cint8" title="`or`(x, y: int8): int8">`or`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#or%2Cint16%2Cint16" title="`or`(x, y: int16): int16">`or`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#or%2Cint32%2Cint32" title="`or`(x, y: int32): int32">`or`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#or%2Cint64%2Cint64" title="`or`(x, y: int64): int64">`or`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#or%2Cuint%2Cuint" title="`or`(x, y: uint): uint">`or`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#or%2Cuint8%2Cuint8" title="`or`(x, y: uint8): uint8">`or`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#or%2Cuint16%2Cuint16" title="`or`(x, y: uint16): uint16">`or`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#or%2Cuint32%2Cuint32" title="`or`(x, y: uint32): uint32">`or`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#or%2Cuint64%2Cuint64" title="`or`(x, y: uint64): uint64">`or`(x, y: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">ord
- <li><a class="reference" href="#ord%2CT" title="ord[T: Ordinal | enum](x: T): int">ord[T: Ordinal | enum](x: T): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">pop
- <li><a class="reference" href="#pop%2Cseq%5BT%5D" title="pop[T](s: var seq[T]): T">pop[T](s: var seq[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">pred
- <li><a class="reference" href="#pred%2CT%2CV" title="pred[T, V: Ordinal](x: T; y: V = 1): T">pred[T, V: Ordinal](x: T; y: V = 1): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">prepareMutation
- <li><a class="reference" href="#prepareMutation%2Cstring" title="prepareMutation(s: var string)">prepareMutation(s: var string)</a></li>
- </ul>
- <ul class="simple nested-toc-section">procCall
- <li><a class="reference" href="#procCall%2Cuntyped" title="procCall(x: untyped)">procCall(x: untyped)</a></li>
- </ul>
- <ul class="simple nested-toc-section">protect
- <li><a class="reference" href="#protect%2Cpointer" title="protect(x: pointer): ForeignCell">protect(x: pointer): ForeignCell</a></li>
- </ul>
- <ul class="simple nested-toc-section">quit
- <li><a class="reference" href="#quit%2Cint" title="quit(errorcode: int = QuitSuccess)">quit(errorcode: int = QuitSuccess)</a></li>
- <li><a class="reference" href="#quit%2Cstring" title="quit(errormsg: string; errorcode = QuitFailure)">quit(errormsg: string; errorcode = QuitFailure)</a></li>
- </ul>
- <ul class="simple nested-toc-section">rawEnv
- <li><a class="reference" href="#rawEnv%2CT" title="rawEnv[T: proc {.closure.} | iterator {.closure.}](x: T): pointer">rawEnv[T: proc {.closure.} | iterator {.closure.}](x: T): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">rawProc
- <li><a class="reference" href="#rawProc%2CT" title="rawProc[T: proc {.closure.} | iterator {.closure.}](x: T): pointer">rawProc[T: proc {.closure.} | iterator {.closure.}](x: T): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">realloc0Impl
- <li><a class="reference" href="#realloc0Impl%2Cpointer%2CNatural%2CNatural" title="realloc0Impl(p: pointer; oldSize, newSize: Natural): pointer">realloc0Impl(p: pointer; oldSize, newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">reallocImpl
- <li><a class="reference" href="#reallocImpl%2Cpointer%2CNatural" title="reallocImpl(p: pointer; newSize: Natural): pointer">reallocImpl(p: pointer; newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">reallocShared0Impl
- <li><a class="reference" href="#reallocShared0Impl%2Cpointer%2CNatural%2CNatural" title="reallocShared0Impl(p: pointer; oldSize, newSize: Natural): pointer">reallocShared0Impl(p: pointer; oldSize, newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">reallocSharedImpl
- <li><a class="reference" href="#reallocSharedImpl%2Cpointer%2CNatural" title="reallocSharedImpl(p: pointer; newSize: Natural): pointer">reallocSharedImpl(p: pointer; newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">repr
- <li><a class="reference" href="#repr%2CHSlice%5BT%2CU%5D" title="repr[T, U](x: HSlice[T, U]): string">repr[T, U](x: HSlice[T, U]): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">reset
- <li><a class="reference" href="#reset%2CT" title="reset[T](obj: var T)">reset[T](obj: var T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">resize
- <li><a class="reference" href="#resize%2Cptr.T%2CNatural" title="resize[T](p: ptr T; newSize: Natural): ptr T">resize[T](p: ptr T; newSize: Natural): ptr T</a></li>
- </ul>
- <ul class="simple nested-toc-section">resizeShared
- <li><a class="reference" href="#resizeShared%2Cptr.T%2CNatural" title="resizeShared[T](p: ptr T; newSize: Natural): ptr T">resizeShared[T](p: ptr T; newSize: Natural): ptr T</a></li>
- </ul>
- <ul class="simple nested-toc-section">runnableExamples
- <li><a class="reference" href="#runnableExamples%2Cstring%2Cuntyped" title="runnableExamples(rdoccmd = ""; body: untyped)">runnableExamples(rdoccmd = ""; body: untyped)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setControlCHook
- <li><a class="reference" href="#setControlCHook%2Cproc%29" title="setControlCHook(hook: proc () {.noconv.})">setControlCHook(hook: proc () {.noconv.})</a></li>
- </ul>
- <ul class="simple nested-toc-section">setCurrentException
- <li><a class="reference" href="#setCurrentException%2Cref.Exception" title="setCurrentException(exc: ref Exception)">setCurrentException(exc: ref Exception)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setFrame
- <li><a class="reference" href="#setFrame%2CPFrame" title="setFrame(s: PFrame)">setFrame(s: PFrame)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setFrameState
- <li><a class="reference" href="#setFrameState%2CFrameState" title="setFrameState(state: FrameState)">setFrameState(state: FrameState)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setLen
- <li><a class="reference" href="#setLen%2Cstring%2CNatural" title="setLen(s: var string; newlen: Natural)">setLen(s: var string; newlen: Natural)</a></li>
- <li><a class="reference" href="#setLen%2Cseq%5BT%5D%2CNatural" title="setLen[T](s: var seq[T]; newlen: Natural)">setLen[T](s: var seq[T]; newlen: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">setLenUninit
- <li><a class="reference" href="#setLenUninit%2Cseq%5BT%5D%2CNatural" title="setLenUninit[T](s: var seq[T]; newlen: Natural)">setLenUninit[T](s: var seq[T]; newlen: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">shl
- <li><a class="reference" href="#shl%2Cint8%2CSomeInteger" title="`shl`(x: int8; y: SomeInteger): int8">`shl`(x: int8; y: SomeInteger): int8</a></li>
- <li><a class="reference" href="#shl%2Cint16%2CSomeInteger" title="`shl`(x: int16; y: SomeInteger): int16">`shl`(x: int16; y: SomeInteger): int16</a></li>
- <li><a class="reference" href="#shl%2Cint32%2CSomeInteger" title="`shl`(x: int32; y: SomeInteger): int32">`shl`(x: int32; y: SomeInteger): int32</a></li>
- <li><a class="reference" href="#shl%2Cint64%2CSomeInteger" title="`shl`(x: int64; y: SomeInteger): int64">`shl`(x: int64; y: SomeInteger): int64</a></li>
- <li><a class="reference" href="#shl%2Cint%2CSomeInteger" title="`shl`(x: int; y: SomeInteger): int">`shl`(x: int; y: SomeInteger): int</a></li>
- <li><a class="reference" href="#shl%2Cuint8%2CSomeInteger" title="`shl`(x: uint8; y: SomeInteger): uint8">`shl`(x: uint8; y: SomeInteger): uint8</a></li>
- <li><a class="reference" href="#shl%2Cuint16%2CSomeInteger" title="`shl`(x: uint16; y: SomeInteger): uint16">`shl`(x: uint16; y: SomeInteger): uint16</a></li>
- <li><a class="reference" href="#shl%2Cuint32%2CSomeInteger" title="`shl`(x: uint32; y: SomeInteger): uint32">`shl`(x: uint32; y: SomeInteger): uint32</a></li>
- <li><a class="reference" href="#shl%2Cuint64%2CSomeInteger" title="`shl`(x: uint64; y: SomeInteger): uint64">`shl`(x: uint64; y: SomeInteger): uint64</a></li>
- <li><a class="reference" href="#shl%2Cuint%2CSomeInteger" title="`shl`(x: uint; y: SomeInteger): uint">`shl`(x: uint; y: SomeInteger): uint</a></li>
- </ul>
- <ul class="simple nested-toc-section">shr
- <li><a class="reference" href="#shr%2Cint8%2CSomeInteger" title="`shr`(x: int8; y: SomeInteger): int8">`shr`(x: int8; y: SomeInteger): int8</a></li>
- <li><a class="reference" href="#shr%2Cint16%2CSomeInteger" title="`shr`(x: int16; y: SomeInteger): int16">`shr`(x: int16; y: SomeInteger): int16</a></li>
- <li><a class="reference" href="#shr%2Cint32%2CSomeInteger" title="`shr`(x: int32; y: SomeInteger): int32">`shr`(x: int32; y: SomeInteger): int32</a></li>
- <li><a class="reference" href="#shr%2Cint64%2CSomeInteger" title="`shr`(x: int64; y: SomeInteger): int64">`shr`(x: int64; y: SomeInteger): int64</a></li>
- <li><a class="reference" href="#shr%2Cint%2CSomeInteger" title="`shr`(x: int; y: SomeInteger): int">`shr`(x: int; y: SomeInteger): int</a></li>
- <li><a class="reference" href="#shr%2Cuint8%2CSomeInteger" title="`shr`(x: uint8; y: SomeInteger): uint8">`shr`(x: uint8; y: SomeInteger): uint8</a></li>
- <li><a class="reference" href="#shr%2Cuint16%2CSomeInteger" title="`shr`(x: uint16; y: SomeInteger): uint16">`shr`(x: uint16; y: SomeInteger): uint16</a></li>
- <li><a class="reference" href="#shr%2Cuint32%2CSomeInteger" title="`shr`(x: uint32; y: SomeInteger): uint32">`shr`(x: uint32; y: SomeInteger): uint32</a></li>
- <li><a class="reference" href="#shr%2Cuint64%2CSomeInteger" title="`shr`(x: uint64; y: SomeInteger): uint64">`shr`(x: uint64; y: SomeInteger): uint64</a></li>
- <li><a class="reference" href="#shr%2Cuint%2CSomeInteger" title="`shr`(x: uint; y: SomeInteger): uint">`shr`(x: uint; y: SomeInteger): uint</a></li>
- </ul>
- <ul class="simple nested-toc-section">shrink
- <li><a class="reference" href="#shrink%2Cseq%5BT%5D%2CNatural" title="shrink[T](x: var seq[T]; newLen: Natural)">shrink[T](x: var seq[T]; newLen: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">sizeof
- <li><a class="reference" href="#sizeof%2Ctypedesc" title="sizeof(x: typedesc): int">sizeof(x: typedesc): int</a></li>
- <li><a class="reference" href="#sizeof%2CT" title="sizeof[T](x: T): int">sizeof[T](x: T): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">slurp
- <li><a class="reference" href="#slurp%2Cstring" title="slurp(filename: string): string">slurp(filename: string): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">stackTraceAvailable
- <li><a class="reference" href="#stackTraceAvailable" title="stackTraceAvailable(): bool">stackTraceAvailable(): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">staticExec
- <li><a class="reference" href="#staticExec%2Cstring%2Cstring%2Cstring" title="staticExec(command: string; input = ""; cache = ""): string">staticExec(command: string; input = ""; cache = ""): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">staticRead
- <li><a class="reference" href="#staticRead%2Cstring" title="staticRead(filename: string): string">staticRead(filename: string): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">substr
- <li><a class="reference" href="#substr%2CopenArray%5Bchar%5D" title="substr(s: openArray[char]): string">substr(s: openArray[char]): string</a></li>
- <li><a class="reference" href="#substr%2Cstring%2Cint" title="substr(s: string; first = 0): string">substr(s: string; first = 0): string</a></li>
- <li><a class="reference" href="#substr%2Cstring%2Cint%2Cint" title="substr(s: string; first, last: int): string">substr(s: string; first, last: int): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">succ
- <li><a class="reference" href="#succ%2CT%2CV" title="succ[T, V: Ordinal](x: T; y: V = 1): T">succ[T, V: Ordinal](x: T; y: V = 1): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">swap
- <li><a class="reference" href="#swap%2CT%2CT" title="swap[T](a, b: var T)">swap[T](a, b: var T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">toBiggestFloat
- <li><a class="reference" href="#toBiggestFloat%2CBiggestInt" title="toBiggestFloat(i: BiggestInt): BiggestFloat">toBiggestFloat(i: BiggestInt): BiggestFloat</a></li>
- </ul>
- <ul class="simple nested-toc-section">toBiggestInt
- <li><a class="reference" href="#toBiggestInt%2CBiggestFloat" title="toBiggestInt(f: BiggestFloat): BiggestInt">toBiggestInt(f: BiggestFloat): BiggestInt</a></li>
- </ul>
- <ul class="simple nested-toc-section">toFloat
- <li><a class="reference" href="#toFloat%2Cint" title="toFloat(i: int): float">toFloat(i: int): float</a></li>
- </ul>
- <ul class="simple nested-toc-section">toInt
- <li><a class="reference" href="#toInt%2Cfloat" title="toInt(f: float): int">toInt(f: float): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">toOpenArray
- <li><a class="reference" href="#toOpenArray%2Ccstring%2Cint%2Cint" title="toOpenArray(x: cstring; first, last: int): openArray[char]">toOpenArray(x: cstring; first, last: int): openArray[char]</a></li>
- <li><a class="reference" href="#toOpenArray%2Cstring%2Cint%2Cint" title="toOpenArray(x: string; first, last: int): openArray[char]">toOpenArray(x: string; first, last: int): openArray[char]</a></li>
- <li><a class="reference" href="#toOpenArray%2Carray%5BI%2CT%5D%2CI%2CI" title="toOpenArray[I, T](x: array[I, T]; first, last: I): openArray[T]">toOpenArray[I, T](x: array[I, T]; first, last: I): openArray[T]</a></li>
- <li><a class="reference" href="#toOpenArray%2CopenArray%5BT%5D%2Cint%2Cint" title="toOpenArray[T](x: openArray[T]; first, last: int): openArray[T]">toOpenArray[T](x: openArray[T]; first, last: int): openArray[T]</a></li>
- <li><a class="reference" href="#toOpenArray%2Cptr.UncheckedArray%5BT%5D%2Cint%2Cint" title="toOpenArray[T](x: ptr UncheckedArray[T]; first, last: int): openArray[T]">toOpenArray[T](x: ptr UncheckedArray[T]; first, last: int): openArray[T]</a></li>
- <li><a class="reference" href="#toOpenArray%2Cseq%5BT%5D%2Cint%2Cint" title="toOpenArray[T](x: seq[T]; first, last: int): openArray[T]">toOpenArray[T](x: seq[T]; first, last: int): openArray[T]</a></li>
- </ul>
- <ul class="simple nested-toc-section">toOpenArrayByte
- <li><a class="reference" href="#toOpenArrayByte%2Ccstring%2Cint%2Cint" title="toOpenArrayByte(x: cstring; first, last: int): openArray[byte]">toOpenArrayByte(x: cstring; first, last: int): openArray[byte]</a></li>
- <li><a class="reference" href="#toOpenArrayByte%2CopenArray%5Bchar%5D%2Cint%2Cint" title="toOpenArrayByte(x: openArray[char]; first, last: int): openArray[byte]">toOpenArrayByte(x: openArray[char]; first, last: int): openArray[byte]</a></li>
- <li><a class="reference" href="#toOpenArrayByte%2Cseq%5Bchar%5D%2Cint%2Cint" title="toOpenArrayByte(x: seq[char]; first, last: int): openArray[byte]">toOpenArrayByte(x: seq[char]; first, last: int): openArray[byte]</a></li>
- <li><a class="reference" href="#toOpenArrayByte%2Cstring%2Cint%2Cint" title="toOpenArrayByte(x: string; first, last: int): openArray[byte]">toOpenArrayByte(x: string; first, last: int): openArray[byte]</a></li>
- </ul>
- <ul class="simple nested-toc-section">toOpenArrayChar
- <li><a class="reference" href="#toOpenArrayChar%2CopenArray%5Bbyte%5D%2Cint%2Cint" title="toOpenArrayChar(x: openArray[byte]; first, last: int): openArray[char]">toOpenArrayChar(x: openArray[byte]; first, last: int): openArray[char]</a></li>
- </ul>
- <ul class="simple nested-toc-section">typeof
- <li><a class="reference" href="#typeof%2Cuntyped" title="typeof(x: untyped; mode = typeOfIter): typedesc">typeof(x: untyped; mode = typeOfIter): typedesc</a></li>
- </ul>
- <ul class="simple nested-toc-section">unsafeAddr
- <li><a class="reference" href="#unsafeAddr%2CT" title="unsafeAddr[T](x: T): ptr T">unsafeAddr[T](x: T): ptr T</a></li>
- </ul>
- <ul class="simple nested-toc-section">unsafeNew
- <li><a class="reference" href="#unsafeNew%2Cref.T%2CNatural" title="unsafeNew[T](a: var ref T; size: Natural)">unsafeNew[T](a: var ref T; size: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">unsetControlCHook
- <li><a class="reference" href="#unsetControlCHook" title="unsetControlCHook()">unsetControlCHook()</a></li>
- </ul>
- <ul class="simple nested-toc-section">wasMoved
- <li><a class="reference" href="#wasMoved%2CT" title="wasMoved[T](obj: var T)">wasMoved[T](obj: var T)</a></li>
- </ul>
- <ul class="simple nested-toc-section">writeStackTrace
- <li><a class="reference" href="#writeStackTrace" title="writeStackTrace()">writeStackTrace()</a></li>
- </ul>
- <ul class="simple nested-toc-section">xor
- <li><a class="reference" href="#xor%2Cbool%2Cbool" title="`xor`(x, y: bool): bool">`xor`(x, y: bool): bool</a></li>
- <li><a class="reference" href="#xor%2Cint%2Cint" title="`xor`(x, y: int): int">`xor`(x, y: int): int</a></li>
- <li><a class="reference" href="#xor%2Cint8%2Cint8" title="`xor`(x, y: int8): int8">`xor`(x, y: int8): int8</a></li>
- <li><a class="reference" href="#xor%2Cint16%2Cint16" title="`xor`(x, y: int16): int16">`xor`(x, y: int16): int16</a></li>
- <li><a class="reference" href="#xor%2Cint32%2Cint32" title="`xor`(x, y: int32): int32">`xor`(x, y: int32): int32</a></li>
- <li><a class="reference" href="#xor%2Cint64%2Cint64" title="`xor`(x, y: int64): int64">`xor`(x, y: int64): int64</a></li>
- <li><a class="reference" href="#xor%2Cuint%2Cuint" title="`xor`(x, y: uint): uint">`xor`(x, y: uint): uint</a></li>
- <li><a class="reference" href="#xor%2Cuint8%2Cuint8" title="`xor`(x, y: uint8): uint8">`xor`(x, y: uint8): uint8</a></li>
- <li><a class="reference" href="#xor%2Cuint16%2Cuint16" title="`xor`(x, y: uint16): uint16">`xor`(x, y: uint16): uint16</a></li>
- <li><a class="reference" href="#xor%2Cuint32%2Cuint32" title="`xor`(x, y: uint32): uint32">`xor`(x, y: uint32): uint32</a></li>
- <li><a class="reference" href="#xor%2Cuint64%2Cuint64" title="`xor`(x, y: uint64): uint64">`xor`(x, y: uint64): uint64</a></li>
- </ul>
- <ul class="simple nested-toc-section">zeroDefault
- <li><a class="reference" href="#zeroDefault%2Ctypedesc%5BT%5D" title="zeroDefault[T](_: typedesc[T]): T">zeroDefault[T](_: typedesc[T]): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">zeroMem
- <li><a class="reference" href="#zeroMem%2Cpointer%2CNatural" title="zeroMem(p: pointer; size: Natural)">zeroMem(p: pointer; size: Natural)</a></li>
- </ul>
- <ul class="simple nested-toc-section">|
- <li><a class="reference" href="#%7C%2Ctypedesc%2Ctypedesc" title="`|`(a, b: typedesc): typedesc">`|`(a, b: typedesc): typedesc</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#15" id="65">Iterators</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">..
- <li><a class="reference" href="#...i%2Cint32%2Cint32" title="`..`(a, b: int32): int32">`..`(a, b: int32): int32</a></li>
- <li><a class="reference" href="#...i%2Cint64%2Cint64" title="`..`(a, b: int64): int64">`..`(a, b: int64): int64</a></li>
- <li><a class="reference" href="#...i%2Cuint32%2Cuint32" title="`..`(a, b: uint32): uint32">`..`(a, b: uint32): uint32</a></li>
- <li><a class="reference" href="#...i%2Cuint64%2Cuint64" title="`..`(a, b: uint64): uint64">`..`(a, b: uint64): uint64</a></li>
- <li><a class="reference" href="#...i%2CT%2CT" title="`..`[T](a, b: T): T">`..`[T](a, b: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">..<
- <li><a class="reference" href="#..%3C.i%2Cint32%2Cint32" title="`..<`(a, b: int32): int32">`..<`(a, b: int32): int32</a></li>
- <li><a class="reference" href="#..%3C.i%2Cint64%2Cint64" title="`..<`(a, b: int64): int64">`..<`(a, b: int64): int64</a></li>
- <li><a class="reference" href="#..%3C.i%2Cuint32%2Cuint32" title="`..<`(a, b: uint32): uint32">`..<`(a, b: uint32): uint32</a></li>
- <li><a class="reference" href="#..%3C.i%2Cuint64%2Cuint64" title="`..<`(a, b: uint64): uint64">`..<`(a, b: uint64): uint64</a></li>
- <li><a class="reference" href="#..%3C.i%2CT%2CT" title="`..<`[T](a, b: T): T">`..<`[T](a, b: T): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">countdown
- <li><a class="reference" href="#countdown.i%2CT%2CT%2CPositive" title="countdown[T](a, b: T; step: Positive = 1): T">countdown[T](a, b: T; step: Positive = 1): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">countup
- <li><a class="reference" href="#countup.i%2CT%2CT%2CPositive" title="countup[T](a, b: T; step: Positive = 1): T">countup[T](a, b: T; step: Positive = 1): T</a></li>
- </ul>
- <ul class="simple nested-toc-section">||
- <li><a class="reference" href="#%7C%7C.i%2CS%2CT%2Cstaticstring" title="`||`[S, T](a: S; b: T; annotation: static string = "parallel for"): T">`||`[S, T](a: S; b: T; annotation: static string = "parallel for"): T</a></li>
- <li><a class="reference" href="#%7C%7C.i%2CS%2CT%2CPositive%2Cstaticstring" title="`||`[S, T](a: S; b: T; step: Positive;
- annotation: static string = "parallel for"): T">`||`[S, T](a: S; b: T; step: Positive;
- annotation: static string = "parallel for"): T</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#17" id="67">Macros</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">varargsLen
- <li><a class="reference" href="#varargsLen.m%2Cvarargs%5Buntyped%5D" title="varargsLen(x: varargs[untyped]): int">varargsLen(x: varargs[untyped]): int</a></li>
- </ul>
- </ul>
- </details>
- </li>
- <li>
- <details open>
- <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
- <ul class="simple simple-toc-section">
- <ul class="simple nested-toc-section">!=
- <li><a class="reference" href="#%21%3D.t%2Cuntyped%2Cuntyped" title="`!=`(x, y: untyped): untyped">`!=`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">&=
- <li><a class="reference" href="#%26%3D.t%2Ctyped%2Ctyped" title="`&=`(x, y: typed)">`&=`(x, y: typed)</a></li>
- </ul>
- <ul class="simple nested-toc-section">..<
- <li><a class="reference" href="#..%3C.t%2Cuntyped%2Cuntyped" title="`..<`(a, b: untyped): untyped">`..<`(a, b: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">..^
- <li><a class="reference" href="#..%5E.t%2Cuntyped%2Cuntyped" title="`..^`(a, b: untyped): untyped">`..^`(a, b: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">=dispose
- <li><a class="reference" href="#%3Ddispose.t" title="`=dispose`[T](x: owned(ref T))">`=dispose`[T](x: owned(ref T))</a></li>
- </ul>
- <ul class="simple nested-toc-section">>
- <li><a class="reference" href="#%3E.t%2Cuntyped%2Cuntyped" title="`>`(x, y: untyped): untyped">`>`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">>%
- <li><a class="reference" href="#%3E%25.t%2Cuntyped%2Cuntyped" title="`>%`(x, y: untyped): untyped">`>%`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">>=
- <li><a class="reference" href="#%3E%3D.t%2Cuntyped%2Cuntyped" title="`>=`(x, y: untyped): untyped">`>=`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">>=%
- <li><a class="reference" href="#%3E%3D%25.t%2Cuntyped%2Cuntyped" title="`>=%`(x, y: untyped): untyped">`>=%`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">[]
- <li><a class="reference" href="#%5B%5D.t%2Cstring%2Cint" title="`[]`(s: string; i: int): char">`[]`(s: string; i: int): char</a></li>
- </ul>
- <ul class="simple nested-toc-section">[]=
- <li><a class="reference" href="#%5B%5D%3D.t%2Cstring%2Cint%2Cchar" title="`[]=`(s: string; i: int; val: char)">`[]=`(s: string; i: int; val: char)</a></li>
- </ul>
- <ul class="simple nested-toc-section">^
- <li><a class="reference" href="#%5E.t%2Cint" title="`^`(x: int): BackwardsIndex">`^`(x: int): BackwardsIndex</a></li>
- </ul>
- <ul class="simple nested-toc-section">alloc
- <li><a class="reference" href="#alloc.t%2CNatural" title="alloc(size: Natural): pointer">alloc(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">alloc0
- <li><a class="reference" href="#alloc0.t%2CNatural" title="alloc0(size: Natural): pointer">alloc0(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocShared
- <li><a class="reference" href="#allocShared.t%2CNatural" title="allocShared(size: Natural): pointer">allocShared(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">allocShared0
- <li><a class="reference" href="#allocShared0.t%2CNatural" title="allocShared0(size: Natural): pointer">allocShared0(size: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">closureScope
- <li><a class="reference" href="#closureScope.t%2Cuntyped" title="closureScope(body: untyped): untyped">closureScope(body: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">currentSourcePath
- <li><a class="reference" href="#currentSourcePath.t" title="currentSourcePath(): string">currentSourcePath(): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">disarm
- <li><a class="reference" href="#disarm.t%2Ctyped" title="disarm(x: typed)">disarm(x: typed)</a></li>
- </ul>
- <ul class="simple nested-toc-section">dumpAllocstats
- <li><a class="reference" href="#dumpAllocstats.t%2Cuntyped" title="dumpAllocstats(code: untyped)">dumpAllocstats(code: untyped)</a></li>
- </ul>
- <ul class="simple nested-toc-section">excl
- <li><a class="reference" href="#excl.t%2Cset%5BT%5D%2Cset%5BT%5D" title="excl[T](x: var set[T]; y: set[T])">excl[T](x: var set[T]; y: set[T])</a></li>
- </ul>
- <ul class="simple nested-toc-section">formatErrorIndexBound
- <li><a class="reference" href="#formatErrorIndexBound.t%2CT%2CT%2CT" title="formatErrorIndexBound[T](i, a, b: T): string">formatErrorIndexBound[T](i, a, b: T): string</a></li>
- <li><a class="reference" href="#formatErrorIndexBound.t%2CT%2CT" title="formatErrorIndexBound[T](i, n: T): string">formatErrorIndexBound[T](i, n: T): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">formatFieldDefect
- <li><a class="reference" href="#formatFieldDefect.t%2C%2C" title="formatFieldDefect(f, discVal): string">formatFieldDefect(f, discVal): string</a></li>
- </ul>
- <ul class="simple nested-toc-section">in
- <li><a class="reference" href="#in.t%2Cuntyped%2Cuntyped" title="`in`(x, y: untyped): untyped">`in`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">incl
- <li><a class="reference" href="#incl.t%2Cset%5BT%5D%2Cset%5BT%5D" title="incl[T](x: var set[T]; y: set[T])">incl[T](x: var set[T]; y: set[T])</a></li>
- </ul>
- <ul class="simple nested-toc-section">isnot
- <li><a class="reference" href="#isnot.t%2Cuntyped%2Cuntyped" title="`isnot`(x, y: untyped): untyped">`isnot`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">likely
- <li><a class="reference" href="#likely.t%2Cbool" title="likely(val: bool): bool">likely(val: bool): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">newException
- <li><a class="reference" href="#newException.t%2Ctypedesc%2Cstring%2Cref.Exception" title="newException(exceptn: typedesc; message: string;
- parentException: ref Exception = nil): untyped">newException(exceptn: typedesc; message: string;
- parentException: ref Exception = nil): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">nimThreadProcWrapperBody
- <li><a class="reference" href="#nimThreadProcWrapperBody.t%2Cuntyped" title="nimThreadProcWrapperBody(closure: untyped): untyped">nimThreadProcWrapperBody(closure: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">notin
- <li><a class="reference" href="#notin.t%2Cuntyped%2Cuntyped" title="`notin`(x, y: untyped): untyped">`notin`(x, y: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">offsetOf
- <li><a class="reference" href="#offsetOf.t%2Ctypedesc%5BT%5D%2Cuntyped" title="offsetOf[T](t: typedesc[T]; member: untyped): int">offsetOf[T](t: typedesc[T]; member: untyped): int</a></li>
- <li><a class="reference" href="#offsetOf.t%2CT%2Cuntyped" title="offsetOf[T](value: T; member: untyped): int">offsetOf[T](value: T; member: untyped): int</a></li>
- </ul>
- <ul class="simple nested-toc-section">once
- <li><a class="reference" href="#once.t%2Cuntyped" title="once(body: untyped): untyped">once(body: untyped): untyped</a></li>
- </ul>
- <ul class="simple nested-toc-section">rangeCheck
- <li><a class="reference" href="#rangeCheck.t" title="rangeCheck(cond)">rangeCheck(cond)</a></li>
- </ul>
- <ul class="simple nested-toc-section">realloc
- <li><a class="reference" href="#realloc.t%2Cpointer%2CNatural" title="realloc(p: pointer; newSize: Natural): pointer">realloc(p: pointer; newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">realloc0
- <li><a class="reference" href="#realloc0.t%2Cpointer%2CNatural%2CNatural" title="realloc0(p: pointer; oldSize, newSize: Natural): pointer">realloc0(p: pointer; oldSize, newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">reallocShared
- <li><a class="reference" href="#reallocShared.t%2Cpointer%2CNatural" title="reallocShared(p: pointer; newSize: Natural): pointer">reallocShared(p: pointer; newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">reallocShared0
- <li><a class="reference" href="#reallocShared0.t%2Cpointer%2CNatural%2CNatural" title="reallocShared0(p: pointer; oldSize, newSize: Natural): pointer">reallocShared0(p: pointer; oldSize, newSize: Natural): pointer</a></li>
- </ul>
- <ul class="simple nested-toc-section">setupForeignThreadGc
- <li><a class="reference" href="#setupForeignThreadGc.t" title="setupForeignThreadGc()">setupForeignThreadGc()</a></li>
- </ul>
- <ul class="simple nested-toc-section">tearDownForeignThreadGc
- <li><a class="reference" href="#tearDownForeignThreadGc.t" title="tearDownForeignThreadGc()">tearDownForeignThreadGc()</a></li>
- </ul>
- <ul class="simple nested-toc-section">unlikely
- <li><a class="reference" href="#unlikely.t%2Cbool" title="unlikely(val: bool): bool">unlikely(val: bool): bool</a></li>
- </ul>
- <ul class="simple nested-toc-section">unown
- <li><a class="reference" href="#unown.t%2Ctyped" title="unown(x: typed): untyped">unown(x: typed): untyped</a></li>
- </ul>
- </ul>
- </details>
- </li>
- </ul>
- </div>
- <div class="nine columns" id="content">
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- <div id="tocRoot"></div>
-
- <p class="module-desc"><p>The compiler depends on the System module to work properly and the System module depends on the compiler. Most of the routines listed here use special compiler magic.</p>
- <p>Each module implicitly imports the System module; it must not be listed explicitly. Because of this there cannot be a user-defined module named <tt class="docutils literal"><span class="pre"><span class="Identifier">system</span></span></tt>.</p>
- <h1><a class="toc-backref" id="system-module" href="#system-module">System module</a></h1><p>The System module imports several separate modules, and their documentation is in separate files:</p>
- <ul class="simple"><li><a class="reference external" href="iterators.html">iterators</a></li>
- <li><a class="reference external" href="exceptions.html">exceptions</a></li>
- <li><a class="reference external" href="assertions.html">assertions</a></li>
- <li><a class="reference external" href="dollars.html">dollars</a></li>
- <li><a class="reference external" href="ctypes.html">ctypes</a></li>
- <li><a class="reference external" href="repr_v2.html">repr_v2</a></li>
- </ul>
- <p>Here is a short overview of the most commonly used functions from the <tt class="docutils literal"><span class="pre"><span class="Identifier">system</span></span></tt> module. Function names in the tables below are clickable and will take you to the full documentation of the function.</p>
- <p>There are many more functions available than the ones listed in this overview. Use the table of contents on the left-hand side and/or <tt class="docutils literal"><span class="pre"><span class="Identifier">Ctrl</span><span class="Operator">+</span><span class="Identifier">F</span></span></tt> to navigate through this module.</p>
- <h2><a class="toc-backref" id="system-module-strings-and-characters" href="#system-module-strings-and-characters">Strings and characters</a></h2><table border="1" class="docutils"><tr><th>Proc</th><th>Usage</th></tr>
- <tr><td><a class="reference external" href="#len,string">len(s)</a></td><td>Return the length of a string</td></tr>
- <tr><td><a class="reference external" href="#chr,range[]">chr(i)</a></td><td>Convert an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> in the range <tt class="docutils literal"><span class="pre"><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">255</span></span></tt> to a character</td></tr>
- <tr><td><a class="reference external" href="#ord,T">ord(c)</a></td><td>Return <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> value of a character</td></tr>
- <tr><td><a class="reference external" href="#&,string,string">a & b</a></td><td>Concatenate two strings</td></tr>
- <tr><td><a class="reference external" href="#add,string,char">s.add(c)</a></td><td>Add character to the string</td></tr>
- <tr><td><a class="reference external" href="dollars.html">$</a></td><td>Convert various types to string</td></tr>
- </table><p><strong>See also:</strong></p>
- <ul class="simple"><li><a class="reference external" href="strutils.html">strutils module</a> for common string functions</li>
- <li><a class="reference external" href="strformat.html">strformat module</a> for string interpolation and formatting</li>
- <li><a class="reference external" href="unicode.html">unicode module</a> for Unicode UTF-8 handling</li>
- <li><a class="reference external" href="strscans.html">strscans</a> for <tt class="docutils literal"><span class="pre"><span class="Identifier">scanf</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">scanp</span></span></tt> macros, which offer easier substring extraction than regular expressions</li>
- <li><a class="reference external" href="strtabs.html">strtabs module</a> for efficient hash tables (dictionaries, in some programming languages) mapping from strings to strings</li>
- </ul>
- <h2><a class="toc-backref" id="system-module-seqs" href="#system-module-seqs">Seqs</a></h2><table border="1" class="docutils"><tr><th>Proc</th><th>Usage</th></tr>
- <tr><td><a class="reference external" href="#newSeq">newSeq</a></td><td>Create a new sequence of a given length</td></tr>
- <tr><td><a class="reference external" href="#newSeqOfCap,Natural">newSeqOfCap</a></td><td>Create a new sequence with zero length and a given capacity</td></tr>
- <tr><td><a class="reference external" href="#setLen,seq[T],Natural">setLen</a></td><td>Set the length of a sequence</td></tr>
- <tr><td><a class="reference external" href="#len,seq[T]">len</a></td><td>Return the length of a sequence</td></tr>
- <tr><td><a class="reference external" href="#@,openArray[T]">@</a></td><td>Turn an array into a sequence</td></tr>
- <tr><td><a class="reference external" href="#add,seq[T],sinkT">add</a></td><td>Add an item to the sequence</td></tr>
- <tr><td><a class="reference external" href="#insert,seq[T],sinkT">insert</a></td><td>Insert an item at a specific position</td></tr>
- <tr><td><a class="reference external" href="#delete,seq[T],Natural">delete</a></td><td>Delete an item while preserving the order of elements (<tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">)</span></span></tt> operation)</td></tr>
- <tr><td><a class="reference external" href="#del,seq[T],Natural">del</a></td><td><tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt> removal, doesn't preserve the order</td></tr>
- <tr><td><a class="reference external" href="#pop,seq[T]">pop</a></td><td>Remove and return last item of a sequence</td></tr>
- <tr><td><a class="reference external" href="#&,seq[T],seq[T]">x & y</a></td><td>Concatenate two sequences</td></tr>
- <tr><td><a class="reference external" href="#[],openArray[T],HSlice[U: Ordinal,V: Ordinal]">x[a .. b]</a></td><td>Slice of a sequence (both ends included)</td></tr>
- <tr><td><a class="reference external" href="#[],openArray[T],HSlice[U: Ordinal,V: Ordinal]">x[a .. ^b]</a></td><td>Slice of a sequence but <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> is a reversed index (both ends included)</td></tr>
- <tr><td><a class="reference external" href="#[],openArray[T],HSlice[U: Ordinal,V: Ordinal]">x[a ..< b]</a></td><td>Slice of a sequence (excluded upper bound)</td></tr>
- </table><p><strong>See also:</strong></p>
- <ul class="simple"><li><a class="reference external" href="sequtils.html">sequtils module</a> for operations on container types (including strings)</li>
- <li><a class="reference external" href="json.html">json module</a> for a structure which allows heterogeneous members</li>
- <li><a class="reference external" href="lists.html">lists module</a> for linked lists</li>
- </ul>
- <h2><a class="toc-backref" id="system-module-sets" href="#system-module-sets">Sets</a></h2><p>Built-in bit sets.</p>
- <table border="1" class="docutils"><tr><th>Proc</th><th>Usage</th></tr>
- <tr><td><a class="reference external" href="#incl,set[T],T">incl</a></td><td>Include element <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#excl,set[T],T">excl</a></td><td>Exclude element <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#card,set[T]">card</a></td><td>Return the cardinality of the set, i.e. the number of elements</td></tr>
- <tr><td><a class="reference external" href="#*,set[T],set[T]">a * b</a></td><td>Intersection</td></tr>
- <tr><td><a class="reference external" href="#+,set[T],set[T]">a + b</a></td><td>Union</td></tr>
- <tr><td><a class="reference external" href="#-,set[T],set[T]">a - b</a></td><td>Difference</td></tr>
- <tr><td><a class="reference external" href="#contains,set[T],T">contains</a></td><td>Check if an element is in the set</td></tr>
- <tr><td><a class="reference external" href="#<,set[T],set[T]">a < b</a></td><td>Check if <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is a subset of <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt></td></tr>
- </table><p><strong>See also:</strong></p>
- <ul class="simple"><li><a class="reference external" href="setutils.html">setutils module</a> for bit set convenience functions</li>
- <li><a class="reference external" href="sets.html">sets module</a> for hash sets</li>
- <li><a class="reference external" href="intsets.html">intsets module</a> for efficient int sets</li>
- </ul>
- <h2><a class="toc-backref" id="system-module-numbers" href="#system-module-numbers">Numbers</a></h2><table border="1" class="docutils"><tr><th>Proc</th><th>Usage </th><th>Also known as (in other languages)</th></tr>
- <tr><td><a class="reference external" href="#div,int,int">div</a></td><td>Integer division</td><td><tt class="docutils literal"><span class="pre"><span class="Operator">//</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#mod,int,int">mod</a></td><td>Integer modulo (remainder)</td><td><tt class="docutils literal"><span class="pre"><span class="Operator">%</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#shl,int,SomeInteger">shl</a></td><td>Shift left</td><td><tt class="docutils literal"><span class="pre"><span class="Operator"><<</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#shr,int,SomeInteger">shr</a></td><td>Shift right</td><td><tt class="docutils literal"><span class="pre"><span class="Operator">>></span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#ashr,int,SomeInteger">ashr</a></td><td>Arithmetic shift right</td><td></td></tr>
- <tr><td><a class="reference external" href="#and,int,int">and</a></td><td>Bitwise <tt class="docutils literal"><span class="pre"><span class="Keyword">and</span></span></tt></td><td><tt class="docutils literal"><span class="pre"><span class="Operator">&</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#or,int,int">or</a></td><td>Bitwise <tt class="docutils literal"><span class="pre"><span class="Keyword">or</span></span></tt></td><td><tt class="docutils literal"><span class="pre"><span class="Operator">|</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#xor,int,int">xor</a></td><td>Bitwise <tt class="docutils literal"><span class="pre"><span class="Keyword">xor</span></span></tt></td><td><tt class="docutils literal"><span class="pre"><span class="Operator">^</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#not,int">not</a></td><td>Bitwise <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span></span></tt> (complement)</td><td><tt class="docutils literal"><span class="pre"><span class="Operator">~</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#toInt,float">toInt</a></td><td>Convert floating-point number into an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt></td><td></td></tr>
- <tr><td><a class="reference external" href="#toFloat,int">toFloat</a></td><td>Convert an integer into a <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt></td><td></td></tr>
- </table><p><strong>See also:</strong></p>
- <ul class="simple"><li><a class="reference external" href="math.html">math module</a> for mathematical operations like trigonometric functions, logarithms, square and cubic roots, etc.</li>
- <li><a class="reference external" href="complex.html">complex module</a> for operations on complex numbers</li>
- <li><a class="reference external" href="rationals.html">rationals module</a> for rational numbers</li>
- </ul>
- <h2><a class="toc-backref" id="system-module-ordinals" href="#system-module-ordinals">Ordinals</a></h2><p><a class="reference external" href="#Ordinal">Ordinal type</a> includes integer, bool, character, and enumeration types, as well as their subtypes.</p>
- <table border="1" class="docutils"><tr><th>Proc</th><th>Usage</th></tr>
- <tr><td><a class="reference internal nimdoc" title="proc succ[T, V: Ordinal](x: T; y: V = 1): T" href="#succ,T,V">succ</a></td><td>Successor of the value</td></tr>
- <tr><td><a class="reference internal nimdoc" title="proc pred[T, V: Ordinal](x: T; y: V = 1): T" href="#pred,T,V">pred</a></td><td>Predecessor of the value</td></tr>
- <tr><td><a class="reference internal nimdoc" title="proc inc[T, V: Ordinal](x: var T; y: V = 1)" href="#inc,T,V">inc</a></td><td>Increment the ordinal</td></tr>
- <tr><td><a class="reference internal nimdoc" title="proc dec[T, V: Ordinal](x: var T; y: V = 1)" href="#dec,T,V">dec</a></td><td>Decrement the ordinal</td></tr>
- <tr><td><a class="reference external" href="#high,T">high</a></td><td>Return the highest possible value</td></tr>
- <tr><td><a class="reference external" href="#low,T">low</a></td><td>Return the lowest possible value</td></tr>
- <tr><td><a class="reference external" href="#ord,T">ord</a></td><td>Return <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> value of an ordinal value</td></tr>
- </table>
- <h2><a class="toc-backref" id="system-module-misc" href="#system-module-misc">Misc</a></h2><table border="1" class="docutils"><tr><th>Proc</th><th>Usage</th></tr>
- <tr><td><a class="reference external" href="#is,T,S">is</a></td><td>Check if two arguments are of the same type</td></tr>
- <tr><td><a class="reference external" href="#isnot.t,untyped,untyped">isnot</a></td><td>Negated version of <tt class="docutils literal"><span class="pre"><span class="Keyword">is</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#!%3D.t,untyped,untyped">!=</a></td><td>Not equals</td></tr>
- <tr><td><a class="reference external" href="#addr,T">addr</a></td><td>Take the address of a memory location</td></tr>
- <tr><td><a class="reference external" href="#and,bool,bool">T and F</a></td><td>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">and</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#or,bool,bool">T or F</a></td><td>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">or</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#xor,bool,bool">T xor F</a></td><td>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">xor</span></span></tt> (exclusive or)</td></tr>
- <tr><td><a class="reference external" href="#not,bool">not T</a></td><td>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#^.t,int">a[^x]</a></td><td>Take the element at the reversed index <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#..,sinkT,sinkU">a .. b</a></td><td>Binary slice that constructs an interval <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">]</span></span></tt></td></tr>
- <tr><td><a class="reference external" href="#..^.t,untyped,untyped">a ..^ b</a></td><td>Interval <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">]</span></span></tt> but <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> as reversed index</td></tr>
- <tr><td><a class="reference external" href="#..<.t,untyped,untyped">a ..< b</a></td><td>Interval <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span></span></tt> (excluded upper bound)</td></tr>
- <tr><td><a class="reference external" href="#runnableExamples,string,untyped">runnableExamples</a></td><td>Create testable documentation</td></tr>
- </table>Default new string implementation used by Nim's core.Default seq implementation used by Nim's core.</p>
- <div class="section" id="6">
- <h1><a class="toc-backref" href="#6">Imports</a></h1>
- <dl class="item">
- <a class="reference external" href="exceptions.html">exceptions</a>, <a class="reference external" href="since.html">since</a>, <a class="reference external" href="ctypes.html">ctypes</a>, <a class="reference external" href="sysatomics.html">sysatomics</a>, <a class="reference external" href="ansi_c.html">ansi_c</a>, <a class="reference external" href="memory.html">memory</a>, <a class="reference external" href="syslocks.html">syslocks</a>, <a class="reference external" href="threadtypes.html">threadtypes</a>, <a class="reference external" href="iterators.html">iterators</a>, <a class="reference external" href="coro_detection.html">coro_detection</a>, <a class="reference external" href="dollars.html">dollars</a>, <a class="reference external" href="miscdollars.html">miscdollars</a>, <a class="reference external" href="stacktraces.html">stacktraces</a>, <a class="reference external" href="formatfloat.html">formatfloat</a>, <a class="reference external" href="countbits_impl.html">countbits_impl</a>, <a class="reference external" href="syslocks.html">syslocks</a>, <a class="reference external" href="sysatomics.html">sysatomics</a>, <a class="reference external" href="digitsutils.html">digitsutils</a>, <a class="reference external" href="digitsutils.html">digitsutils</a>, <a class="reference external" href="repr_v2.html">repr_v2</a>, <a class="reference external" href="assertions.html">assertions</a>
- </dl>
- </div>
- <div class="section" id="7">
- <h1><a class="toc-backref" href="#7">Types</a></h1>
- <dl class="item">
- <div id="AllocStats">
- <dt><pre><a href="system.html#AllocStats"><span class="Identifier">AllocStats</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L67" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L67" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="any">
- <dt><pre><a href="system.html#any"><span class="Identifier">any</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"Deprecated since v1.5; Use auto instead."</span></span>.} <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="system.html#auto"><span class="Identifier">auto</span></a></pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> Deprecated since v1.5; Use auto instead.
- </div>
- Deprecated; Use <tt class="docutils literal"><span class="pre"><span class="Identifier">auto</span></span></tt> instead. See <a class="reference external" href="https://github.com/nim-lang/RFCs/issues/281">https://github.com/nim-lang/RFCs/issues/281</a>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L38" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="array">
- <dt><pre><a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Array"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct fixed-length arrays.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L190" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L190" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="auto">
- <dt><pre><a href="system.html#auto"><span class="Identifier">auto</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Expr</span>.}</pre></dt>
- <dd>
-
- Meta type for automatic type determination.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L37" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="BackwardsIndex">
- <dt><pre><a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- Type that is constructed by <tt class="docutils literal"><span class="pre"><span class="Operator">^</span></span></tt> for reversed array accesses. (See <a class="reference external" href="#^.t,int">^ template</a>)
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L5" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L5" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="bool">
- <dt><pre><a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Bool"</span>.} <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">false</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">,</span> <span class="Identifier">true</span> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
- <dd>
-
- Built-in boolean type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L45" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L45" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="byte">
- <dt><pre><a href="system.html#byte"><span class="Identifier">byte</span></a> <span class="Other">=</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a></pre></dt>
- <dd>
-
- This is an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">uint8</span></span></tt>, that is an unsigned integer, 8 bits wide.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L486" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L486" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="CatchableError">
- <dt><pre><a href="system.html#CatchableError"><span class="Identifier">CatchableError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a></pre></dt>
- <dd>
-
-
- Abstract class for all exceptions that are catchable.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L555" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L555" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="char">
- <dt><pre><a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Char</span>.}</pre></dt>
- <dd>
-
- Built-in 8 bit character type (unsigned).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L22" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="cstring">
- <dt><pre><a href="system.html#cstring"><span class="Identifier">cstring</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Cstring</span>.}</pre></dt>
- <dd>
-
- Built-in cstring (<em>compatible string</em>) type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L24" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Defect">
- <dt><pre><a href="system.html#Defect"><span class="Identifier">Defect</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a></pre></dt>
- <dd>
-
-
- Abstract base class for all exceptions that Nim's runtime raises but that are strictly uncatchable as they can also be mapped to a <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span></span></tt> / <tt class="docutils literal"><span class="pre"><span class="Identifier">trap</span></span></tt> / <tt class="docutils literal"><span class="pre"><span class="Identifier">exit</span></span></tt> operation.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L550" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L550" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Endianness">
- <dt><pre><a href="system.html#Endianness"><span class="Identifier">Endianness</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">littleEndian</span><span class="Other">,</span> <span class="Identifier">bigEndian</span></pre></dt>
- <dd>
-
- Type describing the endianness of a processor.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1036" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1036" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Exception">
- <dt><pre><a href="system.html#Exception"><span class="Identifier">Exception</span></a> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Exception"</span>.} <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a>
- <span class="Identifier">parent</span><span class="Operator">*</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a> <span class="Comment">## Parent exception (can be used as a stack).</span>
- <span class="Identifier">name</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Comment">## The exception's name is its Nim identifier.</span>
- <span class="Comment">## This field is filled automatically in the</span>
- <span class="Comment">## `raise` statement.</span>
- <span class="Identifier">msg</span><span class="Operator">*</span> {.<span class="Identifier">exportc</span><span class="Other">:</span> <span class="StringLit">"message"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Comment">## The exception's message. Not</span>
- <span class="Comment">## providing an exception message</span>
- <span class="Comment">## is bad style.</span>
- <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">js</span><span class="Other">)</span><span class="Other">:</span>
- <span class="Identifier">trace</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
- <span class="Keyword">else</span><span class="Other">:</span>
- <span class="Identifier">trace</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">StackTraceEntry</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>
- Base exception class.</p>
- <p>Each exception has to inherit from <tt class="docutils literal"><span class="pre"><span class="Identifier">Exception</span></span></tt>. See the full <a class="reference external" href="manual.html#exception-handling-exception-hierarchy">exception hierarchy</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L532" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L532" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="float">
- <dt><pre><a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Float</span>.}</pre></dt>
- <dd>
-
- Default floating point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L15" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="float32">
- <dt><pre><a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Float32</span>.}</pre></dt>
- <dd>
-
- 32 bit floating point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L16" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L16" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="float64">
- <dt><pre><a href="system.html#float64"><span class="Identifier">float64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Float</span>.}</pre></dt>
- <dd>
-
- 64 bit floating point type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L17" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L17" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ForeignCell">
- <dt><pre><a href="system.html#ForeignCell"><span class="Identifier">ForeignCell</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/mmdisp.nim#L115" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/mmdisp.nim#L115" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ForLoopStmt">
- <dt><pre><a href="system.html#ForLoopStmt"><span class="Identifier">ForLoopStmt</span></a> {.<span class="Identifier">compilerproc</span>.} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
-
- A special type that marks a macro as a <span id="forminusloop-macro_1">for-loop macro</span>. See <a class="reference external" href="manual.html#macros-for-loop-macro">"For Loop Macro"</a>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2524" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2524" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="GC_Strategy">
- <dt><pre><a href="system.html#GC_Strategy"><span class="Identifier">GC_Strategy</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">gcThroughput</span><span class="Other">,</span> <span class="Comment">## optimize for throughput</span>
- <span class="Identifier">gcResponsiveness</span><span class="Other">,</span> <span class="Comment">## optimize for responsiveness (default)</span>
- <span class="Identifier">gcOptimizeTime</span><span class="Other">,</span> <span class="Comment">## optimize for speed</span>
- <span class="Identifier">gcOptimizeSpace</span> <span class="Comment">## optimize for memory footprint</span></pre></dt>
- <dd>
-
- The strategy the GC should use for the application.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/gc_interface.nim#L10" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/gc_interface.nim#L10" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="HSlice">
- <dt><pre><a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">U</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">a</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">T</span> <span class="Comment">## The lower bound (inclusive).</span>
- <span class="Identifier">b</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">U</span> <span class="Comment">## The upper bound (inclusive).</span></pre></dt>
- <dd>
-
- "Heterogeneous" slice type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L423" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L423" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="int">
- <dt><pre><a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Int</span>.}</pre></dt>
- <dd>
-
- Default integer type; bitwidth depends on architecture, but is always the same as a pointer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L2" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L2" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="int8">
- <dt><pre><a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Int8</span>.}</pre></dt>
- <dd>
-
- Signed 8 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L4" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L4" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="int16">
- <dt><pre><a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Int16</span>.}</pre></dt>
- <dd>
-
- Signed 16 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L5" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L5" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="int32">
- <dt><pre><a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Int32</span>.}</pre></dt>
- <dd>
-
- Signed 32 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L6" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L6" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="int64">
- <dt><pre><a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Int64</span>.}</pre></dt>
- <dd>
-
- Signed 64 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L7" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L7" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="iterable">
- <dt><pre><a href="system.html#iterable"><span class="Identifier">iterable</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">IterableType</span>.}</pre></dt>
- <dd>
-
- Represents an expression that yields <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L90" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="JsRoot">
- <dt><pre><a href="system.html#JsRoot"><span class="Identifier">JsRoot</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a></pre></dt>
- <dd>
-
- Root type of the JavaScript object hierarchy
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L566" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L566" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="lent">
- <dt><pre><a href="system.html#lent"><span class="Identifier">lent</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BuiltinType"</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Natural">
- <dt><pre><a href="system.html#Natural"><span class="Identifier">Natural</span></a> <span class="Other">=</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="Identifier">high</span><span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">]</span></pre></dt>
- <dd>
-
- is an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> type ranging from zero to the maximum value of an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>. This type is often useful for documentation and debugging.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L489" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L489" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimNode">
- <dt><pre><a href="system.html#NimNode"><span class="Identifier">NimNode</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"PNimrodNode"</span>.} <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Identifier">NimNodeObj</span></pre></dt>
- <dd>
-
- Represents a Nim AST node. Macros operate on this type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2520" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2520" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimSeqV2">
- <dt><pre><a href="system.html#NimSeqV2"><span class="Identifier">NimSeqV2</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L28" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L28" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="openArray">
- <dt><pre><a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"OpenArray"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct open arrays. Open arrays are implemented as a pointer to the array data and a length field.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L192" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L192" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Ordinal">
- <dt><pre><a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Ordinal</span>.}</pre></dt>
- <dd>
-
- Generic ordinal type. Includes integer, bool, character, and enumeration types as well as their subtypes. See also <tt class="docutils literal"><span class="pre"><span class="Identifier">SomeOrdinal</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L93" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L93" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="owned">
- <dt><pre><a href="system.html#owned"><span class="Identifier">owned</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BuiltinType"</span>.}</pre></dt>
- <dd>
-
- type constructor to mark a ref/ptr or a closure as <tt class="docutils literal"><span class="pre"><span class="Identifier">owned</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L798" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L798" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="PFrame">
- <dt><pre><a href="system.html#PFrame"><span class="Identifier">PFrame</span></a> <span class="Other">=</span> <span class="Keyword">ptr</span> <a href="system.html#TFrame"><span class="Identifier">TFrame</span></a></pre></dt>
- <dd>
-
- Represents a runtime frame of the call stack; part of the debugger API.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1724" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1724" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="pointer">
- <dt><pre><a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Pointer</span>.}</pre></dt>
- <dd>
-
- Built-in pointer type, use the <tt class="docutils literal"><span class="pre"><span class="Keyword">addr</span></span></tt> operator to get a pointer to a variable.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L25" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Positive">
- <dt><pre><a href="system.html#Positive"><span class="Identifier">Positive</span></a> <span class="Other">=</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Identifier">high</span><span class="Other">(</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">]</span></pre></dt>
- <dd>
-
- is an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> type ranging from one to the maximum value of an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>. This type is often useful for documentation and debugging.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L493" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L493" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ptr">
- <dt><pre><a href="system.html#ptr"><span class="Identifier">ptr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Pointer</span>.}</pre></dt>
- <dd>
-
- Built-in generic untraced pointer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L31" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="range">
- <dt><pre><a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Range"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct range types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L189" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L189" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ref">
- <dt><pre><a href="system.html#ref"><span class="Identifier">ref</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Pointer</span>.}</pre></dt>
- <dd>
-
- Built-in generic traced pointer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L32" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L32" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="RootEffect">
- <dt><pre><a href="system.html#RootEffect"><span class="Identifier">RootEffect</span></a> {.<span class="Identifier">compilerproc</span>.} <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a></pre></dt>
- <dd>
-
- <p>
- Base effect class.</p>
- <p>Each effect should inherit from <tt class="docutils literal"><span class="pre"><span class="Identifier">RootEffect</span></span></tt> unless you know what you're doing.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L508" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L508" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="RootObj">
- <dt><pre><a href="system.html#RootObj"><span class="Identifier">RootObj</span></a> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inheritable</span>.} <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
- <dd>
-
- <p>The root of Nim's object hierarchy.</p>
- <p>Objects should inherit from <tt class="docutils literal"><span class="pre"><span class="Identifier">RootObj</span></span></tt> or one of its descendants. However, objects that have no ancestor are also allowed.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L498" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L498" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="RootRef">
- <dt><pre><a href="system.html#RootRef"><span class="Identifier">RootRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a></pre></dt>
- <dd>
-
- Reference to <tt class="docutils literal"><span class="pre"><span class="Identifier">RootObj</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L503" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L503" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="seq">
- <dt><pre><a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Seq"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct sequences.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L197" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L197" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="set">
- <dt><pre><a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Set"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct bit sets.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L198" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L198" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="sink">
- <dt><pre><a href="system.html#sink"><span class="Identifier">sink</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BuiltinType"</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L204" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L204" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Slice">
- <dt><pre><a href="system.html#Slice"><span class="Identifier">Slice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- An alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">HSlice</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">,</span> <span class="Identifier">T</span><span class="Punctuation">]</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L426" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L426" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeFloat">
- <dt><pre><a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a> <span class="Other">=</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> <span class="Operator">|</span> <a href="system.html#float64"><span class="Identifier">float64</span></a></pre></dt>
- <dd>
-
- Type class matching all floating point number types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L62" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L62" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeInteger">
- <dt><pre><a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a> <span class="Other">=</span> <a href="system.html#SomeSignedInt"><span class="Identifier">SomeSignedInt</span></a> <span class="Operator">|</span> <a href="system.html#SomeUnsignedInt"><span class="Identifier">SomeUnsignedInt</span></a></pre></dt>
- <dd>
-
- Type class matching all integer types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L59" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeNumber">
- <dt><pre><a href="system.html#SomeNumber"><span class="Identifier">SomeNumber</span></a> <span class="Other">=</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a> <span class="Operator">|</span> <a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a></pre></dt>
- <dd>
-
- Type class matching all number types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L65" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeOrdinal">
- <dt><pre><a href="system.html#SomeOrdinal"><span class="Identifier">SomeOrdinal</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Operator">|</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> <span class="Operator">|</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> <span class="Operator">|</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> <span class="Operator">|</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> <span class="Operator">|</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> <span class="Operator">|</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> <span class="Operator">|</span>
- <a href="system.html#uint16"><span class="Identifier">uint16</span></a> <span class="Operator">|</span>
- <a href="system.html#uint32"><span class="Identifier">uint32</span></a> <span class="Operator">|</span>
- <a href="system.html#uint64"><span class="Identifier">uint64</span></a></pre></dt>
- <dd>
-
- Type class matching all ordinal types; however this includes enums with holes. See also <tt class="docutils literal"><span class="pre"><span class="Identifier">Ordinal</span></span></tt>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L68" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L68" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeSignedInt">
- <dt><pre><a href="system.html#SomeSignedInt"><span class="Identifier">SomeSignedInt</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Operator">|</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> <span class="Operator">|</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> <span class="Operator">|</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> <span class="Operator">|</span> <a href="system.html#int64"><span class="Identifier">int64</span></a></pre></dt>
- <dd>
-
- Type class matching all signed integer types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L53" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="SomeUnsignedInt">
- <dt><pre><a href="system.html#SomeUnsignedInt"><span class="Identifier">SomeUnsignedInt</span></a> <span class="Other">=</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> <span class="Operator">|</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> <span class="Operator">|</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> <span class="Operator">|</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> <span class="Operator">|</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a></pre></dt>
- <dd>
-
- Type class matching all unsigned integer types.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L56" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="StackTraceEntry">
- <dt><pre><a href="system.html#StackTraceEntry"><span class="Identifier">StackTraceEntry</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">procname</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Comment">## Name of the proc that is currently executing.</span>
- <span class="Identifier">line</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## Line number of the proc that is currently executing.</span>
- <span class="Identifier">filename</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Comment">## Filename of the proc that is currently executing.</span>
- <span class="Keyword">when</span> <span class="Identifier">NimStackTraceMsgs</span><span class="Other">:</span>
- <span class="Identifier">frameMsg</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Comment">## When a stacktrace is generated in a given frame and</span>
- <span class="Comment">## rendered at a later time, we should ensure the stacktrace</span>
- <span class="Comment">## data isn't invalidated; any pointer into PFrame is</span>
- <span class="Comment">## subject to being invalidated so shouldn't be stored.</span>
- <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Other">(</span><span class="Identifier">nimStackTraceOverride</span><span class="Other">)</span><span class="Other">:</span>
- <span class="Identifier">programCounter</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint</span> <span class="Comment">## Program counter - will be used to get the rest of the info,</span>
- <span class="Comment">## when `$` is called on this type. We can't use</span>
- <span class="Comment">## "cuintptr_t" in here.</span>
- <span class="Identifier">procnameStr</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">filenameStr</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Comment">## GC-ed alternatives to "procname" and "filename"</span></pre></dt>
- <dd>
-
- In debug mode exceptions store the stack trace that led to them. A <tt class="docutils literal"><span class="pre"><span class="Identifier">StackTraceEntry</span></span></tt> is a single entry of the stack trace.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L515" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L515" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="static">
- <dt><pre><a href="system.html#static"><span class="Identifier">static</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Static"</span>.}</pre></dt>
- <dd>
-
- <p>Meta type representing all values that can be evaluated at compile-time.</p>
- <p>The type coercion <tt class="docutils literal"><span class="pre"><span class="Keyword">static</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> can be used to force the compile-time evaluation of the given expression <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L40" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L40" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="string">
- <dt><pre><a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">String</span>.}</pre></dt>
- <dd>
-
- Built-in string type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L23" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L23" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="TFrame">
- <dt><pre><a href="system.html#TFrame"><span class="Identifier">TFrame</span></a> {.<span class="Identifier">importc</span><span class="Other">,</span> <span class="Identifier">nodecl</span><span class="Other">,</span> <span class="Identifier">final</span>.} <span class="Other">=</span> <span class="Keyword">object</span>
- <span class="Identifier">prev</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#PFrame"><span class="Identifier">PFrame</span></a> <span class="Comment">## Previous frame; used for chaining the call stack.</span>
- <span class="Identifier">procname</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Comment">## Name of the proc that is currently executing.</span>
- <span class="Identifier">line</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Comment">## Line number of the proc that is currently executing.</span>
- <span class="Identifier">filename</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a> <span class="Comment">## Filename of the proc that is currently executing.</span>
- <span class="Identifier">len</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> <span class="Comment">## Length of the inspectable slots.</span>
- <span class="Identifier">calldepth</span><span class="Operator">*</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> <span class="Comment">## Used for max call depth checking.</span>
- <span class="Keyword">when</span> <span class="Identifier">NimStackTraceMsgs</span><span class="Other">:</span>
- <span class="Identifier">frameMsgLen</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span> <span class="Comment">## end position in frameMsgBuf for this frame.</span></pre></dt>
- <dd>
-
- The frame itself.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1727" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1727" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="type">
- <dt><pre><a href="system.html#type"><span class="Identifier">type</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Type"</span>.}</pre></dt>
- <dd>
-
- <p>Meta type representing the type of all type values.</p>
- <p>The coercion <tt class="docutils literal"><span class="pre"><span class="Keyword">type</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> can be used to obtain the type of the given expression <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L46" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="typed">
- <dt><pre><a href="system.html#typed"><span class="Identifier">typed</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Stmt</span>.}</pre></dt>
- <dd>
-
- Meta type to denote an expression that is resolved (for templates).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L41" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="typedesc">
- <dt><pre><a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">TypeDesc</span>.}</pre></dt>
- <dd>
-
- Meta type to denote a type description.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L28" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L28" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="TypeOfMode">
- <dt><pre><a href="system.html#TypeOfMode"><span class="Identifier">TypeOfMode</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">typeOfProc</span><span class="Other">,</span> <span class="Comment">## Prefer the interpretation that means `x` is a proc call.</span>
- <span class="Identifier">typeOfIter</span> <span class="Comment">## Prefer the interpretation that means `x` is an iterator call.</span></pre></dt>
- <dd>
-
- Possible modes of <tt class="docutils literal"><span class="pre"><span class="Identifier">typeof</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L53" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="uint">
- <dt><pre><a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">UInt</span>.}</pre></dt>
- <dd>
-
- Unsigned default integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L8" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L8" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="uint8">
- <dt><pre><a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">UInt8</span>.}</pre></dt>
- <dd>
-
- Unsigned 8 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L9" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="uint16">
- <dt><pre><a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">UInt16</span>.}</pre></dt>
- <dd>
-
- Unsigned 16 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L10" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L10" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="uint32">
- <dt><pre><a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">UInt32</span>.}</pre></dt>
- <dd>
-
- Unsigned 32 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L11" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L11" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="uint64">
- <dt><pre><a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">UInt64</span>.}</pre></dt>
- <dd>
-
- Unsigned 64 bit integer type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L12" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L12" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="UncheckedArray">
- <dt><pre><a href="system.html#UncheckedArray"><span class="Identifier">UncheckedArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UncheckedArray"</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L201" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L201" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="untyped">
- <dt><pre><a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="Identifier">Expr</span>.}</pre></dt>
- <dd>
-
- Meta type to denote an expression that is not resolved (for templates).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L39" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="varargs">
- <dt><pre><a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Varargs"</span>.}</pre></dt>
- <dd>
-
- Generic type to construct a varargs type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L196" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L196" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="void">
- <dt><pre><a href="system.html#void"><span class="Identifier">void</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"VoidType"</span>.}</pre></dt>
- <dd>
-
- Meta type to denote the absence of any type.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L36" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="8">
- <h1><a class="toc-backref" href="#8">Vars</a></h1>
- <dl class="item">
- <div id="errorMessageWriter">
- <dt><pre><a href="system.html#errorMessageWriter"><span class="Identifier">errorMessageWriter</span></a><span class="Other">:</span> <span class="Other">(</span><span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><a href="exceptions.html#WriteIOEffect"><span class="Identifier">WriteIOEffect</span></a><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">nimcall</span>.}<span class="Other">)</span></pre></dt>
- <dd>
-
- Function that will be called instead of <tt class="docutils literal"><span class="pre"><span class="Identifier">stdmsg</span><span class="Operator">.</span><span class="Identifier">write</span></span></tt> when printing stacktrace. Unstable API.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L19" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="globalRaiseHook">
- <dt><pre><a href="system.html#globalRaiseHook"><span class="Identifier">globalRaiseHook</span></a><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
- <dd>
-
- With this hook you can influence exception handling on a global level. If not nil, every 'raise' statement ends up calling this hook.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- Ordinary application code should never set this hook! You better know what you do when setting this.</div>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">globalRaiseHook</span></span></tt> returns false, the exception is caught and does not propagate further through the call stack.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1840" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1840" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="localRaiseHook">
- <dt><pre><a href="system.html#localRaiseHook"><span class="Identifier">localRaiseHook</span></a> {.<span class="Identifier">threadvar</span>.}<span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}</pre></dt>
- <dd>
-
- With this hook you can influence exception handling on a thread local level. If not nil, every 'raise' statement ends up calling this hook.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- Ordinary application code should never set this hook! You better know what you do when setting this.</div>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">localRaiseHook</span></span></tt> returns false, the exception is caught and does not propagate further through the call stack.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1849" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1849" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="nimThreadDestructionHandlers">
- <dt><pre><a href="system.html#nimThreadDestructionHandlers"><span class="Identifier">nimThreadDestructionHandlers</span></a> {.<span class="Identifier">threadvar</span>.}<span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span>
- <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}<span class="Other">]</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/threadimpl.nim#L2" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/threadimpl.nim#L2" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="onUnhandledException">
- <dt><pre><a href="system.html#onUnhandledException"><span class="Identifier">onUnhandledException</span></a><span class="Other">:</span> <span class="Other">(</span><span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">errorMsg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span></span>.}<span class="Other">)</span></pre></dt>
- <dd>
-
- <p>Set this error
- handler to override the existing behaviour on an unhandled exception.</p>
- <p>The default is to write a stacktrace to <tt class="docutils literal"><span class="pre"><span class="Identifier">stderr</span></span></tt> and then call <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt>. Unstable API.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L370" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L370" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="outOfMemHook">
- <dt><pre><a href="system.html#outOfMemHook"><span class="Identifier">outOfMemHook</span></a><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Set this variable to provide a procedure that should be called in case of an <span id="out-of-memory_1">out of memory</span> event. The standard handler writes an error message and terminates the program.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">outOfMemHook</span></span></tt> can be used to raise an exception in case of OOM like so:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">gOutOfMem</span><span class="Punctuation">:</span> <span class="Keyword">ref</span> <span class="Identifier">EOutOfMemory</span>
- <span class="Identifier">new</span><span class="Punctuation">(</span><span class="Identifier">gOutOfMem</span><span class="Punctuation">)</span> <span class="Comment"># need to be allocated *before* OOM really happened!</span>
- <span class="Identifier">gOutOfMem</span><span class="Operator">.</span><span class="Identifier">msg</span> <span class="Operator">=</span> <span class="StringLit">"out of memory"</span>
- <span class="Keyword">proc</span> <span class="Identifier">handleOOM</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span>
- <span class="Keyword">raise</span> <span class="Identifier">gOutOfMem</span>
- <span class="Identifier">system</span><span class="Operator">.</span><span class="Identifier">outOfMemHook</span> <span class="Operator">=</span> <span class="Identifier">handleOOM</span></pre></p>
- <p>If the handler does not raise an exception, ordinary control flow continues and the program is terminated.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1859" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1859" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="programResult">
- <dt><pre><a href="system.html#programResult"><span class="Identifier">programResult</span></a> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">exportc</span><span class="Other">:</span> <span class="StringLit">"nim_program_result"</span>.}<span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- deprecated, prefer <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">exitprocs</span><span class="Operator">.</span><span class="Identifier">getProgramResult</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">exitprocs</span><span class="Operator">.</span><span class="Identifier">setProgramResult</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1114" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1114" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="unhandledExceptionHook">
- <dt><pre><a href="system.html#unhandledExceptionHook"><span class="Identifier">unhandledExceptionHook</span></a><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span> {.<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Set this variable to provide a procedure that should be called in case of an <tt class="docutils literal"><span class="pre"><span class="Identifier">unhandle</span> <span class="Identifier">exception</span></span></tt> event. The standard handler writes an error message and terminates the program, except when using <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">os</span><span class="Punctuation">:</span><span class="Identifier">any</span></span></tt>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1879" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1879" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="9">
- <h1><a class="toc-backref" href="#9">Lets</a></h1>
- <dl class="item">
- <div id="nimvm">
- <dt><pre><a href="system.html#nimvm"><span class="Identifier">nimvm</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Nimvm"</span><span class="Other">,</span> <span class="Identifier">compileTime</span>.}<span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="Identifier">false</span></pre></dt>
- <dd>
-
- May be used only in <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span></span></tt> expression. It is true in Nim VM context and false otherwise.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L18" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L18" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="10">
- <h1><a class="toc-backref" href="#10">Consts</a></h1>
- <dl class="item">
- <div id="appType">
- <dt><pre><a href="system.html#appType"><span class="Identifier">appType</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppType"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
- <dd>
-
- A string that describes the application type. Possible values: <tt class="docutils literal"><span class="pre"><span class="StringLit">"console"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"gui"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"lib"</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L458" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L458" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="CompileDate">
- <dt><pre><a href="system.html#CompileDate"><span class="Identifier">CompileDate</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"CompileDate"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">"0000-00-00"</span></pre></dt>
- <dd>
-
- The date (in UTC) of compilation as a string of the form <tt class="docutils literal"><span class="pre"><span class="Identifier">YYYY</span><span class="Operator">-</span><span class="Identifier">MM</span><span class="Operator">-</span><span class="Identifier">DD</span></span></tt>. This works thanks to compiler magic.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L28" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L28" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="CompileTime">
- <dt><pre><a href="system.html#CompileTime"><span class="Identifier">CompileTime</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"CompileTime"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">"00:00:00"</span></pre></dt>
- <dd>
-
- The time (in UTC) of compilation as a string of the form <tt class="docutils literal"><span class="pre"><span class="Identifier">HH</span><span class="Punctuation">:</span><span class="Identifier">MM</span><span class="Punctuation">:</span><span class="Identifier">SS</span></span></tt>. This works thanks to compiler magic.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L32" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L32" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="cpuEndian">
- <dt><pre><a href="system.html#cpuEndian"><span class="Identifier">cpuEndian</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"CpuEndian"</span>.}<span class="Other">:</span> <a href="system.html#Endianness"><span class="Identifier">Endianness</span></a> <span class="Other">=</span> <span class="DecNumber">littleEndian</span></pre></dt>
- <dd>
-
- The endianness of the target CPU. This is a valuable piece of information for low-level code only. This works thanks to compiler magic.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1040" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1040" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="hostCPU">
- <dt><pre><a href="system.html#hostCPU"><span class="Identifier">hostCPU</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"HostCPU"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
- <dd>
-
- <p>A string that describes the host CPU.</p>
- <p>Possible values: <tt class="docutils literal"><span class="pre"><span class="StringLit">"i386"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"alpha"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"powerpc"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"powerpc64"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"powerpc64el"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"sparc"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"amd64"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"mips"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"mipsel"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"arm"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"arm64"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"mips64"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"mips64el"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"riscv32"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"riscv64"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"loongarch64"</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1052" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1052" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="hostOS">
- <dt><pre><a href="system.html#hostOS"><span class="Identifier">hostOS</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"HostOS"</span>.}<span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">""</span></pre></dt>
- <dd>
-
- <p>A string that describes the host operating system.</p>
- <p>Possible values: <tt class="docutils literal"><span class="pre"><span class="StringLit">"windows"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"macosx"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"linux"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"netbsd"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"freebsd"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"openbsd"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"solaris"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"aix"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"haiku"</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="StringLit">"standalone"</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1045" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1045" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="Inf">
- <dt><pre><a href="system.html#Inf"><span class="Identifier">Inf</span></a> <span class="Other">=</span> <span class="FloatNumber">0x7FF0000000000000'f64</span></pre></dt>
- <dd>
-
- Contains the IEEE floating point value of positive infinity.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1277" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1277" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="isMainModule">
- <dt><pre><a href="system.html#isMainModule"><span class="Identifier">isMainModule</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsMainModule"</span>.}<span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
- <dd>
-
- True only when accessed in the main module. This works thanks to compiler magic. It is useful to embed testing code in a module.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L24" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NaN">
- <dt><pre><a href="system.html#NaN"><span class="Identifier">NaN</span></a> <span class="Other">=</span> <span class="FloatNumber">0x7FF7FFFFFFFFFFFF'f64</span></pre></dt>
- <dd>
-
- <p>Contains an IEEE floating point value of <em>Not A Number</em>.</p>
- <p>Note that you cannot compare a floating point value to this value and expect a reasonable result - use the <tt class="docutils literal"><span class="pre"><span class="Identifier">isNaN</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">classify</span></span></tt> procedure in the <a class="reference external" href="math.html">math module</a> for checking for NaN.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1281" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1281" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NegInf">
- <dt><pre><a href="system.html#NegInf"><span class="Identifier">NegInf</span></a> <span class="Other">=</span> <span class="FloatNumber">0xFFF0000000000000'f64</span></pre></dt>
- <dd>
-
- Contains the IEEE floating point value of negative infinity.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1279" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1279" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimMajor">
- <dt><pre><a href="system.html#NimMajor"><span class="Identifier">NimMajor</span></a> {.<span class="Identifier">intdefine</span>.}<span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">2</span></pre></dt>
- <dd>
-
- <p>is the major number of Nim's version. Example:</p>
- <p><pre class="listing"><span class="Keyword">when</span> <span class="Punctuation">(</span><span class="Identifier">NimMajor</span><span class="Punctuation">,</span> <span class="Identifier">NimMinor</span><span class="Punctuation">,</span> <span class="Identifier">NimPatch</span><span class="Punctuation">)</span> <span class="Operator">>=</span> <span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L2" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L2" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimMinor">
- <dt><pre><a href="system.html#NimMinor"><span class="Identifier">NimMinor</span></a> {.<span class="Identifier">intdefine</span>.}<span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">3</span></pre></dt>
- <dd>
-
- is the minor number of Nim's version. Odd for devel, even for releases.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L9" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimPatch">
- <dt><pre><a href="system.html#NimPatch"><span class="Identifier">NimPatch</span></a> {.<span class="Identifier">intdefine</span>.}<span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
- <dd>
-
- is the patch number of Nim's version. Odd for devel, even for releases.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L13" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L13" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="NimVersion">
- <dt><pre><a href="system.html#NimVersion"><span class="Identifier">NimVersion</span></a><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> <span class="Other">=</span> <span class="StringLit">"2.3.1"</span></pre></dt>
- <dd>
-
- is the version of Nim as a string.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2049" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2049" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="off">
- <dt><pre><a href="system.html#off"><span class="Identifier">off</span></a> <span class="Other">=</span> <span class="DecNumber">false</span></pre></dt>
- <dd>
-
- Alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L50" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L50" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="on">
- <dt><pre><a href="system.html#on"><span class="Identifier">on</span></a> <span class="Other">=</span> <span class="DecNumber">true</span></pre></dt>
- <dd>
-
- Alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L49" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="QuitFailure">
- <dt><pre><a href="system.html#QuitFailure"><span class="Identifier">QuitFailure</span></a> <span class="Other">=</span> <span class="DecNumber">1</span></pre></dt>
- <dd>
-
- is the value that should be passed to <a class="reference external" href="#quit,int">quit</a> to indicate failure.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1109" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1109" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="QuitSuccess">
- <dt><pre><a href="system.html#QuitSuccess"><span class="Identifier">QuitSuccess</span></a> <span class="Other">=</span> <span class="DecNumber">0</span></pre></dt>
- <dd>
-
- is the value that should be passed to <a class="reference external" href="#quit,int">quit</a> to indicate success.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1105" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1105" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </dl>
- </div>
- <div class="section" id="12">
- <h1><a class="toc-backref" href="#12">Procs</a></h1>
- <dl class="item">
- <div id="%%-procs-all">
- <div id="%%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cint%2Cint"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and compute the modulo of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>The result is truncated to fit into the result. This implements modulo arithmetic. No overflow errors are possible.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L396" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L396" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="%%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cint8%2Cint8"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L402" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L402" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="%%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cint16%2Cint16"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L403" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L403" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="%%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cint32%2Cint32"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L404" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L404" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="%%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%25%25%2Cint64%2Cint64"><span class="Identifier">`%%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L405" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L405" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="&-procs-all">
- <div id="&,char,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Cchar%2Cchar"><span class="Identifier">`&`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ConStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Concatenates characters <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> into a string.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">' & '</span><span class="Identifier">b</span><span class="CharLit">' == "ab")</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L994" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L994" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Cstring%2Cstring"><span class="Identifier">`&`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ConStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Concatenates strings <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="StringLit">"ab"</span> <span class="Operator">&</span> <span class="StringLit">"cd"</span> <span class="Operator">==</span> <span class="StringLit">"abcd"</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1000" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1000" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,char,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Cchar%2Cstring"><span class="Identifier">`&`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ConStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Concatenates <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> with <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">' & "bc" == "abc")</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1006" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1006" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,string,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Cstring%2Cchar"><span class="Identifier">`&`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ConStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Concatenates <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> with <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="StringLit">"ab"</span> <span class="Operator">&</span> <span class="CharLit">'c'</span> <span class="Operator">==</span> <span class="StringLit">"abc"</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L988" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L988" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,sinkseq[T],sinkseq[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Csinkseq%5BT%5D%2Csinkseq%5BT%5D"><span class="Identifier">`&`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Concatenates two sequences.</p>
- <p>Requires copying of the sequences.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span> <span class="Operator">&</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#add,seq[T],openArray[T]">add(var seq[T], openArray[T])</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1475" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1475" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,sinkseq[T],sinkT">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2Csinkseq%5BT%5D%2CsinkT"><span class="Identifier">`&`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Appends element y to the end of the sequence.</p>
- <p>Requires copying of the sequence.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span> <span class="Operator">&</span> <span class="DecNumber">4</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#add,seq[T],sinkT">add(var seq[T], T)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1491" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1491" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="&,sinkT,sinkseq[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%2CsinkT%2Csinkseq%5BT%5D"><span class="Identifier">`&`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Prepends the element x to the beginning of the sequence.</p>
- <p>Requires copying of the sequence.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">&</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1506" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1506" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="&=-procs-all">
- <div id="&=,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%26%3D%2Cstring%2Cstring"><span class="Identifier">`&=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppendStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Appends in place to a string.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abc"</span>
- <span class="Identifier">a</span> <span class="Operator">&=</span> <span class="StringLit">"de"</span> <span class="Comment"># a <- "abcde"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2469" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2469" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="*-procs-all">
- <div id="*,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cfloat%2Cfloat"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L324" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L324" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cfloat32%2Cfloat32"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L317" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L317" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cint%2Cint"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">*</span></span></tt> operator for an integer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L89" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L89" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cint8%2Cint8"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L91" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L91" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cint16%2Cint16"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L92" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L92" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cint32%2Cint32"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L93" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L93" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cint64%2Cint64"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L94" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L94" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cuint%2Cuint"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">*</span></span></tt> operator for unsigned integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L276" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L276" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cuint8%2Cuint8"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L278" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L278" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cuint16%2Cuint16"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L279" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L279" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cuint32%2Cuint32"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L280" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L280" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%2Cuint64%2Cuint64"><span class="Identifier">`*`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L281" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L281" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*,set[T],set[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2A%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`*`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MulSet"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- This operator computes the intersection of two sets.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span> <span class="Operator">*</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L55" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="*%-procs-all">
- <div id="*%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%25%2Cint%2Cint"><span class="Identifier">`*%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and multiplies them.</p>
- <p>The result is truncated to fit into the result. This implements modulo arithmetic. No overflow errors are possible.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L374" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L374" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%25%2Cint8%2Cint8"><span class="Identifier">`*%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L380" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L380" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%25%2Cint16%2Cint16"><span class="Identifier">`*%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L381" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L381" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%25%2Cint32%2Cint32"><span class="Identifier">`*%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L382" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L382" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%25%2Cint64%2Cint64"><span class="Identifier">`*%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L383" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L383" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="*=-procs-all">
- <div id="*=,T,T_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%3D%2CT%2CT_2"><span class="Identifier">`*=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> <span class="Operator">|</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Multiplies in place a floating point number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L337" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L337" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="*=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2A%3D%2CT%2CT"><span class="Identifier">`*=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">*=</span></span></tt> operator for integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L307" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L307" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="+-procs-all">
- <div id="+,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cfloat%2Cfloat"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L322" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L322" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cfloat32%2Cfloat32"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L315" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L315" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint%2Cint"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">+</span></span></tt> operator for an integer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L75" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L75" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint8%2Cint8"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L77" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L77" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint16%2Cint16"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L78" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint32%2Cint32"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L79" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint64%2Cint64"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L80" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L80" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cuint%2Cuint"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">+</span></span></tt> operator for unsigned integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L262" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L262" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cuint8%2Cuint8"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L264" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L264" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cuint16%2Cuint16"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L265" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L265" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cuint32%2Cuint32"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L266" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L266" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cuint64%2Cuint64"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AddU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L267" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L267" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cfloat"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L320" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L320" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cfloat32"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L313" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L313" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Unary <tt class="docutils literal"><span class="pre"><span class="Operator">+</span></span></tt> operator for an integer. Has no effect.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L49" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L49" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint8"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L51" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint16"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L52" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L52" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint32"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L53" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%2Cint64"><span class="Identifier">`+`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryPlusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+,set[T],set[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#%2B%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`+`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"PlusSet"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- This operator computes the union of two sets.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span> <span class="Operator">+</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L60" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="+%-procs-all">
- <div id="+%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%25%2Cint%2Cint"><span class="Identifier">`+%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and adds them.</p>
- <p>The result is truncated to fit into the result. This implements modulo arithmetic. No overflow errors are possible.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L352" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L352" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%25%2Cint8%2Cint8"><span class="Identifier">`+%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L358" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L358" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%25%2Cint16%2Cint16"><span class="Identifier">`+%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L359" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L359" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%25%2Cint32%2Cint32"><span class="Identifier">`+%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L360" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L360" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%25%2Cint64%2Cint64"><span class="Identifier">`+%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L361" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L361" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="+=-procs-all">
- <div id="+=,T,T_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%3D%2CT%2CT_2"><span class="Identifier">`+=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> <span class="Operator">|</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Increments in place a floating point number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L327" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L327" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="+=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2B%3D%2CT%2CT"><span class="Identifier">`+=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Inc"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Increments an integer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L299" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L299" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="--procs-all">
- <div id="-,AllocStats,AllocStats">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2CAllocStats%2CAllocStats"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#AllocStats"><span class="Identifier">AllocStats</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#AllocStats"><span class="Identifier">AllocStats</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L71" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cfloat%2Cfloat"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L323" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L323" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cfloat32%2Cfloat32"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L316" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L316" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint%2Cint"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">-</span></span></tt> operator for an integer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L82" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L82" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint8%2Cint8"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L84" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint16%2Cint16"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L85" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint32%2Cint32"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L86" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L86" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint64%2Cint64"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L87" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cuint%2Cuint"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Binary <tt class="docutils literal"><span class="pre"><span class="Operator">-</span></span></tt> operator for unsigned integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L269" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L269" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cuint8%2Cuint8"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L271" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L271" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cuint16%2Cuint16"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L272" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L272" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cuint32%2Cuint32"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L273" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L273" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cuint64%2Cuint64"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SubU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L274" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L274" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cfloat"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L321" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L321" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cfloat32"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L314" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L314" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Unary <tt class="docutils literal"><span class="pre"><span class="Operator">-</span></span></tt> operator for an integer. Negates <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L56" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint8"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L58" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint16"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L59" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint32"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L60" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%2Cint64"><span class="Identifier">`-`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"UnaryMinusI64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L61" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-,set[T],set[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#-%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`-`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinusSet"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- This operator computes the difference of two sets.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span> <span class="Operator">-</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">}</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L65" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="-%-procs-all">
- <div id="-%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%25%2Cint%2Cint"><span class="Identifier">`-%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and subtracts them.</p>
- <p>The result is truncated to fit into the result. This implements modulo arithmetic. No overflow errors are possible.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L363" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L363" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%25%2Cint8%2Cint8"><span class="Identifier">`-%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L369" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L369" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%25%2Cint16%2Cint16"><span class="Identifier">`-%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L370" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L370" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%25%2Cint32%2Cint32"><span class="Identifier">`-%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L371" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L371" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%25%2Cint64%2Cint64"><span class="Identifier">`-%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L372" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L372" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="-=-procs-all">
- <div id="-=,T,T_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%3D%2CT%2CT_2"><span class="Identifier">`-=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> <span class="Operator">|</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Decrements in place a floating point number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L332" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L332" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="-=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#-%3D%2CT%2CT"><span class="Identifier">`-=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Dec"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Decrements an integer.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L303" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L303" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="..-procs-all">
- <div id="..,sinkT,sinkU">
- <dt><pre><span class="Keyword">proc</span> <a href="#..%2CsinkT%2CsinkU"><span class="Identifier">`..`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">U</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DotDot"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Binary <span id="slice_1">slice</span> operator that constructs an interval <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">]</span></span></tt>, both <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> are inclusive.</p>
- <p>Slices can also be used in the set constructor and in ordinal case statements, but then they are special-cased by the compiler.</p>
- <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">,</span> <span class="DecNumber">40</span><span class="Punctuation">,</span> <span class="DecNumber">50</span><span class="Punctuation">]</span>
- <span class="Identifier">echo</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="DecNumber">2</span> <span class="Operator">..</span> <span class="DecNumber">3</span><span class="Punctuation">]</span> <span class="Comment"># @[30, 40]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L428" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L428" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="..,sinkT">
- <dt><pre><span class="Keyword">proc</span> <a href="#..%2CsinkT"><span class="Identifier">`..`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DotDot"</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"replace `..b` with `0..b`"</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> replace `..b` with `0..b`
- </div>
- <p>Unary <span id="slice_2">slice</span> operator that constructs an interval <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">default</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">]</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">,</span> <span class="DecNumber">40</span><span class="Punctuation">,</span> <span class="DecNumber">50</span><span class="Punctuation">]</span>
- <span class="Identifier">echo</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Operator">..</span> <span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Comment"># @[10, 20, 30]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L440" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L440" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="/-procs-all">
- <div id="/,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%2Cfloat%2Cfloat"><span class="Identifier">`/`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L325" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L325" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%2Cfloat32%2Cfloat32"><span class="Identifier">`/`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L318" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L318" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%2Cint%2Cint"><span class="Identifier">`/`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Division of integers that results in a float.</p>
- <p><pre class="listing"><span class="Identifier">echo</span> <span class="DecNumber">7</span> <span class="Operator">/</span> <span class="DecNumber">5</span> <span class="Comment"># => 1.4</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="system.html#div,int,int">div</a></li>
- <li><a class="reference external" href="system.html#mod,int,int">mod</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1331" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1331" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="/%-procs-all">
- <div id="/%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%25%2Cint%2Cint"><span class="Identifier">`/%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and divides them.</p>
- <p>The result is truncated to fit into the result. This implements modulo arithmetic. No overflow errors are possible.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L385" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L385" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%25%2Cint8%2Cint8"><span class="Identifier">`/%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L391" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L391" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%25%2Cint16%2Cint16"><span class="Identifier">`/%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L392" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L392" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%25%2Cint32%2Cint32"><span class="Identifier">`/%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L393" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L393" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%25%2Cint64%2Cint64"><span class="Identifier">`/%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L394" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L394" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="/=-procs-all">
- <div id="/=,float64,float64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%3D%2Cfloat64%2Cfloat64"><span class="Identifier">`/=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Divides in place a floating point number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L342" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L342" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="/=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%2F%3D%2CT%2CT"><span class="Identifier">`/=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Divides in place a floating point number.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L346" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L346" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<-procs-all">
- <div id="<,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cbool%2Cbool"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtB"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L123" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,char,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cchar%2Cchar"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtCh"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two chars and returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is lexicographically before <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> (uppercase letters come before lowercase letters).
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="CharLit">'a'</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="CharLit">'b'</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="CharLit">'Z'</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">a</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L97" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L97" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cfloat%2Cfloat"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L216" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L216" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cfloat32%2Cfloat32"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L215" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L215" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cint%2Cint"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is less than <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L158" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cint8%2Cint8"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L160" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L160" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cint16%2Cint16"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L161" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L161" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cint32%2Cint32"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L162" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L162" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cint64%2Cint64"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L163" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L163" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,pointer,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cpointer%2Cpointer"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtPtr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L126" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cstring%2Cstring"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two strings and returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is lexicographically before <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> (uppercase letters come before lowercase letters).
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abc"</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">"abd"</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="StringLit">"ZZZ"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">a</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L85" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cuint%2Cuint"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator"><</span> <span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L172" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L172" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cuint8%2Cuint8"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L174" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L174" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cuint16%2Cuint16"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L175" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L175" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cuint32%2Cuint32"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L176" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L176" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cuint64%2Cuint64"><span class="Identifier">`<`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L177" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,Enum,Enum">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2CEnum%2CEnum"><span class="Identifier">`<`</span></a><span class="Other">[</span><span class="Identifier">Enum</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">Enum</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtEnum"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L84" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2CT%2CT"><span class="Identifier">`<`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Generic lexicographic <tt class="docutils literal"><span class="pre"><span class="Operator"><</span></span></tt> operator for tuples that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>. This implementation uses <tt class="docutils literal"><span class="pre"><span class="Identifier">cmp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1815" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1815" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,ptr.T,ptr.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cptr.T%2Cptr.T"><span class="Identifier">`<`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtPtr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L125" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L125" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,ref.T,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cref.T%2Cref.T"><span class="Identifier">`<`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtPtr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L124" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<,set[T],set[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`<`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LtSet"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is a strict or proper subset of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>A strict or proper subset <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> has all of its members in <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> but <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> has more elements than <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">}</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">a</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L109" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L109" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<%-procs-all">
- <div id="<%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2Cint%2Cint"><span class="Identifier">`<%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and compares them. Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator"><</span> <span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L188" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L188" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2Cint8%2Cint8"><span class="Identifier">`<%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L192" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L192" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2Cint16%2Cint16"><span class="Identifier">`<%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L193" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L193" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2Cint32%2Cint32"><span class="Identifier">`<%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L194" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L194" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%25%2Cint64%2Cint64"><span class="Identifier">`<%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L195" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L195" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<=-procs-all">
- <div id="<=,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cbool%2Cbool"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeB"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L80" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L80" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,char,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cchar%2Cchar"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeCh"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two chars and returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is lexicographically before <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> (uppercase letters come before lowercase letters).
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="CharLit">'a'</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="CharLit">'b'</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="CharLit">'Z'</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">a</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cfloat%2Cfloat"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L213" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L213" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cfloat32%2Cfloat32"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L212" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L212" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cint%2Cint"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is less than or equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L151" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L151" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cint8%2Cint8"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L153" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cint16%2Cint16"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L154" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L154" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cint32%2Cint32"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L155" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cint64%2Cint64"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L156" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L156" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,pointer,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cpointer%2Cpointer"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LePtr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L82" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L82" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cstring%2Cstring"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two strings and returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is lexicographically before <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> (uppercase letters come before lowercase letters).
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abc"</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">"abd"</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="StringLit">"ZZZ"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">a</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L42" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cuint%2Cuint"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator"><=</span> <span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L165" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L165" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cuint8%2Cuint8"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L167" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L167" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cuint16%2Cuint16"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L168" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L168" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cuint32%2Cuint32"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L169" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L169" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cuint64%2Cuint64"><span class="Identifier">`<=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L170" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L170" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,Enum,Enum">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2CEnum%2CEnum"><span class="Identifier">`<=`</span></a><span class="Other">[</span><span class="Identifier">Enum</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">Enum</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeEnum"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L41" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L41" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2CT%2CT"><span class="Identifier">`<=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Generic lexicographic <tt class="docutils literal"><span class="pre"><span class="Operator"><=</span></span></tt> operator for tuples that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>. This implementation uses <tt class="docutils literal"><span class="pre"><span class="Identifier">cmp</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1806" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1806" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,ref.T,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cref.T%2Cref.T"><span class="Identifier">`<=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LePtr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L81" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=,set[T],set[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`<=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LeSet"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is a subset of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>A subset <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> has all of its members in <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> doesn't necessarily have more members than <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. That is, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> can be equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">}</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">b</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">a</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">c</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L66" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="<=%-procs-all">
- <div id="<=%,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2Cint%2Cint"><span class="Identifier">`<=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and compares them. Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator"><=</span> <span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L179" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L179" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=%,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2Cint8%2Cint8"><span class="Identifier">`<=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L183" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L183" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=%,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2Cint16%2Cint16"><span class="Identifier">`<=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L184" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L184" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=%,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2Cint32%2Cint32"><span class="Identifier">`<=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L185" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L185" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="<=%,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3C%3D%25%2Cint64%2Cint64"><span class="Identifier">`<=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L186" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L186" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=-procs-all">
- <div id="=,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%2CT%2CT"><span class="Identifier">`=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Asgn"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L377" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L377" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="==-procs-all">
- <div id="==,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cbool%2Cbool"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqB"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two <tt class="docutils literal"><span class="pre"><span class="Identifier">bool</span></span></tt> variables.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,char,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cchar%2Cchar"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqCh"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two <tt class="docutils literal"><span class="pre"><span class="Identifier">char</span></span></tt> variables.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L25" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,cstring,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Ccstring%2Ccstring"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqCString"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two <tt class="docutils literal"><span class="pre"><span class="Identifier">cstring</span></span></tt> variables.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2719" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2719" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,float,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cfloat%2Cfloat"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L219" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L219" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cfloat32%2Cfloat32"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqF64"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L218" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L218" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cint%2Cint"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two integers for equality.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L144" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L144" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cint8%2Cint8"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L146" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L146" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cint16%2Cint16"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L147" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L147" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cint32%2Cint32"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L148" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L148" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cint64%2Cint64"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L149" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L149" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,pointer,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cpointer%2Cpointer"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqRef"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two <tt class="docutils literal"><span class="pre"><span class="Identifier">pointer</span></span></tt> variables.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Comment"># this is a wildly dangerous example</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Identifier">pointer</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">)</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Identifier">pointer</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Keyword">nil</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">b</span> <span class="Comment"># true due to the special meaning of `nil`/0 as a pointer</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L15" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cstring%2Cstring"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two <tt class="docutils literal"><span class="pre"><span class="Identifier">string</span></span></tt> variables.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L22" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cuint%2Cuint"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Compares two unsigned integers for equality.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cuint8%2Cuint8"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L207" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L207" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cuint16%2Cuint16"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L208" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L208" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cuint32%2Cuint32"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L209" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L209" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cuint64%2Cuint64"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L210" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L210" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,Enum,Enum">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CEnum%2CEnum"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">Enum</span><span class="Other">:</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">Enum</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqEnum"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks whether values within the <em>same enum</em> have the same underlying value.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">type</span>
- <span class="Identifier">Enum1</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">field1</span> <span class="Operator">=</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">field2</span>
- <span class="Identifier">Enum2</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">place1</span><span class="Punctuation">,</span> <span class="Identifier">place2</span> <span class="Operator">=</span> <span class="DecNumber">3</span>
- <span class="Keyword">var</span>
- <span class="Identifier">e1</span> <span class="Operator">=</span> <span class="Identifier">field1</span>
- <span class="Identifier">e2</span> <span class="Operator">=</span> <span class="Identifier">place2</span><span class="Operator">.</span><span class="Identifier">ord</span><span class="Operator">.</span><span class="Identifier">Enum1</span>
- <span class="Identifier">assert</span> <span class="Identifier">e1</span> <span class="Operator">==</span> <span class="Identifier">e2</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">e1</span> <span class="Operator">==</span> <span class="Identifier">place2</span><span class="Punctuation">)</span> <span class="Comment"># raises error</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L2" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L2" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,array[I,T],array[I,T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Carray%5BI%2CT%5D%2Carray%5BI%2CT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L294" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L294" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CT%2CT"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Operator">|</span> <span class="Keyword">iterator</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqProc"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks that two <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span></span></tt> variables refer to the same procedure.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L38" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L38" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,T,T_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CT%2CT_2"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">tuple</span> <span class="Operator">|</span> <span class="Keyword">object</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- Generic <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> operator for tuples that is lifted from the components. of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1799" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1799" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,openArray[T],openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CopenArray%5BT%5D%2CopenArray%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L300" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L300" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,ptr.T,ptr.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cptr.T%2Cptr.T"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqRef"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks that two <tt class="docutils literal"><span class="pre"><span class="Keyword">ptr</span></span></tt> variables refer to the same item.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L36" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,ref.T,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cref.T%2Cref.T"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqRef"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks that two <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span></span></tt> variables refer to the same item.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L34" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,seq[T],seq[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cseq%5BT%5D%2Cseq%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Generic equals operator for sequences: relies on a equals operator for the element type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L309" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L309" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="==,set[T],set[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EqSet"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks for equality between two variables of type <tt class="docutils literal"><span class="pre"><span class="Identifier">set</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">}</span> <span class="Comment"># duplication in sets is ignored</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L29" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=copy-procs-all">
- <div id="=copy,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Dcopy%2CT%2CT"><span class="Identifier">`=copy`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">src</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Asgn"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L378" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L378" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=destroy-procs-all">
- <div id="=destroy,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Ddestroy%2Cstring"><span class="Identifier">`=destroy`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Destroy"</span><span class="Other">,</span> <span class="Identifier">enforceNoRaises</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L396" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L396" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="=destroy,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Ddestroy%2Cref.T"><span class="Identifier">`=destroy`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Destroy"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L402" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L402" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="=destroy,seq[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Ddestroy%2Cseq%5BT%5D"><span class="Identifier">`=destroy`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Destroy"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L399" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L399" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="=destroy,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Ddestroy%2CT"><span class="Identifier">`=destroy`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Destroy"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Generic <span id="destructor_1">destructor</span> implementation that can be overridden.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L391" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L391" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=dup-procs-all">
- <div id="=dup,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Ddup%2CT"><span class="Identifier">`=dup`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Dup"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Generic <span id="dup_1">dup</span> implementation that can be overridden.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L406" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L406" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=sink-procs-all">
- <div id="=sink,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Dsink%2CT%2CT"><span class="Identifier">`=sink`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">nodestroy</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Asgn"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Generic <span id="sink_1">sink</span> implementation that can be overridden.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L410" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L410" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=trace-procs-all">
- <div id="=trace,T,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3Dtrace%2CT%2Cpointer"><span class="Identifier">`=trace`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">env</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Trace"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Generic <span id="trace_1">trace</span> implementation that can be overridden.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L418" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L418" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=wasMoved-procs-all">
- <div id="=wasMoved,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%3DwasMoved%2CT"><span class="Identifier">`=wasMoved`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"WasMoved"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Generic <span id="wasmoved_1">wasMoved</span> implementation that can be overridden.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L161" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L161" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="@-procs-all">
- <div id="@,sinkarray[IDX,T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%40%2Csinkarray%5BIDX%2CT%5D"><span class="Identifier">`@`</span></a><span class="Other">[</span><span class="Identifier">IDX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">IDX</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ArrToSeq"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Turns an array into a sequence.</p>
- <p>This most often useful for constructing sequences with the array constructor: <tt class="docutils literal"><span class="pre"><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></span></tt> has the type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span></span></tt>, while <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></span></tt> has the type <tt class="docutils literal"><span class="pre"><span class="Identifier">array</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">"foo"</span>
- <span class="Identifier">echo</span> <span class="Operator">@</span><span class="Identifier">a</span> <span class="Comment"># => @[1, 3, 5]</span>
- <span class="Identifier">echo</span> <span class="Operator">@</span><span class="Identifier">b</span> <span class="Comment"># => @['f', 'o', 'o']</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L902" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L902" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="@,openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%40%2CopenArray%5BT%5D"><span class="Identifier">`@`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"OpenArrayToSeq"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Turns an <em>openArray</em> into a sequence.</p>
- <p>This is not as efficient as turning a fixed length array into a sequence as it always copies every element of <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1456" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1456" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="[]-procs-all">
- <div id="[],string,BackwardsIndex">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Cstring%2CBackwardsIndex"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">systemRaisesDefect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],string,BackwardsIndex_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Cstring%2CBackwardsIndex_2"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L33" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],T,I">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CT%2CI"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <span class="Identifier">I</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ArrGet"</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L373" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L373" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],array[Idx,T],HSlice[U: Ordinal,V: Ordinal]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice operation for arrays. Returns the inclusive range <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">a</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">b</span><span class="Punctuation">]</span><span class="Punctuation">]</span></span></tt>:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#toOpenArray,array[I,T],I,I">toOpenArray(array[I, T];I,I)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L106" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],array[Idx,T],BackwardsIndex">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L25" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L25" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],array[Idx,T],BackwardsIndex_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex_2"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L31" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],string,HSlice[T: Ordinal,U: Ordinal]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2Cstring%2CHSlice%5BT%3A%20Ordinal%2CU%3A%20Ordinal%5D"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice operation for strings. Returns the inclusive range <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">a</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">b</span><span class="Punctuation">]</span><span class="Punctuation">]</span></span></tt>:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">"abcdef"</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="StringLit">"bcd"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L76" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],openArray[T],HSlice[U: Ordinal,V: Ordinal]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CopenArray%5BT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice operation for sequences. Returns the inclusive range <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">a</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">b</span><span class="Punctuation">]</span><span class="Punctuation">]</span></span></tt>:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#toOpenArray,openArray[T],int,int">toOpenArray(openArray[T];int,int)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L135" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],openArray[T],BackwardsIndex">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CopenArray%5BT%5D%2CBackwardsIndex"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L22" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L22" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[],openArray[T],BackwardsIndex_2">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%2CopenArray%5BT%5D%2CBackwardsIndex_2"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L29" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="[]=-procs-all">
- <div id="[]=,string,BackwardsIndex,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2Cstring%2CBackwardsIndex%2Cchar"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L39" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,T,I,sinkS">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2CT%2CI%2CsinkS"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">;</span> <span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">S</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <span class="Identifier">I</span><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">S</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ArrPut"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L375" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L375" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,array[Idx,T],HSlice[U: Ordinal,V: Ordinal],openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2Carray%5BIdx%2CT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D%2CopenArray%5BT%5D"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">;</span>
- <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice assignment for arrays.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">30</span><span class="Punctuation">,</span> <span class="DecNumber">40</span><span class="Punctuation">,</span> <span class="DecNumber">50</span><span class="Punctuation">]</span>
- <span class="Identifier">a</span><span class="Punctuation">[</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">99</span><span class="Punctuation">,</span> <span class="DecNumber">88</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">99</span><span class="Punctuation">,</span> <span class="DecNumber">88</span><span class="Punctuation">,</span> <span class="DecNumber">40</span><span class="Punctuation">,</span> <span class="DecNumber">50</span><span class="Punctuation">]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L121" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L121" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,array[Idx,T],BackwardsIndex,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2Carray%5BIdx%2CT%5D%2CBackwardsIndex%2CT"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">Idx</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L37" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L37" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,string,HSlice[T: Ordinal,U: Ordinal],string">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2Cstring%2CHSlice%5BT%3A%20Ordinal%2CU%3A%20Ordinal%5D%2Cstring"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice assignment for strings.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> is not exactly the number of elements that are referred to by <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, a <span id="splice_1">splice</span> is performed: </p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="StringLit">"abcdefgh"</span>
- <span class="Identifier">s</span><span class="Punctuation">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"xyz"</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="StringLit">"axyzh"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L88" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L88" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,seq[T],HSlice[U: Ordinal,V: Ordinal],openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2Cseq%5BT%5D%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D%2CopenArray%5BT%5D"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Slice assignment for sequences.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> is not exactly the number of elements that are referred to by <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, a <span id="splice_2">splice</span> is performed.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="StringLit">"abcdefgh"</span>
- <span class="Identifier">s</span><span class="Punctuation">[</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="StringLit">"xyz"</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="StringLit">"axyzh"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L150" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L150" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="[]=,openArray[T],BackwardsIndex,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#%5B%5D%3D%2CopenArray%5BT%5D%2CBackwardsIndex%2CT"><span class="Identifier">`[]=`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L35" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="abs-procs-all">
- <div id="abs,int">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2Cint"><span class="Identifier">abs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AbsI"</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1363" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1363" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="abs,int8">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2Cint8"><span class="Identifier">abs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AbsI"</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1365" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1365" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="abs,int16">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2Cint16"><span class="Identifier">abs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AbsI"</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1367" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1367" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="abs,int32">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2Cint32"><span class="Identifier">abs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AbsI"</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1369" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1369" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="abs,int64">
- <dt><pre><span class="Keyword">func</span> <a href="#abs%2Cint64"><span class="Identifier">abs</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AbsI"</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the absolute value of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is <tt class="docutils literal"><span class="pre"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> (that is -MININT for its type), an overflow exception is thrown (if overflow checking is turned on).</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1371" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1371" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="abs,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#abs%2CT"><span class="Identifier">abs</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> <span class="Operator">|</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1350" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1350" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="add-procs-all">
- <div id="add,cstring,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Ccstring%2Ccstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppendStrStr"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Appends <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in place. Only implemented for JS backend.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">js</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">var</span> <span class="Identifier">tmp</span><span class="Punctuation">:</span> <span class="Identifier">cstring</span> <span class="Operator">=</span> <span class="StringLit">""</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">cstring</span><span class="Punctuation">(</span><span class="StringLit">"ab"</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">cstring</span><span class="Punctuation">(</span><span class="StringLit">"cd"</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">tmp</span> <span class="Operator">==</span> <span class="Identifier">cstring</span><span class="Punctuation">(</span><span class="StringLit">"abcd"</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1901" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1901" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="add,string,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cstring%2Cchar"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppendStrCh"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Appends <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in place.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">tmp</span> <span class="Operator">=</span> <span class="StringLit">""</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">')</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">b</span><span class="CharLit">')</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">tmp</span> <span class="Operator">==</span> <span class="StringLit">"ab"</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1016" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1016" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="add,string,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cstring%2Ccstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span> {.<span class="Identifier">asmNoStackFrame</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Appends <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in place.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">tmp</span> <span class="Operator">=</span> <span class="StringLit">""</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">cstring</span><span class="Punctuation">(</span><span class="StringLit">"ab"</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">cstring</span><span class="Punctuation">(</span><span class="StringLit">"cd"</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">tmp</span> <span class="Operator">==</span> <span class="StringLit">"abcd"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1886" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1886" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="add,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cstring%2Cstring"><span class="Identifier">add</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppendStrStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Concatenates <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in place.</p>
- <p>See also <tt class="docutils literal"><span class="pre"><span class="Identifier">strbasics</span><span class="Operator">.</span><span class="Identifier">add</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">tmp</span> <span class="Operator">=</span> <span class="StringLit">""</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">"ab"</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">"cd"</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">tmp</span> <span class="Operator">==</span> <span class="StringLit">"abcd"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1025" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1025" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="add,seq[T],openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cseq%5BT%5D%2CopenArray%5BT%5D"><span class="Identifier">add</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Generic proc for adding a container <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to a container <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>For containers that have an order, <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt> means <em>append</em>. New generic containers should also call their adding proc <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt> for consistency. Generic code becomes much easier to write if the Nim naming scheme is respected.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#&,seq[T],seq[T]">& proc</a></li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">"a1"</span><span class="Punctuation">,</span> <span class="StringLit">"a2"</span><span class="Punctuation">]</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="StringLit">"b1"</span><span class="Punctuation">,</span> <span class="StringLit">"b2"</span><span class="Punctuation">]</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">"a1"</span><span class="Punctuation">,</span> <span class="StringLit">"a2"</span><span class="Punctuation">,</span> <span class="StringLit">"b1"</span><span class="Punctuation">,</span> <span class="StringLit">"b2"</span><span class="Punctuation">]</span>
- <span class="Keyword">var</span> <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">"c0"</span><span class="Punctuation">,</span> <span class="StringLit">"c1"</span><span class="Punctuation">,</span> <span class="StringLit">"c2"</span><span class="Punctuation">,</span> <span class="StringLit">"c3"</span><span class="Punctuation">]</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Operator">.</span><span class="Identifier">toOpenArray</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="StringLit">"a1"</span><span class="Punctuation">,</span> <span class="StringLit">"a2"</span><span class="Punctuation">,</span> <span class="StringLit">"b1"</span><span class="Punctuation">,</span> <span class="StringLit">"b2"</span><span class="Punctuation">,</span> <span class="StringLit">"c1"</span><span class="Punctuation">,</span> <span class="StringLit">"c2"</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1185" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1185" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="add,seq[T],sinkT">
- <dt><pre><span class="Keyword">proc</span> <a href="#add%2Cseq%5BT%5D%2CsinkT"><span class="Identifier">add</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AppendSeqElem"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span class="Identifier">nodestroy</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Generic proc for adding a data item <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> to a container <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>For containers that have an order, <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt> means <em>append</em>. New generic containers should also call their adding proc <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt> for consistency. Generic code becomes much easier to write if the Nim naming scheme is respected.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L153" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="addEscapedChar-procs-all">
- <div id="addEscapedChar,string,char">
- <dt><pre><span class="Keyword">proc</span> <a href="#addEscapedChar%2Cstring%2Cchar"><span class="Identifier">addEscapedChar</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">c</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Adds a char to string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and applies the following escaping:<ul class="simple"><li>replaces any <tt class="docutils literal"><span class="pre">\</span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="CharLit">'</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="CharLit">'</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="StringLit">"</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="StringLit">"</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">a</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">a</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">b</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">b</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">t</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">t</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">n</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">n</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">v</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">v</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">f</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">f</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">r</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">r</span></span></tt></li>
- <li>replaces any <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">e</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\\</span><span class="Identifier">e</span></span></tt></li>
- <li>replaces any other character not in the set <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">\</span><span class="FloatNumber">21.</span><span class="Operator">.\</span><span class="DecNumber">126</span><span class="Punctuation">}</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Operator">\</span><span class="Identifier">xHH</span></span></tt> where <tt class="docutils literal"><span class="pre"><span class="Identifier">HH</span></span></tt> is its hexadecimal value</li>
- </ul>
- <p>The procedure has been designed so that its output is usable for many different common syntaxes.</p>
- <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- This is <strong>not correct</strong> for producing ANSI C code!</div>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2573" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2573" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="addQuoted-procs-all">
- <div id="addQuoted,string,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#addQuoted%2Cstring%2CT"><span class="Identifier">addQuoted</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- <p>Appends <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> in place, applying quoting and escaping if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is a string or char.</p>
- <p>See <a class="reference external" href="#addEscapedChar,string,char">addEscapedChar</a> for the escaping scheme. When <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is a string, characters in the range <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">\</span><span class="FloatNumber">128.</span><span class="Operator">.\</span><span class="DecNumber">255</span><span class="Punctuation">}</span></span></tt> are never escaped so that multibyte UTF-8 characters are untouched (note that this behavior is different from <tt class="docutils literal"><span class="pre"><span class="Identifier">addEscapedChar</span></span></tt>).</p>
- <p>The Nim standard library uses this function on the elements of collections when producing a string representation of a collection. It is recommended to use this function as well for user-side collections. Users may overload <tt class="docutils literal"><span class="pre"><span class="Identifier">addQuoted</span></span></tt> for custom (string-like) types if they want to implement a customized element representation.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">tmp</span> <span class="Operator">=</span> <span class="StringLit">""</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">addQuoted</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">", "</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">addQuoted</span><span class="Punctuation">(</span><span class="StringLit">"string"</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="StringLit">", "</span><span class="Punctuation">)</span>
- <span class="Identifier">tmp</span><span class="Operator">.</span><span class="Identifier">addQuoted</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">c</span><span class="CharLit">')</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">tmp</span> <span class="Operator">==</span> <span class="LongStringLit">"""1, "string", 'c'"""</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2615" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2615" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="addr-procs-all">
- <div id="addr,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#addr%2CT"><span class="Identifier">`addr`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Addr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Builtin <tt class="docutils literal"><span class="pre"><span class="Keyword">addr</span></span></tt> operator for taking the address of a memory location.<div class="admonition admonition-info"><span class="admonition-info-text"><b>Note:</b></span>
- This works for <tt class="docutils literal"><span class="pre"><span class="Keyword">let</span></span></tt> variables or parameters for better interop with C. When you use it to write a wrapper for a C library and take the address of <tt class="docutils literal"><span class="pre"><span class="Keyword">let</span></span></tt> variables or parameters, you should always check that the original library does never write to data behind the pointer that is returned from this procedure.</div>
- <p>Cannot be overloaded.</p>
- <p><pre class="listing"><span class="Keyword">var</span>
- <span class="Identifier">buf</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">char</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">','</span><span class="Identifier">b</span><span class="CharLit">','</span><span class="Identifier">c</span><span class="CharLit">']</span>
- <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">buf</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Keyword">addr</span>
- <span class="Identifier">echo</span> <span class="Identifier">p</span><span class="Operator">.</span><span class="Identifier">repr</span> <span class="Comment"># ref 0x7faa35c40059 --> 'b'</span>
- <span class="Identifier">echo</span> <span class="Identifier">p</span><span class="Punctuation">[</span><span class="Punctuation">]</span> <span class="Comment"># b</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L99" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L99" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="alignof-procs-all">
- <div id="alignof,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#alignof%2Ctypedesc"><span class="Identifier">alignof</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AlignOf"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L600" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L600" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="alignof,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#alignof%2CT"><span class="Identifier">alignof</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AlignOf"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L599" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L599" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="alloc0Impl-procs-all">
- <div id="alloc0Impl,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#alloc0Impl%2CNatural"><span class="Identifier">alloc0Impl</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L52" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L52" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocCStringArray-procs-all">
- <div id="allocCStringArray,openArray[string]">
- <dt><pre><span class="Keyword">proc</span> <a href="#allocCStringArray%2CopenArray%5Bstring%5D"><span class="Identifier">allocCStringArray</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#cstringArray"><span class="Identifier">cstringArray</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Creates a NULL terminated cstringArray from <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>. The result has to be freed with <tt class="docutils literal"><span class="pre"><span class="Identifier">deallocCStringArray</span></span></tt> after it's not needed anymore.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2138" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2138" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocImpl-procs-all">
- <div id="allocImpl,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#allocImpl%2CNatural"><span class="Identifier">allocImpl</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L51" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocShared0Impl-procs-all">
- <div id="allocShared0Impl,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#allocShared0Impl%2CNatural"><span class="Identifier">allocShared0Impl</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L58" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L58" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocSharedImpl-procs-all">
- <div id="allocSharedImpl,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#allocSharedImpl%2CNatural"><span class="Identifier">allocSharedImpl</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span class="Identifier">compilerproc</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L57" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="and-procs-all">
- <div id="and,typedesc,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Ctypedesc%2Ctypedesc"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"TypeTrait"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Constructs an <tt class="docutils literal"><span class="pre"><span class="Keyword">and</span></span></tt> meta class.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L82" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L82" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cbool%2Cbool"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"And"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">and</span></span></tt>; returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">==</span> <span class="Identifier">y</span> <span class="Operator">==</span> <span class="Identifier">true</span></span></tt> (if both arguments are true).</p>
- <p>Evaluation is lazy: if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is false, <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> will not even be evaluated.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L79" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cint%2Cint"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">and</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0011</span> <span class="Keyword">and</span> <span class="BinNumber">0b0101</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b0001</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0111</span> <span class="Keyword">and</span> <span class="BinNumber">0b1100</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b0100</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L189" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L189" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cint8%2Cint8"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L194" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L194" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cint16%2Cint16"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L195" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L195" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cint32%2Cint32"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L196" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L196" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cint64%2Cint64"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L197" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L197" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cuint%2Cuint"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">and</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L241" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L241" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cuint8%2Cuint8"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L243" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L243" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cuint16%2Cuint16"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L244" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L244" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cuint32%2Cuint32"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L245" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L245" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="and,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#and%2Cuint64%2Cuint64"><span class="Identifier">`and`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitandI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L246" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L246" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="arrayWith-procs-all">
- <div id="arrayWith,T,staticint">
- <dt><pre><span class="Keyword">proc</span> <a href="#arrayWith%2CT%2Cstaticint"><span class="Identifier">arrayWith</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">size</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">nodestroy</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Creates a new array filled with <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2968" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2968" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="arrayWithDefault-procs-all">
- <div id="arrayWithDefault,staticint">
- <dt><pre><span class="Keyword">proc</span> <a href="#arrayWithDefault%2Cstaticint"><span class="Identifier">arrayWithDefault</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">size</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">noinit</span><span class="Other">,</span> <span class="Identifier">nodestroy</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Creates a new array filled with <tt class="docutils literal"><span class="pre"><span class="Identifier">default</span><span class="Punctuation">(</span><span class="Identifier">T</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2977" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2977" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ashr-procs-all">
- <div id="ashr,int8,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#ashr%2Cint8%2CSomeInteger"><span class="Identifier">ashr</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L184" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L184" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ashr,int16,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#ashr%2Cint16%2CSomeInteger"><span class="Identifier">ashr</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L185" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L185" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ashr,int32,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#ashr%2Cint32%2CSomeInteger"><span class="Identifier">ashr</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L186" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L186" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ashr,int64,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#ashr%2Cint64%2CSomeInteger"><span class="Identifier">ashr</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L187" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L187" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="ashr,int,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#ashr%2Cint%2CSomeInteger"><span class="Identifier">ashr</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Shifts right by pushing copies of the leftmost bit in from the left, and let the rightmost bits fall off.</p>
- <p>Note that <tt class="docutils literal"><span class="pre"><span class="Identifier">ashr</span></span></tt> is not an operator so use the normal function call syntax for it.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#shr,int,SomeInteger">shr func</a></li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">ashr</span><span class="Punctuation">(</span><span class="BinNumber">0b0001_0000'i8</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b0000_0100'i8</span>
- <span class="Identifier">assert</span> <span class="Identifier">ashr</span><span class="Punctuation">(</span><span class="BinNumber">0b1000_0000'i8</span><span class="Punctuation">,</span> <span class="DecNumber">8</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b1111_1111'i8</span>
- <span class="Identifier">assert</span> <span class="Identifier">ashr</span><span class="Punctuation">(</span><span class="BinNumber">0b1000_0000'i8</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b1100_0000'i8</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L171" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L171" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="astToStr-procs-all">
- <div id="astToStr,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#astToStr%2CT"><span class="Identifier">astToStr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AstToStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Converts the AST of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> into a string representation. This is very useful for debugging.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L83" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L83" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="capacity-procs-all">
- <div id="capacity,string">
- <dt><pre><span class="Keyword">func</span> <a href="#capacity%2Cstring"><span class="Identifier">capacity</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the current capacity of the string.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">str</span> <span class="Operator">=</span> <span class="Identifier">newStringOfCap</span><span class="Punctuation">(</span><span class="Identifier">cap</span> <span class="Operator">=</span> <span class="DecNumber">42</span><span class="Punctuation">)</span>
- <span class="Identifier">str</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="StringLit">"Nim"</span>
- <span class="Identifier">assert</span> <span class="Identifier">str</span><span class="Operator">.</span><span class="Identifier">capacity</span> <span class="Operator">==</span> <span class="DecNumber">42</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/strs_v2.nim#L216" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/strs_v2.nim#L216" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="capacity,seq[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#capacity%2Cseq%5BT%5D"><span class="Identifier">capacity</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Returns the current capacity of the seq.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">lst</span> <span class="Operator">=</span> <span class="Identifier">newSeqOfCap</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">cap</span> <span class="Operator">=</span> <span class="DecNumber">42</span><span class="Punctuation">)</span>
- <span class="Identifier">lst</span><span class="Operator">.</span><span class="Identifier">add</span> <span class="StringLit">"Nim"</span>
- <span class="Identifier">assert</span> <span class="Identifier">lst</span><span class="Operator">.</span><span class="Identifier">capacity</span> <span class="Operator">==</span> <span class="DecNumber">42</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L194" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L194" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="card-procs-all">
- <div id="card,set[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#card%2Cset%5BT%5D"><span class="Identifier">card</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Card"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the cardinality of the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, i.e. the number of elements in the set.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span>
- <span class="Identifier">assert</span> <span class="Identifier">card</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
- <span class="Keyword">var</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">assert</span> <span class="Identifier">card</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span> <span class="Comment"># repeated 5 doesn't count</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L42" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="chr-procs-all">
- <div id="chr,range[]">
- <dt><pre><span class="Keyword">func</span> <a href="#chr%2Crange%5B%5D"><span class="Identifier">chr</span></a><span class="Other">(</span><span class="Identifier">u</span><span class="Other">:</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">[</span><span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">255</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Chr"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">u</span></span></tt> to a <tt class="docutils literal"><span class="pre"><span class="Identifier">char</span></span></tt>, same as <tt class="docutils literal"><span class="pre"><span class="Identifier">char</span><span class="Punctuation">(</span><span class="Identifier">u</span><span class="Punctuation">)</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">chr</span><span class="Punctuation">(</span><span class="DecNumber">65</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'A'</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">chr</span><span class="Punctuation">(</span><span class="DecNumber">255</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="CharLit">'\255'</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">chr</span><span class="Punctuation">(</span><span class="DecNumber">255</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">char</span><span class="Punctuation">(</span><span class="DecNumber">255</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span> <span class="Identifier">chr</span><span class="Punctuation">(</span><span class="DecNumber">256</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span> <span class="Identifier">char</span><span class="Punctuation">(</span><span class="DecNumber">256</span><span class="Punctuation">)</span>
- <span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="DecNumber">256</span>
- <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">RangeDefect</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">chr</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">RangeDefect</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">char</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L730" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L730" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="clamp-procs-all">
- <div id="clamp,T,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#clamp%2CT%2CT%2CT"><span class="Identifier">clamp</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- Limits the value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> within the interval [a, b]. This proc is equivalent to but faster than <tt class="docutils literal"><span class="pre"><span class="Identifier">max</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">min</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">,</span> <span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">)</span></span></tt>.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Operator"><=</span> <span class="Identifier">b</span></span></tt> is assumed and will not be checked (currently).</div>
- <p><strong>See also:</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">math</span><span class="Operator">.</span><span class="Identifier">clamp</span></span></tt> for a version that takes a <tt class="docutils literal"><span class="pre"><span class="Identifier">Slice</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> instead.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="FloatNumber">1.4</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">clamp</span><span class="Punctuation">(</span><span class="FloatNumber">0.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">1.0</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="FloatNumber">0.5</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">clamp</span><span class="Punctuation">(</span><span class="FloatNumber">0.0</span><span class="Punctuation">,</span> <span class="FloatNumber">1.0</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="FloatNumber">0.5</span>
- <span class="Identifier">assert</span> <span class="FloatNumber">4.</span><span class="Identifier">clamp</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">max</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="Identifier">min</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">)</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L277" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L277" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="cmp-procs-all">
- <div id="cmp,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#cmp%2Cstring%2Cstring"><span class="Identifier">cmp</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Compare proc for strings. More efficient than the generic version.</p>
- <p><strong>Note</strong>: The precise result values depend on the used C runtime library and can differ between operating systems!</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L896" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L896" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="cmp,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#cmp%2CT%2CT"><span class="Identifier">cmp</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- <p>Generic compare proc.</p>
- <p>Returns:</p>
- <ul class="simple"><li>a value less than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator"><</span> <span class="Identifier">y</span></span></tt></li>
- <li>a value greater than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">></span> <span class="Identifier">y</span></span></tt></li>
- <li>zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">==</span> <span class="Identifier">y</span></span></tt></li>
- </ul>
- <p>This is useful for writing generic algorithms without performance loss. This generic implementation uses the <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator"><</span></span></tt> operators.</p>
- <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">algorithm</span>
- <span class="Identifier">echo</span> <span class="Identifier">sorted</span><span class="Punctuation">(</span><span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">8</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span><span class="Punctuation">,</span> <span class="Identifier">cmp</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L878" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L878" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="cmpMem-procs-all">
- <div id="cmpMem,pointer,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#cmpMem%2Cpointer%2Cpointer%2CNatural"><span class="Identifier">cmpMem</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Compares the memory blocks <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes will be compared.</p>
- <p>Returns:</p>
- <ul class="simple"><li>a value less than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Operator"><</span> <span class="Identifier">b</span></span></tt></li>
- <li>a value greater than zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Operator">></span> <span class="Identifier">b</span></span></tt></li>
- <li>zero, if <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Operator">==</span> <span class="Identifier">b</span></span></tt></li>
- </ul>
- <p>Like any procedure dealing with raw memory this is <strong>unsafe</strong>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L36" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="compileOption-procs-all">
- <div id="compileOption,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#compileOption%2Cstring%2Cstring"><span class="Identifier">compileOption</span></a><span class="Other">(</span><span class="Identifier">option</span><span class="Other">,</span> <span class="Identifier">arg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"CompileOptionArg"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Can be used to determine an enum compile-time option.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#compileOption,string">compileOption</a> for <tt class="docutils literal"><span class="pre"><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt> options</li>
- <li><a class="reference external" href="#defined,untyped">defined</a></li>
- <li><a class="reference external" href="compilesettings.html">std/compilesettings module</a></li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">when</span> <span class="Identifier">compileOption</span><span class="Punctuation">(</span><span class="StringLit">"opt"</span><span class="Punctuation">,</span> <span class="StringLit">"size"</span><span class="Punctuation">)</span> <span class="Keyword">and</span> <span class="Identifier">compileOption</span><span class="Punctuation">(</span><span class="StringLit">"gc"</span><span class="Punctuation">,</span> <span class="StringLit">"boehm"</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">discard</span> <span class="StringLit">"compiled with optimization for size and uses Boehm's GC"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L131" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="compileOption,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#compileOption%2Cstring"><span class="Identifier">compileOption</span></a><span class="Other">(</span><span class="Identifier">option</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"CompileOption"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Can be used to determine an <tt class="docutils literal"><span class="pre"><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt> compile-time option.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#compileOption,string,string">compileOption</a> for enum options</li>
- <li><a class="reference external" href="#defined,untyped">defined</a></li>
- <li><a class="reference external" href="compilesettings.html">std/compilesettings module</a></li>
- </ul>
- <p><strong class="examples_text">Example: cmd: --floatChecks:off</strong></p>
- <pre class="listing"><span class="Keyword">static</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compileOption</span><span class="Punctuation">(</span><span class="StringLit">"floatchecks"</span><span class="Punctuation">)</span>
- <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">push</span> <span class="Identifier">floatChecks</span><span class="Punctuation">:</span> <span class="Identifier">on</span><span class="Operator">.</span><span class="Punctuation">}</span>
- <span class="Keyword">static</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Identifier">compileOption</span><span class="Punctuation">(</span><span class="StringLit">"floatchecks"</span><span class="Punctuation">)</span>
- <span class="Comment"># floating point NaN and Inf checks enabled in this scope</span>
- <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">pop</span><span class="Operator">.</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L116" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="compiles-procs-all">
- <div id="compiles,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#compiles%2Cuntyped"><span class="Identifier">compiles</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Compiles"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Special compile-time procedure that checks whether <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> can be compiled without any semantic error. This can be used to check whether a type supports some operation:</p>
- <p><pre class="listing"><span class="Keyword">when</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="DecNumber">3</span> <span class="Operator">+</span> <span class="DecNumber">4</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="StringLit">"'+' for integers is available"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L73" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="contains-procs-all">
- <div id="contains,openArray[T],T">
- <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CopenArray%5BT%5D%2CT"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">item</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">item</span></span></tt> is in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> or false if not found. This is a shortcut for <tt class="docutils literal"><span class="pre"><span class="Identifier">find</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">item</span><span class="Punctuation">)</span> <span class="Operator">>=</span> <span class="DecNumber">0</span></span></tt>.</p>
- <p>This allows the <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> operator: <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="Identifier">item</span><span class="Punctuation">)</span></span></tt> is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">item</span> <span class="Keyword">in</span> <span class="Identifier">a</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="DecNumber">3</span> <span class="Keyword">in</span> <span class="Identifier">a</span>
- <span class="Identifier">assert</span> <span class="DecNumber">99</span> <span class="Keyword">notin</span> <span class="Identifier">a</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1766" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1766" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="contains,set[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#contains%2Cset%5BT%5D%2CT"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"InSet"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>One should overload this proc if one wants to overload the <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> operator.</p>
- <p>The parameters are in reverse order! <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Keyword">in</span> <span class="Identifier">b</span></span></tt> is a template for <tt class="docutils literal"><span class="pre"><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">,</span> <span class="Identifier">a</span><span class="Punctuation">)</span></span></tt>. This is because the unification algorithm that Nim uses for overload resolution works from left to right. But for the <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> operator that would be the wrong direction for this piece of code:</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span><span class="Punctuation">:</span> <span class="Identifier">set</span><span class="Punctuation">[</span><span class="Identifier">range</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">']] = {'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">c</span><span class="CharLit">'}</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">c</span><span class="CharLit">')</span>
- <span class="Identifier">assert</span> <span class="CharLit">'b'</span> <span class="Keyword">in</span> <span class="Identifier">s</span>
- <span class="Identifier">assert</span> <span class="CharLit">'d'</span> <span class="Keyword">notin</span> <span class="Identifier">s</span>
- <span class="Identifier">assert</span> <span class="Identifier">set</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">'] is set[range['</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">']]</span></pre>If <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> had been declared as <tt class="docutils literal"><span class="pre"><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">elem</span><span class="Punctuation">:</span> <span class="Identifier">T</span><span class="Punctuation">,</span> <span class="Identifier">s</span><span class="Punctuation">:</span> <span class="Identifier">set</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span><span class="Punctuation">)</span></span></tt> then <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> would have been bound to <tt class="docutils literal"><span class="pre"><span class="Identifier">char</span></span></tt>. But <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> is not compatible to type <tt class="docutils literal"><span class="pre"><span class="Identifier">set</span><span class="Punctuation">[</span><span class="Identifier">char</span><span class="Punctuation">]</span></span></tt>! The solution is to bind <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">range</span><span class="Punctuation">[</span><span class="Punctuation">'</span><span class="Identifier">a</span><span class="CharLit">'..'</span><span class="Identifier">z</span><span class="CharLit">']</span></span></tt>. This is achieved by reversing the parameters for <tt class="docutils literal"><span class="pre"><span class="Identifier">contains</span></span></tt>; <tt class="docutils literal"><span class="pre"><span class="Keyword">in</span></span></tt> then passes its arguments in reverse order.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L70" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="contains,HSlice[U,V],W">
- <dt><pre><span class="Keyword">proc</span> <a href="#contains%2CHSlice%5BU%2CV%5D%2CW"><span class="Identifier">contains</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">,</span> <span class="Identifier">W</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <span class="Identifier">W</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Checks if <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> is within the range of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt>; returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span> <span class="Operator">>=</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">a</span> <span class="Keyword">and</span> <span class="Identifier">value</span> <span class="Operator"><=</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">b</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">contains</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L746" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L746" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="copyMem-procs-all">
- <div id="copyMem,pointer,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#copyMem%2Cpointer%2Cpointer%2CNatural"><span class="Identifier">copyMem</span></a><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Copies the contents from the memory at <tt class="docutils literal"><span class="pre"><span class="Identifier">source</span></span></tt> to the memory at <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>. Exactly <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes will be copied. The memory regions may not overlap. Like any procedure dealing with raw memory this is <strong>unsafe</strong>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L9" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="create-procs-all">
- <div id="create,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#create%2Ctypedesc"><span class="Identifier">create</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">.</span><span class="Identifier">Positive</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T:type</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Allocates a new memory block with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#resize,ptr.T,Natural">resize(block, 0)</a> or <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>. The block is initialized with all bytes containing zero, so it is somewhat safer than <a class="reference external" href="#createU,typedesc">createU</a>.</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#createShared,typedesc">createShared</a> to allocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L134" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L134" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="createShared-procs-all">
- <div id="createShared,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#createShared%2Ctypedesc"><span class="Identifier">createShared</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">.</span><span class="Identifier">Positive</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T:type</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Allocates a new memory block on the shared heap with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#resizeShared,ptr.T,Natural">resizeShared(block, 0)</a> or <a class="reference external" href="#freeShared,ptr.T">freeShared(block)</a>.</p>
- <p>The block is initialized with all bytes containing zero, so it is somewhat safer than <a class="reference external" href="#createSharedU,typedesc">createSharedU</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L250" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="createSharedU-procs-all">
- <div id="createSharedU,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#createSharedU%2Ctypedesc"><span class="Identifier">createSharedU</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">.</span><span class="Identifier">Positive</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T:type</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Allocates a new memory block on the shared heap with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#resizeShared,ptr.T,Natural">resizeShared(block, 0)</a> or <a class="reference external" href="#freeShared,ptr.T">freeShared(block)</a>.</p>
- <p>The block is not initialized, so reading from it before writing to it is undefined behaviour!</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#createShared,typedesc">createShared</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L220" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L220" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="createU-procs-all">
- <div id="createU,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#createU%2Ctypedesc"><span class="Identifier">createU</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">.</span><span class="Identifier">Positive</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T:type</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Allocates a new memory block with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#resize,ptr.T,Natural">resize(block, 0)</a> or <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>. The block is not initialized, so reading from it before writing to it is undefined behaviour!</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#createSharedU,typedesc">createSharedU</a> to allocate from a shared heap.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#create,typedesc">create</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L106" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="cstringArrayToSeq-procs-all">
- <div id="cstringArrayToSeq,cstringArray">
- <dt><pre><span class="Keyword">proc</span> <a href="#cstringArrayToSeq%2CcstringArray"><span class="Identifier">cstringArrayToSeq</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="ctypes.html#cstringArray"><span class="Identifier">cstringArray</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Converts a <tt class="docutils literal"><span class="pre"><span class="Identifier">cstringArray</span></span></tt> to a <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is supposed to be terminated by <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2128" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2128" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="cstringArrayToSeq,cstringArray,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#cstringArrayToSeq%2CcstringArray%2CNatural"><span class="Identifier">cstringArrayToSeq</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="ctypes.html#cstringArray"><span class="Identifier">cstringArray</span></a><span class="Other">;</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Converts a <tt class="docutils literal"><span class="pre"><span class="Identifier">cstringArray</span></span></tt> to a <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> is supposed to be of length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2121" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2121" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="dealloc-procs-all">
- <div id="dealloc,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#dealloc%2Cpointer"><span class="Identifier">dealloc</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span class="Identifier">compilerproc</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Frees the memory allocated with <tt class="docutils literal"><span class="pre"><span class="Identifier">alloc</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">alloc0</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">realloc</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">create</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">createU</span></span></tt>.</p>
- <p><strong>This procedure is dangerous!</strong> If one forgets to free the memory a leak occurs; if one tries to access freed memory (or just freeing it twice!) a core dump may happen or other memory may be corrupted.</p>
- <p>The freed memory must belong to its allocating thread! Use <a class="reference external" href="#deallocShared,pointer">deallocShared</a> to deallocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L190" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L190" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="deallocCStringArray-procs-all">
- <div id="deallocCStringArray,cstringArray">
- <dt><pre><span class="Keyword">proc</span> <a href="#deallocCStringArray%2CcstringArray"><span class="Identifier">deallocCStringArray</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="ctypes.html#cstringArray"><span class="Identifier">cstringArray</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Frees a NULL terminated cstringArray.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2148" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2148" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="deallocImpl-procs-all">
- <div id="deallocImpl,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#deallocImpl%2Cpointer"><span class="Identifier">deallocImpl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L53" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L53" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="deallocShared-procs-all">
- <div id="deallocShared,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#deallocShared%2Cpointer"><span class="Identifier">deallocShared</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span class="Identifier">compilerproc</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Frees the memory allocated with <tt class="docutils literal"><span class="pre"><span class="Identifier">allocShared</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">allocShared0</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">reallocShared</span></span></tt>.</p>
- <p><strong>This procedure is dangerous!</strong> If one forgets to free the memory a leak occurs; if one tries to access freed memory (or just freeing it twice!) a core dump may happen or other memory may be corrupted.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L299" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L299" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="deallocSharedImpl-procs-all">
- <div id="deallocSharedImpl,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#deallocSharedImpl%2Cpointer"><span class="Identifier">deallocSharedImpl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L59" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L59" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="debugEcho-procs-all">
- <div id="debugEcho,varargs[typed,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#debugEcho%2Cvarargs%5Btyped%2C%5D"><span class="Identifier">debugEcho</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Echo"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Same as <a class="reference external" href="#echo,varargs[typed,]">echo</a>, but as a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">debugEcho</span></span></tt> pretends to be free of side effects, so that it can be used for debugging routines marked as <a class="reference external" href="manual.html#pragmas-nosideeffect-pragma">noSideEffect</a>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1936" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1936" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="dec-procs-all">
- <div id="dec,T,V">
- <dt><pre><span class="Keyword">proc</span> <a href="#dec%2CT%2CV"><span class="Identifier">dec</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">V</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Dec"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Decrements the ordinal <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>If such a value does not exist, <tt class="docutils literal"><span class="pre"><span class="Identifier">OverflowDefect</span></span></tt> is raised or a compile time error occurs. This is a short notation for: <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">pred</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="DecNumber">2</span>
- <span class="Identifier">dec</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
- <span class="Identifier">dec</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L31" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="declared-procs-all">
- <div id="declared,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#declared%2Cuntyped"><span class="Identifier">declared</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Declared"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Special compile-time procedure that checks whether <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is declared. <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> has to be an identifier or a qualified identifier.</p>
- <p>This can be used to check whether a library provides a certain feature or not:</p>
- <p><pre class="listing"><span class="Keyword">when</span> <span class="Keyword">not</span> <span class="Identifier">declared</span><span class="Punctuation">(</span><span class="Identifier">strutils</span><span class="Operator">.</span><span class="Identifier">toUpper</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Comment"># provide our own toUpper proc here, because strutils is</span>
- <span class="Comment"># missing it.</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#declaredInScope,untyped">declaredInScope</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="declaredInScope-procs-all">
- <div id="declaredInScope,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#declaredInScope%2Cuntyped"><span class="Identifier">declaredInScope</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DeclaredInScope"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Special compile-time procedure that checks whether <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is declared in the current scope. <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> has to be an identifier.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L69" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L69" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="deepCopy-procs-all">
- <div id="deepCopy,,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#deepCopy%2C%2CT"><span class="Identifier">deepCopy</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">out</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DeepCopy"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Performs a deep copy of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> and copies it into <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>This is also used by the code generator for the implementation of <tt class="docutils literal"><span class="pre"><span class="Identifier">spawn</span></span></tt>.</p>
- <p>For <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">arc</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> deepcopy support has to be enabled via <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">deepcopy</span><span class="Punctuation">:</span><span class="Identifier">on</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2693" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2693" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="deepCopy,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#deepCopy%2CT"><span class="Identifier">deepCopy</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- Convenience wrapper around <tt class="docutils literal"><span class="pre"><span class="Identifier">deepCopy</span></span></tt> overload.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2703" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2703" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="default-procs-all">
- <div id="default,typedesc[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#default%2Ctypedesc%5BT%5D"><span class="Identifier">default</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Default"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the default value of the type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>. Contrary to <tt class="docutils literal"><span class="pre"><span class="Identifier">zeroDefault</span></span></tt>, it takes default fields of an object into consideration.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#zeroDefault,typedesc[T]">zeroDefault</a></li>
- </ul>
- <p><strong class="examples_text">Example: cmd: -d:nimPreviewRangeDefault</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">default</span> <span class="Operator">==</span> <span class="Punctuation">(</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="FloatNumber">0.0</span><span class="Punctuation">)</span>
- <span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">object</span>
- <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">range</span><span class="Punctuation">[</span><span class="FloatNumber">2.</span><span class="Operator">.</span><span class="DecNumber">6</span><span class="Punctuation">]</span>
- <span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">Foo</span><span class="Operator">.</span><span class="Identifier">default</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">a</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L918" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L918" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="defined-procs-all">
- <div id="defined,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#defined%2Cuntyped"><span class="Identifier">defined</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Defined"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Special compile-time procedure that checks whether <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is defined.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is an external symbol introduced through the compiler's <a class="reference external" href="nimc.html#compiler-usage-compileminustime-symbols">-d:x switch</a> to enable build time conditionals:</p>
- <p><pre class="listing"><span class="Keyword">when</span> <span class="Keyword">not</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">release</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Comment"># Do here programmer friendly expensive sanity checks.</span>
- <span class="Comment"># Put here the normal code</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#compileOption,string">compileOption</a> for <tt class="docutils literal"><span class="pre"><span class="Identifier">on</span><span class="Operator">|</span><span class="Identifier">off</span></span></tt> options</li>
- <li><a class="reference external" href="#compileOption,string,string">compileOption</a> for enum options</li>
- <li><a class="reference external" href="manual.html#implementation-specific-pragmas-compileminustime-define-pragmas">define pragmas</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L36" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="del-procs-all">
- <div id="del,seq[T],Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#del%2Cseq%5BT%5D%2CNatural"><span class="Identifier">del</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Deletes the item at index <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt> by putting <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span><span class="Punctuation">[</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">]</span></span></tt> into position <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>.</p>
- <p>This is an <tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt> operation.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#delete,seq[T],Natural">delete</a> for preserving the order</li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">11</span><span class="Punctuation">,</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="DecNumber">13</span><span class="Punctuation">,</span> <span class="DecNumber">14</span><span class="Punctuation">]</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">del</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">11</span><span class="Punctuation">,</span> <span class="DecNumber">14</span><span class="Punctuation">,</span> <span class="DecNumber">13</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1216" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1216" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="delete-procs-all">
- <div id="delete,seq[T],Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#delete%2Cseq%5BT%5D%2CNatural"><span class="Identifier">delete</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">systemRaisesDefect</span>.}</pre></dt>
- <dd>
-
- <p>Deletes the item at index <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt> by moving all <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Operator">+</span><span class="FloatNumber">1.</span><span class="Operator">.^</span><span class="DecNumber">1</span><span class="Punctuation">]</span></span></tt> items by one position.</p>
- <p>This is an <tt class="docutils literal"><span class="pre"><span class="Identifier">O</span><span class="Punctuation">(</span><span class="Identifier">n</span><span class="Punctuation">)</span></span></tt> operation.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#del,seq[T],Natural">del</a> for O(1) operation</li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
- <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">delete</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">s</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2016" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2016" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="dispose-procs-all">
- <div id="dispose,ForeignCell">
- <dt><pre><span class="Keyword">proc</span> <a href="#dispose%2CForeignCell"><span class="Identifier">dispose</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#ForeignCell"><span class="Identifier">ForeignCell</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/mmdisp.nim#L119" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/mmdisp.nim#L119" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="div-procs-all">
- <div id="div,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cint%2Cint"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Computes the integer division.</p>
- <p>This is roughly the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">math</span><span class="Operator">.</span><span class="Identifier">trunc</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">/</span><span class="Identifier">y</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">int</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Keyword">div</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">2</span> <span class="Keyword">div</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">3</span> <span class="Keyword">div</span> <span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">7</span> <span class="Keyword">div</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">7</span> <span class="Keyword">div</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">7</span> <span class="Keyword">div</span> <span class="Operator">-</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">7</span> <span class="Keyword">div</span> <span class="Operator">-</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L96" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L96" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cint8%2Cint8"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L108" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cint16%2Cint16"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L109" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L109" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cint32%2Cint32"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L110" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L110" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cint64%2Cint64"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L111" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L111" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cuint%2Cuint"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the integer division for unsigned integers. This is roughly the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">trunc</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Operator">/</span><span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L283" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L283" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cuint8%2Cuint8"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L286" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L286" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cuint16%2Cuint16"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L287" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L287" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cuint32%2Cuint32"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L288" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L288" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="div,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#div%2Cuint64%2Cuint64"><span class="Identifier">`div`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"DivU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L289" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L289" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="echo-procs-all">
- <div id="echo,varargs[typed,]">
- <dt><pre><span class="Keyword">proc</span> <a href="#echo%2Cvarargs%5Btyped%2C%5D"><span class="Identifier">echo</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">,</span> <span class="Other">`</span><span class="Operator">$</span><span class="Other">`</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Echo"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">sideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Writes and flushes the parameters to the standard output.</p>
- <p>Special built-in that takes a variable number of arguments. Each argument is converted to a string via <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt>, so it works for user-defined types that have an overloaded <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> operator. It is roughly equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">writeLine</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">,</span> <span class="Identifier">x</span><span class="Punctuation">)</span><span class="Punctuation">;</span> <span class="Identifier">flushFile</span><span class="Punctuation">(</span><span class="Identifier">stdout</span><span class="Punctuation">)</span></span></tt>, but available for the JavaScript target too.</p>
- <p>Unlike other IO operations this is guaranteed to be thread-safe as <tt class="docutils literal"><span class="pre"><span class="Identifier">echo</span></span></tt> is very often used for debugging convenience. If you want to use <tt class="docutils literal"><span class="pre"><span class="Identifier">echo</span></span></tt> inside a <a class="reference external" href="manual.html#pragmas-nosideeffect-pragma">proc without side effects</a> you can use <a class="reference external" href="#debugEcho,varargs[typed,]">debugEcho</a> instead.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1921" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1921" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ensureMove-procs-all">
- <div id="ensureMove,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#ensureMove%2CT"><span class="Identifier">ensureMove</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"EnsureMove"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Ensures that <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is moved to the new location, otherwise it gives an error at the compile time.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">foo</span> <span class="Operator">=</span>
- <span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="StringLit">"Hello"</span>
- <span class="Keyword">let</span> <span class="Identifier">y</span> <span class="Operator">=</span> <span class="Identifier">ensureMove</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">y</span> <span class="Operator">==</span> <span class="StringLit">"Hello"</span>
- <span class="Identifier">foo</span><span class="Punctuation">(</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L177" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="equalMem-procs-all">
- <div id="equalMem,pointer,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#equalMem%2Cpointer%2Cpointer%2CNatural"><span class="Identifier">equalMem</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Compares the memory blocks <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes will be compared.</p>
- <p>If the blocks are equal, <tt class="docutils literal"><span class="pre"><span class="Identifier">true</span></span></tt> is returned, <tt class="docutils literal"><span class="pre"><span class="Identifier">false</span></span></tt> otherwise. Like any procedure dealing with raw memory this is <strong>unsafe</strong>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="excl-procs-all">
- <div id="excl,set[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#excl%2Cset%5BT%5D%2CT"><span class="Identifier">excl</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Excl"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Excludes element <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">x</span> <span class="Operator">-</span> <span class="Punctuation">{</span><span class="Identifier">y</span><span class="Punctuation">}</span></span></tt>, but it might be more efficient.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="DecNumber">54</span><span class="Punctuation">}</span>
- <span class="Identifier">b</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">12</span><span class="Punctuation">,</span> <span class="DecNumber">54</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L24" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="find-procs-all">
- <div id="find,T,S">
- <dt><pre><span class="Keyword">proc</span> <a href="#find%2CT%2CS"><span class="Identifier">find</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">S</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">item</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Returns the first index of <tt class="docutils literal"><span class="pre"><span class="Identifier">item</span></span></tt> in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> or -1 if not found. This requires appropriate <tt class="docutils literal"><span class="pre"><span class="Identifier">items</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Operator">==</span></span></tt> operations to work.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1757" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1757" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="finished-procs-all">
- <div id="finished,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#finished%2CT"><span class="Identifier">finished</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">iterator</span> {.<span class="Identifier">closure</span>.}<span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Finished"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- It can be used to determine if a first class iterator has finished.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2373" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2373" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="freeShared-procs-all">
- <div id="freeShared,ptr.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#freeShared%2Cptr.T"><span class="Identifier">freeShared</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Frees the memory allocated with <tt class="docutils literal"><span class="pre"><span class="Identifier">createShared</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">createSharedU</span></span></tt> or <tt class="docutils literal"><span class="pre"><span class="Identifier">resizeShared</span></span></tt>.</p>
- <p><strong>This procedure is dangerous!</strong> If one forgets to free the memory a leak occurs; if one tries to access freed memory (or just freeing it twice!) a core dump may happen or other memory may be corrupted.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L310" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L310" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_disableMarkAndSweep-procs-all">
- <div id="GC_disableMarkAndSweep">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_disableMarkAndSweep"><span class="Identifier">GC_disableMarkAndSweep</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- For <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">GC_disableOrc</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L486" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L486" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_disableOrc-procs-all">
- <div id="GC_disableOrc">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_disableOrc"><span class="Identifier">GC_disableOrc</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Disables the cycle collector subsystem of <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt>. This is a <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> specific API. Check with <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">gcOrc</span><span class="Punctuation">)</span></span></tt> for its existence.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L466" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L466" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_enableMarkAndSweep-procs-all">
- <div id="GC_enableMarkAndSweep">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_enableMarkAndSweep"><span class="Identifier">GC_enableMarkAndSweep</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- For <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">GC_enableOrc</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L482" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L482" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_enableOrc-procs-all">
- <div id="GC_enableOrc">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_enableOrc"><span class="Identifier">GC_enableOrc</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Enables the cycle collector subsystem of <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt>. This is a <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> specific API. Check with <tt class="docutils literal"><span class="pre"><span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">gcOrc</span><span class="Punctuation">)</span></span></tt> for its existence.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L460" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L460" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_fullCollect-procs-all">
- <div id="GC_fullCollect">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_fullCollect"><span class="Identifier">GC_fullCollect</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Forces a full garbage collection pass. With <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">orc</span></span></tt> triggers the cycle collector. This is an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">GC_runOrc</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L477" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L477" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_getStatistics-procs-all">
- <div id="GC_getStatistics">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_getStatistics"><span class="Identifier">GC_getStatistics</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/strmantle.nim#L258" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/strmantle.nim#L258" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_partialCollect-procs-all">
- <div id="GC_partialCollect,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_partialCollect%2Cint"><span class="Identifier">GC_partialCollect</span></a><span class="Other">(</span><span class="Identifier">limit</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L474" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L474" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_prepareOrc-procs-all">
- <div id="GC_prepareOrc">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_prepareOrc"><span class="Identifier">GC_prepareOrc</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L472" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L472" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_ref-procs-all">
- <div id="GC_ref,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_ref%2Cref.T"><span class="Identifier">GC_ref</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- New runtime only supports this operation for 'ref T'.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L248" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L248" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_runOrc-procs-all">
- <div id="GC_runOrc">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_runOrc"><span class="Identifier">GC_runOrc</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">Exception</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Forces a cycle collection pass.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/orc.nim#L455" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/orc.nim#L455" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="GC_unref-procs-all">
- <div id="GC_unref,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#GC_unref%2Cref.T"><span class="Identifier">GC_unref</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
- <dd>
-
- New runtime only supports this operation for 'ref T'.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L243" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L243" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getAllocStats-procs-all">
- <div id="getAllocStats">
- <dt><pre><span class="Keyword">proc</span> <a href="#getAllocStats"><span class="Identifier">getAllocStats</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#AllocStats"><span class="Identifier">AllocStats</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L88" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L88" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getCurrentException-procs-all">
- <div id="getCurrentException">
- <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentException"><span class="Identifier">getCurrentException</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Retrieves the current exception; if there is none, <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt> is returned.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2295" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2295" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getCurrentExceptionMsg-procs-all">
- <div id="getCurrentExceptionMsg">
- <dt><pre><span class="Keyword">proc</span> <a href="#getCurrentExceptionMsg"><span class="Identifier">getCurrentExceptionMsg</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Retrieves the error message that was attached to the current exception; if there is none, <tt class="docutils literal"><span class="pre"><span class="StringLit">""</span></span></tt> is returned.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2304" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2304" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getFrame-procs-all">
- <div id="getFrame">
- <dt><pre><span class="Keyword">proc</span> <a href="#getFrame"><span class="Identifier">getFrame</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#PFrame"><span class="Identifier">PFrame</span></a> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L116" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L116" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getFrameState-procs-all">
- <div id="getFrameState">
- <dt><pre><span class="Keyword">proc</span> <a href="#getFrameState"><span class="Identifier">getFrameState</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">FrameState</span> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L100" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getFreeMem-procs-all">
- <div id="getFreeMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getFreeMem"><span class="Identifier">getFreeMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes that are owned by the process, but do not hold any meaningful data.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L409" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L409" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getFreeSharedMem-procs-all">
- <div id="getFreeSharedMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getFreeSharedMem"><span class="Identifier">getFreeSharedMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes that are owned by the process on the shared heap, but do not hold any meaningful data. This is only available when threads are enabled.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L442" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L442" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getMaxMem-procs-all">
- <div id="getMaxMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getMaxMem"><span class="Identifier">getMaxMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/alloc.nim#L1267" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/alloc.nim#L1267" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getOccupiedMem-procs-all">
- <div id="getOccupiedMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getOccupiedMem"><span class="Identifier">getOccupiedMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes that are owned by the process and hold data.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L406" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L406" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getOccupiedSharedMem-procs-all">
- <div id="getOccupiedSharedMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getOccupiedSharedMem"><span class="Identifier">getOccupiedSharedMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes that are owned by the process on the shared heap and hold data. This is only available when threads are enabled.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L437" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L437" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getStackTrace-procs-all">
- <div id="getStackTrace">
- <dt><pre><span class="Keyword">proc</span> <a href="#getStackTrace"><span class="Identifier">getStackTrace</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Gets the current stack trace. This only works for debug builds.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2199" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2199" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="getStackTrace,ref.Exception">
- <dt><pre><span class="Keyword">proc</span> <a href="#getStackTrace%2Cref.Exception"><span class="Identifier">getStackTrace</span></a><span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Gets the stack trace associated with <tt class="docutils literal"><span class="pre"><span class="Identifier">e</span></span></tt>, which is the stack that lead to the <tt class="docutils literal"><span class="pre"><span class="Keyword">raise</span></span></tt> statement. This only works for debug builds.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2202" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2202" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getStackTraceEntries-procs-all">
- <div id="getStackTraceEntries">
- <dt><pre><span class="Keyword">proc</span> <a href="#getStackTraceEntries"><span class="Identifier">getStackTraceEntries</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#StackTraceEntry"><span class="Identifier">StackTraceEntry</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the stack trace entries for the current stack trace. This is not yet available for the JS backend.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L553" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L553" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="getStackTraceEntries,ref.Exception">
- <dt><pre><span class="Keyword">proc</span> <a href="#getStackTraceEntries%2Cref.Exception"><span class="Identifier">getStackTraceEntries</span></a><span class="Other">(</span><span class="Identifier">e</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#lent"><span class="Identifier">lent</span></a> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#StackTraceEntry"><span class="Identifier">StackTraceEntry</span></a><span class="Other">]</span> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L548" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L548" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getThreadId-procs-all">
- <div id="getThreadId">
- <dt><pre><span class="Keyword">proc</span> <a href="#getThreadId"><span class="Identifier">getThreadId</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Gets the ID of the currently running thread.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/threadids.nim#L30" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/threadids.nim#L30" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getTotalMem-procs-all">
- <div id="getTotalMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getTotalMem"><span class="Identifier">getTotalMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes that are owned by the process.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L413" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L413" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getTotalSharedMem-procs-all">
- <div id="getTotalSharedMem">
- <dt><pre><span class="Keyword">proc</span> <a href="#getTotalSharedMem"><span class="Identifier">getTotalSharedMem</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the number of bytes on the shared heap that are owned by the process. This is only available when threads are enabled.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L447" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L447" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="getTypeInfo-procs-all">
- <div id="getTypeInfo,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#getTypeInfo%2CT"><span class="Identifier">getTypeInfo</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"GetTypeInfo"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Get type information for <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>Ordinary code should not use this, but the <a class="reference external" href="typeinfo.html">typeinfo module</a> instead.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1948" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1948" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="gorge-procs-all">
- <div id="gorge,string,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#gorge%2Cstring%2Cstring%2Cstring"><span class="Identifier">gorge</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">input</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">cache</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"StaticExec"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- This is an alias for <a class="reference external" href="#staticExec,string,string,string">staticExec</a>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L174" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L174" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="gorgeEx-procs-all">
- <div id="gorgeEx,string,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#gorgeEx%2Cstring%2Cstring%2Cstring"><span class="Identifier">gorgeEx</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">input</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">cache</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">output</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span>
- <span class="Identifier">exitCode</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span class="Identifier">noinit</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Similar to <a class="reference external" href="#gorge,string,string,string">gorge</a> but also returns the precious exit code.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="grow-procs-all">
- <div id="grow,seq[T],Natural,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#grow%2Cseq%5BT%5D%2CNatural%2CT"><span class="Identifier">grow</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">newLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">nodestroy</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L138" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L138" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="high-procs-all">
- <div id="high,typedesc[SomeFloat]">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Ctypedesc%5BSomeFloat%5D"><span class="Identifier">high</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1288" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1288" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Ccstring"><span class="Identifier">high</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible index of a compatible string <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. This is sometimes an O(n) operation.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,cstring">low(cstring)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L268" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L268" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Cstring"><span class="Identifier">high</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible index of a string <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">str</span> <span class="Operator">=</span> <span class="StringLit">"Hello world!"</span>
- <span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">str</span><span class="Punctuation">)</span> <span class="Comment"># => 11</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,string">low(string)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L275" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L275" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,array[I,T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Carray%5BI%2CT%5D"><span class="Identifier">high</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">I</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible index of an array <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>For empty arrays, the return type is <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">arr</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span> <span class="Comment"># => 6</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">arr</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,array[I,T]">low(array)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L243" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L243" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,typedesc[array[I,T]]">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Ctypedesc%5Barray%5BI%2CT%5D%5D"><span class="Identifier">high</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">I</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible index of an array type.</p>
- <p>For empty arrays, the return type is <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Comment"># => 6</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,typedesc[array[I,T]]">low(typedesc[array])</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L257" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2CT"><span class="Identifier">high</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"Deprecated since v1.4; there should not be `high(value)`. Use `high(type)`."</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> Deprecated since v1.4; there should not be `high(value)`. Use `high(type)`.
- </div>
- <p>Returns the highest possible value of an ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>As a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> may also be a type identifier.</p>
- <p><strong>This proc is deprecated</strong>, use this one instead:</p>
- <ul class="simple"><li><a class="reference external" href="#high,typedesc[T]">high(typedesc)</a></li>
- </ul>
- <p><pre class="listing"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Comment"># => 9223372036854775807</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L207" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L207" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,typedesc[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2Ctypedesc%5BT%5D"><span class="Identifier">high</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible value of an ordinal or enum type.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span></span></tt> is Nim's way of writing <span id="int-max_1">INT_MAX</span> or <span id="max-int_1">MAX_INT</span>.</p>
- <p><pre class="listing"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Comment"># => 9223372036854775807</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,typedesc[T]">low(typedesc)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L220" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L220" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="high,openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#high%2CopenArray%5BT%5D"><span class="Identifier">high</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"High"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the highest possible index of a sequence <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Comment"># => 6</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#low,openArray[T]">low(openArray)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L231" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L231" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="inc-procs-all">
- <div id="inc,T,V">
- <dt><pre><span class="Keyword">proc</span> <a href="#inc%2CT%2CV"><span class="Identifier">inc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">V</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Inc"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Increments the ordinal <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> by <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p>If such a value does not exist, <tt class="docutils literal"><span class="pre"><span class="Identifier">OverflowDefect</span></span></tt> is raised or a compile time error occurs. This is a short notation for: <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">succ</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">,</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="DecNumber">2</span>
- <span class="Identifier">inc</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">inc</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">i</span> <span class="Operator">==</span> <span class="DecNumber">6</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L19" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L19" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="incl-procs-all">
- <div id="incl,set[T],T">
- <dt><pre><span class="Keyword">func</span> <a href="#incl%2Cset%5BT%5D%2CT"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Incl"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Includes element <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">x</span> <span class="Operator">+</span> <span class="Punctuation">{</span><span class="Identifier">y</span><span class="Punctuation">}</span></span></tt>, but it might be more efficient.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="DecNumber">4</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="insert-procs-all">
- <div id="insert,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#insert%2Cstring%2Cstring"><span class="Identifier">insert</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">item</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">.</span><span class="Identifier">Natural</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Inserts <tt class="docutils literal"><span class="pre"><span class="Identifier">item</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> at position <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abc"</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">insert</span><span class="Punctuation">(</span><span class="StringLit">"zz"</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Comment"># a <- "zzabc"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2548" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2548" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="insert,seq[T],sinkT">
- <dt><pre><span class="Keyword">proc</span> <a href="#insert%2Cseq%5BT%5D%2CsinkT"><span class="Identifier">insert</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">item</span><span class="Other">:</span> <a href="system.html#sink"><span class="Identifier">sink</span></a> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">i</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">.</span><span class="Identifier">Natural</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Inserts <tt class="docutils literal"><span class="pre"><span class="Identifier">item</span></span></tt> into <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> at position <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">i</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span>
- <span class="Identifier">i</span><span class="Operator">.</span><span class="Identifier">insert</span><span class="Punctuation">(</span><span class="DecNumber">99</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">)</span> <span class="Comment"># i <- @[99, 1, 3, 5]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1231" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1231" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="instantiationInfo-procs-all">
- <div id="instantiationInfo,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#instantiationInfo%2Cint"><span class="Identifier">instantiationInfo</span></a><span class="Other">(</span><span class="Identifier">index</span> <span class="Other">=</span> <span class="DecNumber">-1</span><span class="Other">;</span> <span class="Identifier">fullPaths</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">tuple</span><span class="Other">[</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">,</span>
- <span class="Identifier">line</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">,</span> <span class="Identifier">column</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"InstantiationInfo"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Provides access to the compiler's instantiation stack line information of a template.</p>
- <p>While similar to the <span id="caller-info_1">caller info</span> of other languages, it is determined at compile time.</p>
- <p>This proc is mostly useful for meta programming (eg. <tt class="docutils literal"><span class="pre"><span class="Identifier">assert</span></span></tt> template) to retrieve information about the current filename and line number. Example:</p>
- <p><pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">strutils</span>
- <span class="Keyword">template</span> <span class="Identifier">testException</span><span class="Punctuation">(</span><span class="Identifier">exception</span><span class="Punctuation">,</span> <span class="Identifier">code</span><span class="Punctuation">:</span> <span class="Identifier">untyped</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">typed</span> <span class="Operator">=</span>
- <span class="Keyword">try</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">pos</span> <span class="Operator">=</span> <span class="Identifier">instantiationInfo</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Keyword">discard</span><span class="Punctuation">(</span><span class="Identifier">code</span><span class="Punctuation">)</span>
- <span class="Identifier">echo</span> <span class="StringLit">"Test failure at $1:$2 with '$3'"</span> <span class="Operator">%</span> <span class="Punctuation">[</span><span class="Identifier">pos</span><span class="Operator">.</span><span class="Identifier">filename</span><span class="Punctuation">,</span>
- <span class="Operator">$</span><span class="Identifier">pos</span><span class="Operator">.</span><span class="Identifier">line</span><span class="Punctuation">,</span> <span class="Identifier">astToStr</span><span class="Punctuation">(</span><span class="Identifier">code</span><span class="Punctuation">)</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">false</span><span class="Punctuation">,</span> <span class="StringLit">"A test expecting failure succeeded?"</span>
- <span class="Keyword">except</span> <span class="Identifier">exception</span><span class="Punctuation">:</span>
- <span class="Keyword">discard</span>
- <span class="Keyword">proc</span> <span class="Identifier">tester</span><span class="Punctuation">(</span><span class="Identifier">pos</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span>
- <span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span>
- <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">pos</span><span class="Punctuation">]</span>
- <span class="Keyword">when</span> <span class="Identifier">isMainModule</span><span class="Punctuation">:</span>
- <span class="Identifier">testException</span><span class="Punctuation">(</span><span class="Identifier">IndexDefect</span><span class="Punctuation">,</span> <span class="Identifier">tester</span><span class="Punctuation">(</span><span class="DecNumber">30</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Identifier">testException</span><span class="Punctuation">(</span><span class="Identifier">IndexDefect</span><span class="Punctuation">,</span> <span class="Identifier">tester</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Comment"># --> Test failure at example.nim:20 with 'tester(1)'</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1564" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1564" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="is-procs-all">
- <div id="is,T,S">
- <dt><pre><span class="Keyword">proc</span> <a href="#is%2CT%2CS"><span class="Identifier">`is`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">S</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Is"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Checks if <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> is of the same type as <tt class="docutils literal"><span class="pre"><span class="Identifier">S</span></span></tt>.</p>
- <p>For a negated version, use <a class="reference external" href="#isnot.t,untyped,untyped">isnot</a>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span> <span class="DecNumber">42</span> <span class="Keyword">is</span> <span class="Identifier">int</span>
- <span class="Identifier">assert</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Keyword">is</span> <span class="Identifier">seq</span>
- <span class="Keyword">proc</span> <span class="Identifier">test</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">T</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span>
- <span class="Keyword">when</span> <span class="Punctuation">(</span><span class="Identifier">T</span> <span class="Keyword">is</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">return</span> <span class="Identifier">a</span>
- <span class="Keyword">else</span><span class="Punctuation">:</span>
- <span class="Keyword">return</span> <span class="DecNumber">0</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">test</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Identifier">test</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="StringLit">"xyz"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L772" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L772" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="isNil-procs-all">
- <div id="isNil,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNil%2Ccstring"><span class="Identifier">isNil</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsNil"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1449" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1449" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="isNil,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNil%2Cpointer"><span class="Identifier">isNil</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsNil"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1448" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1448" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="isNil,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNil%2CT"><span class="Identifier">isNil</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Operator">|</span> <span class="Keyword">iterator</span> {.<span class="Identifier">closure</span>.}<span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsNil"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Fast check whether <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is nil. This is sometimes more efficient than <tt class="docutils literal"><span class="pre"><span class="Operator">==</span> <span class="Keyword">nil</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1450" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1450" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="isNil,ptr.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNil%2Cptr.T"><span class="Identifier">isNil</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsNil"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1447" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1447" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="isNil,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNil%2Cref.T"><span class="Identifier">isNil</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"IsNil"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1445" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1445" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="isNotForeign-procs-all">
- <div id="isNotForeign,ForeignCell">
- <dt><pre><span class="Keyword">proc</span> <a href="#isNotForeign%2CForeignCell"><span class="Identifier">isNotForeign</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#ForeignCell"><span class="Identifier">ForeignCell</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/mmdisp.nim#L120" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/mmdisp.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="isUniqueRef-procs-all">
- <div id="isUniqueRef,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#isUniqueRef%2Cref.T"><span class="Identifier">isUniqueRef</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Returns true if the object <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> points to is uniquely referenced. Such an object can potentially be passed over to a different thread safely, if great care is taken. This queries the internal reference count of the object which is subject to lots of optimizations! In other words the value of <tt class="docutils literal"><span class="pre"><span class="Identifier">isUniqueRef</span></span></tt> can depend on the used compiler version and optimizer setting. Nevertheless it can be used as a very valuable debugging tool and can be used to specify the constraints of a threading related API via <tt class="docutils literal"><span class="pre"><span class="Identifier">assert</span> <span class="Identifier">isUniqueRef</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L136" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L136" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="iterToProc-procs-all">
- <div id="iterToProc,typed,typedesc,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#iterToProc%2Ctyped%2Ctypedesc%2Cuntyped"><span class="Identifier">iterToProc</span></a><span class="Other">(</span><span class="Identifier">iter</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">;</span> <span class="Identifier">envType</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">procName</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Plugin"</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/alloc.nim#L490" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/alloc.nim#L490" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="len-procs-all">
- <div id="len">
- <dt><pre><span class="Keyword">func</span> <a href="#len"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Other">(</span><span class="Keyword">type</span> <span class="Identifier">array</span><span class="Other">)</span> <span class="Operator">|</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LengthArray"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the length of an array or an array type. This is roughly the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">T</span><span class="Punctuation">)</span><span class="Operator">-</span><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">T</span><span class="Punctuation">)</span><span class="Operator">+</span><span class="DecNumber">1</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">assert</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Keyword">static</span><span class="Punctuation">:</span> <span class="Identifier">assert</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="Operator">-</span><span class="FloatNumber">2.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="Identifier">float</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">5</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L700" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L700" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#len%2Ccstring"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LengthStr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the length of a compatible string. This is an O(n) operation except in js at runtime.</p>
- <p><strong>Note:</strong> On the JS backend this currently counts UTF-16 code points instead of bytes at runtime (not at compile time). For now, if you need the byte length of the UTF-8 encoding, convert to string with <tt class="docutils literal"><span class="pre"><span class="Operator">$</span></span></tt> first then call <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="RawData">cstring"abc"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">cstring</span> <span class="RawData">r"ab\0c"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span> <span class="Comment"># \0 is escaped</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="RawData">cstring"ab\0c"</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">5</span> <span class="Comment"># ditto</span>
- <span class="Keyword">var</span> <span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">cstring</span> <span class="Operator">=</span> <span class="StringLit">"ab</span><span class="EscapeSequence">\0</span><span class="StringLit">c"</span>
- <span class="Keyword">when</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">js</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">4</span> <span class="Comment"># len ignores \0 for js</span>
- <span class="Keyword">else</span><span class="Punctuation">:</span> <span class="Identifier">doAssert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment"># \0 is a null terminator</span>
- <span class="Keyword">static</span><span class="Punctuation">:</span>
- <span class="Keyword">var</span> <span class="Identifier">a2</span><span class="Punctuation">:</span> <span class="Identifier">cstring</span> <span class="Operator">=</span> <span class="StringLit">"ab</span><span class="EscapeSequence">\0</span><span class="StringLit">c"</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">a2</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">2</span> <span class="Comment"># \0 is a null terminator, even in js vm</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L681" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L681" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,string">
- <dt><pre><span class="Keyword">func</span> <a href="#len%2Cstring"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LengthStr"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the length of a string.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="StringLit">"abc"</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">assert</span> <span class="StringLit">""</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">assert</span> <span class="Identifier">string</span><span class="Operator">.</span><span class="Identifier">default</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L674" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L674" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,seq[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#len%2Cseq%5BT%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LengthSeq"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the length of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">default</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">assert</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Identifier">newSeqOfCap</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L709" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L709" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,set[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#len%2Cset%5BT%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Card"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- An alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">card</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L51" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,TOpenArray">
- <dt><pre><span class="Keyword">func</span> <a href="#len%2CTOpenArray"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">TOpenArray</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a> <span class="Operator">|</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">TOpenArray</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"LengthOpenArray"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the length of an openArray.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">bar</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">:</span> <span class="Identifier">openArray</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">bar</span><span class="Punctuation">(</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span><span class="DecNumber">2</span><span class="Punctuation">]</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L667" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L667" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="len,HSlice[U: Ordinal,V: Ordinal]">
- <dt><pre><span class="Keyword">proc</span> <a href="#len%2CHSlice%5BU%3A%20Ordinal%2CV%3A%20Ordinal%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">;</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">U</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Length of ordinal slice. When x.b < x.a returns zero length.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="FloatNumber">0.</span><span class="Operator">.</span><span class="DecNumber">5</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">6</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="Punctuation">(</span><span class="FloatNumber">5.</span><span class="Operator">.</span><span class="DecNumber">2</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">len</span> <span class="Operator">==</span> <span class="DecNumber">0</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1437" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1437" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="locals-procs-all">
- <div id="locals">
- <dt><pre><span class="Keyword">proc</span> <a href="#locals"><span class="Identifier">locals</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#RootObj"><span class="Identifier">RootObj</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Plugin"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Generates a tuple constructor expression listing all the local variables in the current scope.</p>
- <p>This is quite fast as it does not rely on any debug or runtime information. Note that in contrast to what the official signature says, the return type is <em>not</em> <tt class="docutils literal"><span class="pre"><span class="Identifier">RootObj</span></span></tt> but a tuple of a structure that depends on the current scope. Example:</p>
- <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">testLocals</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span>
- <span class="Keyword">var</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"something"</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="DecNumber">4</span>
- <span class="Identifier">c</span> <span class="Operator">=</span> <span class="Identifier">locals</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">d</span> <span class="Operator">=</span> <span class="StringLit">"super!"</span>
-
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="DecNumber">1</span>
- <span class="Keyword">for</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Identifier">fieldPairs</span><span class="Punctuation">(</span><span class="Identifier">c</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="StringLit">"name "</span><span class="Punctuation">,</span> <span class="Identifier">name</span><span class="Punctuation">,</span> <span class="StringLit">" with value "</span><span class="Punctuation">,</span> <span class="Identifier">value</span>
- <span class="Identifier">echo</span> <span class="StringLit">"B is "</span><span class="Punctuation">,</span> <span class="Identifier">b</span>
- <span class="Comment"># -> name a with value something</span>
- <span class="Comment"># -> name b with value 4</span>
- <span class="Comment"># -> B is 1</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2664" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2664" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="low-procs-all">
- <div id="low,typedesc[SomeFloat]">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Ctypedesc%5BSomeFloat%5D"><span class="Identifier">low</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1289" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1289" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,cstring">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Ccstring"><span class="Identifier">low</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible index of a compatible string <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,cstring">high(cstring)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L345" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L345" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Cstring"><span class="Identifier">low</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible index of a string <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">str</span> <span class="Operator">=</span> <span class="StringLit">"Hello world!"</span>
- <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">str</span><span class="Punctuation">)</span> <span class="Comment"># => 0</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,string">high(string)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L351" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L351" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,array[I,T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Carray%5BI%2CT%5D"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">I</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible index of an array <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>For empty arrays, the return type is <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">arr</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span> <span class="Comment"># => 0</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">arr</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">arr</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,array[I,T]">high(array)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L320" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L320" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,typedesc[array[I,T]]">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Ctypedesc%5Barray%5BI%2CT%5D%5D"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">I</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible index of an array type.</p>
- <p>For empty arrays, the return type is <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Comment"># => 0</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,typedesc[array[I,T]]">high(typedesc[array])</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L334" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L334" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2CT"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"Deprecated since v1.4; there should not be `low(value)`. Use `low(type)`."</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> Deprecated since v1.4; there should not be `low(value)`. Use `low(type)`.
- </div>
- <p>Returns the lowest possible value of an ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. As a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> may also be a type identifier.</p>
- <p><strong>This proc is deprecated</strong>, use this one instead:</p>
- <ul class="simple"><li><a class="reference external" href="#low,typedesc[T]">low(typedesc)</a></li>
- </ul>
- <p><pre class="listing"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Comment"># => -9223372036854775808</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L285" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L285" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,typedesc[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2Ctypedesc%5BT%5D"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span> <span class="Operator">|</span> <a href="system.html#range"><span class="Identifier">range</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible value of an ordinal or enum type.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span></span></tt> is Nim's way of writing <span id="int-min_1">INT_MIN</span> or <span id="min-int_1">MIN_INT</span>.</p>
- <p><pre class="listing"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Comment"># => -9223372036854775808</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,typedesc[T]">high(typedesc)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L297" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L297" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="low,openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#low%2CopenArray%5BT%5D"><span class="Identifier">low</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Low"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the lowest possible index of a sequence <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span> <span class="Comment"># => 0</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#high,openArray[T]">high(openArray)</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L308" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L308" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="max-procs-all">
- <div id="max,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cfloat32%2Cfloat32"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L253" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L253" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,float64,float64">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cfloat64%2Cfloat64"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L255" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L255" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cint%2Cint"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MaxI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L242" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L242" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cint8%2Cint8"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MaxI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L244" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L244" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cint16%2Cint16"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MaxI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L246" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L246" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cint32%2Cint32"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MaxI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L248" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L248" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2Cint64%2Cint64"><span class="Identifier">max</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MaxI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- The maximum value of two integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L250" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2CT%2CT"><span class="Identifier">max</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">not</span> <a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Generic maximum operator of 2 values based on <tt class="docutils literal"><span class="pre"><span class="Operator"><=</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L257" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="max,openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#max%2CopenArray%5BT%5D"><span class="Identifier">max</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- The maximum value of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> needs to have a <tt class="docutils literal"><span class="pre"><span class="Operator"><</span></span></tt> operator.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L268" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L268" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="min-procs-all">
- <div id="min,float32,float32">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cfloat32%2Cfloat32"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float32"><span class="Identifier">float32</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L234" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L234" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,float64,float64">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cfloat64%2Cfloat64"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float64"><span class="Identifier">float64</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L236" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cint%2Cint"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L223" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L223" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cint8%2Cint8"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L225" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L225" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cint16%2Cint16"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L227" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L227" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cint32%2Cint32"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L229" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L229" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2Cint64%2Cint64"><span class="Identifier">min</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"MinI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- The minimum value of two integers.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L231" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L231" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2CT%2CT"><span class="Identifier">min</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">not</span> <a href="system.html#SomeFloat"><span class="Identifier">SomeFloat</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Generic minimum operator of 2 values based on <tt class="docutils literal"><span class="pre"><span class="Operator"><=</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L238" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L238" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="min,openArray[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#min%2CopenArray%5BT%5D"><span class="Identifier">min</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
- <dd>
-
- The minimum value of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> needs to have a <tt class="docutils literal"><span class="pre"><span class="Operator"><</span></span></tt> operator.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L262" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L262" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="mod-procs-all">
- <div id="mod,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cint%2Cint"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Computes the integer modulo operation (remainder).</p>
- <p>This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">-</span> <span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Keyword">div</span> <span class="Identifier">y</span><span class="Punctuation">)</span> <span class="Operator">*</span> <span class="Identifier">y</span></span></tt>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">7</span> <span class="Keyword">mod</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">7</span> <span class="Keyword">mod</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="DecNumber">7</span> <span class="Keyword">mod</span> <span class="Operator">-</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="Operator">-</span><span class="DecNumber">7</span> <span class="Keyword">mod</span> <span class="Operator">-</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L113" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L113" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cint8%2Cint8"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L122" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L122" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cint16%2Cint16"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L123" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cint32%2Cint32"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L124" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cint64%2Cint64"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L125" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L125" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cuint%2Cuint"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the integer modulo operation (remainder) for unsigned integers. This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">-</span> <span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Keyword">div</span> <span class="Identifier">y</span><span class="Punctuation">)</span> <span class="Operator">*</span> <span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L291" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L291" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cuint8%2Cuint8"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L294" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L294" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cuint16%2Cuint16"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L295" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L295" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cuint32%2Cuint32"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L296" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L296" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="mod,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#mod%2Cuint64%2Cuint64"><span class="Identifier">`mod`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ModU"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L297" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L297" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="move-procs-all">
- <div id="move,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#move%2CT"><span class="Identifier">move</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Move"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L171" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L171" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="moveMem-procs-all">
- <div id="moveMem,pointer,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#moveMem%2Cpointer%2Cpointer%2CNatural"><span class="Identifier">moveMem</span></a><span class="Other">(</span><span class="Identifier">dest</span><span class="Other">,</span> <span class="Identifier">source</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Copies the contents from the memory at <tt class="docutils literal"><span class="pre"><span class="Identifier">source</span></span></tt> to the memory at <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>.</p>
- <p>Exactly <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes will be copied. The memory regions may overlap, <tt class="docutils literal"><span class="pre"><span class="Identifier">moveMem</span></span></tt> handles this case appropriately and is thus somewhat more safe than <tt class="docutils literal"><span class="pre"><span class="Identifier">copyMem</span></span></tt>. Like any procedure dealing with raw memory this is still <strong>unsafe</strong>, though.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L17" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L17" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="new-procs-all">
- <div id="new,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc"><span class="Identifier">new</span></a><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#auto"><span class="Identifier">auto</span></a></pre></dt>
- <dd>
-
- <p>Creates a new object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> and returns a safe (traced) reference to it as result value.</p>
- <p>When <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> is a ref type then the resulting type will be <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>, otherwise it will be <tt class="docutils literal"><span class="pre"><span class="Keyword">ref</span> <span class="Identifier">T</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L831" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L831" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="new,ref.T">
- <dt><pre><span class="Keyword">proc</span> <a href="#new%2Cref.T"><span class="Identifier">new</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"New"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Creates a new object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> and returns a safe (traced) reference to it in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L827" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L827" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="new,ref.T,proc(ref.T)">
- <dt><pre><span class="Keyword">proc</span> <a href="#new%2Cref.T%2Cproc%28ref.T%29"><span class="Identifier">new</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">finalizer</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">nimcall</span>.}<span class="Other">)</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewFinalize"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"pass a finalizer of the \'proc (x: T) {.nimcall.}\' type"</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> pass a finalizer of the 'proc (x: T) {.nimcall.}' type
- </div>
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L144" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L144" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="new,ref.T,proc(T)">
- <dt><pre><span class="Keyword">proc</span> <a href="#new%2Cref.T%2Cproc%28T%29"><span class="Identifier">new</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">finalizer</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">nimcall</span>.}<span class="Other">)</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewFinalize"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Creates a new object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> and returns a safe (traced) reference to it in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.</p>
- <p>When the garbage collector frees the object, <tt class="docutils literal"><span class="pre"><span class="Identifier">finalizer</span></span></tt> is called. The <tt class="docutils literal"><span class="pre"><span class="Identifier">finalizer</span></span></tt> may not keep a reference to the object pointed to by <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. The <tt class="docutils literal"><span class="pre"><span class="Identifier">finalizer</span></span></tt> cannot prevent the GC from freeing the object.</p>
- <p><strong>Note</strong>: The <tt class="docutils literal"><span class="pre"><span class="Identifier">finalizer</span></span></tt> refers to the type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>, not to the object! This means that for each object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> the finalizer will be called!</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L131" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newSeq-procs-all">
- <div id="newSeq">
- <dt><pre><span class="Keyword">proc</span> <a href="#newSeq"><span class="Identifier">newSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">len</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">.</span><span class="Identifier">Natural</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>Creates a new sequence of type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.</p>
- <p>Note that the sequence will be filled with zeroed entries. After the creation of the sequence you should assign entries to the sequence instead of adding them.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">inputStrings</span> <span class="Operator">=</span> <span class="Identifier">newSeq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">inputStrings</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"The fourth"</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"assignment"</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"would crash"</span>
- <span class="Comment">#inputStrings[3] = "out of bounds"</span></pre></p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#newSeqOfCap,Natural">newSeqOfCap</a></li>
- <li><a class="reference external" href="#newSeqUninit,Natural">newSeqUninit</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L635" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L635" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="newSeq,seq[T],Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newSeq%2Cseq%5BT%5D%2CNatural"><span class="Identifier">newSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewSeq"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Creates a new sequence of type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.</p>
- <p>This is equivalent to <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="Punctuation">]</span><span class="Punctuation">;</span> <span class="Identifier">setlen</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">,</span> <span class="Identifier">len</span><span class="Punctuation">)</span></span></tt>, but more efficient since no reallocation is needed.</p>
- <p>Note that the sequence will be filled with zeroed entries. After the creation of the sequence you should assign entries to the sequence instead of adding them. Example:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">inputStrings</span><span class="Punctuation">:</span> <span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">string</span><span class="Punctuation">]</span>
- <span class="Identifier">newSeq</span><span class="Punctuation">(</span><span class="Identifier">inputStrings</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">inputStrings</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"The fourth"</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"assignment"</span>
- <span class="Identifier">inputStrings</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="StringLit">"would crash"</span>
- <span class="Comment">#inputStrings[3] = "out of bounds"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L616" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L616" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newSeqOfCap-procs-all">
- <div id="newSeqOfCap,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newSeqOfCap%2CNatural"><span class="Identifier">newSeqOfCap</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">cap</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewSeqOfCap"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Creates a new sequence of type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with length zero and capacity <tt class="docutils literal"><span class="pre"><span class="Identifier">cap</span></span></tt>. Example:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">newSeqOfCap</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">add</span><span class="Punctuation">(</span><span class="DecNumber">10</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L655" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L655" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newSeqUninit-procs-all">
- <div id="newSeqUninit,Natural">
- <dt><pre><span class="Keyword">func</span> <a href="#newSeqUninit%2CNatural"><span class="Identifier">newSeqUninit</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt>
- <dd>
-
- <p>Creates a new sequence of type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.</p>
- <p>Only available for types, which don't contain managed memory or have destructors. Note that the sequence will be uninitialized. After the creation of the sequence you should assign entries to the sequence instead of adding them.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">newSeqUninit</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">x</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="DecNumber">10</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1668" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1668" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newSeqUninitialized-procs-all">
- <div id="newSeqUninitialized,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newSeqUninitialized%2CNatural"><span class="Identifier">newSeqUninitialized</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#SomeNumber"><span class="Identifier">SomeNumber</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">deprecated</span><span class="Other">:</span> <span class="StringLit">"Use `newSeqUninit` instead"</span></span>.}</pre></dt>
- <dd>
- <div class="deprecation-message">
- <b>Deprecated:</b> Use `newSeqUninit` instead
- </div>
- <p>Creates a new sequence of type <tt class="docutils literal"><span class="pre"><span class="Identifier">seq</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> with length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>.</p>
- <p>Only available for numbers types. Note that the sequence will be uninitialized. After the creation of the sequence you should assign entries to the sequence instead of adding them. Example:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">newSeqUninitialized</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">len</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Identifier">x</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="DecNumber">10</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1649" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1649" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newString-procs-all">
- <div id="newString,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newString%2CNatural"><span class="Identifier">newString</span></a><span class="Other">(</span><span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewString"</span><span class="Other">,</span>
- <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"mnewString"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns a new string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt>. One needs to fill the string character after character with the index operator <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></span></tt>.</p>
- <p>This procedure exists only for optimization purposes; the same effect can be achieved with the <tt class="docutils literal"><span class="pre"><span class="Operator">&</span></span></tt> operator or with <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L972" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L972" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newStringOfCap-procs-all">
- <div id="newStringOfCap,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newStringOfCap%2CNatural"><span class="Identifier">newStringOfCap</span></a><span class="Other">(</span><span class="Identifier">cap</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"NewStringOfCap"</span><span class="Other">,</span>
- <span class="Identifier">importc</span><span class="Other">:</span> <span class="StringLit">"rawNewString"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns a new string of length <tt class="docutils literal"><span class="pre"><span class="DecNumber">0</span></span></tt> but with capacity <tt class="docutils literal"><span class="pre"><span class="Identifier">cap</span></span></tt>.</p>
- <p>This procedure exists only for optimization purposes; the same effect can be achieved with the <tt class="docutils literal"><span class="pre"><span class="Operator">&</span></span></tt> operator or with <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L981" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L981" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newStringUninit-procs-all">
- <div id="newStringUninit,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#newStringUninit%2CNatural"><span class="Identifier">newStringUninit</span></a><span class="Other">(</span><span class="Identifier">len</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns a new string of length <tt class="docutils literal"><span class="pre"><span class="Identifier">len</span></span></tt> but with uninitialized content. One needs to fill the string character after character with the index operator <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Punctuation">[</span><span class="Identifier">i</span><span class="Punctuation">]</span></span></tt>.</p>
- <p>This procedure exists only for optimization purposes; the same effect can be achieved with the <tt class="docutils literal"><span class="pre"><span class="Operator">&</span></span></tt> operator or with <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1688" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1688" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="not-procs-all">
- <div id="not,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Ctypedesc"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"TypeTrait"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Constructs an <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span></span></tt> meta class.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L85" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L85" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cbool"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Not"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Boolean not; returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">==</span> <span class="Identifier">false</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L76" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L76" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cint"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Identifier">complement</span></span></tt> of the integer <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="DecNumber">0'</span><span class="Identifier">u8</span> <span class="Operator">==</span> <span class="DecNumber">255</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="DecNumber">0'i8</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="DecNumber">1000'</span><span class="Identifier">u16</span> <span class="Operator">==</span> <span class="DecNumber">64535</span>
- <span class="Identifier">assert</span> <span class="Keyword">not</span> <span class="DecNumber">1000'i16</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1001</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L63" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L63" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cint8"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L70" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L70" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cint16"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L71" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L71" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cint32"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L72" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cint64"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L73" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L73" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cuint"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Identifier">complement</span></span></tt> of the integer <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L220" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L220" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cuint8"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L222" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L222" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cuint16"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L223" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L223" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cuint32"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L224" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L224" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="not,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#not%2Cuint64"><span class="Identifier">`not`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitnotI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L225" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L225" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="of-procs-all">
- <div id="of,T,typedesc[S]">
- <dt><pre><span class="Keyword">proc</span> <a href="#of%2CT%2Ctypedesc%5BS%5D"><span class="Identifier">`of`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">S</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">S</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Of"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Checks if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is an instance of <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">type</span>
- <span class="Identifier">Base</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">RootObj</span>
- <span class="Identifier">Sub1</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">Base</span>
- <span class="Identifier">Sub2</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <span class="Identifier">Base</span>
- <span class="Identifier">Unrelated</span> <span class="Operator">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span>
- <span class="Keyword">var</span> <span class="Identifier">base</span><span class="Punctuation">:</span> <span class="Identifier">Base</span> <span class="Operator">=</span> <span class="Identifier">Sub1</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># downcast</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">base</span> <span class="Keyword">of</span> <span class="Identifier">Base</span> <span class="Comment"># generates `CondTrue` (statically true)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">base</span> <span class="Keyword">of</span> <span class="Identifier">Sub1</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">base</span> <span class="Keyword">isnot</span> <span class="Identifier">Sub1</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">base</span> <span class="Keyword">of</span> <span class="Identifier">Sub2</span><span class="Punctuation">)</span>
- <span class="Identifier">base</span> <span class="Operator">=</span> <span class="Identifier">Sub2</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># re-assign</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">base</span> <span class="Keyword">of</span> <span class="Identifier">Sub2</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">Sub2</span><span class="Punctuation">(</span><span class="Identifier">base</span><span class="Punctuation">)</span> <span class="Operator">!=</span> <span class="Keyword">nil</span> <span class="Comment"># upcast</span>
- <span class="Identifier">doAssertRaises</span><span class="Punctuation">(</span><span class="Identifier">ObjectConversionDefect</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Keyword">discard</span> <span class="Identifier">Sub1</span><span class="Punctuation">(</span><span class="Identifier">base</span><span class="Punctuation">)</span>
- <span class="Keyword">var</span> <span class="Identifier">sub1</span> <span class="Operator">=</span> <span class="Identifier">Sub1</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">sub1</span> <span class="Keyword">of</span> <span class="Identifier">Base</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">sub1</span><span class="Operator">.</span><span class="Identifier">Base</span> <span class="Keyword">of</span> <span class="Identifier">Sub1</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">base</span> <span class="Keyword">of</span> <span class="Identifier">Unrelated</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L852" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L852" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="onThreadDestruction-procs-all">
- <div id="onThreadDestruction,proc)">
- <dt><pre><span class="Keyword">proc</span> <a href="#onThreadDestruction%2Cproc%29"><span class="Identifier">onThreadDestruction</span></a><span class="Other">(</span><span class="Identifier">handler</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">closure</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}<span class="Other">)</span> {.
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Registers a <em>thread local</em> handler that is called at the thread's destruction.</p>
- <p>A thread is destructed when the <tt class="docutils literal"><span class="pre"><span class="Operator">.</span><span class="Identifier">thread</span></span></tt> proc returns normally or when it raises an exception. Note that unhandled exceptions in a thread nevertheless cause the whole process to die.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/threadimpl.nim#L31" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/threadimpl.nim#L31" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="or-procs-all">
- <div id="or,typedesc,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Ctypedesc%2Ctypedesc"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"TypeTrait"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Constructs an <tt class="docutils literal"><span class="pre"><span class="Keyword">or</span></span></tt> meta class.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L79" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cbool%2Cbool"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Or"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Boolean <tt class="docutils literal"><span class="pre"><span class="Keyword">or</span></span></tt>; returns true if <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Keyword">not</span> <span class="Identifier">x</span> <span class="Keyword">and</span> <span class="Keyword">not</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt> (if any of the arguments is true).</p>
- <p>Evaluation is lazy: if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> is true, <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> will not even be evaluated.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L84" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L84" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cint%2Cint"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">or</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0011</span> <span class="Keyword">or</span> <span class="BinNumber">0b0101</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b0111</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0111</span> <span class="Keyword">or</span> <span class="BinNumber">0b1100</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b1111</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L199" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L199" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cint8%2Cint8"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L204" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L204" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cint16%2Cint16"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cint32%2Cint32"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L206" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L206" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cint64%2Cint64"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L207" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L207" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cuint%2Cuint"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">or</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L248" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L248" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cuint8%2Cuint8"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L250" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L250" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cuint16%2Cuint16"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L251" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L251" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cuint32%2Cuint32"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L252" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L252" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="or,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#or%2Cuint64%2Cuint64"><span class="Identifier">`or`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L253" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L253" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="ord-procs-all">
- <div id="ord,T">
- <dt><pre><span class="Keyword">func</span> <a href="#ord%2CT"><span class="Identifier">ord</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a> <span class="Operator">|</span> <span class="Keyword">enum</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Ord"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Returns the internal <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt> value of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, including for enum with holes and distinct ordinal types.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">ord</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">A</span><span class="CharLit">') == 65</span>
- <span class="Keyword">type</span> <span class="Identifier">Foo</span> <span class="Operator">=</span> <span class="Keyword">enum</span>
- <span class="Identifier">f0</span> <span class="Operator">=</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="Identifier">f1</span> <span class="Operator">=</span> <span class="DecNumber">3</span>
- <span class="Identifier">assert</span> <span class="Identifier">f1</span><span class="Operator">.</span><span class="Identifier">ord</span> <span class="Operator">==</span> <span class="DecNumber">3</span>
- <span class="Keyword">type</span> <span class="Identifier">Bar</span> <span class="Operator">=</span> <span class="Keyword">distinct</span> <span class="Identifier">int</span>
- <span class="Identifier">assert</span> <span class="FloatNumber">3.</span><span class="Identifier">Bar</span><span class="Operator">.</span><span class="Identifier">ord</span> <span class="Operator">==</span> <span class="DecNumber">3</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L719" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L719" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="pop-procs-all">
- <div id="pop,seq[T]">
- <dt><pre><span class="Keyword">proc</span> <a href="#pop%2Cseq%5BT%5D"><span class="Identifier">pop</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- <p>Returns the last item of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> and decreases <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> by one. This treats <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> as a stack and implements the common <em>pop</em> operation.</p>
- <p>Raises <tt class="docutils literal"><span class="pre"><span class="Identifier">IndexDefect</span></span></tt> if <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> is empty.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Keyword">let</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">pop</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="DecNumber">7</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1780" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1780" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="pred-procs-all">
- <div id="pred,T,V">
- <dt><pre><span class="Keyword">proc</span> <a href="#pred%2CT%2CV"><span class="Identifier">pred</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">V</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Pred"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>-th predecessor (default: 1) of the value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>If such a value does not exist, <tt class="docutils literal"><span class="pre"><span class="Identifier">OverflowDefect</span></span></tt> is raised or a compile time error occurs.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">pred</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
- <span class="Identifier">assert</span> <span class="Identifier">pred</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">2</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L10" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L10" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="prepareMutation-procs-all">
- <div id="prepareMutation,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#prepareMutation%2Cstring"><span class="Identifier">prepareMutation</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/strs_v2.nim#L198" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/strs_v2.nim#L198" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="procCall-procs-all">
- <div id="procCall,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#procCall%2Cuntyped"><span class="Identifier">procCall</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ProcCall"</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Special magic to prohibit dynamic binding for <span id="method_1">method</span> calls. This is similar to <span id="super_1">super</span> in ordinary OO languages.</p>
- <p><pre class="listing"><span class="Comment"># 'someMethod' will be resolved fully statically:</span>
- <span class="Identifier">procCall</span> <span class="Identifier">someMethod</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2709" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2709" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="protect-procs-all">
- <div id="protect,pointer">
- <dt><pre><span class="Keyword">proc</span> <a href="#protect%2Cpointer"><span class="Identifier">protect</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#ForeignCell"><span class="Identifier">ForeignCell</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/mmdisp.nim#L118" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/mmdisp.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="quit-procs-all">
- <div id="quit,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#quit%2Cint"><span class="Identifier">quit</span></a><span class="Other">(</span><span class="Identifier">errorcode</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> <span class="Other">=</span> <span class="Identifier">QuitSuccess</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Exit"</span><span class="Other">,</span> <span class="Identifier">noreturn</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Stops the program immediately with an exit code.</p>
- <p>Before stopping the program the "exit procedures" are called in the opposite order they were added with <a class="reference external" href="exitprocs.html#addExitProc,proc)">addExitProc</a>.</p>
- <p>The proc <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span><span class="Punctuation">(</span><span class="Identifier">QuitSuccess</span><span class="Punctuation">)</span></span></tt> is called implicitly when your nim program finishes without incident for platforms where this is the expected behavior. A raised unhandled exception is equivalent to calling <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span><span class="Punctuation">(</span><span class="Identifier">QuitFailure</span><span class="Punctuation">)</span></span></tt>.</p>
- <p>Note that this is a <em>runtime</em> call and using <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span></span></tt> inside a macro won't have any compile time effect. If you need to stop the compiler inside a macro, use the <a class="reference external" href="manual.html#pragmas-error-pragma">error</a> or <a class="reference external" href="manual.html#pragmas-fatal-pragma">fatal</a> pragmas.</p>
- <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- <tt class="docutils literal"><span class="pre"><span class="Identifier">errorcode</span></span></tt> gets saturated when it exceeds the valid range on the specific platform. On Posix, the valid range is <tt class="docutils literal"><span class="pre"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">int8</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">int8</span><span class="Punctuation">)</span></span></tt>. On Windows, the valid range is <tt class="docutils literal"><span class="pre"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">int32</span><span class="Punctuation">)</span><span class="Operator">..</span><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">int32</span><span class="Punctuation">)</span></span></tt>. For instance, <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">(</span><span class="HexNumber">0x100000000</span><span class="Punctuation">)</span><span class="Punctuation">)</span></span></tt> is equal to <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span><span class="Punctuation">(</span><span class="DecNumber">127</span><span class="Punctuation">)</span></span></tt> on Linux.</div>
- <div class="admonition admonition-error"><span class="admonition-error-text"><b>Danger:</b></span>
- In almost all cases, in particular in library code, prefer alternatives, e.g. <tt class="docutils literal"><span class="pre"><span class="Identifier">raiseAssert</span></span></tt> or raise a <tt class="docutils literal"><span class="pre"><span class="Identifier">Defect</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">quit</span></span></tt> bypasses regular control flow in particular <tt class="docutils literal"><span class="pre"><span class="Keyword">defer</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Keyword">try</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">catch</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Keyword">finally</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">destructors</span></span></tt>, and exceptions that may have been raised by an <tt class="docutils literal"><span class="pre"><span class="Identifier">addExitProc</span></span></tt> proc, as well as cleanup code in other threads. It does <em>not</em> call the garbage collector to free all the memory, unless an <tt class="docutils literal"><span class="pre"><span class="Identifier">addExitProc</span></span></tt> proc calls <a class="reference external" href="#GC_fullCollect">GC_fullCollect</a>.</div>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2399" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2399" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="quit,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#quit%2Cstring"><span class="Identifier">quit</span></a><span class="Other">(</span><span class="Identifier">errormsg</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">errorcode</span> <span class="Other">=</span> <span class="Identifier">QuitFailure</span><span class="Other">)</span> {.<span class="Identifier">noreturn</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A shorthand for <tt class="docutils literal"><span class="pre"><span class="Identifier">echo</span><span class="Punctuation">(</span><span class="Identifier">errormsg</span><span class="Punctuation">)</span><span class="Punctuation">;</span> <span class="Identifier">quit</span><span class="Punctuation">(</span><span class="Identifier">errorcode</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2452" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2452" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="rawEnv-procs-all">
- <div id="rawEnv,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#rawEnv%2CT"><span class="Identifier">rawEnv</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">proc</span> {.<span class="Identifier">closure</span>.} <span class="Operator">|</span> <span class="Keyword">iterator</span> {.<span class="Identifier">closure</span>.}<span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Retrieves the raw environment pointer of the closure <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. See also <tt class="docutils literal"><span class="pre"><span class="Identifier">rawProc</span></span></tt>. This is not available for the JS target.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2365" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2365" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="rawProc-procs-all">
- <div id="rawProc,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#rawProc%2CT"><span class="Identifier">rawProc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">proc</span> {.<span class="Identifier">closure</span>.} <span class="Operator">|</span> <span class="Keyword">iterator</span> {.<span class="Identifier">closure</span>.}<span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- Retrieves the raw proc pointer of the closure <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. This is useful for interfacing closures with C/C++, hash computations, etc. If <tt class="docutils literal"><span class="pre"><span class="Identifier">rawEnv</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> returns <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>, the proc which the result points to takes as many parameters as <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>, but with <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">nimcall</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt> as its calling convention instead of <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">closure</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt>, otherwise it takes one more parameter which is a <tt class="docutils literal"><span class="pre"><span class="Identifier">pointer</span></span></tt>, and it still has <tt class="docutils literal"><span class="pre"><span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">nimcall</span><span class="Operator">.</span><span class="Punctuation">}</span></span></tt> as its calling convention. To invoke the resulted proc, what this returns has to be casted into a <tt class="docutils literal"><span class="pre"><span class="Keyword">proc</span></span></tt>, not a <tt class="docutils literal"><span class="pre"><span class="Keyword">ptr</span> <span class="Keyword">proc</span></span></tt>, and, in a case where <tt class="docutils literal"><span class="pre"><span class="Identifier">rawEnv</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt> returns non-<tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>, the last and additional argument has to be the result of <tt class="docutils literal"><span class="pre"><span class="Identifier">rawEnv</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span></span></tt>. This is not available for the JS target.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">makeClosure</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Punctuation">(</span><span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span> <span class="Operator">=</span>
- <span class="Keyword">var</span> <span class="Identifier">n</span> <span class="Operator">=</span> <span class="Identifier">x</span>
- <span class="Identifier">result</span> <span class="Operator">=</span> <span class="Punctuation">(</span>
- <span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span>
- <span class="Identifier">n</span> <span class="Operator">+=</span> <span class="Identifier">y</span>
- <span class="Keyword">return</span> <span class="Identifier">n</span>
- <span class="Punctuation">)</span>
- <span class="Keyword">var</span>
- <span class="Identifier">c1</span> <span class="Operator">=</span> <span class="Identifier">makeClosure</span><span class="Punctuation">(</span><span class="DecNumber">10</span><span class="Punctuation">)</span>
- <span class="Identifier">e</span> <span class="Operator">=</span> <span class="Identifier">c1</span><span class="Operator">.</span><span class="Identifier">rawEnv</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">p</span> <span class="Operator">=</span> <span class="Identifier">c1</span><span class="Operator">.</span><span class="Identifier">rawProc</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Keyword">if</span> <span class="Identifier">e</span><span class="Operator">.</span><span class="Identifier">isNil</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">c2</span> <span class="Operator">=</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">nimcall</span><span class="Operator">.</span><span class="Punctuation">}</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span>
- <span class="Identifier">echo</span> <span class="Identifier">c2</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span>
- <span class="Keyword">else</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">c3</span> <span class="Operator">=</span> <span class="Keyword">cast</span><span class="Punctuation">[</span><span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">;</span> <span class="Identifier">env</span><span class="Punctuation">:</span> <span class="Identifier">pointer</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">nimcall</span><span class="Operator">.</span><span class="Punctuation">}</span><span class="Punctuation">]</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span>
- <span class="Identifier">echo</span> <span class="Identifier">c3</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="Identifier">e</span><span class="Punctuation">)</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2323" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2323" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="realloc0Impl-procs-all">
- <div id="realloc0Impl,pointer,Natural,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#realloc0Impl%2Cpointer%2CNatural%2CNatural"><span class="Identifier">realloc0Impl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">oldSize</span><span class="Other">,</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L55" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reallocImpl-procs-all">
- <div id="reallocImpl,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#reallocImpl%2Cpointer%2CNatural"><span class="Identifier">reallocImpl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L54" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reallocShared0Impl-procs-all">
- <div id="reallocShared0Impl,pointer,Natural,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#reallocShared0Impl%2Cpointer%2CNatural%2CNatural"><span class="Identifier">reallocShared0Impl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">oldSize</span><span class="Other">,</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.
- <span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L61" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L61" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reallocSharedImpl-procs-all">
- <div id="reallocSharedImpl,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#reallocSharedImpl%2Cpointer%2CNatural"><span class="Identifier">reallocSharedImpl</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a> {.<span class="Identifier">noconv</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L60" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L60" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="repr-procs-all">
- <div id="repr,HSlice[T,U]">
- <dt><pre><span class="Keyword">proc</span> <a href="#repr%2CHSlice%5BT%2CU%5D"><span class="Identifier">repr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#HSlice"><span class="Identifier">HSlice</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">U</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
- <p>Generic <tt class="docutils literal"><span class="pre"><span class="Identifier">repr</span></span></tt> operator for slices that is lifted from the components of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>. Example:</p>
- <p><pre class="listing"><span class="Operator">$</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"1 .. 5"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2537" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2537" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reset-procs-all">
- <div id="reset,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#reset%2CT"><span class="Identifier">reset</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Resets an object <tt class="docutils literal"><span class="pre"><span class="Identifier">obj</span></span></tt> to its default value.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L933" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L933" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="resize-procs-all">
- <div id="resize,ptr.T,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#resize%2Cptr.T%2CNatural"><span class="Identifier">resize</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">resize</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">dealloc</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <tt class="docutils literal"><span class="pre"><span class="Identifier">free</span></span></tt>.</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#resizeShared,ptr.T,Natural">resizeShared</a> to reallocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L177" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L177" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="resizeShared-procs-all">
- <div id="resizeShared,ptr.T,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#resizeShared%2Cptr.T%2CNatural"><span class="Identifier">resizeShared</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block on the heap.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span><span class="Operator">.</span><span class="Identifier">sizeof</span> <span class="Operator">*</span> <span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">resizeShared</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">freeShared</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <a class="reference external" href="#freeShared,ptr.T">freeShared</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L288" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L288" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="runnableExamples-procs-all">
- <div id="runnableExamples,string,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#runnableExamples%2Cstring%2Cuntyped"><span class="Identifier">runnableExamples</span></a><span class="Other">(</span><span class="Identifier">rdoccmd</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"RunnableExamples"</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A section you should use to mark <span id="runnable-example_1">runnable example</span> code with.<ul class="simple"><li>In normal debug and release builds code within a <tt class="docutils literal"><span class="pre"><span class="Identifier">runnableExamples</span></span></tt> section is ignored.</li>
- <li>The documentation generator is aware of these examples and considers them part of the <tt class="docutils literal"><span class="pre"><span class="Comment">##</span></span></tt> doc comment. As the last step of documentation generation each runnableExample is put in its own file <tt class="docutils literal"><span class="pre"><span class="Operator">$</span><span class="Identifier">file_examples</span><span class="Operator">$</span><span class="Identifier">i</span><span class="Operator">.</span><span class="Identifier">nim</span></span></tt>, compiled and tested. The collected examples are put into their own module to ensure the examples do not refer to non-exported symbols.</li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">timesTwo</span><span class="Operator">*</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">int</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">int</span> <span class="Operator">=</span>
- <span class="Comment">## This proc doubles a number.</span>
- <span class="Identifier">runnableExamples</span><span class="Punctuation">:</span>
- <span class="Comment"># at module scope</span>
- <span class="Keyword">const</span> <span class="Identifier">exported</span><span class="Operator">*</span> <span class="Operator">=</span> <span class="DecNumber">123</span>
- <span class="Identifier">assert</span> <span class="Identifier">timesTwo</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">10</span>
- <span class="Keyword">block</span><span class="Punctuation">:</span> <span class="Comment"># at block scope</span>
- <span class="Keyword">defer</span><span class="Punctuation">:</span> <span class="Identifier">echo</span> <span class="StringLit">"done"</span>
- <span class="Identifier">runnableExamples</span> <span class="StringLit">"-d:foo -b:cpp"</span><span class="Punctuation">:</span>
- <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">compilesettings</span>
- <span class="Identifier">assert</span> <span class="Identifier">querySetting</span><span class="Punctuation">(</span><span class="Identifier">backend</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"cpp"</span>
- <span class="Identifier">assert</span> <span class="Identifier">defined</span><span class="Punctuation">(</span><span class="Identifier">foo</span><span class="Punctuation">)</span>
- <span class="Identifier">runnableExamples</span> <span class="StringLit">"-r:off"</span><span class="Punctuation">:</span> <span class="Comment">## this one is only compiled</span>
- <span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">browsers</span>
- <span class="Identifier">openDefaultBrowser</span> <span class="StringLit">"https://forum.nim-lang.org/"</span>
- <span class="DecNumber">2</span> <span class="Operator">*</span> <span class="Identifier">x</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L87" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L87" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setControlCHook-procs-all">
- <div id="setControlCHook,proc)">
- <dt><pre><span class="Keyword">proc</span> <a href="#setControlCHook%2Cproc%29"><span class="Identifier">setControlCHook</span></a><span class="Other">(</span><span class="Identifier">hook</span><span class="Other">:</span> <span class="Keyword">proc</span> <span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">noconv</span>.}<span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Allows you to override the behaviour of your application when CTRL+C is pressed. Only one such hook is supported. Example:</p>
- <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">ctrlc</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">noconv</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span>
- <span class="Identifier">echo</span> <span class="StringLit">"Ctrl+C fired!"</span>
- <span class="Comment"># do clean up stuff</span>
- <span class="Identifier">quit</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">setControlCHook</span><span class="Punctuation">(</span><span class="Identifier">ctrlc</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2180" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2180" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setCurrentException-procs-all">
- <div id="setCurrentException,ref.Exception">
- <dt><pre><span class="Keyword">proc</span> <a href="#setCurrentException%2Cref.Exception"><span class="Identifier">setCurrentException</span></a><span class="Other">(</span><span class="Identifier">exc</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Sets the current exception.<div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- Only use this if you know what you are doing.</div>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2309" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2309" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setFrame-procs-all">
- <div id="setFrame,PFrame">
- <dt><pre><span class="Keyword">proc</span> <a href="#setFrame%2CPFrame"><span class="Identifier">setFrame</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#PFrame"><span class="Identifier">PFrame</span></a><span class="Other">)</span> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L133" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L133" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setFrameState-procs-all">
- <div id="setFrameState,FrameState">
- <dt><pre><span class="Keyword">proc</span> <a href="#setFrameState%2CFrameState"><span class="Identifier">setFrameState</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Identifier">FrameState</span><span class="Other">)</span> {.<span class="Identifier">compilerproc</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L106" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setLen-procs-all">
- <div id="setLen,string,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#setLen%2Cstring%2CNatural"><span class="Identifier">setLen</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">newlen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SetLengthStr"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Sets the length of string <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">newlen</span></span></tt>.</p>
- <p>If the current length is greater than the new length, <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> will be truncated.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myS</span> <span class="Operator">=</span> <span class="StringLit">"Nim is great!!"</span>
- <span class="Identifier">myS</span><span class="Operator">.</span><span class="Identifier">setLen</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Comment"># myS <- "Nim"</span>
- <span class="Identifier">echo</span> <span class="Identifier">myS</span><span class="Punctuation">,</span> <span class="StringLit">" is fantastic!!"</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L960" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L960" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="setLen,seq[T],Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#setLen%2Cseq%5BT%5D%2CNatural"><span class="Identifier">setLen</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">newlen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SetLengthSeq"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">nodestroy</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Sets the length of seq <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">newlen</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> may be any sequence type.</p>
- <p>If the current length is greater than the new length, <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> will be truncated.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">]</span>
- <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">setLen</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">x</span><span class="Punctuation">[</span><span class="DecNumber">4</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="DecNumber">50</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">50</span><span class="Punctuation">]</span>
- <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">setLen</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L945" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L945" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setLenUninit-procs-all">
- <div id="setLenUninit,seq[T],Natural">
- <dt><pre><span class="Keyword">func</span> <a href="#setLenUninit%2Cseq%5BT%5D%2CNatural"><span class="Identifier">setLenUninit</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">newlen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">nodestroy</span>.}</pre></dt>
- <dd>
-
- <p>Sets the length of seq <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">newlen</span></span></tt>. <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> may be any sequence type. New slots will not be initialized.</p>
- <p>If the current length is greater than the new length, <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> will be truncated.</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">,</span> <span class="DecNumber">20</span><span class="Punctuation">]</span>
- <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">setLenUninit</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span>
- <span class="Identifier">x</span><span class="Punctuation">[</span><span class="DecNumber">4</span><span class="Punctuation">]</span> <span class="Operator">=</span> <span class="DecNumber">50</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span><span class="Punctuation">[</span><span class="DecNumber">4</span><span class="Punctuation">]</span> <span class="Operator">==</span> <span class="DecNumber">50</span>
- <span class="Identifier">x</span><span class="Operator">.</span><span class="Identifier">setLenUninit</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">10</span><span class="Punctuation">]</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L205" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L205" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="shl-procs-all">
- <div id="shl,int8,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cint8%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L166" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L166" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,int16,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cint16%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L167" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L167" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,int32,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cint32%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L168" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L168" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,int64,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cint64%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L169" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L169" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,int,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cint%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">shift</span> <span class="Identifier">left</span></span></tt> operation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.</p>
- <p><strong>Note</strong>: <a class="reference external" href="manual.html#syntax-precedence">Operator precedence</a> is different than in <em>C</em>.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="DecNumber">1'i32</span> <span class="Keyword">shl</span> <span class="DecNumber">4</span> <span class="Operator">==</span> <span class="HexNumber">0x0000_0010</span>
- <span class="Identifier">assert</span> <span class="DecNumber">1'i64</span> <span class="Keyword">shl</span> <span class="DecNumber">4</span> <span class="Operator">==</span> <span class="HexNumber">0x0000_0000_0000_0010</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L158" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L158" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,uint8,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cuint8%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L236" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,uint16,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cuint16%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L237" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L237" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,uint32,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cuint32%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L238" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L238" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,uint64,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cuint64%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L239" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L239" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shl,uint,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shl%2Cuint%2CSomeInteger"><span class="Identifier">`shl`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShlI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">shift</span> <span class="Identifier">left</span></span></tt> operation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L234" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L234" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="shr-procs-all">
- <div id="shr,int8,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cint8%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L152" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L152" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,int16,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cint16%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L153" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L153" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,int32,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cint32%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L154" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L154" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,int64,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cint64%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L155" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,int,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cint%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"AshrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">shift</span> <span class="Identifier">right</span></span></tt> operation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>, filling vacant bit positions with the sign bit.</p>
- <p><strong>Note</strong>: <a class="reference external" href="manual.html#syntax-precedence">Operator precedence</a> is different than in <em>C</em>.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#ashr,int,SomeInteger">ashr func</a> for arithmetic shift right</li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="BinNumber">0b0001_0000'i8</span> <span class="Keyword">shr</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="BinNumber">0b0000_0100'i8</span>
- <span class="Identifier">assert</span> <span class="BinNumber">0b0000_0001'i8</span> <span class="Keyword">shr</span> <span class="DecNumber">1</span> <span class="Operator">==</span> <span class="BinNumber">0b0000_0000'i8</span>
- <span class="Identifier">assert</span> <span class="BinNumber">0b1000_0000'i8</span> <span class="Keyword">shr</span> <span class="DecNumber">4</span> <span class="Operator">==</span> <span class="BinNumber">0b1111_1000'i8</span>
- <span class="Identifier">assert</span> <span class="Operator">-</span><span class="DecNumber">1</span> <span class="Keyword">shr</span> <span class="DecNumber">5</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span>
- <span class="Identifier">assert</span> <span class="DecNumber">1</span> <span class="Keyword">shr</span> <span class="DecNumber">5</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">assert</span> <span class="DecNumber">16</span> <span class="Keyword">shr</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="DecNumber">4</span>
- <span class="Identifier">assert</span> <span class="Operator">-</span><span class="DecNumber">16</span> <span class="Keyword">shr</span> <span class="DecNumber">2</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">4</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L135" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,uint8,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cuint8%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L229" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L229" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,uint16,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cuint16%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L230" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L230" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,uint32,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cuint32%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L231" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L231" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,uint64,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cuint64%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L232" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L232" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="shr,uint,SomeInteger">
- <dt><pre><span class="Keyword">proc</span> <a href="#shr%2Cuint%2CSomeInteger"><span class="Identifier">`shr`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#SomeInteger"><span class="Identifier">SomeInteger</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ShrI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">shift</span> <span class="Identifier">right</span></span></tt> operation of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L227" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L227" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="shrink-procs-all">
- <div id="shrink,seq[T],Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#shrink%2Cseq%5BT%5D%2CNatural"><span class="Identifier">shrink</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">newLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/seqs_v2.nim#L125" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/seqs_v2.nim#L125" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="sizeof-procs-all">
- <div id="sizeof,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#sizeof%2Ctypedesc"><span class="Identifier">sizeof</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SizeOf"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L613" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L613" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="sizeof,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#sizeof%2CT"><span class="Identifier">sizeof</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"SizeOf"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the size of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> in bytes.</p>
- <p>Since this is a low-level proc, its usage is discouraged - using <a class="reference external" href="#new,ref.T,proc(ref.T)">new</a> for the most cases suffices that one never needs to know <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>'s size.</p>
- <p>As a special semantic rule, <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> may also be a type identifier (<tt class="docutils literal"><span class="pre"><span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span></span></tt> is valid).</p>
- <p>Limitations: If used for types that are imported from C or C++, sizeof should fallback to the <tt class="docutils literal"><span class="pre"><span class="Identifier">sizeof</span></span></tt> in the C compiler. The result isn't available for the Nim compiler and therefore can't be used inside of macros.</p>
- <p><pre class="listing"><span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="Punctuation">'</span><span class="Identifier">A</span><span class="CharLit">') # => 1</span>
- <span class="Identifier">sizeof</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Comment"># => 8</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L580" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L580" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="slurp-procs-all">
- <div id="slurp,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#slurp%2Cstring"><span class="Identifier">slurp</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slurp"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- This is an alias for <a class="reference external" href="#staticRead,string">staticRead</a>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L159" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L159" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="stackTraceAvailable-procs-all">
- <div id="stackTraceAvailable">
- <dt><pre><span class="Keyword">proc</span> <a href="#stackTraceAvailable"><span class="Identifier">stackTraceAvailable</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/excpt.nim#L329" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/excpt.nim#L329" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="staticExec-procs-all">
- <div id="staticExec,string,string,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#staticExec%2Cstring%2Cstring%2Cstring"><span class="Identifier">staticExec</span></a><span class="Other">(</span><span class="Identifier">command</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">input</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">;</span> <span class="Identifier">cache</span> <span class="Other">=</span> <span class="StringLit">""</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"StaticExec"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Executes an external process at compile-time and returns its text output (stdout + stderr).</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">input</span></span></tt> is not an empty string, it will be passed as a standard input to the executed program.</p>
- <p><pre class="listing"><span class="Keyword">const</span> <span class="Identifier">buildInfo</span> <span class="Operator">=</span> <span class="StringLit">"Revision "</span> <span class="Operator">&</span> <span class="Identifier">staticExec</span><span class="Punctuation">(</span><span class="StringLit">"git rev-parse HEAD"</span><span class="Punctuation">)</span> <span class="Operator">&</span>
- <span class="StringLit">"</span><span class="EscapeSequence">\n</span><span class="StringLit">Compiled on "</span> <span class="Operator">&</span> <span class="Identifier">staticExec</span><span class="Punctuation">(</span><span class="StringLit">"uname -v"</span><span class="Punctuation">)</span></pre></p>
- <p><a class="reference external" href="#gorge,string,string,string">gorge</a> is an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">staticExec</span></span></tt>.</p>
- <p>Note that you can use this proc inside a pragma like <a class="reference external" href="manual.html#implementation-specific-pragmas-passc-pragma">passc</a> or <a class="reference external" href="manual.html#implementation-specific-pragmas-passl-pragma">passl</a>.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">cache</span></span></tt> is not empty, the results of <tt class="docutils literal"><span class="pre"><span class="Identifier">staticExec</span></span></tt> are cached within the <tt class="docutils literal"><span class="pre"><span class="Identifier">nimcache</span></span></tt> directory. Use <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">forceBuild</span></span></tt> to get rid of this caching behaviour then. <tt class="docutils literal"><span class="pre"><span class="Identifier">command</span> <span class="Operator">&</span> <span class="Identifier">input</span> <span class="Operator">&</span> <span class="Identifier">cache</span></span></tt> (the concatenated string) is used to determine whether the entry in the cache is still valid. You can use versioning information for <tt class="docutils literal"><span class="pre"><span class="Identifier">cache</span></span></tt>:</p>
- <p><pre class="listing"><span class="Keyword">const</span> <span class="Identifier">stateMachine</span> <span class="Operator">=</span> <span class="Identifier">staticExec</span><span class="Punctuation">(</span><span class="StringLit">"dfaoptimizer"</span><span class="Punctuation">,</span> <span class="StringLit">"input"</span><span class="Punctuation">,</span> <span class="StringLit">"0.8.0"</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L178" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L178" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="staticRead-procs-all">
- <div id="staticRead,string">
- <dt><pre><span class="Keyword">proc</span> <a href="#staticRead%2Cstring"><span class="Identifier">staticRead</span></a><span class="Other">(</span><span class="Identifier">filename</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slurp"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Compile-time <a class="reference external" href="syncio.html#readFile,string">readFile</a> proc for easy <span id="resource_1">resource</span> embedding:</p>
- <p>The maximum file size limit that <tt class="docutils literal"><span class="pre"><span class="Identifier">staticRead</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">slurp</span></span></tt> can read is near or equal to the <em>free</em> memory of the device you are using to compile.</p>
- <p><pre class="listing"><span class="Keyword">const</span> <span class="Identifier">myResource</span> <span class="Operator">=</span> <span class="RawData">staticRead"mydatafile.bin"</span></pre></p>
- <p><a class="reference external" href="#slurp,string">slurp</a> is an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">staticRead</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L162" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L162" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="substr-procs-all">
- <div id="substr,openArray[char]">
- <dt><pre><span class="Keyword">proc</span> <a href="#substr%2CopenArray%5Bchar%5D"><span class="Identifier">substr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Copies a slice of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into a new string and returns this new string.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abcdefgh"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"cdef"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"cdefgh"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">99</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"fgh"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2772" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2772" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="substr,string,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#substr%2Cstring%2Cint"><span class="Identifier">substr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">first</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2805" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2805" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="substr,string,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#substr%2Cstring%2Cint%2Cint"><span class="Identifier">substr</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Copies a slice of <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span></span></tt> into a new string and returns this new string.</p>
- <p>The bounds <tt class="docutils literal"><span class="pre"><span class="Identifier">first</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span></span></tt> denote the indices of the first and last characters that shall be copied. If <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span></span></tt> is omitted, it is treated as <tt class="docutils literal"><span class="pre"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">s</span><span class="Punctuation">)</span></span></tt>. If <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span> <span class="Operator">>=</span> <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">len</span></span></tt> is used instead: This means <tt class="docutils literal"><span class="pre"><span class="Identifier">substr</span></span></tt> can also be used to <span id="cut_1">cut</span> or <span id="limit_1">limit</span> a string's length.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">let</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="StringLit">"abcdefgh"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"cdef"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"cdefgh"</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">substr</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">99</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="StringLit">"fgh"</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2784" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2784" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="succ-procs-all">
- <div id="succ,T,V">
- <dt><pre><span class="Keyword">proc</span> <a href="#succ%2CT%2CV"><span class="Identifier">succ</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">V</span><span class="Other">:</span> <a href="system.html#Ordinal"><span class="Identifier">Ordinal</span></a><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <span class="Identifier">V</span> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Succ"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>-th successor (default: 1) of the value <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.</p>
- <p>If such a value does not exist, <tt class="docutils literal"><span class="pre"><span class="Identifier">OverflowDefect</span></span></tt> is raised or a compile time error occurs.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Identifier">succ</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">6</span>
- <span class="Identifier">assert</span> <span class="Identifier">succ</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">8</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L1" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="swap-procs-all">
- <div id="swap,T,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#swap%2CT%2CT"><span class="Identifier">swap</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Swap"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Swaps the values <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt>.</p>
- <p>This is often more efficient than <tt class="docutils literal"><span class="pre"><span class="Identifier">tmp</span> <span class="Operator">=</span> <span class="Identifier">a</span><span class="Punctuation">;</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Identifier">b</span><span class="Punctuation">;</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Identifier">tmp</span></span></tt>. Particularly useful for sorting algorithms.</p>
- <p><pre class="listing"><span class="Keyword">var</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="DecNumber">5</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="DecNumber">9</span>
- <span class="Identifier">swap</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="DecNumber">9</span>
- <span class="Identifier">assert</span> <span class="Identifier">b</span> <span class="Operator">==</span> <span class="DecNumber">5</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1394" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1394" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toBiggestFloat-procs-all">
- <div id="toBiggestFloat,BiggestInt">
- <dt><pre><span class="Keyword">proc</span> <a href="#toBiggestFloat%2CBiggestInt"><span class="Identifier">toBiggestFloat</span></a><span class="Other">(</span><span class="Identifier">i</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Same as <a class="reference external" href="#toFloat,int">toFloat</a> but for <tt class="docutils literal"><span class="pre"><span class="Identifier">BiggestInt</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">BiggestFloat</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1306" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1306" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toBiggestInt-procs-all">
- <div id="toBiggestInt,BiggestFloat">
- <dt><pre><span class="Keyword">proc</span> <a href="#toBiggestInt%2CBiggestFloat"><span class="Identifier">toBiggestInt</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="ctypes.html#BiggestFloat"><span class="Identifier">BiggestFloat</span></a><span class="Other">)</span><span class="Other">:</span> <a href="ctypes.html#BiggestInt"><span class="Identifier">BiggestInt</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Same as <a class="reference external" href="#toInt,float">toInt</a> but for <tt class="docutils literal"><span class="pre"><span class="Identifier">BiggestFloat</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">BiggestInt</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1327" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1327" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toFloat-procs-all">
- <div id="toFloat,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toFloat%2Cint"><span class="Identifier">toFloat</span></a><span class="Other">(</span><span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Converts an integer <tt class="docutils literal"><span class="pre"><span class="Identifier">i</span></span></tt> into a <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span></span></tt>. Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">float</span><span class="Punctuation">(</span><span class="Identifier">i</span><span class="Punctuation">)</span></span></tt>.</p>
- <p>If the conversion fails, <tt class="docutils literal"><span class="pre"><span class="Identifier">ValueError</span></span></tt> is raised. However, on most platforms the conversion cannot fail.</p>
- <p><pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="DecNumber">2</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="FloatNumber">3.7</span>
- <span class="Identifier">echo</span> <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">toFloat</span> <span class="Operator">+</span> <span class="Identifier">b</span> <span class="Comment"># => 5.7</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1291" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1291" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toInt-procs-all">
- <div id="toInt,float">
- <dt><pre><span class="Keyword">proc</span> <a href="#toInt%2Cfloat"><span class="Identifier">toInt</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">:</span> <a href="system.html#float"><span class="Identifier">float</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Converts a floating point number <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> into an <tt class="docutils literal"><span class="pre"><span class="Identifier">int</span></span></tt>.</p>
- <p>Conversion rounds <tt class="docutils literal"><span class="pre"><span class="Identifier">f</span></span></tt> half away from 0, see <a class="reference external" href="https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero">Round half away from zero</a>, as opposed to a type conversion which rounds towards zero.</p>
- <p>Note that some floating point numbers (e.g. infinity or even 1e19) cannot be accurately converted.</p>
- <p><pre class="listing"><span class="Identifier">doAssert</span> <span class="Identifier">toInt</span><span class="Punctuation">(</span><span class="FloatNumber">0.49</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">0</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">toInt</span><span class="Punctuation">(</span><span class="FloatNumber">0.5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="DecNumber">1</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">toInt</span><span class="Punctuation">(</span><span class="Operator">-</span><span class="FloatNumber">0.5</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Operator">-</span><span class="DecNumber">1</span> <span class="Comment"># rounding is symmetrical</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1310" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1310" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toOpenArray-procs-all">
- <div id="toOpenArray,cstring,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2Ccstring%2Cint%2Cint"><span class="Identifier">toOpenArray</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2814" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2814" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArray,string,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2Cstring%2Cint%2Cint"><span class="Identifier">toOpenArray</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2837" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2837" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArray,array[I,T],I,I">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2Carray%5BI%2CT%5D%2CI%2CI"><span class="Identifier">toOpenArray</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#array"><span class="Identifier">array</span></a><span class="Other">[</span><span class="Identifier">I</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <span class="Identifier">I</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2835" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2835" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArray,openArray[T],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2CopenArray%5BT%5D%2Cint%2Cint"><span class="Identifier">toOpenArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2833" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2833" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArray,ptr.UncheckedArray[T],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2Cptr.UncheckedArray%5BT%5D%2Cint%2Cint"><span class="Identifier">toOpenArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">ptr</span> <a href="system.html#UncheckedArray"><span class="Identifier">UncheckedArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2812" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2812" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArray,seq[T],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArray%2Cseq%5BT%5D%2Cint%2Cint"><span class="Identifier">toOpenArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Allows passing the slice of <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> from the element at <tt class="docutils literal"><span class="pre"><span class="Identifier">first</span></span></tt> to the element at <tt class="docutils literal"><span class="pre"><span class="Identifier">last</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">openArray</span><span class="Punctuation">[</span><span class="Identifier">T</span><span class="Punctuation">]</span></span></tt> parameters without copying it.</p>
- <p>Example:</p>
- <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">test</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">:</span> <span class="Identifier">openArray</span><span class="Punctuation">[</span><span class="Identifier">int</span><span class="Punctuation">]</span><span class="Punctuation">)</span> <span class="Operator">=</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span>
- <span class="Keyword">let</span> <span class="Identifier">s</span> <span class="Operator">=</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">0</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">]</span>
- <span class="Identifier">s</span><span class="Operator">.</span><span class="Identifier">toOpenArray</span><span class="Punctuation">(</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Operator">.</span><span class="Identifier">test</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2819" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2819" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toOpenArrayByte-procs-all">
- <div id="toOpenArrayByte,cstring,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArrayByte%2Ccstring%2Cint%2Cint"><span class="Identifier">toOpenArrayByte</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#cstring"><span class="Identifier">cstring</span></a><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2816" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2816" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArrayByte,openArray[char],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArrayByte%2CopenArray%5Bchar%5D%2Cint%2Cint"><span class="Identifier">toOpenArrayByte</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2842" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2842" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArrayByte,seq[char],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArrayByte%2Cseq%5Bchar%5D%2Cint%2Cint"><span class="Identifier">toOpenArrayByte</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#seq"><span class="Identifier">seq</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2844" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2844" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="toOpenArrayByte,string,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArrayByte%2Cstring%2Cint%2Cint"><span class="Identifier">toOpenArrayByte</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2840" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2840" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="toOpenArrayChar-procs-all">
- <div id="toOpenArrayChar,openArray[byte],int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#toOpenArrayChar%2CopenArray%5Bbyte%5D%2Cint%2Cint"><span class="Identifier">toOpenArrayChar</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#byte"><span class="Identifier">byte</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">first</span><span class="Other">,</span> <span class="Identifier">last</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#openArray"><span class="Identifier">openArray</span></a><span class="Other">[</span><a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">]</span> {.
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Slice"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2847" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2847" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="typeof-procs-all">
- <div id="typeof,untyped">
- <dt><pre><span class="Keyword">proc</span> <a href="#typeof%2Cuntyped"><span class="Identifier">typeof</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">;</span> <span class="Identifier">mode</span> <span class="Other">=</span> <span class="Identifier">typeOfIter</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"TypeOf"</span><span class="Other">,</span>
- <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span class="Identifier">compileTime</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Builtin <tt class="docutils literal"><span class="pre"><span class="Identifier">typeof</span></span></tt> operation for accessing the type of an expression. Since version 0.20.0.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">float</span> <span class="Operator">=</span> <span class="FloatNumber">0.0</span>
- <span class="Keyword">iterator</span> <span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span> <span class="Keyword">yield</span> <span class="StringLit">"abc"</span>
- <span class="Keyword">iterator</span> <span class="Identifier">myFoo2</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Operator">=</span> <span class="Keyword">yield</span> <span class="StringLit">"abc"</span>
- <span class="Keyword">iterator</span> <span class="Identifier">myFoo3</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">string</span> <span class="Punctuation">{</span><span class="Operator">.</span><span class="Identifier">closure</span><span class="Operator">.</span><span class="Punctuation">}</span> <span class="Operator">=</span> <span class="Keyword">yield</span> <span class="StringLit">"abc"</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">type</span><span class="Punctuation">(</span><span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">string</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">string</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">typeOfIter</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">string</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo3</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Keyword">iterator</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">typeOfProc</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">float</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="FloatNumber">0.0</span><span class="Punctuation">,</span> <span class="Identifier">typeOfProc</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Identifier">float</span>
- <span class="Identifier">doAssert</span> <span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo3</span><span class="Punctuation">,</span> <span class="Identifier">typeOfProc</span><span class="Punctuation">)</span> <span class="Keyword">is</span> <span class="Keyword">iterator</span>
- <span class="Identifier">doAssert</span> <span class="Keyword">not</span> <span class="Identifier">compiles</span><span class="Punctuation">(</span><span class="Identifier">typeof</span><span class="Punctuation">(</span><span class="Identifier">myFoo2</span><span class="Punctuation">(</span><span class="Punctuation">)</span><span class="Punctuation">,</span> <span class="Identifier">typeOfProc</span><span class="Punctuation">)</span><span class="Punctuation">)</span>
- <span class="Comment"># this would give: Error: attempting to call routine: 'myFoo2'</span>
- <span class="Comment"># since `typeOfProc` expects a typed expression and `myFoo2()` can</span>
- <span class="Comment"># only be used in a `for` context.</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L57" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unsafeAddr-procs-all">
- <div id="unsafeAddr,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#unsafeAddr%2CT"><span class="Identifier">unsafeAddr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">ptr</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Addr"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <div class="admonition admonition-warning"><span class="admonition-warning-text"><b>Warning:</b></span>
- <tt class="docutils literal"><span class="pre"><span class="Identifier">unsafeAddr</span></span></tt> is a deprecated alias for <tt class="docutils literal"><span class="pre"><span class="Keyword">addr</span></span></tt>, use <tt class="docutils literal"><span class="pre"><span class="Keyword">addr</span></span></tt> instead.</div>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L120" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L120" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unsafeNew-procs-all">
- <div id="unsafeNew,ref.T,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#unsafeNew%2Cref.T%2CNatural"><span class="Identifier">unsafeNew</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"New"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span>
- <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Creates a new object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> and returns a safe (traced) reference to it in <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt>.</p>
- <p>This is <strong>unsafe</strong> as it allocates an object of the passed <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt>. This should only be used for optimization purposes when you know what you're doing!</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#new,ref.T,proc(ref.T)">new</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L569" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L569" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unsetControlCHook-procs-all">
- <div id="unsetControlCHook">
- <dt><pre><span class="Keyword">proc</span> <a href="#unsetControlCHook"><span class="Identifier">unsetControlCHook</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Reverts a call to setControlCHook.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2195" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2195" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="wasMoved-procs-all">
- <div id="wasMoved,T">
- <dt><pre><span class="Keyword">proc</span> <a href="#wasMoved%2CT"><span class="Identifier">wasMoved</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">obj</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span>.}</pre></dt>
- <dd>
-
- Resets an object <tt class="docutils literal"><span class="pre"><span class="Identifier">obj</span></span></tt> to its initial (binary zero) value to signify it was "moved" and to signify its destructor should do nothing and ideally be optimized away.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L164" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L164" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="writeStackTrace-procs-all">
- <div id="writeStackTrace">
- <dt><pre><span class="Keyword">proc</span> <a href="#writeStackTrace"><span class="Identifier">writeStackTrace</span></a><span class="Other">(</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Writes the current stack trace to <tt class="docutils literal"><span class="pre"><span class="Identifier">stderr</span></span></tt>. This is only works for debug builds. Since it's usually used for debugging, this is proclaimed to have no IO effect!
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1715" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1715" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="xor-procs-all">
- <div id="xor,bool,bool">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cbool%2Cbool"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"Xor"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Boolean <tt class="docutils literal"><span class="pre"><span class="Identifier">exclusive</span> <span class="Keyword">or</span></span></tt>; returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span> <span class="Operator">!=</span> <span class="Identifier">y</span></span></tt> (if either argument is true while the other is false).
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/basic_types.nim#L89" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/basic_types.nim#L89" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,int,int">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cint%2Cint"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">xor</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0011</span> <span class="Keyword">xor</span> <span class="BinNumber">0b0101</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b0110</span>
- <span class="Identifier">assert</span> <span class="Punctuation">(</span><span class="BinNumber">0b0111</span> <span class="Keyword">xor</span> <span class="BinNumber">0b1100</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="BinNumber">0b1011</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L209" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L209" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,int8,int8">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cint8%2Cint8"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int8"><span class="Identifier">int8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L214" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L214" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,int16,int16">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cint16%2Cint16"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int16"><span class="Identifier">int16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L215" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L215" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,int32,int32">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cint32%2Cint32"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L216" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L216" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,int64,int64">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cint64%2Cint64"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L217" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L217" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,uint,uint">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cuint%2Cuint"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint"><span class="Identifier">uint</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- Computes the <tt class="docutils literal"><span class="pre"><span class="Identifier">bitwise</span> <span class="Keyword">xor</span></span></tt> of numbers <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L255" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L255" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,uint8,uint8">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cuint8%2Cuint8"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint8"><span class="Identifier">uint8</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L257" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,uint16,uint16">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cuint16%2Cuint16"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint16"><span class="Identifier">uint16</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L258" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L258" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,uint32,uint32">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cuint32%2Cuint32"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L259" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L259" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="xor,uint64,uint64">
- <dt><pre><span class="Keyword">proc</span> <a href="#xor%2Cuint64%2Cuint64"><span class="Identifier">`xor`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"BitxorI"</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arithmetics.nim#L260" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arithmetics.nim#L260" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="zeroDefault-procs-all">
- <div id="zeroDefault,typedesc[T]">
- <dt><pre><span class="Keyword">func</span> <a href="#zeroDefault%2Ctypedesc%5BT%5D"><span class="Identifier">zeroDefault</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"ZeroDefault"</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Returns the binary zeros representation of the type <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt>. It ignores default fields of an object.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#default,typedesc[T]">default</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L27" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="zeroMem-procs-all">
- <div id="zeroMem,pointer,Natural">
- <dt><pre><span class="Keyword">proc</span> <a href="#zeroMem%2Cpointer%2CNatural"><span class="Identifier">zeroMem</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">noSideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
- <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>Overwrites the contents of the memory at <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> with the value 0.</p>
- <p>Exactly <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes will be overwritten. Like any procedure dealing with raw memory this is <strong>unsafe</strong>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L2" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L2" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="|-procs-all">
- <div id="|,typedesc,typedesc">
- <dt><pre><span class="Keyword">proc</span> <a href="#%7C%2Ctypedesc%2Ctypedesc"><span class="Identifier">`|`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1432" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1432" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="15">
- <h1><a class="toc-backref" href="#15">Iterators</a></h1>
- <dl class="item">
- <div id="..-iterators-all">
- <div id="...i,int32,int32">
- <dt><pre><span class="Keyword">iterator</span> <a href="#...i%2Cint32%2Cint32"><span class="Identifier">`..`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt> for convenience so that mixing integer types works better.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#..<.i,T,T">..<</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L122" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L122" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="...i,int64,int64">
- <dt><pre><span class="Keyword">iterator</span> <a href="#...i%2Cint64%2Cint64"><span class="Identifier">`..`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt> for convenience so that mixing integer types works better.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#..<.i,T,T">..<</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L121" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L121" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="...i,uint32,uint32">
- <dt><pre><span class="Keyword">iterator</span> <a href="#...i%2Cuint32%2Cuint32"><span class="Identifier">`..`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt> for convenience so that mixing integer types works better.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#..<.i,T,T">..<</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L124" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="...i,uint64,uint64">
- <dt><pre><span class="Keyword">iterator</span> <a href="#...i%2Cuint64%2Cuint64"><span class="Identifier">`..`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt> for convenience so that mixing integer types works better.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#..<.i,T,T">..<</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L123" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L123" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="...i,T,T">
- <dt><pre><span class="Keyword">iterator</span> <a href="#...i%2CT%2CT"><span class="Identifier">`..`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>An alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">countup</span><span class="Punctuation">(</span><span class="Identifier">a</span><span class="Punctuation">,</span> <span class="Identifier">b</span><span class="Punctuation">,</span> <span class="DecNumber">1</span><span class="Punctuation">)</span></span></tt>.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#..<.i,T,T">..<</a></li>
- </ul>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
- <span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Identifier">newSeq</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="DecNumber">3</span> <span class="Operator">..</span> <span class="DecNumber">7</span><span class="Punctuation">:</span>
- <span class="Identifier">i</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L81" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L81" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="..<-iterators-all">
- <div id="..<.i,int32,int32">
- <dt><pre><span class="Keyword">iterator</span> <a href="#..%3C.i%2Cint32%2Cint32"><span class="Identifier">`..<`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int32"><span class="Identifier">int32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..<</span></span></tt> for convenience so that mixing integer types works better.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L143" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L143" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="..<.i,int64,int64">
- <dt><pre><span class="Keyword">iterator</span> <a href="#..%3C.i%2Cint64%2Cint64"><span class="Identifier">`..<`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int64"><span class="Identifier">int64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..<</span></span></tt> for convenience so that mixing integer types works better.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L142" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L142" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="..<.i,uint32,uint32">
- <dt><pre><span class="Keyword">iterator</span> <a href="#..%3C.i%2Cuint32%2Cuint32"><span class="Identifier">`..<`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint32"><span class="Identifier">uint32</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..<</span></span></tt> for convenience so that mixing integer types works better.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L145" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L145" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="..<.i,uint64,uint64">
- <dt><pre><span class="Keyword">iterator</span> <a href="#..%3C.i%2Cuint64%2Cuint64"><span class="Identifier">`..<`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#uint64"><span class="Identifier">uint64</span></a> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- A type specialized version of <tt class="docutils literal"><span class="pre"><span class="Operator">..<</span></span></tt> for convenience so that mixing integer types works better.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L144" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L144" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="..<.i,T,T">
- <dt><pre><span class="Keyword">iterator</span> <a href="#..%3C.i%2CT%2CT"><span class="Identifier">`..<`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L126" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L126" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="countdown-iterators-all">
- <div id="countdown.i,T,T,Positive">
- <dt><pre><span class="Keyword">iterator</span> <a href="#countdown.i%2CT%2CT%2CPositive"><span class="Identifier">countdown</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">step</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</span></a> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Counts from ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> down to <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> (inclusive) with the given step count.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> may be any ordinal type, <tt class="docutils literal"><span class="pre"><span class="Identifier">step</span></span></tt> may only be positive.</p>
- <p><strong>Note</strong>: This fails to count to <tt class="docutils literal"><span class="pre"><span class="Identifier">low</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span></span></tt> if T = int for efficiency reasons.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
- <span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Identifier">newSeq</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">countdown</span><span class="Punctuation">(</span><span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">i</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span>
- <span class="Keyword">let</span> <span class="Identifier">y</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Identifier">newseq</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">countdown</span><span class="Punctuation">(</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">i</span>
- <span class="Identifier">assert</span> <span class="Identifier">y</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L6" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L6" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="countup-iterators-all">
- <div id="countup.i,T,T,Positive">
- <dt><pre><span class="Keyword">iterator</span> <a href="#countup.i%2CT%2CT%2CPositive"><span class="Identifier">countup</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">step</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</span></a> <span class="Other">=</span> <span class="DecNumber">1</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span>.}</pre></dt>
- <dd>
-
- <p>Counts from ordinal value <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Identifier">b</span></span></tt> (inclusive) with the given step count.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> may be any ordinal type, <tt class="docutils literal"><span class="pre"><span class="Identifier">step</span></span></tt> may only be positive.</p>
- <p><strong>Note</strong>: This fails to count to <tt class="docutils literal"><span class="pre"><span class="Identifier">high</span><span class="Punctuation">(</span><span class="Identifier">int</span><span class="Punctuation">)</span></span></tt> if T = int for efficiency reasons.</p>
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">import</span> <span class="Identifier">std</span><span class="Operator">/</span><span class="Identifier">sugar</span>
- <span class="Keyword">let</span> <span class="Identifier">x</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Identifier">newSeq</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">countup</span><span class="Punctuation">(</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">i</span>
- <span class="Identifier">assert</span> <span class="Identifier">x</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">]</span>
- <span class="Keyword">let</span> <span class="Identifier">y</span> <span class="Operator">=</span> <span class="Identifier">collect</span><span class="Punctuation">(</span><span class="Identifier">newseq</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="Identifier">countup</span><span class="Punctuation">(</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">9</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">i</span>
- <span class="Identifier">assert</span> <span class="Identifier">y</span> <span class="Operator">==</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">2</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">8</span><span class="Punctuation">]</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L46" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="||-iterators-all">
- <div id="||.i,S,T,staticstring">
- <dt><pre><span class="Keyword">iterator</span> <a href="#%7C%7C.i%2CS%2CT%2Cstaticstring"><span class="Identifier">`||`</span></a><span class="Other">[</span><span class="Identifier">S</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">annotation</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">"parallel for"</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.
- <span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"OmpParFor"</span><span class="Other">,</span> <span class="Identifier">sideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>OpenMP parallel loop iterator. Same as <tt class="docutils literal"><span class="pre"><span class="Operator">..</span></span></tt> but the loop may run in parallel.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">annotation</span></span></tt> is an additional annotation for the code generator to use. The default annotation is <tt class="docutils literal"><span class="pre"><span class="Identifier">parallel</span> <span class="Keyword">for</span></span></tt>. Please refer to the <a class="reference external" href="https://www.openmp.org/wp-content/uploads/OpenMP-4.5-1115-CPP-web.pdf">OpenMP Syntax Reference</a> for further information.</p>
- <p>Note that the compiler maps that to the <tt class="docutils literal"><span class="pre"><span class="Comment">#pragma omp parallel for</span></span></tt> construct of <span id="openmp_1">OpenMP</span> and as such isn't aware of the parallelism in your code! Be careful! Later versions of <tt class="docutils literal"><span class="pre"><span class="Operator">||</span></span></tt> will get proper support by Nim's code generator and GC.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L147" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L147" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="||.i,S,T,Positive,staticstring">
- <dt><pre><span class="Keyword">iterator</span> <a href="#%7C%7C.i%2CS%2CT%2CPositive%2Cstaticstring"><span class="Identifier">`||`</span></a><span class="Other">[</span><span class="Identifier">S</span><span class="Other">,</span> <span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">step</span><span class="Other">:</span> <a href="system.html#Positive"><span class="Identifier">Positive</span></a><span class="Other">;</span>
- <span class="Identifier">annotation</span><span class="Other">:</span> <a href="system.html#static"><span class="Identifier">static</span></a> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">"parallel for"</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
- <span class="Identifier">magic</span><span class="Other">:</span> <span class="StringLit">"OmpParFor"</span><span class="Other">,</span> <span class="Identifier">sideEffect</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
- <dd>
-
- <p>OpenMP parallel loop iterator with stepping. Same as <tt class="docutils literal"><span class="pre"><span class="Identifier">countup</span></span></tt> but the loop may run in parallel.</p>
- <p><tt class="docutils literal"><span class="pre"><span class="Identifier">annotation</span></span></tt> is an additional annotation for the code generator to use. The default annotation is <tt class="docutils literal"><span class="pre"><span class="Identifier">parallel</span> <span class="Keyword">for</span></span></tt>. Please refer to the <a class="reference external" href="https://www.openmp.org/wp-content/uploads/OpenMP-4.5-1115-CPP-web.pdf">OpenMP Syntax Reference</a> for further information.</p>
- <p>Note that the compiler maps that to the <tt class="docutils literal"><span class="pre"><span class="Comment">#pragma omp parallel for</span></span></tt> construct of <span id="openmp_2">OpenMP</span> and as such isn't aware of the parallelism in your code! Be careful! Later versions of <tt class="docutils literal"><span class="pre"><span class="Operator">||</span></span></tt> will get proper support by Nim's code generator and GC.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/iterators_1.nim#L164" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/iterators_1.nim#L164" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="17">
- <h1><a class="toc-backref" href="#17">Macros</a></h1>
- <dl class="item">
- <div id="varargsLen-macros-all">
- <div id="varargsLen.m,varargs[untyped]">
- <dt><pre><span class="Keyword">macro</span> <a href="#varargsLen.m%2Cvarargs%5Buntyped%5D"><span class="Identifier">varargsLen</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#varargs"><span class="Identifier">varargs</span></a><span class="Other">[</span><a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
- returns number of variadic arguments in <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2528" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2528" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- <div class="section" id="18">
- <h1><a class="toc-backref" href="#18">Templates</a></h1>
- <dl class="item">
- <div id="!=-templates-all">
- <div id="!=.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#%21%3D.t%2Cuntyped%2Cuntyped"><span class="Identifier">`!=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- Unequals operator. This is a shorthand for <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span> <span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Operator">==</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L131" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L131" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="&=-templates-all">
- <div id="&=.t,typed,typed">
- <dt><pre><span class="Keyword">template</span> <a href="#%26%3D.t%2Ctyped%2Ctyped"><span class="Identifier">`&=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">)</span></pre></dt>
- <dd>
-
- <p>Generic 'sink' operator for Nim.</p>
- <p>If not specialized further, an alias for <tt class="docutils literal"><span class="pre"><span class="Identifier">add</span></span></tt>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2476" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2476" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="..<-templates-all">
- <div id="..<.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#..%3C.t%2Cuntyped%2Cuntyped"><span class="Identifier">`..<`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- <p>A shortcut for <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span> <span class="Operator">..</span> <span class="Identifier">pred</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="DecNumber">5</span> <span class="Operator">..<</span> <span class="DecNumber">9</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="Identifier">i</span> <span class="Comment"># => 5; 6; 7; 8</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L47" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="..^-templates-all">
- <div id="..^.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#..%5E.t%2Cuntyped%2Cuntyped"><span class="Identifier">`..^`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- A shortcut for <tt class="docutils literal"><span class="pre"><span class="Operator">..</span> <span class="Operator">^</span></span></tt> to avoid the common gotcha that a space between '..' and '^' is required.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L42" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="=dispose-templates-all">
- <div id="=dispose.t">
- <dt><pre><span class="Keyword">template</span> <a href="#%3Ddispose.t"><span class="Identifier">`=dispose`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Identifier">owned</span><span class="Other">(</span><span class="Keyword">ref</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">)</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L193" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L193" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id=">-templates-all">
- <div id=">.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#%3E.t%2Cuntyped%2Cuntyped"><span class="Identifier">`>`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- "is greater" operator. This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span> <span class="Operator"><</span> <span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L139" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L139" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id=">%-templates-all">
- <div id=">%.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#%3E%25.t%2Cuntyped%2Cuntyped"><span class="Identifier">`>%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and compares them. Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">></span> <span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L201" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L201" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id=">=-templates-all">
- <div id=">=.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#%3E%3D.t%2Cuntyped%2Cuntyped"><span class="Identifier">`>=`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- "is greater or equals" operator. This is the same as <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span> <span class="Operator"><=</span> <span class="Identifier">x</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L135" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L135" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id=">=%-templates-all">
- <div id=">=%.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#%3E%3D%25.t%2Cuntyped%2Cuntyped"><span class="Identifier">`>=%`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- Treats <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> as unsigned and compares them. Returns true if <tt class="docutils literal"><span class="pre"><span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">x</span><span class="Punctuation">)</span> <span class="Operator">>=</span> <span class="Identifier">unsigned</span><span class="Punctuation">(</span><span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/comparisons.nim#L197" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/comparisons.nim#L197" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="[]-templates-all">
- <div id="[].t,string,int">
- <dt><pre><span class="Keyword">template</span> <a href="#%5B%5D.t%2Cstring%2Cint"><span class="Identifier">`[]`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L55" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="[]=-templates-all">
- <div id="[]=.t,string,int,char">
- <dt><pre><span class="Keyword">template</span> <a href="#%5B%5D%3D.t%2Cstring%2Cint%2Cchar"><span class="Identifier">`[]=`</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span> <span class="Identifier">i</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#char"><span class="Identifier">char</span></a><span class="Other">)</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L56" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L56" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="^-templates-all">
- <div id="^.t,int">
- <dt><pre><span class="Keyword">template</span> <a href="#%5E.t%2Cint"><span class="Identifier">`^`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a></pre></dt>
- <dd>
-
- <p>Builtin <span id="roof_1">roof</span> operator that can be used for convenient array access. <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="Identifier">x</span><span class="Punctuation">]</span></span></tt> is a shortcut for <tt class="docutils literal"><span class="pre"><span class="Identifier">a</span><span class="Punctuation">[</span><span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">len</span><span class="Operator">-</span><span class="Identifier">x</span><span class="Punctuation">]</span></span></tt>.</p>
- <p><pre class="listing"><span class="Keyword">let</span>
- <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">,</span> <span class="DecNumber">9</span><span class="Punctuation">]</span>
- <span class="Identifier">b</span> <span class="Operator">=</span> <span class="StringLit">"abcdefgh"</span>
- <span class="Identifier">echo</span> <span class="Identifier">a</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">1</span><span class="Punctuation">]</span> <span class="Comment"># => 9</span>
- <span class="Identifier">echo</span> <span class="Identifier">b</span><span class="Punctuation">[</span><span class="Operator">^</span><span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Comment"># => g</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indices.nim#L9" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indices.nim#L9" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="alloc-templates-all">
- <div id="alloc.t,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#alloc.t%2CNatural"><span class="Identifier">alloc</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Allocates a new memory block with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#realloc.t,pointer,Natural">realloc(block, 0)</a> or <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>. The block is not initialized, so reading from it before writing to it is undefined behaviour!</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#allocShared.t,Natural">allocShared</a> to allocate from a shared heap.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#alloc0.t,Natural">alloc0</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L90" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="alloc0-templates-all">
- <div id="alloc0.t,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#alloc0.t%2CNatural"><span class="Identifier">alloc0</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Allocates a new memory block with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#realloc.t,pointer,Natural">realloc(block, 0)</a> or <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>. The block is initialized with all bytes containing zero, so it is somewhat safer than <a class="reference external" href="#alloc.t,Natural">alloc</a>.</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#allocShared0.t,Natural">allocShared0</a> to allocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L121" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L121" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocShared-templates-all">
- <div id="allocShared.t,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#allocShared.t%2CNatural"><span class="Identifier">allocShared</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Allocates a new memory block on the shared heap with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#reallocShared.t,pointer,Natural">reallocShared(block, 0)</a> or <a class="reference external" href="#deallocShared,pointer">deallocShared(block)</a>.</p>
- <p>The block is not initialized, so reading from it before writing to it is undefined behaviour!</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="#allocShared0.t,Natural">allocShared0</a>.</li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L204" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L204" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="allocShared0-templates-all">
- <div id="allocShared0.t,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#allocShared0.t%2CNatural"><span class="Identifier">allocShared0</span></a><span class="Other">(</span><span class="Identifier">size</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Allocates a new memory block on the shared heap with at least <tt class="docutils literal"><span class="pre"><span class="Identifier">size</span></span></tt> bytes.</p>
- <p>The block has to be freed with <a class="reference external" href="#reallocShared.t,pointer,Natural">reallocShared(block, 0)</a> or <a class="reference external" href="#deallocShared,pointer">deallocShared(block)</a>.</p>
- <p>The block is initialized with all bytes containing zero, so it is somewhat safer than <a class="reference external" href="#allocShared.t,Natural">allocShared</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L236" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L236" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="closureScope-templates-all">
- <div id="closureScope.t,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#closureScope.t%2Cuntyped"><span class="Identifier">closureScope</span></a><span class="Other">(</span><span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- <p>Useful when creating a closure in a loop to capture local loop variables by their current iteration values.</p>
- <p>Note: This template may not work in some cases, use <a class="reference external" href="sugar.html#capture.m,varargs[typed],untyped">capture</a> instead.</p>
- <p>Example:</p>
- <p><pre class="listing"><span class="Keyword">var</span> <span class="Identifier">myClosure</span> <span class="Punctuation">:</span> <span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Comment"># without closureScope:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">:</span>
- <span class="Keyword">let</span> <span class="Identifier">j</span> <span class="Operator">=</span> <span class="Identifier">i</span>
- <span class="Keyword">if</span> <span class="Identifier">j</span> <span class="Operator">==</span> <span class="DecNumber">3</span><span class="Punctuation">:</span>
- <span class="Identifier">myClosure</span> <span class="Operator">=</span> <span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">echo</span> <span class="Identifier">j</span>
- <span class="Identifier">myClosure</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># outputs 5. `j` is changed after closure creation</span>
- <span class="Comment"># with closureScope:</span>
- <span class="Keyword">for</span> <span class="Identifier">i</span> <span class="Keyword">in</span> <span class="DecNumber">0</span> <span class="Operator">..</span> <span class="DecNumber">5</span><span class="Punctuation">:</span>
- <span class="Identifier">closureScope</span><span class="Punctuation">:</span> <span class="Comment"># Everything in this scope is locked after closure creation</span>
- <span class="Keyword">let</span> <span class="Identifier">j</span> <span class="Operator">=</span> <span class="Identifier">i</span>
- <span class="Keyword">if</span> <span class="Identifier">j</span> <span class="Operator">==</span> <span class="DecNumber">3</span><span class="Punctuation">:</span>
- <span class="Identifier">myClosure</span> <span class="Operator">=</span> <span class="Keyword">proc</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Operator">=</span> <span class="Identifier">echo</span> <span class="Identifier">j</span>
- <span class="Identifier">myClosure</span><span class="Punctuation">(</span><span class="Punctuation">)</span> <span class="Comment"># outputs 3</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2728" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2728" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="currentSourcePath-templates-all">
- <div id="currentSourcePath.t">
- <dt><pre><span class="Keyword">template</span> <a href="#currentSourcePath.t"><span class="Identifier">currentSourcePath</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
- <p>Returns the full file-system path of the current source.</p>
- <p>To get the directory containing the current source, use it with <a class="reference external" href="ospaths2.html#parentDir%2Cstring">ospaths2.parentDir()</a> as <tt class="docutils literal"><span class="pre"><span class="Identifier">currentSourcePath</span><span class="Operator">.</span><span class="Identifier">parentDir</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>.</p>
- <p>The path returned by this template is set at compile time.</p>
- <p>See the docstring of <a class="reference external" href="macros.html#getProjectPath">macros.getProjectPath()</a> for an example to see the distinction between the <tt class="docutils literal"><span class="pre"><span class="Identifier">currentSourcePath</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">getProjectPath</span><span class="Punctuation">(</span><span class="Punctuation">)</span></span></tt>.</p>
- <p>See also:</p>
- <ul class="simple"><li><a class="reference external" href="ospaths2.html#getCurrentDir">ospaths2.getCurrentDir() proc</a></li>
- </ul>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/compilation.nim#L143" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/compilation.nim#L143" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="disarm-templates-all">
- <div id="disarm.t,typed">
- <dt><pre><span class="Keyword">template</span> <a href="#disarm.t%2Ctyped"><span class="Identifier">disarm</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">)</span></pre></dt>
- <dd>
-
- Useful for <tt class="docutils literal"><span class="pre"><span class="Identifier">disarming</span></span></tt> dangling pointers explicitly for <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">newruntime</span></span></tt>. Regardless of whether <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">newruntime</span></span></tt> is used or not this sets the pointer or callback <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt> to <tt class="docutils literal"><span class="pre"><span class="Keyword">nil</span></span></tt>. This is an experimental API!
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L845" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L845" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="dumpAllocstats-templates-all">
- <div id="dumpAllocstats.t,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#dumpAllocstats.t%2Cuntyped"><span class="Identifier">dumpAllocstats</span></a><span class="Other">(</span><span class="Identifier">code</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L75" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L75" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="excl-templates-all">
- <div id="excl.t,set[T],set[T]">
- <dt><pre><span class="Keyword">template</span> <a href="#excl.t%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">excl</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- Excludes the set <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> from the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span>
- <span class="Keyword">var</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">}</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">excl</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L33" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L33" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="formatErrorIndexBound-templates-all">
- <div id="formatErrorIndexBound.t,T,T,T">
- <dt><pre><span class="Keyword">template</span> <a href="#formatErrorIndexBound.t%2CT%2CT%2CT"><span class="Identifier">formatErrorIndexBound</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">i</span><span class="Other">,</span> <span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indexerrors.nim#L4" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indexerrors.nim#L4" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="formatErrorIndexBound.t,T,T">
- <dt><pre><span class="Keyword">template</span> <a href="#formatErrorIndexBound.t%2CT%2CT"><span class="Identifier">formatErrorIndexBound</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">i</span><span class="Other">,</span> <span class="Identifier">n</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indexerrors.nim#L11" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indexerrors.nim#L11" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="formatFieldDefect-templates-all">
- <div id="formatFieldDefect.t,,">
- <dt><pre><span class="Keyword">template</span> <a href="#formatFieldDefect.t%2C%2C"><span class="Identifier">formatFieldDefect</span></a><span class="Other">(</span><span class="Identifier">f</span><span class="Other">,</span> <span class="Identifier">discVal</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/indexerrors.nim#L14" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/indexerrors.nim#L14" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="in-templates-all">
- <div id="in.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#in.t%2Cuntyped%2Cuntyped"><span class="Identifier">`in`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">dirty</span><span class="Other">,</span> <span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- <p>Sugar for <tt class="docutils literal"><span class="pre"><span class="Identifier">contains</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Keyword">in</span> <span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="DecNumber">5</span> <span class="Keyword">in</span> <span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L759" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L759" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="incl-templates-all">
- <div id="incl.t,set[T],set[T]">
- <dt><pre><span class="Keyword">template</span> <a href="#incl.t%2Cset%5BT%5D%2Cset%5BT%5D"><span class="Identifier">incl</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#set"><span class="Identifier">set</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- Includes the set <tt class="docutils literal"><span class="pre"><span class="Identifier">y</span></span></tt> in the set <tt class="docutils literal"><span class="pre"><span class="Identifier">x</span></span></tt>.
- <p><strong class="examples_text">Example:</strong></p>
- <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">a</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span>
- <span class="Keyword">var</span> <span class="Identifier">b</span> <span class="Operator">=</span> <span class="Punctuation">{</span><span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">}</span>
- <span class="Identifier">a</span><span class="Operator">.</span><span class="Identifier">incl</span><span class="Punctuation">(</span><span class="Identifier">b</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span> <span class="Identifier">a</span> <span class="Operator">==</span> <span class="Punctuation">{</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">3</span><span class="Punctuation">,</span> <span class="DecNumber">4</span><span class="Punctuation">,</span> <span class="DecNumber">5</span><span class="Punctuation">,</span> <span class="DecNumber">6</span><span class="Punctuation">,</span> <span class="DecNumber">7</span><span class="Punctuation">}</span></pre>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/setops.nim#L15" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/setops.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="isnot-templates-all">
- <div id="isnot.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#isnot.t%2Cuntyped%2Cuntyped"><span class="Identifier">`isnot`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- <p>Negated version of <a class="reference external" href="#is,T,S">is</a>. Equivalent to <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span><span class="Punctuation">(</span><span class="Identifier">x</span> <span class="Keyword">is</span> <span class="Identifier">y</span><span class="Punctuation">)</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span> <span class="DecNumber">42</span> <span class="Keyword">isnot</span> <span class="Identifier">float</span>
- <span class="Identifier">assert</span> <span class="Operator">@</span><span class="Punctuation">[</span><span class="DecNumber">1</span><span class="Punctuation">,</span> <span class="DecNumber">2</span><span class="Punctuation">]</span> <span class="Keyword">isnot</span> <span class="Keyword">enum</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L790" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L790" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="likely-templates-all">
- <div id="likely.t,bool">
- <dt><pre><span class="Keyword">template</span> <a href="#likely.t%2Cbool"><span class="Identifier">likely</span></a><span class="Other">(</span><span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- <p>Hints the optimizer that <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> is likely going to be true.</p>
- <p>You can use this template to decorate a branch condition. On certain platforms this can help the processor predict better which branch is going to be run. Example:</p>
- <p><pre class="listing"><span class="Keyword">for</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Identifier">inputValues</span><span class="Punctuation">:</span>
- <span class="Keyword">if</span> <span class="Identifier">likely</span><span class="Punctuation">(</span><span class="Identifier">value</span> <span class="Operator"><=</span> <span class="DecNumber">100</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">process</span><span class="Punctuation">(</span><span class="Identifier">value</span><span class="Punctuation">)</span>
- <span class="Keyword">else</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="StringLit">"Value too big!"</span></pre></p>
- <p>On backends without branch prediction (JS and the nimscript VM), this template will not affect code execution.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1960" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1960" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="newException-templates-all">
- <div id="newException.t,typedesc,string,ref.Exception">
- <dt><pre><span class="Keyword">template</span> <a href="#newException.t%2Ctypedesc%2Cstring%2Cref.Exception"><span class="Identifier">newException</span></a><span class="Other">(</span><span class="Identifier">exceptn</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">;</span> <span class="Identifier">message</span><span class="Other">:</span> <a href="system.html#string"><span class="Identifier">string</span></a><span class="Other">;</span>
- <span class="Identifier">parentException</span><span class="Other">:</span> <span class="Keyword">ref</span> <a href="system.html#Exception"><span class="Identifier">Exception</span></a> <span class="Other">=</span> <span class="Keyword">nil</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- Creates an exception object of type <tt class="docutils literal"><span class="pre"><span class="Identifier">exceptn</span></span></tt> and sets its <tt class="docutils literal"><span class="pre"><span class="Identifier">msg</span></span></tt> field to <tt class="docutils literal"><span class="pre"><span class="Identifier">message</span></span></tt>. Returns the new exception object.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1743" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1743" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="nimThreadProcWrapperBody-templates-all">
- <div id="nimThreadProcWrapperBody.t,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#nimThreadProcWrapperBody.t%2Cuntyped"><span class="Identifier">nimThreadProcWrapperBody</span></a><span class="Other">(</span><span class="Identifier">closure</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/threadimpl.nim#L97" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/threadimpl.nim#L97" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="notin-templates-all">
- <div id="notin.t,untyped,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#notin.t%2Cuntyped%2Cuntyped"><span class="Identifier">`notin`</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">,</span> <span class="Identifier">y</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a> {.<span class="Identifier">dirty</span><span class="Other">,</span> <span class="Identifier">callsite</span>.}</pre></dt>
- <dd>
-
- <p>Sugar for <tt class="docutils literal"><span class="pre"><span class="Keyword">not</span> <span class="Identifier">contains</span></span></tt>.</p>
- <p><pre class="listing"><span class="Identifier">assert</span><span class="Punctuation">(</span><span class="DecNumber">1</span> <span class="Keyword">notin</span> <span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">false</span><span class="Punctuation">)</span>
- <span class="Identifier">assert</span><span class="Punctuation">(</span><span class="DecNumber">5</span> <span class="Keyword">notin</span> <span class="Punctuation">(</span><span class="FloatNumber">1.</span><span class="Operator">.</span><span class="DecNumber">3</span><span class="Punctuation">)</span> <span class="Operator">==</span> <span class="Identifier">true</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L765" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L765" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="offsetOf-templates-all">
- <div id="offsetOf.t,typedesc[T],untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#offsetOf.t%2Ctypedesc%5BT%5D%2Cuntyped"><span class="Identifier">offsetOf</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">t</span><span class="Other">:</span> <a href="system.html#typedesc"><span class="Identifier">typedesc</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">member</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L604" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L604" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- <div id="offsetOf.t,T,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#offsetOf.t%2CT%2Cuntyped"><span class="Identifier">offsetOf</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">;</span> <span class="Identifier">member</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L608" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L608" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="once-templates-all">
- <div id="once.t,untyped">
- <dt><pre><span class="Keyword">template</span> <a href="#once.t%2Cuntyped"><span class="Identifier">once</span></a><span class="Other">(</span><span class="Identifier">body</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
- <p>Executes a block of code only once (the first time the block is reached).</p>
- <p><pre class="listing"><span class="Keyword">proc</span> <span class="Identifier">draw</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Punctuation">:</span> <span class="Identifier">Triangle</span><span class="Punctuation">)</span> <span class="Operator">=</span>
- <span class="Identifier">once</span><span class="Punctuation">:</span>
- <span class="Identifier">graphicsInit</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
- <span class="Identifier">line</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p1</span><span class="Punctuation">,</span> <span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p2</span><span class="Punctuation">)</span>
- <span class="Identifier">line</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p2</span><span class="Punctuation">,</span> <span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p3</span><span class="Punctuation">)</span>
- <span class="Identifier">line</span><span class="Punctuation">(</span><span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p3</span><span class="Punctuation">,</span> <span class="Identifier">t</span><span class="Operator">.</span><span class="Identifier">p1</span><span class="Punctuation">)</span></pre></p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2755" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2755" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="rangeCheck-templates-all">
- <div id="rangeCheck.t">
- <dt><pre><span class="Keyword">template</span> <a href="#rangeCheck.t"><span class="Identifier">rangeCheck</span></a><span class="Other">(</span><span class="Identifier">cond</span><span class="Other">)</span></pre></dt>
- <dd>
-
- Helper for performing user-defined range checks. Such checks will be performed only when the <tt class="docutils literal"><span class="pre"><span class="Identifier">rangechecks</span></span></tt> compile-time option is enabled.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L2483" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L2483" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="realloc-templates-all">
- <div id="realloc.t,pointer,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#realloc.t%2Cpointer%2CNatural"><span class="Identifier">realloc</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">realloc</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">dealloc</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>.</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#reallocShared.t,pointer,Natural">reallocShared</a> to reallocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L146" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L146" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="realloc0-templates-all">
- <div id="realloc0.t,pointer,Natural,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#realloc0.t%2Cpointer%2CNatural%2CNatural"><span class="Identifier">realloc0</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">oldSize</span><span class="Other">,</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">realloc</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">dealloc</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <a class="reference external" href="#dealloc,pointer">dealloc(block)</a>.</p>
- <p>The block is initialized with all bytes containing zero, so it is somewhat safer then realloc</p>
- <p>The allocated memory belongs to its allocating thread! Use <a class="reference external" href="#reallocShared.t,pointer,Natural">reallocShared</a> to reallocate from a shared heap.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L160" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L160" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reallocShared-templates-all">
- <div id="reallocShared.t,pointer,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#reallocShared.t%2Cpointer%2CNatural"><span class="Identifier">reallocShared</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block on the heap.</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">reallocShared</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">deallocShared</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <a class="reference external" href="#deallocShared,pointer">deallocShared</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L263" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L263" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="reallocShared0-templates-all">
- <div id="reallocShared0.t,pointer,Natural,Natural">
- <dt><pre><span class="Keyword">template</span> <a href="#reallocShared0.t%2Cpointer%2CNatural%2CNatural"><span class="Identifier">reallocShared0</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">oldSize</span><span class="Other">,</span> <span class="Identifier">newSize</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
- <dd>
-
- <p>Grows or shrinks a given memory block on the heap.</p>
- <p>When growing, the new bytes of the block is initialized with all bytes containing zero, so it is somewhat safer then reallocShared</p>
- <p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is <strong>nil</strong> then a new memory block is returned. In either way the block has at least <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span></span></tt> bytes. If <tt class="docutils literal"><span class="pre"><span class="Identifier">newSize</span> <span class="Operator">==</span> <span class="DecNumber">0</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">p</span></span></tt> is not <strong>nil</strong> <tt class="docutils literal"><span class="pre"><span class="Identifier">reallocShared</span></span></tt> calls <tt class="docutils literal"><span class="pre"><span class="Identifier">deallocShared</span><span class="Punctuation">(</span><span class="Identifier">p</span><span class="Punctuation">)</span></span></tt>. In other cases the block has to be freed with <a class="reference external" href="#deallocShared,pointer">deallocShared</a>.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/memalloc.nim#L274" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/memalloc.nim#L274" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="setupForeignThreadGc-templates-all">
- <div id="setupForeignThreadGc.t">
- <dt><pre><span class="Keyword">template</span> <a href="#setupForeignThreadGc.t"><span class="Identifier">setupForeignThreadGc</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
- <dd>
-
- With <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">arc</span></span></tt> a nop.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L257" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L257" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="tearDownForeignThreadGc-templates-all">
- <div id="tearDownForeignThreadGc.t">
- <dt><pre><span class="Keyword">template</span> <a href="#tearDownForeignThreadGc.t"><span class="Identifier">tearDownForeignThreadGc</span></a><span class="Other">(</span><span class="Other">)</span></pre></dt>
- <dd>
-
- With <tt class="docutils literal"><span class="pre"><span class="Operator">--</span><span class="Identifier">mm</span><span class="Punctuation">:</span><span class="Identifier">arc</span></span></tt> a nop.
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system/arc.nim#L261" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system/arc.nim#L261" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unlikely-templates-all">
- <div id="unlikely.t,bool">
- <dt><pre><span class="Keyword">template</span> <a href="#unlikely.t%2Cbool"><span class="Identifier">unlikely</span></a><span class="Other">(</span><span class="Identifier">val</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#bool"><span class="Identifier">bool</span></a></pre></dt>
- <dd>
-
- <p>Hints the optimizer that <tt class="docutils literal"><span class="pre"><span class="Identifier">val</span></span></tt> is likely going to be false.</p>
- <p>You can use this proc to decorate a branch condition. On certain platforms this can help the processor predict better which branch is going to be run. Example:</p>
- <p><pre class="listing"><span class="Keyword">for</span> <span class="Identifier">value</span> <span class="Keyword">in</span> <span class="Identifier">inputValues</span><span class="Punctuation">:</span>
- <span class="Keyword">if</span> <span class="Identifier">unlikely</span><span class="Punctuation">(</span><span class="Identifier">value</span> <span class="Operator">></span> <span class="DecNumber">100</span><span class="Punctuation">)</span><span class="Punctuation">:</span>
- <span class="Identifier">echo</span> <span class="StringLit">"Value too big!"</span>
- <span class="Keyword">else</span><span class="Punctuation">:</span>
- <span class="Identifier">process</span><span class="Punctuation">(</span><span class="Identifier">value</span><span class="Punctuation">)</span></pre></p>
- <p>On backends without branch prediction (JS and the nimscript VM), this template will not affect code execution.</p>
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L1984" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L1984" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- <div id="unown-templates-all">
- <div id="unown.t,typed">
- <dt><pre><span class="Keyword">template</span> <a href="#unown.t%2Ctyped"><span class="Identifier">unown</span></a><span class="Other">(</span><span class="Identifier">x</span><span class="Other">:</span> <a href="system.html#typed"><span class="Identifier">typed</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#untyped"><span class="Identifier">untyped</span></a></pre></dt>
- <dd>
-
-
- <a href="https://github.com/nim-lang/Nim/tree/devel/lib/system.nim#L825" class="link-seesrc" target="_blank">Source</a>
- <a href="https://github.com/nim-lang/Nim/edit/devel/lib/system.nim#L825" class="link-seesrc" target="_blank" >Edit</a>
- </dd>
- </div>
- </div>
- </dl>
- </div>
- </div>
- </div>
- <div class="twelve-columns footer">
- <span class="nim-sprite"></span>
- <br>
- <small style="color: var(--hint);">Made with Nim. Generated: 2025-03-15 14:12:57 UTC</small>
- </div>
- </div>
- </div>
- <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
-
- </body>
- </html>
|
