autodoc.xml 127 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162
  1. <?xml version="1.0" standalone="yes"?>
  2. <library-reference><header name="boost/algorithm/algorithm.hpp">
  3. <para>Misc Algorithms. </para><para><para>Marshall Clow </para>
  4. </para><namespace name="boost">
  5. <namespace name="algorithm">
  6. <function name="identity_operation"><type>BOOST_CXX14_CONSTEXPR T</type><template>
  7. <template-type-parameter name="T"/>
  8. </template><parameter name=""><paramtype>std::multiplies&lt; T &gt;</paramtype></parameter></function>
  9. <function name="identity_operation"><type>BOOST_CXX14_CONSTEXPR T</type><template>
  10. <template-type-parameter name="T"/>
  11. </template><parameter name=""><paramtype>std::plus&lt; T &gt;</paramtype></parameter></function>
  12. <function name="power"><type>BOOST_CXX14_CONSTEXPR boost::enable_if&lt; boost::is_integral&lt; Integer &gt;, T &gt;::type</type><template>
  13. <template-type-parameter name="T"/>
  14. <template-type-parameter name="Integer"/>
  15. </template><parameter name="x"><paramtype>T</paramtype><description><para>The value to be exponentiated </para></description></parameter><parameter name="n"><paramtype>Integer</paramtype><description><para>The exponent (must be &gt;= 0) </para></description></parameter><description><para>
  16. </para></description><returns><para>the value "x" raised to the power "n"</para>
  17. </returns></function>
  18. <function name="power"><type>BOOST_CXX14_CONSTEXPR boost::enable_if&lt; boost::is_integral&lt; Integer &gt;, T &gt;::type</type><template>
  19. <template-type-parameter name="T"/>
  20. <template-type-parameter name="Integer"/>
  21. <template-type-parameter name="Operation"/>
  22. </template><parameter name="x"><paramtype>T</paramtype><description><para>The value to be exponentiated </para></description></parameter><parameter name="n"><paramtype>Integer</paramtype><description><para>The exponent (must be &gt;= 0) </para></description></parameter><parameter name="op"><paramtype>Operation</paramtype><description><para>The operation used </para></description></parameter><description><para>
  23. </para></description><returns><para>the value "x" raised to the power "n" using the operation "op".</para>
  24. </returns></function>
  25. </namespace>
  26. </namespace>
  27. </header>
  28. <header name="boost/algorithm/apply_permutation.hpp">
  29. <para>Apply permutation to a sequence. </para><para><para>Alexander Zaitsev </para>
  30. </para><namespace name="boost">
  31. <namespace name="algorithm">
  32. <function name="apply_permutation"><type>void</type><template>
  33. <template-type-parameter name="RandomAccessIterator1"/>
  34. <template-type-parameter name="RandomAccessIterator2"/>
  35. </template><parameter name="item_begin"><paramtype>RandomAccessIterator1</paramtype></parameter><parameter name="item_end"><paramtype>RandomAccessIterator1</paramtype></parameter><parameter name="ind_begin"><paramtype>RandomAccessIterator2</paramtype></parameter><parameter name="ind_end"><paramtype>RandomAccessIterator2</paramtype></parameter></function>
  36. <function name="apply_reverse_permutation"><type>void</type><template>
  37. <template-type-parameter name="RandomAccessIterator1"/>
  38. <template-type-parameter name="RandomAccessIterator2"/>
  39. </template><parameter name="item_begin"><paramtype>RandomAccessIterator1</paramtype></parameter><parameter name="item_end"><paramtype>RandomAccessIterator1</paramtype></parameter><parameter name="ind_begin"><paramtype>RandomAccessIterator2</paramtype></parameter><parameter name="ind_end"><paramtype>RandomAccessIterator2</paramtype></parameter></function>
  40. <function name="apply_permutation"><type>void</type><template>
  41. <template-type-parameter name="Range1"/>
  42. <template-type-parameter name="Range2"/>
  43. </template><parameter name="item_range"><paramtype>Range1 &amp;</paramtype></parameter><parameter name="ind_range"><paramtype>Range2 &amp;</paramtype></parameter></function>
  44. <function name="apply_reverse_permutation"><type>void</type><template>
  45. <template-type-parameter name="Range1"/>
  46. <template-type-parameter name="Range2"/>
  47. </template><parameter name="item_range"><paramtype>Range1 &amp;</paramtype></parameter><parameter name="ind_range"><paramtype>Range2 &amp;</paramtype></parameter></function>
  48. </namespace>
  49. </namespace>
  50. </header>
  51. <header name="boost/algorithm/clamp.hpp">
  52. <para>Clamp algorithm. </para><para><para>Marshall Clow</para>
  53. Suggested by olafvdspek in <ulink url="https://svn.boost.org/trac/boost/ticket/3215">https://svn.boost.org/trac/boost/ticket/3215</ulink> </para><namespace name="boost">
  54. <namespace name="algorithm">
  55. <function name="clamp"><type>BOOST_CXX14_CONSTEXPR T const &amp;</type><template>
  56. <template-type-parameter name="T"/>
  57. <template-type-parameter name="Pred"/>
  58. </template><parameter name="val"><paramtype>T const &amp;</paramtype><description><para>The value to be clamped </para></description></parameter><parameter name="lo"><paramtype>typename boost::mpl::identity&lt; T &gt;::type const &amp;</paramtype><description><para>The lower bound of the range to be clamped to </para></description></parameter><parameter name="hi"><paramtype>typename boost::mpl::identity&lt; T &gt;::type const &amp;</paramtype><description><para>The upper bound of the range to be clamped to </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A predicate to use to compare the values. p ( a, b ) returns a boolean. </para></description></parameter><description><para>
  59. </para></description><returns><para>the value "val" brought into the range [ lo, hi ] using the comparison predicate p. If p ( val, lo ) return lo. If p ( hi, val ) return hi. Otherwise, return the original value.</para>
  60. </returns></function>
  61. <function name="clamp"><type>BOOST_CXX14_CONSTEXPR T const &amp;</type><template>
  62. <template-type-parameter name="T"/>
  63. </template><parameter name="val"><paramtype>const T &amp;</paramtype><description><para>The value to be clamped </para></description></parameter><parameter name="lo"><paramtype>typename boost::mpl::identity&lt; T &gt;::type const &amp;</paramtype><description><para>The lower bound of the range to be clamped to </para></description></parameter><parameter name="hi"><paramtype>typename boost::mpl::identity&lt; T &gt;::type const &amp;</paramtype><description><para>The upper bound of the range to be clamped to </para></description></parameter><description><para>
  64. </para></description><returns><para>the value "val" brought into the range [ lo, hi ]. If the value is less than lo, return lo. If the value is greater than "hi", return hi. Otherwise, return the original value.</para>
  65. </returns></function>
  66. <function name="clamp_range"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  67. <template-type-parameter name="InputIterator"/>
  68. <template-type-parameter name="OutputIterator"/>
  69. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="out"><paramtype>OutputIterator</paramtype></parameter><parameter name="lo"><paramtype>typename std::iterator_traits&lt; InputIterator &gt;::value_type const &amp;</paramtype></parameter><parameter name="hi"><paramtype>typename std::iterator_traits&lt; InputIterator &gt;::value_type const &amp;</paramtype></parameter></function>
  70. <function name="clamp_range"><type>BOOST_CXX14_CONSTEXPR boost::disable_if_c&lt; boost::is_same&lt; Range, OutputIterator &gt;::value, OutputIterator &gt;::type</type><template>
  71. <template-type-parameter name="Range"/>
  72. <template-type-parameter name="OutputIterator"/>
  73. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The range of values to be clamped </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the clamped values into </para></description></parameter><parameter name="lo"><paramtype>typename std::iterator_traits&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;::value_type const &amp;</paramtype><description><para>The lower bound of the range to be clamped to </para></description></parameter><parameter name="hi"><paramtype>typename std::iterator_traits&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;::value_type const &amp;</paramtype><description><para>The upper bound of the range to be clamped to </para></description></parameter><description><para>
  74. </para></description><returns><para>clamp the sequence of values [first, last) into [ lo, hi ]</para>
  75. </returns></function>
  76. <function name="clamp_range"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  77. <template-type-parameter name="InputIterator"/>
  78. <template-type-parameter name="OutputIterator"/>
  79. <template-type-parameter name="Pred"/>
  80. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="out"><paramtype>OutputIterator</paramtype></parameter><parameter name="lo"><paramtype>typename std::iterator_traits&lt; InputIterator &gt;::value_type const &amp;</paramtype></parameter><parameter name="hi"><paramtype>typename std::iterator_traits&lt; InputIterator &gt;::value_type const &amp;</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  81. <function name="clamp_range"><type>BOOST_CXX14_CONSTEXPR boost::disable_if_c&lt; boost::is_same&lt; Range, OutputIterator &gt;::value, OutputIterator &gt;::type</type><template>
  82. <template-type-parameter name="Range"/>
  83. <template-type-parameter name="OutputIterator"/>
  84. <template-type-parameter name="Pred"/>
  85. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The range of values to be clamped </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the clamped values into </para></description></parameter><parameter name="lo"><paramtype>typename std::iterator_traits&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;::value_type const &amp;</paramtype><description><para>The lower bound of the range to be clamped to </para></description></parameter><parameter name="hi"><paramtype>typename std::iterator_traits&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;::value_type const &amp;</paramtype><description><para>The upper bound of the range to be clamped to </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A predicate to use to compare the values. p ( a, b ) returns a boolean. </para></description></parameter><description><para>
  86. </para></description><returns><para>clamp the sequence of values [first, last) into [ lo, hi ] using the comparison predicate p.</para>
  87. </returns></function>
  88. </namespace>
  89. </namespace>
  90. </header>
  91. <header name="boost/algorithm/cxx11/all_of.hpp">
  92. <para>Test ranges to see if all elements match a value or predicate. </para><para><para>Marshall Clow </para>
  93. </para><namespace name="boost">
  94. <namespace name="algorithm">
  95. <function name="all_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  96. <template-type-parameter name="InputIterator"/>
  97. <template-type-parameter name="Predicate"/>
  98. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the sequence</para></description></parameter><description><para>
  99. <note><para>returns true on an empty range</para>
  100. </note>
  101. <note><para>This function is part of the C++2011 standard library. </para>
  102. </note>
  103. </para></description><returns><para>true if all elements in [first, last) satisfy the predicate 'p' </para>
  104. </returns></function>
  105. <function name="all_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  106. <template-type-parameter name="Range"/>
  107. <template-type-parameter name="Predicate"/>
  108. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><description><para>
  109. <note><para>returns true on an empty range</para>
  110. </note>
  111. </para></description><returns><para>true if all elements in the range satisfy the predicate 'p' </para>
  112. </returns></function>
  113. <function name="all_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  114. <template-type-parameter name="InputIterator"/>
  115. <template-type-parameter name="T"/>
  116. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="val"><paramtype>const T &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  117. <note><para>returns true on an empty range</para>
  118. </note>
  119. </para></description><returns><para>true if all elements in [first, last) are equal to 'val' </para>
  120. </returns></function>
  121. <function name="all_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  122. <template-type-parameter name="Range"/>
  123. <template-type-parameter name="T"/>
  124. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="val"><paramtype>const T &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  125. <note><para>returns true on an empty range</para>
  126. </note>
  127. </para></description><returns><para>true if all elements in the range are equal to 'val' </para>
  128. </returns></function>
  129. </namespace>
  130. </namespace>
  131. </header>
  132. <header name="boost/algorithm/cxx11/any_of.hpp">
  133. <para>Test ranges to see if any elements match a value or predicate. </para><para><para>Marshall Clow </para>
  134. </para><namespace name="boost">
  135. <namespace name="algorithm">
  136. <function name="any_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  137. <template-type-parameter name="InputIterator"/>
  138. <template-type-parameter name="Predicate"/>
  139. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the sequence </para></description></parameter><description><para>
  140. <note><para>returns false on an empty range</para>
  141. </note>
  142. </para></description><returns><para>true if any of the elements in [first, last) satisfy the predicate </para>
  143. </returns></function>
  144. <function name="any_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  145. <template-type-parameter name="Range"/>
  146. <template-type-parameter name="Predicate"/>
  147. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><description><para>
  148. <note><para>returns false on an empty range</para>
  149. </note>
  150. </para></description><returns><para>true if any elements in the range satisfy the predicate 'p' </para>
  151. </returns></function>
  152. <function name="any_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  153. <template-type-parameter name="InputIterator"/>
  154. <template-type-parameter name="V"/>
  155. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  156. <note><para>returns false on an empty range</para>
  157. </note>
  158. </para></description><returns><para>true if any of the elements in [first, last) are equal to 'val' </para>
  159. </returns></function>
  160. <function name="any_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  161. <template-type-parameter name="Range"/>
  162. <template-type-parameter name="V"/>
  163. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  164. <note><para>returns false on an empty range</para>
  165. </note>
  166. </para></description><returns><para>true if any of the elements in the range are equal to 'val' </para>
  167. </returns></function>
  168. </namespace>
  169. </namespace>
  170. </header>
  171. <header name="boost/algorithm/cxx11/copy_if.hpp">
  172. <para>Copy a subset of a sequence to a new sequence. </para><para><para>Marshall Clow </para>
  173. </para><namespace name="boost">
  174. <namespace name="algorithm">
  175. <function name="copy_if"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  176. <template-type-parameter name="InputIterator"/>
  177. <template-type-parameter name="OutputIterator"/>
  178. <template-type-parameter name="Predicate"/>
  179. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements from the input range that satisfy the predicate to the output range. </purpose><description><para>
  180. <note><para>This function is part of the C++2011 standard library. </para>
  181. </note>
  182. </para></description><returns><para>The updated output iterator</para>
  183. </returns></function>
  184. <function name="copy_if"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  185. <template-type-parameter name="Range"/>
  186. <template-type-parameter name="OutputIterator"/>
  187. <template-type-parameter name="Predicate"/>
  188. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements from the input range that satisfy the predicate to the output range. </purpose><description><para>
  189. </para></description><returns><para>The updated output iterator</para>
  190. </returns></function>
  191. <function name="copy_while"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; InputIterator, OutputIterator &gt;</type><template>
  192. <template-type-parameter name="InputIterator"/>
  193. <template-type-parameter name="OutputIterator"/>
  194. <template-type-parameter name="Predicate"/>
  195. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements at the start of the input range that satisfy the predicate to the output range. </purpose><description><para>
  196. </para></description><returns><para>The updated input and output iterators</para>
  197. </returns></function>
  198. <function name="copy_while"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; typename boost::range_iterator&lt; const Range &gt;::type, OutputIterator &gt;</type><template>
  199. <template-type-parameter name="Range"/>
  200. <template-type-parameter name="OutputIterator"/>
  201. <template-type-parameter name="Predicate"/>
  202. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements at the start of the input range that satisfy the predicate to the output range. </purpose><description><para>
  203. </para></description><returns><para>The updated input and output iterators</para>
  204. </returns></function>
  205. <function name="copy_until"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; InputIterator, OutputIterator &gt;</type><template>
  206. <template-type-parameter name="InputIterator"/>
  207. <template-type-parameter name="OutputIterator"/>
  208. <template-type-parameter name="Predicate"/>
  209. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements at the start of the input range that do not satisfy the predicate to the output range. </purpose><description><para>
  210. </para></description><returns><para>The updated output iterator</para>
  211. </returns></function>
  212. <function name="copy_until"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; typename boost::range_iterator&lt; const Range &gt;::type, OutputIterator &gt;</type><template>
  213. <template-type-parameter name="Range"/>
  214. <template-type-parameter name="OutputIterator"/>
  215. <template-type-parameter name="Predicate"/>
  216. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Copies all the elements at the start of the input range that do not satisfy the predicate to the output range. </purpose><description><para>
  217. </para></description><returns><para>The updated output iterator</para>
  218. </returns></function>
  219. </namespace>
  220. </namespace>
  221. </header>
  222. <header name="boost/algorithm/cxx11/copy_n.hpp">
  223. <para>Copy n items from one sequence to another. </para><para><para>Marshall Clow </para>
  224. </para><namespace name="boost">
  225. <namespace name="algorithm">
  226. <function name="copy_n"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  227. <template-type-parameter name="InputIterator"/>
  228. <template-type-parameter name="Size"/>
  229. <template-type-parameter name="OutputIterator"/>
  230. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="n"><paramtype>Size</paramtype><description><para>The number of elements to copy </para></description></parameter><parameter name="result"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><purpose>Copies exactly n (n &gt; 0) elements from the range starting at first to the range starting at result. </purpose><description><para>
  231. <note><para>This function is part of the C++2011 standard library. </para>
  232. </note>
  233. </para></description><returns><para>The updated output iterator</para>
  234. </returns></function>
  235. </namespace>
  236. </namespace>
  237. </header>
  238. <header name="boost/algorithm/cxx11/find_if_not.hpp">
  239. <para>Find the first element in a sequence that does not satisfy a predicate. </para><para><para>Marshall Clow </para>
  240. </para><namespace name="boost">
  241. <namespace name="algorithm">
  242. <function name="find_if_not"><type>BOOST_CXX14_CONSTEXPR InputIterator</type><template>
  243. <template-type-parameter name="InputIterator"/>
  244. <template-type-parameter name="Predicate"/>
  245. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Finds the first element in the sequence that does not satisfy the predicate. </purpose><description><para>
  246. <note><para>This function is part of the C++2011 standard library. </para>
  247. </note>
  248. </para></description><returns><para>The iterator pointing to the desired element.</para>
  249. </returns></function>
  250. <function name="find_if_not"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; const Range &gt;::type</type><template>
  251. <template-type-parameter name="Range"/>
  252. <template-type-parameter name="Predicate"/>
  253. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><purpose>Finds the first element in the sequence that does not satisfy the predicate. </purpose><description><para>
  254. </para></description><returns><para>The iterator pointing to the desired element.</para>
  255. </returns></function>
  256. </namespace>
  257. </namespace>
  258. </header>
  259. <header name="boost/algorithm/cxx11/iota.hpp">
  260. <para>Generate an increasing series. </para><para><para>Marshall Clow </para>
  261. </para><namespace name="boost">
  262. <namespace name="algorithm">
  263. <function name="iota"><type>BOOST_CXX14_CONSTEXPR void</type><template>
  264. <template-type-parameter name="ForwardIterator"/>
  265. <template-type-parameter name="T"/>
  266. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="value"><paramtype>T</paramtype><description><para>The initial value of the sequence to be generated </para></description></parameter><purpose>Generates an increasing sequence of values, and stores them in [first, last) </purpose><description><para>
  267. <note><para>This function is part of the C++2011 standard library. </para>
  268. </note>
  269. </para></description></function>
  270. <function name="iota"><type>BOOST_CXX14_CONSTEXPR void</type><template>
  271. <template-type-parameter name="Range"/>
  272. <template-type-parameter name="T"/>
  273. </template><parameter name="r"><paramtype>Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="value"><paramtype>T</paramtype><description><para>The initial value of the sequence to be generated </para></description></parameter><purpose>Generates an increasing sequence of values, and stores them in the input Range. </purpose><description><para>
  274. </para></description></function>
  275. <function name="iota_n"><type>BOOST_CXX14_CONSTEXPR OutputIterator</type><template>
  276. <template-type-parameter name="OutputIterator"/>
  277. <template-type-parameter name="T"/>
  278. </template><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to write the results into </para></description></parameter><parameter name="value"><paramtype>T</paramtype><description><para>The initial value of the sequence to be generated </para></description></parameter><parameter name="n"><paramtype>std::size_t</paramtype><description><para>The number of items to write </para></description></parameter><purpose>Generates an increasing sequence of values, and stores them in the input Range. </purpose><description><para>
  279. </para></description></function>
  280. </namespace>
  281. </namespace>
  282. </header>
  283. <header name="boost/algorithm/cxx11/is_partitioned.hpp">
  284. <para>Tell if a sequence is partitioned. </para><para><para>Marshall Clow </para>
  285. </para><namespace name="boost">
  286. <namespace name="algorithm">
  287. <function name="is_partitioned"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  288. <template-type-parameter name="InputIterator"/>
  289. <template-type-parameter name="UnaryPredicate"/>
  290. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>The predicate to test the values with </para></description></parameter><purpose>Tests to see if a sequence is partitioned according to a predicate. In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. </purpose><description><para>
  291. <note><para>This function is part of the C++2011 standard library. </para>
  292. </note>
  293. </para></description></function>
  294. <function name="is_partitioned"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  295. <template-type-parameter name="Range"/>
  296. <template-type-parameter name="UnaryPredicate"/>
  297. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>The predicate to test the values with </para></description></parameter><purpose>Tests to see if a sequence is partitioned according to a predicate. In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. </purpose><description><para>
  298. </para></description></function>
  299. </namespace>
  300. </namespace>
  301. </header>
  302. <header name="boost/algorithm/cxx11/is_permutation.hpp">
  303. <namespace name="boost">
  304. <namespace name="algorithm">
  305. <function name="is_permutation"><type>bool</type><template>
  306. <template-type-parameter name="ForwardIterator1"/>
  307. <template-type-parameter name="ForwardIterator2"/>
  308. <template-type-parameter name="BinaryPredicate"/>
  309. </template><parameter name="first1"><paramtype>ForwardIterator1</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last1"><paramtype>ForwardIterator1</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="first2"><paramtype>ForwardIterator2</paramtype><description><para>The start of the second sequence </para></description></parameter><parameter name="p"><paramtype>BinaryPredicate</paramtype><description><para>The predicate to compare elements with</para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  310. <note><para>This function is part of the C++2011 standard library. </para>
  311. </note>
  312. </para></description></function>
  313. <function name="is_permutation"><type>bool</type><template>
  314. <template-type-parameter name="ForwardIterator1"/>
  315. <template-type-parameter name="ForwardIterator2"/>
  316. </template><parameter name="first1"><paramtype>ForwardIterator1</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last1"><paramtype>ForwardIterator1</paramtype></parameter><parameter name="first2"><paramtype>ForwardIterator2</paramtype><description><para>The start of the second sequence </para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  317. <note><para>This function is part of the C++2011 standard library. </para>
  318. </note>
  319. </para></description></function>
  320. <function name="is_permutation"><type>bool</type><template>
  321. <template-type-parameter name="Range"/>
  322. <template-type-parameter name="ForwardIterator"/>
  323. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="first2"><paramtype>ForwardIterator</paramtype><description><para>The start of the second sequence </para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  324. </para></description></function>
  325. <function name="is_permutation"><type>boost::disable_if_c&lt; boost::is_same&lt; Range, ForwardIterator &gt;::value, bool &gt;::type</type><template>
  326. <template-type-parameter name="Range"/>
  327. <template-type-parameter name="ForwardIterator"/>
  328. <template-type-parameter name="BinaryPredicate"/>
  329. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="first2"><paramtype>ForwardIterator</paramtype><description><para>The start of the second sequence </para></description></parameter><parameter name="pred"><paramtype>BinaryPredicate</paramtype><description><para>The predicate to compare elements with </para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  330. </para></description></function>
  331. </namespace>
  332. </namespace>
  333. </header>
  334. <header name="boost/algorithm/cxx14/is_permutation.hpp">
  335. <namespace name="boost">
  336. <namespace name="algorithm">
  337. <function name="is_permutation"><type>bool</type><template>
  338. <template-type-parameter name="ForwardIterator1"/>
  339. <template-type-parameter name="ForwardIterator2"/>
  340. </template><parameter name="first1"><paramtype>ForwardIterator1</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last1"><paramtype>ForwardIterator1</paramtype><description><para>One past the end of the second sequence </para></description></parameter><parameter name="first2"><paramtype>ForwardIterator2</paramtype><description><para>The start of the second sequence </para></description></parameter><parameter name="last2"><paramtype>ForwardIterator2</paramtype><description><para>One past the end of the input sequence </para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  341. <note><para>This function is part of the C++2014 standard library. </para>
  342. </note>
  343. </para></description></function>
  344. <function name="is_permutation"><type>bool</type><template>
  345. <template-type-parameter name="ForwardIterator1"/>
  346. <template-type-parameter name="ForwardIterator2"/>
  347. <template-type-parameter name="BinaryPredicate"/>
  348. </template><parameter name="first1"><paramtype>ForwardIterator1</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last1"><paramtype>ForwardIterator1</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="first2"><paramtype>ForwardIterator2</paramtype><description><para>The start of the second sequence </para></description></parameter><parameter name="last2"><paramtype>ForwardIterator2</paramtype><description><para>One past the end of the second sequence </para></description></parameter><parameter name="pred"><paramtype>BinaryPredicate</paramtype><description><para>The predicate to compare elements with</para></description></parameter><purpose>Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2. </purpose><description><para>
  349. <note><para>This function is part of the C++2014 standard library. </para>
  350. </note>
  351. </para></description></function>
  352. </namespace>
  353. </namespace>
  354. </header>
  355. <header name="boost/algorithm/cxx11/is_sorted.hpp">
  356. <namespace name="boost">
  357. <namespace name="algorithm">
  358. <function name="is_sorted_until"><type>BOOST_CXX14_CONSTEXPR ForwardIterator</type><template>
  359. <template-type-parameter name="ForwardIterator"/>
  360. <template-type-parameter name="Pred"/>
  361. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A binary predicate that returns true if two elements are ordered. </para></description></parameter><description><para>
  362. </para></description><returns><para>the point in the sequence [first, last) where the elements are unordered (according to the comparison predicate 'p').</para>
  363. </returns></function>
  364. <function name="is_sorted_until"><type>BOOST_CXX14_CONSTEXPR ForwardIterator</type><template>
  365. <template-type-parameter name="ForwardIterator"/>
  366. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence </para></description></parameter><description><para>
  367. </para></description><returns><para>the point in the sequence [first, last) where the elements are unordered</para>
  368. </returns></function>
  369. <function name="is_sorted"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  370. <template-type-parameter name="ForwardIterator"/>
  371. <template-type-parameter name="Pred"/>
  372. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A binary predicate that returns true if two elements are ordered. </para></description></parameter><description><para>
  373. </para></description><returns><para>whether or not the entire sequence is sorted</para>
  374. </returns></function>
  375. <function name="is_sorted"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  376. <template-type-parameter name="ForwardIterator"/>
  377. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence </para></description></parameter><description><para>
  378. </para></description><returns><para>whether or not the entire sequence is sorted</para>
  379. </returns></function>
  380. <function name="is_sorted_until"><type>BOOST_CXX14_CONSTEXPR boost::lazy_disable_if_c&lt; boost::is_same&lt; R, Pred &gt;::value, typename boost::range_iterator&lt; const R &gt; &gt;::type</type><template>
  381. <template-type-parameter name="R"/>
  382. <template-type-parameter name="Pred"/>
  383. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested. </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A binary predicate that returns true if two elements are ordered. </para></description></parameter><description><para>– Range based versions of the C++11 functions
  384. </para></description><returns><para>the point in the range R where the elements are unordered (according to the comparison predicate 'p').</para>
  385. </returns></function>
  386. <function name="is_sorted_until"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; const R &gt;::type</type><template>
  387. <template-type-parameter name="R"/>
  388. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested. </para></description></parameter><description><para>
  389. </para></description><returns><para>the point in the range R where the elements are unordered</para>
  390. </returns></function>
  391. <function name="is_sorted"><type>BOOST_CXX14_CONSTEXPR boost::lazy_disable_if_c&lt; boost::is_same&lt; R, Pred &gt;::value, boost::mpl::identity&lt; bool &gt; &gt;::type</type><template>
  392. <template-type-parameter name="R"/>
  393. <template-type-parameter name="Pred"/>
  394. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested. </para></description></parameter><parameter name="p"><paramtype>Pred</paramtype><description><para>A binary predicate that returns true if two elements are ordered. </para></description></parameter><description><para>
  395. </para></description><returns><para>whether or not the entire range R is sorted (according to the comparison predicate 'p').</para>
  396. </returns></function>
  397. <function name="is_sorted"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  398. <template-type-parameter name="R"/>
  399. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested. </para></description></parameter><description><para>
  400. </para></description><returns><para>whether or not the entire range R is sorted</para>
  401. </returns></function>
  402. <function name="is_increasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  403. <template-type-parameter name="ForwardIterator"/>
  404. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence</para></description></parameter><description><para>– Range based versions of the C++11 functions
  405. equal to the previous one.</para><para>
  406. <note><para>This function will return true for sequences that contain items that compare equal. If that is not what you intended, you should use is_strictly_increasing instead. </para>
  407. </note>
  408. </para></description><returns><para>true if the entire sequence is increasing; i.e, each item is greater than or</para>
  409. </returns></function>
  410. <function name="is_increasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  411. <template-type-parameter name="R"/>
  412. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested.</para></description></parameter><description><para>
  413. equal to the previous one.</para><para>
  414. <note><para>This function will return true for sequences that contain items that compare equal. If that is not what you intended, you should use is_strictly_increasing instead. </para>
  415. </note>
  416. </para></description><returns><para>true if the entire sequence is increasing; i.e, each item is greater than or</para>
  417. </returns></function>
  418. <function name="is_decreasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  419. <template-type-parameter name="ForwardIterator"/>
  420. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence</para></description></parameter><description><para>
  421. <note><para>This function will return true for sequences that contain items that compare equal. If that is not what you intended, you should use is_strictly_decreasing instead. </para>
  422. </note>
  423. </para></description><returns><para>true if the entire sequence is decreasing; i.e, each item is less than or equal to the previous one.</para>
  424. </returns></function>
  425. <function name="is_decreasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  426. <template-type-parameter name="R"/>
  427. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested.</para></description></parameter><description><para>
  428. <note><para>This function will return true for sequences that contain items that compare equal. If that is not what you intended, you should use is_strictly_decreasing instead. </para>
  429. </note>
  430. </para></description><returns><para>true if the entire sequence is decreasing; i.e, each item is less than or equal to the previous one.</para>
  431. </returns></function>
  432. <function name="is_strictly_increasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  433. <template-type-parameter name="ForwardIterator"/>
  434. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence</para></description></parameter><description><para>
  435. <note><para>This function will return false for sequences that contain items that compare equal. If that is not what you intended, you should use is_increasing instead. </para>
  436. </note>
  437. </para></description><returns><para>true if the entire sequence is strictly increasing; i.e, each item is greater than the previous one</para>
  438. </returns></function>
  439. <function name="is_strictly_increasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  440. <template-type-parameter name="R"/>
  441. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested.</para></description></parameter><description><para>
  442. <note><para>This function will return false for sequences that contain items that compare equal. If that is not what you intended, you should use is_increasing instead. </para>
  443. </note>
  444. </para></description><returns><para>true if the entire sequence is strictly increasing; i.e, each item is greater than the previous one</para>
  445. </returns></function>
  446. <function name="is_strictly_decreasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  447. <template-type-parameter name="ForwardIterator"/>
  448. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the sequence to be tested. </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the sequence</para></description></parameter><description><para>
  449. <note><para>This function will return false for sequences that contain items that compare equal. If that is not what you intended, you should use is_decreasing instead. </para>
  450. </note>
  451. </para></description><returns><para>true if the entire sequence is strictly decreasing; i.e, each item is less than the previous one</para>
  452. </returns></function>
  453. <function name="is_strictly_decreasing"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  454. <template-type-parameter name="R"/>
  455. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested.</para></description></parameter><description><para>
  456. <note><para>This function will return false for sequences that contain items that compare equal. If that is not what you intended, you should use is_decreasing instead. </para>
  457. </note>
  458. </para></description><returns><para>true if the entire sequence is strictly decreasing; i.e, each item is less than the previous one</para>
  459. </returns></function>
  460. </namespace>
  461. </namespace>
  462. </header>
  463. <header name="boost/algorithm/cxx11/none_of.hpp">
  464. <para>Test ranges to see if no elements match a value or predicate. </para><para><para>Marshall Clow </para>
  465. </para><namespace name="boost">
  466. <namespace name="algorithm">
  467. <function name="none_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  468. <template-type-parameter name="InputIterator"/>
  469. <template-type-parameter name="Predicate"/>
  470. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the sequence </para></description></parameter><description><para>
  471. <note><para>returns true on an empty range</para>
  472. </note>
  473. </para></description><returns><para>true if none of the elements in [first, last) satisfy the predicate 'p' </para>
  474. </returns></function>
  475. <function name="none_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  476. <template-type-parameter name="Range"/>
  477. <template-type-parameter name="Predicate"/>
  478. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><description><para>
  479. <note><para>returns true on an empty range</para>
  480. </note>
  481. </para></description><returns><para>true if none of the elements in the range satisfy the predicate 'p' </para>
  482. </returns></function>
  483. <function name="none_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  484. <template-type-parameter name="InputIterator"/>
  485. <template-type-parameter name="V"/>
  486. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  487. <note><para>returns true on an empty range</para>
  488. </note>
  489. </para></description><returns><para>true if none of the elements in [first, last) are equal to 'val' </para>
  490. </returns></function>
  491. <function name="none_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  492. <template-type-parameter name="Range"/>
  493. <template-type-parameter name="V"/>
  494. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  495. <note><para>returns true on an empty range</para>
  496. </note>
  497. </para></description><returns><para>true if none of the elements in the range are equal to 'val' </para>
  498. </returns></function>
  499. </namespace>
  500. </namespace>
  501. </header>
  502. <header name="boost/algorithm/cxx11/one_of.hpp">
  503. <para>Test ranges to see if only one element matches a value or predicate. </para><para><para>Marshall Clow </para>
  504. </para><namespace name="boost">
  505. <namespace name="algorithm">
  506. <function name="one_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  507. <template-type-parameter name="InputIterator"/>
  508. <template-type-parameter name="Predicate"/>
  509. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the sequence </para></description></parameter><description><para>
  510. </para></description><returns><para>true if the predicate 'p' is true for exactly one item in [first, last).</para>
  511. </returns></function>
  512. <function name="one_of"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  513. <template-type-parameter name="Range"/>
  514. <template-type-parameter name="Predicate"/>
  515. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate for testing the elements of the range </para></description></parameter><description><para>
  516. </para></description><returns><para>true if the predicate 'p' is true for exactly one item in the range.</para>
  517. </returns></function>
  518. <function name="one_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  519. <template-type-parameter name="InputIterator"/>
  520. <template-type-parameter name="V"/>
  521. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  522. </para></description><returns><para>true if the value 'val' exists only once in [first, last).</para>
  523. </returns></function>
  524. <function name="one_of_equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  525. <template-type-parameter name="Range"/>
  526. <template-type-parameter name="V"/>
  527. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="val"><paramtype>const V &amp;</paramtype><description><para>A value to compare against </para></description></parameter><description><para>
  528. </para></description><returns><para>true if the value 'val' exists only once in the range.</para>
  529. </returns></function>
  530. </namespace>
  531. </namespace>
  532. </header>
  533. <header name="boost/algorithm/cxx11/partition_copy.hpp">
  534. <para>Copy a subset of a sequence to a new sequence. </para><para><para>Marshall Clow </para>
  535. </para><namespace name="boost">
  536. <namespace name="algorithm">
  537. <function name="partition_copy"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; OutputIterator1, OutputIterator2 &gt;</type><template>
  538. <template-type-parameter name="InputIterator"/>
  539. <template-type-parameter name="OutputIterator1"/>
  540. <template-type-parameter name="OutputIterator2"/>
  541. <template-type-parameter name="UnaryPredicate"/>
  542. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="out_true"><paramtype>OutputIterator1</paramtype><description><para>An output iterator to write the elements that satisfy the predicate into </para></description></parameter><parameter name="out_false"><paramtype>OutputIterator2</paramtype><description><para>An output iterator to write the elements that do not satisfy the predicate into </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>A predicate for dividing the elements of the input sequence.</para></description></parameter><purpose>Copies the elements that satisfy the predicate p from the range [first, last) to the range beginning at d_first_true, and copies the elements that do not satisfy p to the range beginning at d_first_false. </purpose><description><para>
  543. <note><para>This function is part of the C++2011 standard library. </para>
  544. </note>
  545. </para></description></function>
  546. <function name="partition_copy"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; OutputIterator1, OutputIterator2 &gt;</type><template>
  547. <template-type-parameter name="Range"/>
  548. <template-type-parameter name="OutputIterator1"/>
  549. <template-type-parameter name="OutputIterator2"/>
  550. <template-type-parameter name="UnaryPredicate"/>
  551. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="out_true"><paramtype>OutputIterator1</paramtype><description><para>An output iterator to write the elements that satisfy the predicate into </para></description></parameter><parameter name="out_false"><paramtype>OutputIterator2</paramtype><description><para>An output iterator to write the elements that do not satisfy the predicate into </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>A predicate for dividing the elements of the input sequence. </para></description></parameter><description><para>
  552. </para></description></function>
  553. </namespace>
  554. </namespace>
  555. </header>
  556. <header name="boost/algorithm/cxx11/partition_point.hpp">
  557. <para>Find the partition point in a sequence. </para><para><para>Marshall Clow </para>
  558. </para><namespace name="boost">
  559. <namespace name="algorithm">
  560. <function name="partition_point"><type>ForwardIterator</type><template>
  561. <template-type-parameter name="ForwardIterator"/>
  562. <template-type-parameter name="Predicate"/>
  563. </template><parameter name="first"><paramtype>ForwardIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>ForwardIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>The predicate to test the values with </para></description></parameter><purpose>Given a partitioned range, returns the partition point, i.e, the first element that does not satisfy p. </purpose><description><para>
  564. <note><para>This function is part of the C++2011 standard library. </para>
  565. </note>
  566. </para></description></function>
  567. <function name="partition_point"><type>boost::range_iterator&lt; Range &gt;::type</type><template>
  568. <template-type-parameter name="Range"/>
  569. <template-type-parameter name="Predicate"/>
  570. </template><parameter name="r"><paramtype>Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>The predicate to test the values with </para></description></parameter><purpose>Given a partitioned range, returns the partition point. </purpose><description><para>
  571. </para></description></function>
  572. </namespace>
  573. </namespace>
  574. </header>
  575. <header name="boost/algorithm/cxx14/equal.hpp">
  576. <para>Test ranges to if they are equal. </para><para><para>Marshall Clow </para>
  577. </para><namespace name="boost">
  578. <namespace name="algorithm">
  579. <function name="equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  580. <template-type-parameter name="InputIterator1"/>
  581. <template-type-parameter name="InputIterator2"/>
  582. <template-type-parameter name="BinaryPredicate"/>
  583. </template><parameter name="first1"><paramtype>InputIterator1</paramtype><description><para>The start of the first range. </para></description></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype><description><para>One past the end of the first range. </para></description></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype><description><para>The start of the second range. </para></description></parameter><parameter name="last2"><paramtype>InputIterator2</paramtype><description><para>One past the end of the second range. </para></description></parameter><parameter name="pred"><paramtype>BinaryPredicate</paramtype><description><para>A predicate for comparing the elements of the ranges </para></description></parameter><description><para>
  584. </para></description><returns><para>true if all elements in the two ranges are equal</para>
  585. </returns></function>
  586. <function name="equal"><type>BOOST_CXX14_CONSTEXPR bool</type><template>
  587. <template-type-parameter name="InputIterator1"/>
  588. <template-type-parameter name="InputIterator2"/>
  589. </template><parameter name="first1"><paramtype>InputIterator1</paramtype><description><para>The start of the first range. </para></description></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype><description><para>One past the end of the first range. </para></description></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype><description><para>The start of the second range. </para></description></parameter><parameter name="last2"><paramtype>InputIterator2</paramtype><description><para>One past the end of the second range. </para></description></parameter><description><para>
  590. </para></description><returns><para>true if all elements in the two ranges are equal</para>
  591. </returns></function>
  592. </namespace>
  593. </namespace>
  594. </header>
  595. <header name="boost/algorithm/cxx14/mismatch.hpp">
  596. <para>Find the first mismatched element in a sequence. </para><para><para>Marshall Clow </para>
  597. </para><namespace name="boost">
  598. <namespace name="algorithm">
  599. <function name="mismatch"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; InputIterator1, InputIterator2 &gt;</type><template>
  600. <template-type-parameter name="InputIterator1"/>
  601. <template-type-parameter name="InputIterator2"/>
  602. <template-type-parameter name="BinaryPredicate"/>
  603. </template><parameter name="first1"><paramtype>InputIterator1</paramtype><description><para>The start of the first range. </para></description></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype><description><para>One past the end of the first range. </para></description></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype><description><para>The start of the second range. </para></description></parameter><parameter name="last2"><paramtype>InputIterator2</paramtype><description><para>One past the end of the second range. </para></description></parameter><parameter name="pred"><paramtype>BinaryPredicate</paramtype><description><para>A predicate for comparing the elements of the ranges </para></description></parameter><description><para>
  604. </para></description><returns><para>a pair of iterators pointing to the first elements in the sequence that do not match</para>
  605. </returns></function>
  606. <function name="mismatch"><type>BOOST_CXX14_CONSTEXPR std::pair&lt; InputIterator1, InputIterator2 &gt;</type><template>
  607. <template-type-parameter name="InputIterator1"/>
  608. <template-type-parameter name="InputIterator2"/>
  609. </template><parameter name="first1"><paramtype>InputIterator1</paramtype><description><para>The start of the first range. </para></description></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype><description><para>One past the end of the first range. </para></description></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype><description><para>The start of the second range. </para></description></parameter><parameter name="last2"><paramtype>InputIterator2</paramtype><description><para>One past the end of the second range. </para></description></parameter><description><para>
  610. </para></description><returns><para>a pair of iterators pointing to the first elements in the sequence that do not match</para>
  611. </returns></function>
  612. </namespace>
  613. </namespace>
  614. </header>
  615. <header name="boost/algorithm/cxx17/exclusive_scan.hpp">
  616. <para>??? </para><para><para>Marshall Clow </para>
  617. </para><namespace name="boost">
  618. <namespace name="algorithm">
  619. <function name="exclusive_scan"><type>OutputIterator</type><template>
  620. <template-type-parameter name="InputIterator"/>
  621. <template-type-parameter name="OutputIterator"/>
  622. <template-type-parameter name="T"/>
  623. <template-type-parameter name="BinaryOperation"/>
  624. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter></function>
  625. <function name="exclusive_scan"><type>OutputIterator</type><template>
  626. <template-type-parameter name="InputIterator"/>
  627. <template-type-parameter name="OutputIterator"/>
  628. <template-type-parameter name="T"/>
  629. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  630. </namespace>
  631. </namespace>
  632. </header>
  633. <header name="boost/algorithm/cxx17/for_each_n.hpp">
  634. <para>Apply a functor to the elements of a sequence. </para><para><para>Marshall Clow </para>
  635. </para><namespace name="boost">
  636. <namespace name="algorithm">
  637. <function name="for_each_n"><type>InputIterator</type><template>
  638. <template-type-parameter name="InputIterator"/>
  639. <template-type-parameter name="Size"/>
  640. <template-type-parameter name="Function"/>
  641. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the first range. </para></description></parameter><parameter name="n"><paramtype>Size</paramtype><description><para>One past the end of the first range. </para></description></parameter><parameter name="f"><paramtype>Function</paramtype><description><para>A functor to apply to the elements of the sequence </para></description></parameter><description><para>
  642. <note><para>If f returns a result, the result is ignored. </para>
  643. </note>
  644. </para></description><returns><para>first + n</para>
  645. </returns></function>
  646. </namespace>
  647. </namespace>
  648. </header>
  649. <header name="boost/algorithm/cxx17/inclusive_scan.hpp">
  650. <namespace name="boost">
  651. <namespace name="algorithm">
  652. <function name="inclusive_scan"><type>OutputIterator</type><template>
  653. <template-type-parameter name="InputIterator"/>
  654. <template-type-parameter name="OutputIterator"/>
  655. <template-type-parameter name="T"/>
  656. <template-type-parameter name="BinaryOperation"/>
  657. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  658. <function name="inclusive_scan"><type>OutputIterator</type><template>
  659. <template-type-parameter name="InputIterator"/>
  660. <template-type-parameter name="OutputIterator"/>
  661. <template-type-parameter name="BinaryOperation"/>
  662. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter></function>
  663. <function name="inclusive_scan"><type>OutputIterator</type><template>
  664. <template-type-parameter name="InputIterator"/>
  665. <template-type-parameter name="OutputIterator"/>
  666. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter></function>
  667. </namespace>
  668. </namespace>
  669. </header>
  670. <header name="boost/algorithm/cxx17/reduce.hpp">
  671. <para>Combine the elements of a sequence into a single value. </para><para><para>Marshall Clow </para>
  672. </para><namespace name="boost">
  673. <namespace name="algorithm">
  674. <function name="reduce"><type>T</type><template>
  675. <template-type-parameter name="InputIterator"/>
  676. <template-type-parameter name="T"/>
  677. <template-type-parameter name="BinaryOperation"/>
  678. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter></function>
  679. <function name="reduce"><type>T</type><template>
  680. <template-type-parameter name="InputIterator"/>
  681. <template-type-parameter name="T"/>
  682. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  683. <function name="reduce"><type>std::iterator_traits&lt; InputIterator &gt;::value_type</type><template>
  684. <template-type-parameter name="InputIterator"/>
  685. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter></function>
  686. <function name="reduce"><type>boost::range_value&lt; Range &gt;::type</type><template>
  687. <template-type-parameter name="Range"/>
  688. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter></function>
  689. <function name="reduce"><type>T</type><template>
  690. <template-type-parameter name="Range"/>
  691. <template-type-parameter name="T"/>
  692. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  693. <function name="reduce"><type>T</type><template>
  694. <template-type-parameter name="Range"/>
  695. <template-type-parameter name="T"/>
  696. <template-type-parameter name="BinaryOperation"/>
  697. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter></function>
  698. </namespace>
  699. </namespace>
  700. </header>
  701. <header name="boost/algorithm/cxx17/transform_exclusive_scan.hpp">
  702. <para>???? </para><para><para>Marshall Clow </para>
  703. </para><namespace name="boost">
  704. <namespace name="algorithm">
  705. <function name="transform_exclusive_scan"><type>OutputIterator</type><template>
  706. <template-type-parameter name="InputIterator"/>
  707. <template-type-parameter name="OutputIterator"/>
  708. <template-type-parameter name="T"/>
  709. <template-type-parameter name="BinaryOperation"/>
  710. <template-type-parameter name="UnaryOperation"/>
  711. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter><parameter name="uOp"><paramtype>UnaryOperation</paramtype></parameter></function>
  712. </namespace>
  713. </namespace>
  714. </header>
  715. <header name="boost/algorithm/cxx17/transform_inclusive_scan.hpp">
  716. <namespace name="boost">
  717. <namespace name="algorithm">
  718. <function name="transform_inclusive_scan"><type>OutputIterator</type><template>
  719. <template-type-parameter name="InputIterator"/>
  720. <template-type-parameter name="OutputIterator"/>
  721. <template-type-parameter name="BinaryOperation"/>
  722. <template-type-parameter name="UnaryOperation"/>
  723. <template-type-parameter name="T"/>
  724. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter><parameter name="uOp"><paramtype>UnaryOperation</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  725. <function name="transform_inclusive_scan"><type>OutputIterator</type><template>
  726. <template-type-parameter name="InputIterator"/>
  727. <template-type-parameter name="OutputIterator"/>
  728. <template-type-parameter name="BinaryOperation"/>
  729. <template-type-parameter name="UnaryOperation"/>
  730. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="result"><paramtype>OutputIterator</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter><parameter name="uOp"><paramtype>UnaryOperation</paramtype></parameter></function>
  731. </namespace>
  732. </namespace>
  733. </header>
  734. <header name="boost/algorithm/cxx17/transform_reduce.hpp">
  735. <para>Combine the (transformed) elements of a sequence (or two) into a single value. </para><para><para>Marshall Clow </para>
  736. </para><namespace name="boost">
  737. <namespace name="algorithm">
  738. <function name="transform_reduce"><type>T</type><template>
  739. <template-type-parameter name="InputIterator1"/>
  740. <template-type-parameter name="InputIterator2"/>
  741. <template-type-parameter name="T"/>
  742. <template-type-parameter name="BinaryOperation1"/>
  743. <template-type-parameter name="BinaryOperation2"/>
  744. </template><parameter name="first1"><paramtype>InputIterator1</paramtype></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp1"><paramtype>BinaryOperation1</paramtype></parameter><parameter name="bOp2"><paramtype>BinaryOperation2</paramtype></parameter></function>
  745. <function name="transform_reduce"><type>T</type><template>
  746. <template-type-parameter name="InputIterator"/>
  747. <template-type-parameter name="T"/>
  748. <template-type-parameter name="BinaryOperation"/>
  749. <template-type-parameter name="UnaryOperation"/>
  750. </template><parameter name="first"><paramtype>InputIterator</paramtype></parameter><parameter name="last"><paramtype>InputIterator</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter><parameter name="bOp"><paramtype>BinaryOperation</paramtype></parameter><parameter name="uOp"><paramtype>UnaryOperation</paramtype></parameter></function>
  751. <function name="transform_reduce"><type>T</type><template>
  752. <template-type-parameter name="InputIterator1"/>
  753. <template-type-parameter name="InputIterator2"/>
  754. <template-type-parameter name="T"/>
  755. </template><parameter name="first1"><paramtype>InputIterator1</paramtype></parameter><parameter name="last1"><paramtype>InputIterator1</paramtype></parameter><parameter name="first2"><paramtype>InputIterator2</paramtype></parameter><parameter name="init"><paramtype>T</paramtype></parameter></function>
  756. </namespace>
  757. </namespace>
  758. </header>
  759. <header name="boost/algorithm/find_backward.hpp">
  760. <namespace name="boost">
  761. <namespace name="algorithm">
  762. <function name="find_backward"><type>BOOST_CXX14_CONSTEXPR BidiIter</type><template>
  763. <template-type-parameter name="BidiIter"/>
  764. <template-type-parameter name="T"/>
  765. </template><parameter name="first"><paramtype>BidiIter</paramtype></parameter><parameter name="last"><paramtype>BidiIter</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  766. <function name="find_backward"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; Range &gt;::type</type><template>
  767. <template-type-parameter name="Range"/>
  768. <template-type-parameter name="T"/>
  769. </template><parameter name="range"><paramtype>Range &amp;</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  770. <function name="find_not_backward"><type>BOOST_CXX14_CONSTEXPR BidiIter</type><template>
  771. <template-type-parameter name="BidiIter"/>
  772. <template-type-parameter name="T"/>
  773. </template><parameter name="first"><paramtype>BidiIter</paramtype></parameter><parameter name="last"><paramtype>BidiIter</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  774. <function name="find_not_backward"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; Range &gt;::type</type><template>
  775. <template-type-parameter name="Range"/>
  776. <template-type-parameter name="T"/>
  777. </template><parameter name="range"><paramtype>Range &amp;</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  778. <function name="find_if_backward"><type>BOOST_CXX14_CONSTEXPR BidiIter</type><template>
  779. <template-type-parameter name="BidiIter"/>
  780. <template-type-parameter name="Pred"/>
  781. </template><parameter name="first"><paramtype>BidiIter</paramtype></parameter><parameter name="last"><paramtype>BidiIter</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  782. <function name="find_if_backward"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; Range &gt;::type</type><template>
  783. <template-type-parameter name="Range"/>
  784. <template-type-parameter name="Pred"/>
  785. </template><parameter name="range"><paramtype>Range &amp;</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  786. <function name="find_if_not_backward"><type>BOOST_CXX14_CONSTEXPR BidiIter</type><template>
  787. <template-type-parameter name="BidiIter"/>
  788. <template-type-parameter name="Pred"/>
  789. </template><parameter name="first"><paramtype>BidiIter</paramtype></parameter><parameter name="last"><paramtype>BidiIter</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  790. <function name="find_if_not_backward"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; Range &gt;::type</type><template>
  791. <template-type-parameter name="Range"/>
  792. <template-type-parameter name="Pred"/>
  793. </template><parameter name="range"><paramtype>Range &amp;</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  794. </namespace>
  795. </namespace>
  796. </header>
  797. <header name="boost/algorithm/find_not.hpp">
  798. <namespace name="boost">
  799. <namespace name="algorithm">
  800. <function name="find_not"><type>BOOST_CXX14_CONSTEXPR InputIter</type><template>
  801. <template-type-parameter name="InputIter"/>
  802. <template-type-parameter name="Sentinel"/>
  803. <template-type-parameter name="T"/>
  804. </template><parameter name="first"><paramtype>InputIter</paramtype></parameter><parameter name="last"><paramtype>Sentinel</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  805. <function name="find_not"><type>BOOST_CXX14_CONSTEXPR boost::range_iterator&lt; Range &gt;::type</type><template>
  806. <template-type-parameter name="Range"/>
  807. <template-type-parameter name="T"/>
  808. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter><parameter name="x"><paramtype>const T &amp;</paramtype></parameter></function>
  809. </namespace>
  810. </namespace>
  811. </header>
  812. <header name="boost/algorithm/gather.hpp">
  813. <namespace name="boost">
  814. <namespace name="algorithm">
  815. <function name="gather"><type>std::pair&lt; BidirectionalIterator, BidirectionalIterator &gt;</type><template>
  816. <template-type-parameter name="BidirectionalIterator"/>
  817. <template-type-parameter name="Pred"/>
  818. </template><parameter name="first"><paramtype>BidirectionalIterator</paramtype></parameter><parameter name="last"><paramtype>BidirectionalIterator</paramtype></parameter><parameter name="pivot"><paramtype>BidirectionalIterator</paramtype></parameter><parameter name="pred"><paramtype>Pred</paramtype></parameter><purpose>iterator-based gather implementation </purpose></function>
  819. <function name="gather"><type>std::pair&lt; typename boost::range_iterator&lt; const BidirectionalRange &gt;::type, typename boost::range_iterator&lt; const BidirectionalRange &gt;::type &gt;</type><template>
  820. <template-type-parameter name="BidirectionalRange"/>
  821. <template-type-parameter name="Pred"/>
  822. </template><parameter name="range"><paramtype>const BidirectionalRange &amp;</paramtype></parameter><parameter name="pivot"><paramtype>typename boost::range_iterator&lt; const BidirectionalRange &gt;::type</paramtype></parameter><parameter name="pred"><paramtype>Pred</paramtype></parameter><purpose>range-based gather implementation </purpose></function>
  823. </namespace>
  824. </namespace>
  825. </header>
  826. <header name="boost/algorithm/hex.hpp">
  827. <para>Convert sequence of integral types into a sequence of hexadecimal characters and back. Based on the MySQL functions HEX and UNHEX. </para><para><para>Marshall Clow </para>
  828. </para><namespace name="boost">
  829. <namespace name="algorithm">
  830. <struct name="hex_decode_error"><inherit access="public">exception</inherit><inherit access="public">exception</inherit><purpose>Base exception class for all hex decoding errors. </purpose></struct><struct name="non_hex_input"><inherit access="public">boost::algorithm::hex_decode_error</inherit><purpose>Thrown when a non-hex value (0-9, A-F) encountered when decoding. Contains the offending character. </purpose></struct><struct name="not_enough_input"><inherit access="public">boost::algorithm::hex_decode_error</inherit><purpose>Thrown when the input sequence unexpectedly ends. </purpose></struct><typedef name="bad_char"><type>boost::error_info&lt; struct bad_char_, char &gt;</type></typedef>
  831. <function name="hex"><type><emphasis>unspecified</emphasis></type><template>
  832. <template-type-parameter name="InputIterator"/>
  833. <template-type-parameter name="OutputIterator"/>
  834. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a hexadecimal sequence of characters. </purpose><description><para>
  835. <note><para>Based on the MySQL function of the same name </para>
  836. </note>
  837. </para></description><returns><para>The updated output iterator </para>
  838. </returns></function>
  839. <function name="hex_lower"><type><emphasis>unspecified</emphasis></type><template>
  840. <template-type-parameter name="InputIterator"/>
  841. <template-type-parameter name="OutputIterator"/>
  842. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a lower case hexadecimal sequence of characters. </purpose><description><para>
  843. <note><para>Based on the MySQL function of the same name </para>
  844. </note>
  845. </para></description><returns><para>The updated output iterator </para>
  846. </returns></function>
  847. <function name="hex"><type>boost::enable_if&lt; boost::is_integral&lt; T &gt;, OutputIterator &gt;::type</type><template>
  848. <template-type-parameter name="T"/>
  849. <template-type-parameter name="OutputIterator"/>
  850. </template><parameter name="ptr"><paramtype>const T *</paramtype><description><para>A pointer to a 0-terminated sequence of data. </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a hexadecimal sequence of characters. </purpose><description><para>
  851. <note><para>Based on the MySQL function of the same name </para>
  852. </note>
  853. </para></description><returns><para>The updated output iterator </para>
  854. </returns></function>
  855. <function name="hex_lower"><type>boost::enable_if&lt; boost::is_integral&lt; T &gt;, OutputIterator &gt;::type</type><template>
  856. <template-type-parameter name="T"/>
  857. <template-type-parameter name="OutputIterator"/>
  858. </template><parameter name="ptr"><paramtype>const T *</paramtype><description><para>A pointer to a 0-terminated sequence of data. </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a lower case hexadecimal sequence of characters. </purpose><description><para>
  859. <note><para>Based on the MySQL function of the same name </para>
  860. </note>
  861. </para></description><returns><para>The updated output iterator </para>
  862. </returns></function>
  863. <function name="hex"><type><emphasis>unspecified</emphasis></type><template>
  864. <template-type-parameter name="Range"/>
  865. <template-type-parameter name="OutputIterator"/>
  866. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a hexadecimal sequence of characters. </purpose><description><para>
  867. <note><para>Based on the MySQL function of the same name </para>
  868. </note>
  869. </para></description><returns><para>The updated output iterator </para>
  870. </returns></function>
  871. <function name="hex_lower"><type><emphasis>unspecified</emphasis></type><template>
  872. <template-type-parameter name="Range"/>
  873. <template-type-parameter name="OutputIterator"/>
  874. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of integral types into a lower case hexadecimal sequence of characters. </purpose><description><para>
  875. <note><para>Based on the MySQL function of the same name </para>
  876. </note>
  877. </para></description><returns><para>The updated output iterator </para>
  878. </returns></function>
  879. <function name="unhex"><type>OutputIterator</type><template>
  880. <template-type-parameter name="InputIterator"/>
  881. <template-type-parameter name="OutputIterator"/>
  882. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of hexadecimal characters into a sequence of integers. </purpose><description><para>
  883. <note><para>Based on the MySQL function of the same name </para>
  884. </note>
  885. </para></description><returns><para>The updated output iterator </para>
  886. </returns></function>
  887. <function name="unhex"><type>OutputIterator</type><template>
  888. <template-type-parameter name="T"/>
  889. <template-type-parameter name="OutputIterator"/>
  890. </template><parameter name="ptr"><paramtype>const T *</paramtype><description><para>A pointer to a null-terminated input sequence. </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of hexadecimal characters into a sequence of integers. </purpose><description><para>
  891. <note><para>Based on the MySQL function of the same name </para>
  892. </note>
  893. </para></description><returns><para>The updated output iterator </para>
  894. </returns></function>
  895. <function name="unhex"><type>OutputIterator</type><template>
  896. <template-type-parameter name="Range"/>
  897. <template-type-parameter name="OutputIterator"/>
  898. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="out"><paramtype>OutputIterator</paramtype><description><para>An output iterator to the results into </para></description></parameter><purpose>Converts a sequence of hexadecimal characters into a sequence of integers. </purpose><description><para>
  899. <note><para>Based on the MySQL function of the same name </para>
  900. </note>
  901. </para></description><returns><para>The updated output iterator </para>
  902. </returns></function>
  903. <function name="hex"><type>String</type><template>
  904. <template-type-parameter name="String"/>
  905. </template><parameter name="input"><paramtype>const String &amp;</paramtype><description><para>A container to be converted </para></description></parameter><purpose>Converts a sequence of integral types into a hexadecimal sequence of characters. </purpose><description><para>
  906. </para></description><returns><para>A container with the encoded text </para>
  907. </returns></function>
  908. <function name="hex_lower"><type>String</type><template>
  909. <template-type-parameter name="String"/>
  910. </template><parameter name="input"><paramtype>const String &amp;</paramtype><description><para>A container to be converted </para></description></parameter><purpose>Converts a sequence of integral types into a lower case hexadecimal sequence of characters. </purpose><description><para>
  911. </para></description><returns><para>A container with the encoded text </para>
  912. </returns></function>
  913. <function name="unhex"><type>String</type><template>
  914. <template-type-parameter name="String"/>
  915. </template><parameter name="input"><paramtype>const String &amp;</paramtype><description><para>A container to be converted </para></description></parameter><purpose>Converts a sequence of hexadecimal characters into a sequence of characters. </purpose><description><para>
  916. </para></description><returns><para>A container with the decoded text </para>
  917. </returns></function>
  918. </namespace>
  919. </namespace>
  920. </header>
  921. <header name="boost/algorithm/is_palindrome.hpp">
  922. <para>Checks the input sequence on palindrome. </para><para><para>Alexander Zaitsev </para>
  923. </para><namespace name="boost">
  924. <namespace name="algorithm">
  925. <function name="is_palindrome"><type>bool</type><template>
  926. <template-type-parameter name="BidirectionalIterator"/>
  927. <template-type-parameter name="Predicate"/>
  928. </template><parameter name="begin"><paramtype>BidirectionalIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="end"><paramtype>BidirectionalIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate used to compare the values.</para></description></parameter><description><para>
  929. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  930. </note>
  931. </para></description><returns><para>true if the entire sequence is palindrome</para>
  932. </returns></function>
  933. <function name="is_palindrome"><type>bool</type><template>
  934. <template-type-parameter name="BidirectionalIterator"/>
  935. </template><parameter name="begin"><paramtype>BidirectionalIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="end"><paramtype>BidirectionalIterator</paramtype><description><para>One past the end of the input sequence</para></description></parameter><description><para>
  936. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  937. </note>
  938. </para></description><returns><para>true if the entire sequence is palindrome</para>
  939. </returns></function>
  940. <function name="is_palindrome"><type>bool</type><template>
  941. <template-type-parameter name="R"/>
  942. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested.</para></description></parameter><description><para>
  943. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  944. </note>
  945. </para></description><returns><para>true if the entire sequence is palindrome</para>
  946. </returns></function>
  947. <function name="is_palindrome"><type>bool</type><template>
  948. <template-type-parameter name="R"/>
  949. <template-type-parameter name="Predicate"/>
  950. </template><parameter name="range"><paramtype>const R &amp;</paramtype><description><para>The range to be tested. </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate used to compare the values.</para></description></parameter><description><para>
  951. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  952. </note>
  953. </para></description><returns><para>true if the entire sequence is palindrome</para>
  954. </returns></function>
  955. <function name="is_palindrome"><type>bool</type><parameter name="str"><paramtype>const char *</paramtype><description><para>C-string to be tested.</para></description></parameter><description><para>
  956. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  957. </note>
  958. </para></description><returns><para>true if the entire sequence is palindrome</para>
  959. </returns></function>
  960. <function name="is_palindrome"><type>bool</type><template>
  961. <template-type-parameter name="Predicate"/>
  962. </template><parameter name="str"><paramtype>const char *</paramtype><description><para>C-string to be tested. </para></description></parameter><parameter name="p"><paramtype>Predicate</paramtype><description><para>A predicate used to compare the values.</para></description></parameter><description><para>
  963. <note><para>This function will return true for empty sequences and for palindromes. For other sequences function will return false. Complexity: O(N). </para>
  964. </note>
  965. </para></description><returns><para>true if the entire sequence is palindrome</para>
  966. </returns></function>
  967. </namespace>
  968. </namespace>
  969. </header>
  970. <header name="boost/algorithm/is_partitioned_until.hpp">
  971. <para>Tell if a sequence is partitioned. </para><para><para>Alexander Zaitsev </para>
  972. </para><namespace name="boost">
  973. <namespace name="algorithm">
  974. <function name="is_partitioned_until"><type>InputIterator</type><template>
  975. <template-type-parameter name="InputIterator"/>
  976. <template-type-parameter name="UnaryPredicate"/>
  977. </template><parameter name="first"><paramtype>InputIterator</paramtype><description><para>The start of the input sequence </para></description></parameter><parameter name="last"><paramtype>InputIterator</paramtype><description><para>One past the end of the input sequence </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>The predicate to test the values with</para></description></parameter><purpose>Tests to see if a sequence is partitioned according to a predicate. In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. </purpose><description><para>
  978. <note><para>Returns the first iterator 'it' in the sequence [first, last) for which is_partitioned(first, it, p) is false. Returns last if the entire sequence is partitioned. Complexity: O(N). </para>
  979. </note>
  980. </para></description></function>
  981. <function name="is_partitioned_until"><type>boost::range_iterator&lt; const Range &gt;::type</type><template>
  982. <template-type-parameter name="Range"/>
  983. <template-type-parameter name="UnaryPredicate"/>
  984. </template><parameter name="r"><paramtype>const Range &amp;</paramtype><description><para>The input range </para></description></parameter><parameter name="p"><paramtype>UnaryPredicate</paramtype><description><para>The predicate to test the values with</para></description></parameter><purpose>Tests to see if a sequence is partitioned according to a predicate. In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. </purpose><description><para>
  985. <note><para>Returns the first iterator 'it' in the sequence [first, last) for which is_partitioned(first, it, p) is false. Returns last if the entire sequence is partitioned. Complexity: O(N). </para>
  986. </note>
  987. </para></description></function>
  988. </namespace>
  989. </namespace>
  990. </header>
  991. <header name="boost/algorithm/minmax.hpp">
  992. <namespace name="boost">
  993. <function name="minmax"><type>tuple&lt; T const &amp;, T const &amp; &gt;</type><template>
  994. <template-type-parameter name="T"/>
  995. </template><parameter name="a"><paramtype>T const &amp;</paramtype></parameter><parameter name="b"><paramtype>T const &amp;</paramtype></parameter></function>
  996. <function name="minmax"><type>tuple&lt; T const &amp;, T const &amp; &gt;</type><template>
  997. <template-type-parameter name="T"/>
  998. <template-type-parameter name="BinaryPredicate"/>
  999. </template><parameter name="a"><paramtype>T const &amp;</paramtype></parameter><parameter name="b"><paramtype>T const &amp;</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1000. </namespace>
  1001. </header>
  1002. <header name="boost/algorithm/minmax_element.hpp">
  1003. <namespace name="boost">
  1004. <function name="minmax_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1005. <template-type-parameter name="ForwardIter"/>
  1006. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1007. <function name="minmax_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1008. <template-type-parameter name="ForwardIter"/>
  1009. <template-type-parameter name="BinaryPredicate"/>
  1010. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1011. <function name="first_min_element"><type>ForwardIter</type><template>
  1012. <template-type-parameter name="ForwardIter"/>
  1013. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1014. <function name="first_min_element"><type>ForwardIter</type><template>
  1015. <template-type-parameter name="ForwardIter"/>
  1016. <template-type-parameter name="BinaryPredicate"/>
  1017. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1018. <function name="last_min_element"><type>ForwardIter</type><template>
  1019. <template-type-parameter name="ForwardIter"/>
  1020. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1021. <function name="last_min_element"><type>ForwardIter</type><template>
  1022. <template-type-parameter name="ForwardIter"/>
  1023. <template-type-parameter name="BinaryPredicate"/>
  1024. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1025. <function name="first_max_element"><type>ForwardIter</type><template>
  1026. <template-type-parameter name="ForwardIter"/>
  1027. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1028. <function name="first_max_element"><type>ForwardIter</type><template>
  1029. <template-type-parameter name="ForwardIter"/>
  1030. <template-type-parameter name="BinaryPredicate"/>
  1031. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1032. <function name="last_max_element"><type>ForwardIter</type><template>
  1033. <template-type-parameter name="ForwardIter"/>
  1034. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1035. <function name="last_max_element"><type>ForwardIter</type><template>
  1036. <template-type-parameter name="ForwardIter"/>
  1037. <template-type-parameter name="BinaryPredicate"/>
  1038. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1039. <function name="first_min_first_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1040. <template-type-parameter name="ForwardIter"/>
  1041. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1042. <function name="first_min_first_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1043. <template-type-parameter name="ForwardIter"/>
  1044. <template-type-parameter name="BinaryPredicate"/>
  1045. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1046. <function name="first_min_last_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1047. <template-type-parameter name="ForwardIter"/>
  1048. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1049. <function name="first_min_last_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1050. <template-type-parameter name="ForwardIter"/>
  1051. <template-type-parameter name="BinaryPredicate"/>
  1052. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1053. <function name="last_min_first_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1054. <template-type-parameter name="ForwardIter"/>
  1055. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1056. <function name="last_min_first_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1057. <template-type-parameter name="ForwardIter"/>
  1058. <template-type-parameter name="BinaryPredicate"/>
  1059. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1060. <function name="last_min_last_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1061. <template-type-parameter name="ForwardIter"/>
  1062. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter></function>
  1063. <function name="last_min_last_max_element"><type>std::pair&lt; ForwardIter, ForwardIter &gt;</type><template>
  1064. <template-type-parameter name="ForwardIter"/>
  1065. <template-type-parameter name="BinaryPredicate"/>
  1066. </template><parameter name="first"><paramtype>ForwardIter</paramtype></parameter><parameter name="last"><paramtype>ForwardIter</paramtype></parameter><parameter name="comp"><paramtype>BinaryPredicate</paramtype></parameter></function>
  1067. </namespace>
  1068. </header>
  1069. <header name="boost/algorithm/searching/boyer_moore.hpp">
  1070. <namespace name="boost">
  1071. <namespace name="algorithm">
  1072. <class name="boyer_moore"><template>
  1073. <template-type-parameter name="patIter"/>
  1074. <template-type-parameter name="traits"><default>detail::BM_traits&lt;patIter&gt;</default></template-type-parameter>
  1075. </template><method-group name="public member functions">
  1076. <method name="operator()" cv="const"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1077. <template-type-parameter name="corpusIter"/>
  1078. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter></method>
  1079. <method name="operator()" cv="const"><type>std::pair&lt; typename boost::range_iterator&lt; Range &gt;::type, typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1080. <template-type-parameter name="Range"/>
  1081. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></method>
  1082. </method-group>
  1083. <constructor><parameter name="first"><paramtype>patIter</paramtype></parameter><parameter name="last"><paramtype>patIter</paramtype></parameter></constructor>
  1084. <destructor/>
  1085. </class>
  1086. <function name="boyer_moore_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1087. <template-type-parameter name="patIter"/>
  1088. <template-type-parameter name="corpusIter"/>
  1089. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype><description><para>The start of the data to search (Random Access Iterator) </para></description></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype><description><para>One past the end of the data to search </para></description></parameter><parameter name="pat_first"><paramtype>patIter</paramtype><description><para>The start of the pattern to search for (Random Access Iterator) </para></description></parameter><parameter name="pat_last"><paramtype>patIter</paramtype><description><para>One past the end of the data to search for </para></description></parameter><purpose>Searches the corpus for the pattern. </purpose><description><para>
  1090. </para></description></function>
  1091. <function name="boyer_moore_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1092. <template-type-parameter name="PatternRange"/>
  1093. <template-type-parameter name="corpusIter"/>
  1094. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1095. <function name="boyer_moore_search"><type>boost::disable_if_c&lt; boost::is_same&lt; CorpusRange, patIter &gt;::value, std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt; &gt;::type</type><template>
  1096. <template-type-parameter name="patIter"/>
  1097. <template-type-parameter name="CorpusRange"/>
  1098. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pat_first"><paramtype>patIter</paramtype></parameter><parameter name="pat_last"><paramtype>patIter</paramtype></parameter></function>
  1099. <function name="boyer_moore_search"><type>std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt;</type><template>
  1100. <template-type-parameter name="PatternRange"/>
  1101. <template-type-parameter name="CorpusRange"/>
  1102. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1103. <function name="make_boyer_moore"><type><classname>boost::algorithm::boyer_moore</classname>&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;</type><template>
  1104. <template-type-parameter name="Range"/>
  1105. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter></function>
  1106. <function name="make_boyer_moore"><type><classname>boost::algorithm::boyer_moore</classname>&lt; typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1107. <template-type-parameter name="Range"/>
  1108. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></function>
  1109. </namespace>
  1110. </namespace>
  1111. </header>
  1112. <header name="boost/algorithm/searching/boyer_moore_horspool.hpp">
  1113. <namespace name="boost">
  1114. <namespace name="algorithm">
  1115. <class name="boyer_moore_horspool"><template>
  1116. <template-type-parameter name="patIter"/>
  1117. <template-type-parameter name="traits"><default>detail::BM_traits&lt;patIter&gt;</default></template-type-parameter>
  1118. </template><method-group name="public member functions">
  1119. <method name="operator()" cv="const"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1120. <template-type-parameter name="corpusIter"/>
  1121. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter></method>
  1122. <method name="operator()" cv="const"><type>std::pair&lt; typename boost::range_iterator&lt; Range &gt;::type, typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1123. <template-type-parameter name="Range"/>
  1124. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></method>
  1125. </method-group>
  1126. <constructor><parameter name="first"><paramtype>patIter</paramtype></parameter><parameter name="last"><paramtype>patIter</paramtype></parameter></constructor>
  1127. <destructor/>
  1128. </class>
  1129. <function name="boyer_moore_horspool_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1130. <template-type-parameter name="patIter"/>
  1131. <template-type-parameter name="corpusIter"/>
  1132. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype><description><para>The start of the data to search (Random Access Iterator) </para></description></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype><description><para>One past the end of the data to search </para></description></parameter><parameter name="pat_first"><paramtype>patIter</paramtype><description><para>The start of the pattern to search for (Random Access Iterator) </para></description></parameter><parameter name="pat_last"><paramtype>patIter</paramtype><description><para>One past the end of the data to search for </para></description></parameter><purpose>Searches the corpus for the pattern. </purpose><description><para>
  1133. </para></description></function>
  1134. <function name="boyer_moore_horspool_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1135. <template-type-parameter name="PatternRange"/>
  1136. <template-type-parameter name="corpusIter"/>
  1137. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1138. <function name="boyer_moore_horspool_search"><type>boost::disable_if_c&lt; boost::is_same&lt; CorpusRange, patIter &gt;::value, std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt; &gt;::type</type><template>
  1139. <template-type-parameter name="patIter"/>
  1140. <template-type-parameter name="CorpusRange"/>
  1141. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pat_first"><paramtype>patIter</paramtype></parameter><parameter name="pat_last"><paramtype>patIter</paramtype></parameter></function>
  1142. <function name="boyer_moore_horspool_search"><type>std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt;</type><template>
  1143. <template-type-parameter name="PatternRange"/>
  1144. <template-type-parameter name="CorpusRange"/>
  1145. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1146. <function name="make_boyer_moore_horspool"><type><classname>boost::algorithm::boyer_moore_horspool</classname>&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;</type><template>
  1147. <template-type-parameter name="Range"/>
  1148. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter></function>
  1149. <function name="make_boyer_moore_horspool"><type><classname>boost::algorithm::boyer_moore_horspool</classname>&lt; typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1150. <template-type-parameter name="Range"/>
  1151. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></function>
  1152. </namespace>
  1153. </namespace>
  1154. </header>
  1155. <header name="boost/algorithm/searching/knuth_morris_pratt.hpp">
  1156. <namespace name="boost">
  1157. <namespace name="algorithm">
  1158. <class name="knuth_morris_pratt"><template>
  1159. <template-type-parameter name="patIter"/>
  1160. </template><method-group name="public member functions">
  1161. <method name="operator()" cv="const"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1162. <template-type-parameter name="corpusIter"/>
  1163. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter></method>
  1164. <method name="operator()" cv="const"><type>std::pair&lt; typename boost::range_iterator&lt; Range &gt;::type, typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1165. <template-type-parameter name="Range"/>
  1166. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></method>
  1167. </method-group>
  1168. <constructor><parameter name="first"><paramtype>patIter</paramtype></parameter><parameter name="last"><paramtype>patIter</paramtype></parameter></constructor>
  1169. <destructor/>
  1170. </class>
  1171. <function name="knuth_morris_pratt_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1172. <template-type-parameter name="patIter"/>
  1173. <template-type-parameter name="corpusIter"/>
  1174. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype><description><para>The start of the data to search (Random Access Iterator) </para></description></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype><description><para>One past the end of the data to search </para></description></parameter><parameter name="pat_first"><paramtype>patIter</paramtype><description><para>The start of the pattern to search for (Random Access Iterator) </para></description></parameter><parameter name="pat_last"><paramtype>patIter</paramtype><description><para>One past the end of the data to search for </para></description></parameter><purpose>Searches the corpus for the pattern. </purpose><description><para>
  1175. </para></description></function>
  1176. <function name="knuth_morris_pratt_search"><type>std::pair&lt; corpusIter, corpusIter &gt;</type><template>
  1177. <template-type-parameter name="PatternRange"/>
  1178. <template-type-parameter name="corpusIter"/>
  1179. </template><parameter name="corpus_first"><paramtype>corpusIter</paramtype></parameter><parameter name="corpus_last"><paramtype>corpusIter</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1180. <function name="knuth_morris_pratt_search"><type>boost::disable_if_c&lt; boost::is_same&lt; CorpusRange, patIter &gt;::value, std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt; &gt;::type</type><template>
  1181. <template-type-parameter name="patIter"/>
  1182. <template-type-parameter name="CorpusRange"/>
  1183. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pat_first"><paramtype>patIter</paramtype></parameter><parameter name="pat_last"><paramtype>patIter</paramtype></parameter></function>
  1184. <function name="knuth_morris_pratt_search"><type>std::pair&lt; typename boost::range_iterator&lt; CorpusRange &gt;::type, typename boost::range_iterator&lt; CorpusRange &gt;::type &gt;</type><template>
  1185. <template-type-parameter name="PatternRange"/>
  1186. <template-type-parameter name="CorpusRange"/>
  1187. </template><parameter name="corpus"><paramtype>CorpusRange &amp;</paramtype></parameter><parameter name="pattern"><paramtype>const PatternRange &amp;</paramtype></parameter></function>
  1188. <function name="make_knuth_morris_pratt"><type><classname>boost::algorithm::knuth_morris_pratt</classname>&lt; typename boost::range_iterator&lt; const Range &gt;::type &gt;</type><template>
  1189. <template-type-parameter name="Range"/>
  1190. </template><parameter name="r"><paramtype>const Range &amp;</paramtype></parameter></function>
  1191. <function name="make_knuth_morris_pratt"><type><classname>boost::algorithm::knuth_morris_pratt</classname>&lt; typename boost::range_iterator&lt; Range &gt;::type &gt;</type><template>
  1192. <template-type-parameter name="Range"/>
  1193. </template><parameter name="r"><paramtype>Range &amp;</paramtype></parameter></function>
  1194. </namespace>
  1195. </namespace>
  1196. </header>
  1197. <header name="boost/algorithm/sort_subrange.hpp">
  1198. <para>Sort a subrange. </para><para><para>Marshall Clow</para>
  1199. Suggested by Sean Parent in his CppCon 2015 keynote </para><namespace name="boost">
  1200. <namespace name="algorithm">
  1201. <function name="sort_subrange"><type>void</type><template>
  1202. <template-type-parameter name="Iterator"/>
  1203. <template-type-parameter name="Pred"/>
  1204. </template><parameter name="first"><paramtype>Iterator</paramtype></parameter><parameter name="last"><paramtype>Iterator</paramtype></parameter><parameter name="sub_first"><paramtype>Iterator</paramtype></parameter><parameter name="sub_last"><paramtype>Iterator</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  1205. <function name="sort_subrange"><type>void</type><template>
  1206. <template-type-parameter name="Iterator"/>
  1207. </template><parameter name="first"><paramtype>Iterator</paramtype></parameter><parameter name="last"><paramtype>Iterator</paramtype></parameter><parameter name="sub_first"><paramtype>Iterator</paramtype></parameter><parameter name="sub_last"><paramtype>Iterator</paramtype></parameter></function>
  1208. <function name="partition_subrange"><type>void</type><template>
  1209. <template-type-parameter name="Iterator"/>
  1210. <template-type-parameter name="Pred"/>
  1211. </template><parameter name="first"><paramtype>Iterator</paramtype></parameter><parameter name="last"><paramtype>Iterator</paramtype></parameter><parameter name="sub_first"><paramtype>Iterator</paramtype></parameter><parameter name="sub_last"><paramtype>Iterator</paramtype></parameter><parameter name="p"><paramtype>Pred</paramtype></parameter></function>
  1212. <function name="partition_subrange"><type>void</type><template>
  1213. <template-type-parameter name="Iterator"/>
  1214. </template><parameter name="first"><paramtype>Iterator</paramtype></parameter><parameter name="last"><paramtype>Iterator</paramtype></parameter><parameter name="sub_first"><paramtype>Iterator</paramtype></parameter><parameter name="sub_last"><paramtype>Iterator</paramtype></parameter></function>
  1215. </namespace>
  1216. </namespace>
  1217. </header>
  1218. <header name="boost/algorithm/string.hpp">
  1219. <para>Cumulative include for string_algo library </para></header>
  1220. <header name="boost/algorithm/string_regex.hpp">
  1221. <para>Cumulative include for string_algo library. In addition to string.hpp contains also regex-related stuff. </para></header>
  1222. </library-reference>