field_meat.hpp 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959
  1. // Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
  2. // Copyright 2008-2016 National ICT Australia (NICTA)
  3. //
  4. // Licensed under the Apache License, Version 2.0 (the "License");
  5. // you may not use this file except in compliance with the License.
  6. // You may obtain a copy of the License at
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. // ------------------------------------------------------------------------
  15. //! \addtogroup field
  16. //! @{
  17. template<typename oT>
  18. inline
  19. field<oT>::~field()
  20. {
  21. arma_extra_debug_sigprint_this(this);
  22. delete_objects();
  23. if(n_elem > field_prealloc_n_elem::val) { delete [] mem; }
  24. // try to expose buggy user code that accesses deleted objects
  25. if(arma_config::debug) { mem = 0; }
  26. }
  27. template<typename oT>
  28. inline
  29. field<oT>::field()
  30. : n_rows(0)
  31. , n_cols(0)
  32. , n_slices(0)
  33. , n_elem(0)
  34. , mem(0)
  35. {
  36. arma_extra_debug_sigprint_this(this);
  37. }
  38. //! construct a field from a given field
  39. template<typename oT>
  40. inline
  41. field<oT>::field(const field& x)
  42. : n_rows(0)
  43. , n_cols(0)
  44. , n_slices(0)
  45. , n_elem(0)
  46. , mem(0)
  47. {
  48. arma_extra_debug_sigprint(arma_str::format("this = %x x = %x") % this % &x);
  49. init(x);
  50. }
  51. //! construct a field from a given field
  52. template<typename oT>
  53. inline
  54. field<oT>&
  55. field<oT>::operator=(const field& x)
  56. {
  57. arma_extra_debug_sigprint();
  58. init(x);
  59. return *this;
  60. }
  61. //! construct a field from subview_field (e.g. construct a field from a delayed subfield operation)
  62. template<typename oT>
  63. inline
  64. field<oT>::field(const subview_field<oT>& X)
  65. : n_rows(0)
  66. , n_cols(0)
  67. , n_slices(0)
  68. , n_elem(0)
  69. , mem(0)
  70. {
  71. arma_extra_debug_sigprint_this(this);
  72. this->operator=(X);
  73. }
  74. //! construct a field from subview_field (e.g. construct a field from a delayed subfield operation)
  75. template<typename oT>
  76. inline
  77. field<oT>&
  78. field<oT>::operator=(const subview_field<oT>& X)
  79. {
  80. arma_extra_debug_sigprint();
  81. subview_field<oT>::extract(*this, X);
  82. return *this;
  83. }
  84. //! construct the field with the specified number of elements,
  85. //! assuming a column-major layout
  86. template<typename oT>
  87. inline
  88. field<oT>::field(const uword n_elem_in)
  89. : n_rows(0)
  90. , n_cols(0)
  91. , n_slices(0)
  92. , n_elem(0)
  93. , mem(0)
  94. {
  95. arma_extra_debug_sigprint_this(this);
  96. init(n_elem_in, 1);
  97. }
  98. //! construct the field with the specified dimensions
  99. template<typename oT>
  100. inline
  101. field<oT>::field(const uword n_rows_in, const uword n_cols_in)
  102. : n_rows(0)
  103. , n_cols(0)
  104. , n_slices(0)
  105. , n_elem(0)
  106. , mem(0)
  107. {
  108. arma_extra_debug_sigprint_this(this);
  109. init(n_rows_in, n_cols_in);
  110. }
  111. //! construct the field with the specified dimensions
  112. template<typename oT>
  113. inline
  114. field<oT>::field(const uword n_rows_in, const uword n_cols_in, const uword n_slices_in)
  115. : n_rows(0)
  116. , n_cols(0)
  117. , n_slices(0)
  118. , n_elem(0)
  119. , mem(0)
  120. {
  121. arma_extra_debug_sigprint_this(this);
  122. init(n_rows_in, n_cols_in, n_slices_in);
  123. }
  124. template<typename oT>
  125. inline
  126. field<oT>::field(const SizeMat& s)
  127. : n_rows(0)
  128. , n_cols(0)
  129. , n_slices(0)
  130. , n_elem(0)
  131. , mem(0)
  132. {
  133. arma_extra_debug_sigprint_this(this);
  134. init(s.n_rows, s.n_cols);
  135. }
  136. template<typename oT>
  137. inline
  138. field<oT>::field(const SizeCube& s)
  139. : n_rows(0)
  140. , n_cols(0)
  141. , n_slices(0)
  142. , n_elem(0)
  143. , mem(0)
  144. {
  145. arma_extra_debug_sigprint_this(this);
  146. init(s.n_rows, s.n_cols, s.n_slices);
  147. }
  148. //! change the field to have the specified number of elements,
  149. //! assuming a column-major layout (data is not preserved)
  150. template<typename oT>
  151. inline
  152. void
  153. field<oT>::set_size(const uword n_elem_in)
  154. {
  155. arma_extra_debug_sigprint(arma_str::format("n_elem_in = %d") % n_elem_in);
  156. init(n_elem_in, 1);
  157. }
  158. //! change the field to have the specified dimensions (data is not preserved)
  159. template<typename oT>
  160. inline
  161. void
  162. field<oT>::set_size(const uword n_rows_in, const uword n_cols_in)
  163. {
  164. arma_extra_debug_sigprint(arma_str::format("n_rows_in = %d, n_cols_in = %d") % n_rows_in % n_cols_in);
  165. init(n_rows_in, n_cols_in);
  166. }
  167. //! change the field to have the specified dimensions (data is not preserved)
  168. template<typename oT>
  169. inline
  170. void
  171. field<oT>::set_size(const uword n_rows_in, const uword n_cols_in, const uword n_slices_in)
  172. {
  173. arma_extra_debug_sigprint(arma_str::format("n_rows_in = %d, n_cols_in = %d, n_slices_in = %d") % n_rows_in % n_cols_in % n_slices_in);
  174. init(n_rows_in, n_cols_in, n_slices_in);
  175. }
  176. template<typename oT>
  177. inline
  178. void
  179. field<oT>::set_size(const SizeMat& s)
  180. {
  181. init(s.n_rows, s.n_cols);
  182. }
  183. template<typename oT>
  184. inline
  185. void
  186. field<oT>::set_size(const SizeCube& s)
  187. {
  188. init(s.n_rows, s.n_cols, s.n_slices);
  189. }
  190. #if defined(ARMA_USE_CXX11)
  191. template<typename oT>
  192. inline
  193. field<oT>::field(const std::initializer_list<oT>& list)
  194. : n_rows (0)
  195. , n_cols (0)
  196. , n_slices(0)
  197. , n_elem (0)
  198. {
  199. arma_extra_debug_sigprint_this(this);
  200. (*this).operator=(list);
  201. }
  202. template<typename oT>
  203. inline
  204. field<oT>&
  205. field<oT>::operator=(const std::initializer_list<oT>& list)
  206. {
  207. arma_extra_debug_sigprint();
  208. const uword N = uword(list.size());
  209. set_size(1, N);
  210. const oT* item_ptr = list.begin();
  211. for(uword i=0; i<N; ++i)
  212. {
  213. operator[](i) = item_ptr[i];
  214. }
  215. return *this;
  216. }
  217. template<typename oT>
  218. inline
  219. field<oT>::field(const std::initializer_list< std::initializer_list<oT> >& list)
  220. : n_rows (0)
  221. , n_cols (0)
  222. , n_slices(0)
  223. , n_elem (0)
  224. {
  225. arma_extra_debug_sigprint_this(this);
  226. (*this).operator=(list);
  227. }
  228. template<typename oT>
  229. inline
  230. field<oT>&
  231. field<oT>::operator=(const std::initializer_list< std::initializer_list<oT> >& list)
  232. {
  233. arma_extra_debug_sigprint();
  234. uword x_n_rows = uword(list.size());
  235. uword x_n_cols = 0;
  236. bool x_n_cols_found = false;
  237. auto it = list.begin();
  238. auto it_end = list.end();
  239. for(; it != it_end; ++it)
  240. {
  241. if(x_n_cols_found == false)
  242. {
  243. x_n_cols = uword( (*it).size() );
  244. x_n_cols_found = true;
  245. }
  246. else
  247. {
  248. arma_check( (uword((*it).size()) != x_n_cols), "field::init(): inconsistent number of columns in initialiser list" );
  249. }
  250. }
  251. field<oT>& t = (*this);
  252. t.set_size(x_n_rows, x_n_cols);
  253. uword row_num = 0;
  254. auto row_it = list.begin();
  255. auto row_it_end = list.end();
  256. for(; row_it != row_it_end; ++row_it)
  257. {
  258. uword col_num = 0;
  259. auto col_it = (*row_it).begin();
  260. auto col_it_end = (*row_it).end();
  261. for(; col_it != col_it_end; ++col_it)
  262. {
  263. t.at(row_num, col_num) = (*col_it);
  264. ++col_num;
  265. }
  266. ++row_num;
  267. }
  268. return *this;
  269. }
  270. template<typename oT>
  271. inline
  272. field<oT>::field(field<oT>&& X)
  273. : n_rows (X.n_rows )
  274. , n_cols (X.n_cols )
  275. , n_slices(X.n_slices)
  276. , n_elem (X.n_elem )
  277. {
  278. arma_extra_debug_sigprint(arma_str::format("this = %x X = %x") % this % &X);
  279. if(n_elem > field_prealloc_n_elem::val)
  280. {
  281. mem = X.mem;
  282. }
  283. else
  284. {
  285. arrayops::copy(&mem_local[0], &X.mem_local[0], n_elem);
  286. mem = mem_local;
  287. }
  288. access::rw(X.n_rows ) = 0;
  289. access::rw(X.n_cols ) = 0;
  290. access::rw(X.n_slices) = 0;
  291. access::rw(X.n_elem ) = 0;
  292. access::rw(X.mem ) = 0;
  293. }
  294. template<typename oT>
  295. inline
  296. field<oT>&
  297. field<oT>::operator=(field<oT>&& X)
  298. {
  299. arma_extra_debug_sigprint(arma_str::format("this = %x X = %x") % this % &X);
  300. reset();
  301. access::rw(n_rows ) = X.n_rows;
  302. access::rw(n_cols ) = X.n_cols;
  303. access::rw(n_slices) = X.n_slices;
  304. access::rw(n_elem ) = X.n_elem;
  305. if(n_elem > field_prealloc_n_elem::val)
  306. {
  307. mem = X.mem;
  308. }
  309. else
  310. {
  311. arrayops::copy(&mem_local[0], &X.mem_local[0], n_elem);
  312. mem = mem_local;
  313. }
  314. access::rw(X.n_rows ) = 0;
  315. access::rw(X.n_cols ) = 0;
  316. access::rw(X.n_elem ) = 0;
  317. access::rw(X.n_slices) = 0;
  318. access::rw(X.mem ) = 0;
  319. return *this;
  320. }
  321. #endif
  322. //! change the field to have the specified dimensions (data is not preserved)
  323. template<typename oT>
  324. template<typename oT2>
  325. inline
  326. void
  327. field<oT>::copy_size(const field<oT2>& x)
  328. {
  329. arma_extra_debug_sigprint();
  330. init(x.n_rows, x.n_cols, x.n_slices);
  331. }
  332. //! linear element accessor (treats the field as a vector); no bounds check
  333. template<typename oT>
  334. arma_inline
  335. oT&
  336. field<oT>::operator[] (const uword i)
  337. {
  338. return (*mem[i]);
  339. }
  340. //! linear element accessor (treats the field as a vector); no bounds check
  341. template<typename oT>
  342. arma_inline
  343. const oT&
  344. field<oT>::operator[] (const uword i) const
  345. {
  346. return (*mem[i]);
  347. }
  348. //! linear element accessor (treats the field as a vector); no bounds check
  349. template<typename oT>
  350. arma_inline
  351. oT&
  352. field<oT>::at(const uword i)
  353. {
  354. return (*mem[i]);
  355. }
  356. //! linear element accessor (treats the field as a vector); no bounds check
  357. template<typename oT>
  358. arma_inline
  359. const oT&
  360. field<oT>::at(const uword i) const
  361. {
  362. return (*mem[i]);
  363. }
  364. //! linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined
  365. template<typename oT>
  366. arma_inline
  367. oT&
  368. field<oT>::operator() (const uword i)
  369. {
  370. arma_debug_check( (i >= n_elem), "field::operator(): index out of bounds" );
  371. return (*mem[i]);
  372. }
  373. //! linear element accessor (treats the field as a vector); bounds checking not done when ARMA_NO_DEBUG is defined
  374. template<typename oT>
  375. arma_inline
  376. const oT&
  377. field<oT>::operator() (const uword i) const
  378. {
  379. arma_debug_check( (i >= n_elem), "field::operator(): index out of bounds" );
  380. return (*mem[i]);
  381. }
  382. //! element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
  383. template<typename oT>
  384. arma_inline
  385. oT&
  386. field<oT>::operator() (const uword in_row, const uword in_col)
  387. {
  388. arma_debug_check( ((in_row >= n_rows) || (in_col >= n_cols) || (0 >= n_slices) ), "field::operator(): index out of bounds" );
  389. return (*mem[in_row + in_col*n_rows]);
  390. }
  391. //! element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
  392. template<typename oT>
  393. arma_inline
  394. const oT&
  395. field<oT>::operator() (const uword in_row, const uword in_col) const
  396. {
  397. arma_debug_check( ((in_row >= n_rows) || (in_col >= n_cols) || (0 >= n_slices) ), "field::operator(): index out of bounds" );
  398. return (*mem[in_row + in_col*n_rows]);
  399. }
  400. //! element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
  401. template<typename oT>
  402. arma_inline
  403. oT&
  404. field<oT>::operator() (const uword in_row, const uword in_col, const uword in_slice)
  405. {
  406. arma_debug_check( ((in_row >= n_rows) || (in_col >= n_cols) || (in_slice >= n_slices)), "field::operator(): index out of bounds" );
  407. return (*mem[in_row + in_col*n_rows + in_slice*(n_rows*n_cols)]);
  408. }
  409. //! element accessor; bounds checking not done when ARMA_NO_DEBUG is defined
  410. template<typename oT>
  411. arma_inline
  412. const oT&
  413. field<oT>::operator() (const uword in_row, const uword in_col, const uword in_slice) const
  414. {
  415. arma_debug_check( ((in_row >= n_rows) || (in_col >= n_cols) || (in_slice >= n_slices)), "field::operator(): index out of bounds" );
  416. return (*mem[in_row + in_col*n_rows + in_slice*(n_rows*n_cols)]);
  417. }
  418. //! element accessor; no bounds check
  419. template<typename oT>
  420. arma_inline
  421. oT&
  422. field<oT>::at(const uword in_row, const uword in_col)
  423. {
  424. return (*mem[in_row + in_col*n_rows]);
  425. }
  426. //! element accessor; no bounds check
  427. template<typename oT>
  428. arma_inline
  429. const oT&
  430. field<oT>::at(const uword in_row, const uword in_col) const
  431. {
  432. return (*mem[in_row + in_col*n_rows]);
  433. }
  434. //! element accessor; no bounds check
  435. template<typename oT>
  436. arma_inline
  437. oT&
  438. field<oT>::at(const uword in_row, const uword in_col, const uword in_slice)
  439. {
  440. return (*mem[in_row + in_col*n_rows + in_slice*(n_rows*n_cols)]);
  441. }
  442. //! element accessor; no bounds check
  443. template<typename oT>
  444. arma_inline
  445. const oT&
  446. field<oT>::at(const uword in_row, const uword in_col, const uword in_slice) const
  447. {
  448. return (*mem[in_row + in_col*n_rows + in_slice*(n_rows*n_cols)]);
  449. }
  450. template<typename oT>
  451. inline
  452. field_injector< field<oT> >
  453. field<oT>::operator<<(const oT& val)
  454. {
  455. return field_injector< field<oT> >(*this, val);
  456. }
  457. template<typename oT>
  458. inline
  459. field_injector< field<oT> >
  460. field<oT>::operator<<(const injector_end_of_row<>& x)
  461. {
  462. return field_injector< field<oT> >(*this, x);
  463. }
  464. //! creation of subview_field (row of a field)
  465. template<typename oT>
  466. inline
  467. subview_field<oT>
  468. field<oT>::row(const uword row_num)
  469. {
  470. arma_extra_debug_sigprint();
  471. arma_debug_check( (n_slices >= 2), "field::row(): field must be 2D" );
  472. arma_debug_check( (row_num >= n_rows), "field::row(): row out of bounds" );
  473. return subview_field<oT>(*this, row_num, 0, 1, n_cols);
  474. }
  475. //! creation of subview_field (row of a field)
  476. template<typename oT>
  477. inline
  478. const subview_field<oT>
  479. field<oT>::row(const uword row_num) const
  480. {
  481. arma_extra_debug_sigprint();
  482. arma_debug_check( (n_slices >= 2), "field::row(): field must be 2D" );
  483. arma_debug_check( (row_num >= n_rows), "field::row(): row out of bounds" );
  484. return subview_field<oT>(*this, row_num, 0, 1, n_cols);
  485. }
  486. //! creation of subview_field (column of a field)
  487. template<typename oT>
  488. inline
  489. subview_field<oT>
  490. field<oT>::col(const uword col_num)
  491. {
  492. arma_extra_debug_sigprint();
  493. arma_debug_check( (n_slices >= 2), "field::col(): field must be 2D" );
  494. arma_debug_check( (col_num >= n_cols), "field::col(): out of bounds" );
  495. return subview_field<oT>(*this, 0, col_num, n_rows, 1);
  496. }
  497. //! creation of subview_field (column of a field)
  498. template<typename oT>
  499. inline
  500. const subview_field<oT>
  501. field<oT>::col(const uword col_num) const
  502. {
  503. arma_extra_debug_sigprint();
  504. arma_debug_check( (n_slices >= 2), "field::col(): field must be 2D" );
  505. arma_debug_check( (col_num >= n_cols), "field::col(): out of bounds" );
  506. return subview_field<oT>(*this, 0, col_num, n_rows, 1);
  507. }
  508. //! creation of subview_field (slice of a field)
  509. template<typename oT>
  510. inline
  511. subview_field<oT>
  512. field<oT>::slice(const uword slice_num)
  513. {
  514. arma_extra_debug_sigprint();
  515. arma_debug_check( (slice_num >= n_slices), "field::slice(): out of bounds" );
  516. return subview_field<oT>(*this, 0, 0, slice_num, n_rows, n_cols, 1);
  517. }
  518. //! creation of subview_field (slice of a field)
  519. template<typename oT>
  520. inline
  521. const subview_field<oT>
  522. field<oT>::slice(const uword slice_num) const
  523. {
  524. arma_extra_debug_sigprint();
  525. arma_debug_check( (slice_num >= n_slices), "field::slice(): out of bounds" );
  526. return subview_field<oT>(*this, 0, 0, slice_num, n_rows, n_cols, 1);
  527. }
  528. //! creation of subview_field (subfield comprised of specified rows)
  529. template<typename oT>
  530. inline
  531. subview_field<oT>
  532. field<oT>::rows(const uword in_row1, const uword in_row2)
  533. {
  534. arma_extra_debug_sigprint();
  535. arma_debug_check( (n_slices >= 2), "field::rows(): field must be 2D" );
  536. arma_debug_check
  537. (
  538. ( (in_row1 > in_row2) || (in_row2 >= n_rows) ),
  539. "field::rows(): indicies out of bounds or incorrectly used"
  540. );
  541. const uword sub_n_rows = in_row2 - in_row1 + 1;
  542. return subview_field<oT>(*this, in_row1, 0, sub_n_rows, n_cols);
  543. }
  544. //! creation of subview_field (subfield comprised of specified rows)
  545. template<typename oT>
  546. inline
  547. const subview_field<oT>
  548. field<oT>::rows(const uword in_row1, const uword in_row2) const
  549. {
  550. arma_extra_debug_sigprint();
  551. arma_debug_check( (n_slices >= 2), "field::rows(): field must be 2D" );
  552. arma_debug_check
  553. (
  554. ( (in_row1 > in_row2) || (in_row2 >= n_rows) ),
  555. "field::rows(): indicies out of bounds or incorrectly used"
  556. );
  557. const uword sub_n_rows = in_row2 - in_row1 + 1;
  558. return subview_field<oT>(*this, in_row1, 0, sub_n_rows, n_cols);
  559. }
  560. //! creation of subview_field (subfield comprised of specified columns)
  561. template<typename oT>
  562. inline
  563. subview_field<oT>
  564. field<oT>::cols(const uword in_col1, const uword in_col2)
  565. {
  566. arma_extra_debug_sigprint();
  567. arma_debug_check( (n_slices >= 2), "field::cols(): field must be 2D" );
  568. arma_debug_check
  569. (
  570. ( (in_col1 > in_col2) || (in_col2 >= n_cols) ),
  571. "field::cols(): indicies out of bounds or incorrectly used"
  572. );
  573. const uword sub_n_cols = in_col2 - in_col1 + 1;
  574. return subview_field<oT>(*this, 0, in_col1, n_rows, sub_n_cols);
  575. }
  576. //! creation of subview_field (subfield comprised of specified columns)
  577. template<typename oT>
  578. inline
  579. const subview_field<oT>
  580. field<oT>::cols(const uword in_col1, const uword in_col2) const
  581. {
  582. arma_extra_debug_sigprint();
  583. arma_debug_check( (n_slices >= 2), "field::cols(): field must be 2D" );
  584. arma_debug_check
  585. (
  586. ( (in_col1 > in_col2) || (in_col2 >= n_cols) ),
  587. "field::cols(): indicies out of bounds or incorrectly used"
  588. );
  589. const uword sub_n_cols = in_col2 - in_col1 + 1;
  590. return subview_field<oT>(*this, 0, in_col1, n_rows, sub_n_cols);
  591. }
  592. //! creation of subview_field (subfield comprised of specified slices)
  593. template<typename oT>
  594. inline
  595. subview_field<oT>
  596. field<oT>::slices(const uword in_slice1, const uword in_slice2)
  597. {
  598. arma_extra_debug_sigprint();
  599. arma_debug_check
  600. (
  601. ( (in_slice1 > in_slice2) || (in_slice2 >= n_slices) ),
  602. "field::slices(): indicies out of bounds or incorrectly used"
  603. );
  604. const uword sub_n_slices = in_slice2 - in_slice1 + 1;
  605. return subview_field<oT>(*this, 0, 0, in_slice1, n_rows, n_cols, sub_n_slices);
  606. }
  607. //! creation of subview_field (subfield comprised of specified slices)
  608. template<typename oT>
  609. inline
  610. const subview_field<oT>
  611. field<oT>::slices(const uword in_slice1, const uword in_slice2) const
  612. {
  613. arma_extra_debug_sigprint();
  614. arma_debug_check
  615. (
  616. ( (in_slice1 > in_slice2) || (in_slice2 >= n_slices) ),
  617. "field::slices(): indicies out of bounds or incorrectly used"
  618. );
  619. const uword sub_n_slices = in_slice2 - in_slice1 + 1;
  620. return subview_field<oT>(*this, 0, 0, in_slice1, n_rows, n_cols, sub_n_slices);
  621. }
  622. //! creation of subview_field (subfield with arbitrary dimensions)
  623. template<typename oT>
  624. inline
  625. subview_field<oT>
  626. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2)
  627. {
  628. arma_extra_debug_sigprint();
  629. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  630. arma_debug_check
  631. (
  632. (in_row1 > in_row2) || (in_col1 > in_col2) || (in_row2 >= n_rows) || (in_col2 >= n_cols),
  633. "field::subfield(): indices out of bounds or incorrectly used"
  634. );
  635. const uword sub_n_rows = in_row2 - in_row1 + 1;
  636. const uword sub_n_cols = in_col2 - in_col1 + 1;
  637. return subview_field<oT>(*this, in_row1, in_col1, sub_n_rows, sub_n_cols);
  638. }
  639. //! creation of subview_field (subfield with arbitrary dimensions)
  640. template<typename oT>
  641. inline
  642. const subview_field<oT>
  643. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_row2, const uword in_col2) const
  644. {
  645. arma_extra_debug_sigprint();
  646. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  647. arma_debug_check
  648. (
  649. (in_row1 > in_row2) || (in_col1 > in_col2) || (in_row2 >= n_rows) || (in_col2 >= n_cols),
  650. "field::subfield(): indices out of bounds or incorrectly used"
  651. );
  652. const uword sub_n_rows = in_row2 - in_row1 + 1;
  653. const uword sub_n_cols = in_col2 - in_col1 + 1;
  654. return subview_field<oT>(*this, in_row1, in_col1, sub_n_rows, sub_n_cols);
  655. }
  656. //! creation of subview_field (subfield with arbitrary dimensions)
  657. template<typename oT>
  658. inline
  659. subview_field<oT>
  660. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_slice1, const uword in_row2, const uword in_col2, const uword in_slice2)
  661. {
  662. arma_extra_debug_sigprint();
  663. arma_debug_check
  664. (
  665. (in_row1 > in_row2) || (in_col1 > in_col2) || (in_slice1 > in_slice2) || (in_row2 >= n_rows) || (in_col2 >= n_cols) || (in_slice2 >= n_slices),
  666. "field::subfield(): indices out of bounds or incorrectly used"
  667. );
  668. const uword sub_n_rows = in_row2 - in_row1 + 1;
  669. const uword sub_n_cols = in_col2 - in_col1 + 1;
  670. const uword sub_n_slices = in_slice2 - in_slice1 + 1;
  671. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, sub_n_rows, sub_n_cols, sub_n_slices);
  672. }
  673. //! creation of subview_field (subfield with arbitrary dimensions)
  674. template<typename oT>
  675. inline
  676. const subview_field<oT>
  677. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_slice1, const uword in_row2, const uword in_col2, const uword in_slice2) const
  678. {
  679. arma_extra_debug_sigprint();
  680. arma_debug_check
  681. (
  682. (in_row1 > in_row2) || (in_col1 > in_col2) || (in_slice1 > in_slice2) || (in_row2 >= n_rows) || (in_col2 >= n_cols) || (in_slice2 >= n_slices),
  683. "field::subfield(): indices out of bounds or incorrectly used"
  684. );
  685. const uword sub_n_rows = in_row2 - in_row1 + 1;
  686. const uword sub_n_cols = in_col2 - in_col1 + 1;
  687. const uword sub_n_slices = in_slice2 - in_slice1 + 1;
  688. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, sub_n_rows, sub_n_cols, sub_n_slices);
  689. }
  690. //! creation of subview_field (subfield with arbitrary dimensions)
  691. template<typename oT>
  692. inline
  693. subview_field<oT>
  694. field<oT>::subfield(const uword in_row1, const uword in_col1, const SizeMat& s)
  695. {
  696. arma_extra_debug_sigprint();
  697. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  698. const uword l_n_rows = n_rows;
  699. const uword l_n_cols = n_cols;
  700. const uword s_n_rows = s.n_rows;
  701. const uword s_n_cols = s.n_cols;
  702. arma_debug_check
  703. (
  704. ((in_row1 >= l_n_rows) || (in_col1 >= l_n_cols) || ((in_row1 + s_n_rows) > l_n_rows) || ((in_col1 + s_n_cols) > l_n_cols)),
  705. "field::subfield(): indices or size out of bounds"
  706. );
  707. return subview_field<oT>(*this, in_row1, in_col1, s_n_rows, s_n_cols);
  708. }
  709. //! creation of subview_field (subfield with arbitrary dimensions)
  710. template<typename oT>
  711. inline
  712. const subview_field<oT>
  713. field<oT>::subfield(const uword in_row1, const uword in_col1, const SizeMat& s) const
  714. {
  715. arma_extra_debug_sigprint();
  716. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  717. const uword l_n_rows = n_rows;
  718. const uword l_n_cols = n_cols;
  719. const uword s_n_rows = s.n_rows;
  720. const uword s_n_cols = s.n_cols;
  721. arma_debug_check
  722. (
  723. ((in_row1 >= l_n_rows) || (in_col1 >= l_n_cols) || ((in_row1 + s_n_rows) > l_n_rows) || ((in_col1 + s_n_cols) > l_n_cols)),
  724. "field::subfield(): indices or size out of bounds"
  725. );
  726. return subview_field<oT>(*this, in_row1, in_col1, s_n_rows, s_n_cols);
  727. }
  728. //! creation of subview_field (subfield with arbitrary dimensions)
  729. template<typename oT>
  730. inline
  731. subview_field<oT>
  732. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_slice1, const SizeCube& s)
  733. {
  734. arma_extra_debug_sigprint();
  735. const uword l_n_rows = n_rows;
  736. const uword l_n_cols = n_cols;
  737. const uword l_n_slices = n_slices;
  738. const uword s_n_rows = s.n_rows;
  739. const uword s_n_cols = s.n_cols;
  740. const uword sub_n_slices = s.n_slices;
  741. arma_debug_check
  742. (
  743. ((in_row1 >= l_n_rows) || (in_col1 >= l_n_cols) || (in_slice1 >= l_n_slices) || ((in_row1 + s_n_rows) > l_n_rows) || ((in_col1 + s_n_cols) > l_n_cols) || ((in_slice1 + sub_n_slices) > l_n_slices)),
  744. "field::subfield(): indices or size out of bounds"
  745. );
  746. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, s_n_rows, s_n_cols, sub_n_slices);
  747. }
  748. //! creation of subview_field (subfield with arbitrary dimensions)
  749. template<typename oT>
  750. inline
  751. const subview_field<oT>
  752. field<oT>::subfield(const uword in_row1, const uword in_col1, const uword in_slice1, const SizeCube& s) const
  753. {
  754. arma_extra_debug_sigprint();
  755. const uword l_n_rows = n_rows;
  756. const uword l_n_cols = n_cols;
  757. const uword l_n_slices = n_slices;
  758. const uword s_n_rows = s.n_rows;
  759. const uword s_n_cols = s.n_cols;
  760. const uword sub_n_slices = s.n_slices;
  761. arma_debug_check
  762. (
  763. ((in_row1 >= l_n_rows) || (in_col1 >= l_n_cols) || (in_slice1 >= l_n_slices) || ((in_row1 + s_n_rows) > l_n_rows) || ((in_col1 + s_n_cols) > l_n_cols) || ((in_slice1 + sub_n_slices) > l_n_slices)),
  764. "field::subfield(): indices or size out of bounds"
  765. );
  766. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, s_n_rows, s_n_cols, sub_n_slices);
  767. }
  768. //! creation of subview_field (subfield with arbitrary dimensions)
  769. template<typename oT>
  770. inline
  771. subview_field<oT>
  772. field<oT>::subfield(const span& row_span, const span& col_span)
  773. {
  774. arma_extra_debug_sigprint();
  775. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  776. const bool row_all = row_span.whole;
  777. const bool col_all = col_span.whole;
  778. const uword local_n_rows = n_rows;
  779. const uword local_n_cols = n_cols;
  780. const uword in_row1 = row_all ? 0 : row_span.a;
  781. const uword in_row2 = row_span.b;
  782. const uword sub_n_rows = row_all ? local_n_rows : in_row2 - in_row1 + 1;
  783. const uword in_col1 = col_all ? 0 : col_span.a;
  784. const uword in_col2 = col_span.b;
  785. const uword sub_n_cols = col_all ? local_n_cols : in_col2 - in_col1 + 1;
  786. arma_debug_check
  787. (
  788. ( row_all ? false : ((in_row1 > in_row2) || (in_row2 >= local_n_rows)) )
  789. ||
  790. ( col_all ? false : ((in_col1 > in_col2) || (in_col2 >= local_n_cols)) )
  791. ,
  792. "field::subfield(): indices out of bounds or incorrectly used"
  793. );
  794. return subview_field<oT>(*this, in_row1, in_col1, sub_n_rows, sub_n_cols);
  795. }
  796. //! creation of subview_field (subfield with arbitrary dimensions)
  797. template<typename oT>
  798. inline
  799. const subview_field<oT>
  800. field<oT>::subfield(const span& row_span, const span& col_span) const
  801. {
  802. arma_extra_debug_sigprint();
  803. arma_debug_check( (n_slices >= 2), "field::subfield(): field must be 2D" );
  804. const bool row_all = row_span.whole;
  805. const bool col_all = col_span.whole;
  806. const uword local_n_rows = n_rows;
  807. const uword local_n_cols = n_cols;
  808. const uword in_row1 = row_all ? 0 : row_span.a;
  809. const uword in_row2 = row_span.b;
  810. const uword sub_n_rows = row_all ? local_n_rows : in_row2 - in_row1 + 1;
  811. const uword in_col1 = col_all ? 0 : col_span.a;
  812. const uword in_col2 = col_span.b;
  813. const uword sub_n_cols = col_all ? local_n_cols : in_col2 - in_col1 + 1;
  814. arma_debug_check
  815. (
  816. ( row_all ? false : ((in_row1 > in_row2) || (in_row2 >= local_n_rows)) )
  817. ||
  818. ( col_all ? false : ((in_col1 > in_col2) || (in_col2 >= local_n_cols)) )
  819. ,
  820. "field::subfield(): indices out of bounds or incorrectly used"
  821. );
  822. return subview_field<oT>(*this, in_row1, in_col1, sub_n_rows, sub_n_cols);
  823. }
  824. //! creation of subview_field (subfield with arbitrary dimensions)
  825. template<typename oT>
  826. inline
  827. subview_field<oT>
  828. field<oT>::subfield(const span& row_span, const span& col_span, const span& slice_span)
  829. {
  830. arma_extra_debug_sigprint();
  831. const bool row_all = row_span.whole;
  832. const bool col_all = col_span.whole;
  833. const bool slice_all = slice_span.whole;
  834. const uword local_n_rows = n_rows;
  835. const uword local_n_cols = n_cols;
  836. const uword local_n_slices = n_slices;
  837. const uword in_row1 = row_all ? 0 : row_span.a;
  838. const uword in_row2 = row_span.b;
  839. const uword sub_n_rows = row_all ? local_n_rows : in_row2 - in_row1 + 1;
  840. const uword in_col1 = col_all ? 0 : col_span.a;
  841. const uword in_col2 = col_span.b;
  842. const uword sub_n_cols = col_all ? local_n_cols : in_col2 - in_col1 + 1;
  843. const uword in_slice1 = slice_all ? 0 : slice_span.a;
  844. const uword in_slice2 = slice_span.b;
  845. const uword sub_n_slices = slice_all ? local_n_slices : in_slice2 - in_slice1 + 1;
  846. arma_debug_check
  847. (
  848. ( row_all ? false : ((in_row1 > in_row2) || (in_row2 >= local_n_rows)) )
  849. ||
  850. ( col_all ? false : ((in_col1 > in_col2) || (in_col2 >= local_n_cols)) )
  851. ||
  852. ( slice_all ? false : ((in_slice1 > in_slice2) || (in_slice2 >= local_n_slices)) )
  853. ,
  854. "field::subfield(): indices out of bounds or incorrectly used"
  855. );
  856. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, sub_n_rows, sub_n_cols, sub_n_slices);
  857. }
  858. //! creation of subview_field (subfield with arbitrary dimensions)
  859. template<typename oT>
  860. inline
  861. const subview_field<oT>
  862. field<oT>::subfield(const span& row_span, const span& col_span, const span& slice_span) const
  863. {
  864. arma_extra_debug_sigprint();
  865. const bool row_all = row_span.whole;
  866. const bool col_all = col_span.whole;
  867. const bool slice_all = slice_span.whole;
  868. const uword local_n_rows = n_rows;
  869. const uword local_n_cols = n_cols;
  870. const uword local_n_slices = n_slices;
  871. const uword in_row1 = row_all ? 0 : row_span.a;
  872. const uword in_row2 = row_span.b;
  873. const uword sub_n_rows = row_all ? local_n_rows : in_row2 - in_row1 + 1;
  874. const uword in_col1 = col_all ? 0 : col_span.a;
  875. const uword in_col2 = col_span.b;
  876. const uword sub_n_cols = col_all ? local_n_cols : in_col2 - in_col1 + 1;
  877. const uword in_slice1 = slice_all ? 0 : slice_span.a;
  878. const uword in_slice2 = slice_span.b;
  879. const uword sub_n_slices = slice_all ? local_n_slices : in_slice2 - in_slice1 + 1;
  880. arma_debug_check
  881. (
  882. ( row_all ? false : ((in_row1 > in_row2) || (in_row2 >= local_n_rows)) )
  883. ||
  884. ( col_all ? false : ((in_col1 > in_col2) || (in_col2 >= local_n_cols)) )
  885. ||
  886. ( slice_all ? false : ((in_slice1 > in_slice2) || (in_slice2 >= local_n_slices)) )
  887. ,
  888. "field::subfield(): indices out of bounds or incorrectly used"
  889. );
  890. return subview_field<oT>(*this, in_row1, in_col1, in_slice1, sub_n_rows, sub_n_cols, sub_n_slices);
  891. }
  892. template<typename oT>
  893. inline
  894. subview_field<oT>
  895. field<oT>::operator()(const span& row_span, const span& col_span)
  896. {
  897. arma_extra_debug_sigprint();
  898. return (*this).subfield(row_span, col_span);
  899. }
  900. template<typename oT>
  901. inline
  902. const subview_field<oT>
  903. field<oT>::operator()(const span& row_span, const span& col_span) const
  904. {
  905. arma_extra_debug_sigprint();
  906. return (*this).subfield(row_span, col_span);
  907. }
  908. template<typename oT>
  909. inline
  910. subview_field<oT>
  911. field<oT>::operator()(const span& row_span, const span& col_span, const span& slice_span)
  912. {
  913. arma_extra_debug_sigprint();
  914. return (*this).subfield(row_span, col_span, slice_span);
  915. }
  916. template<typename oT>
  917. inline
  918. const subview_field<oT>
  919. field<oT>::operator()(const span& row_span, const span& col_span, const span& slice_span) const
  920. {
  921. arma_extra_debug_sigprint();
  922. return (*this).subfield(row_span, col_span, slice_span);
  923. }
  924. template<typename oT>
  925. inline
  926. subview_field<oT>
  927. field<oT>::operator()(const uword in_row1, const uword in_col1, const SizeMat& s)
  928. {
  929. arma_extra_debug_sigprint();
  930. return (*this).subfield(in_row1, in_col1, s);
  931. }
  932. template<typename oT>
  933. inline
  934. const subview_field<oT>
  935. field<oT>::operator()(const uword in_row1, const uword in_col1, const SizeMat& s) const
  936. {
  937. arma_extra_debug_sigprint();
  938. return (*this).subfield(in_row1, in_col1, s);
  939. }
  940. template<typename oT>
  941. inline
  942. subview_field<oT>
  943. field<oT>::operator()(const uword in_row1, const uword in_col1, const uword in_slice1, const SizeCube& s)
  944. {
  945. arma_extra_debug_sigprint();
  946. return (*this).subfield(in_row1, in_col1, in_slice1, s);
  947. }
  948. template<typename oT>
  949. inline
  950. const subview_field<oT>
  951. field<oT>::operator()(const uword in_row1, const uword in_col1, const uword in_slice1, const SizeCube& s) const
  952. {
  953. arma_extra_debug_sigprint();
  954. return (*this).subfield(in_row1, in_col1, in_slice1, s);
  955. }
  956. //! print contents of the field (to the cout stream),
  957. //! optionally preceding with a user specified line of text.
  958. //! the field class preserves the stream's flags
  959. //! but the associated operator<< function for type oT
  960. //! may still modify the stream's parameters.
  961. //! NOTE: this function assumes that type oT can be printed,
  962. //! i.e. the function "std::ostream& operator<< (std::ostream&, const oT&)"
  963. //! has been defined.
  964. template<typename oT>
  965. arma_cold
  966. inline
  967. void
  968. field<oT>::print(const std::string extra_text) const
  969. {
  970. arma_extra_debug_sigprint();
  971. if(extra_text.length() != 0)
  972. {
  973. const std::streamsize orig_width = get_cout_stream().width();
  974. get_cout_stream() << extra_text << '\n';
  975. get_cout_stream().width(orig_width);
  976. }
  977. arma_ostream::print(get_cout_stream(), *this);
  978. }
  979. //! print contents of the field to a user specified stream,
  980. //! optionally preceding with a user specified line of text.
  981. //! the field class preserves the stream's flags
  982. //! but the associated operator<< function for type oT
  983. //! may still modify the stream's parameters.
  984. //! NOTE: this function assumes that type oT can be printed,
  985. //! i.e. the function "std::ostream& operator<< (std::ostream&, const oT&)"
  986. //! has been defined.
  987. template<typename oT>
  988. arma_cold
  989. inline
  990. void
  991. field<oT>::print(std::ostream& user_stream, const std::string extra_text) const
  992. {
  993. arma_extra_debug_sigprint();
  994. if(extra_text.length() != 0)
  995. {
  996. const std::streamsize orig_width = user_stream.width();
  997. user_stream << extra_text << '\n';
  998. user_stream.width(orig_width);
  999. }
  1000. arma_ostream::print(user_stream, *this);
  1001. }
  1002. #if defined(ARMA_USE_CXX11)
  1003. //! apply a lambda function to each object
  1004. template<typename oT>
  1005. inline
  1006. const field<oT>&
  1007. field<oT>::for_each(const std::function< void(oT&) >& F)
  1008. {
  1009. arma_extra_debug_sigprint();
  1010. for(uword i=0; i < n_elem; ++i)
  1011. {
  1012. F(operator[](i));
  1013. }
  1014. return *this;
  1015. }
  1016. template<typename oT>
  1017. inline
  1018. const field<oT>&
  1019. field<oT>::for_each(const std::function< void(const oT&) >& F) const
  1020. {
  1021. arma_extra_debug_sigprint();
  1022. for(uword i=0; i < n_elem; ++i)
  1023. {
  1024. F(operator[](i));
  1025. }
  1026. return *this;
  1027. }
  1028. #else
  1029. //! apply a functor to each object
  1030. template<typename oT>
  1031. template<typename functor>
  1032. inline
  1033. const field<oT>&
  1034. field<oT>::for_each(functor F)
  1035. {
  1036. arma_extra_debug_sigprint();
  1037. for(uword i=0; i < n_elem; ++i)
  1038. {
  1039. F(operator[](i));
  1040. }
  1041. return *this;
  1042. }
  1043. template<typename oT>
  1044. template<typename functor>
  1045. inline
  1046. const field<oT>&
  1047. field<oT>::for_each(functor F) const
  1048. {
  1049. arma_extra_debug_sigprint();
  1050. for(uword i=0; i < n_elem; ++i)
  1051. {
  1052. F(operator[](i));
  1053. }
  1054. return *this;
  1055. }
  1056. #endif
  1057. //! fill the field with an object
  1058. template<typename oT>
  1059. inline
  1060. const field<oT>&
  1061. field<oT>::fill(const oT& x)
  1062. {
  1063. arma_extra_debug_sigprint();
  1064. field<oT>& t = *this;
  1065. for(uword i=0; i<n_elem; ++i)
  1066. {
  1067. t[i] = x;
  1068. }
  1069. return *this;
  1070. }
  1071. //! reset the field to an empty state (i.e. the field will have no objects)
  1072. template<typename oT>
  1073. inline
  1074. void
  1075. field<oT>::reset()
  1076. {
  1077. arma_extra_debug_sigprint();
  1078. init(0,0,0);
  1079. }
  1080. //! reset each object
  1081. template<typename oT>
  1082. inline
  1083. void
  1084. field<oT>::reset_objects()
  1085. {
  1086. arma_extra_debug_sigprint();
  1087. field_aux::reset_objects(*this);
  1088. }
  1089. //! returns true if the field has no objects
  1090. template<typename oT>
  1091. arma_inline
  1092. bool
  1093. field<oT>::is_empty() const
  1094. {
  1095. return (n_elem == 0);
  1096. }
  1097. //! returns true if the given index is currently in range
  1098. template<typename oT>
  1099. arma_inline
  1100. arma_warn_unused
  1101. bool
  1102. field<oT>::in_range(const uword i) const
  1103. {
  1104. return (i < n_elem);
  1105. }
  1106. //! returns true if the given start and end indices are currently in range
  1107. template<typename oT>
  1108. arma_inline
  1109. arma_warn_unused
  1110. bool
  1111. field<oT>::in_range(const span& x) const
  1112. {
  1113. arma_extra_debug_sigprint();
  1114. if(x.whole == true)
  1115. {
  1116. return true;
  1117. }
  1118. else
  1119. {
  1120. const uword a = x.a;
  1121. const uword b = x.b;
  1122. return ( (a <= b) && (b < n_elem) );
  1123. }
  1124. }
  1125. //! returns true if the given location is currently in range
  1126. template<typename oT>
  1127. arma_inline
  1128. arma_warn_unused
  1129. bool
  1130. field<oT>::in_range(const uword in_row, const uword in_col) const
  1131. {
  1132. return ( (in_row < n_rows) && (in_col < n_cols) );
  1133. }
  1134. template<typename oT>
  1135. arma_inline
  1136. arma_warn_unused
  1137. bool
  1138. field<oT>::in_range(const span& row_span, const uword in_col) const
  1139. {
  1140. arma_extra_debug_sigprint();
  1141. if(row_span.whole == true)
  1142. {
  1143. return (in_col < n_cols);
  1144. }
  1145. else
  1146. {
  1147. const uword in_row1 = row_span.a;
  1148. const uword in_row2 = row_span.b;
  1149. return ( (in_row1 <= in_row2) && (in_row2 < n_rows) && (in_col < n_cols) );
  1150. }
  1151. }
  1152. template<typename oT>
  1153. arma_inline
  1154. arma_warn_unused
  1155. bool
  1156. field<oT>::in_range(const uword in_row, const span& col_span) const
  1157. {
  1158. arma_extra_debug_sigprint();
  1159. if(col_span.whole == true)
  1160. {
  1161. return (in_row < n_rows);
  1162. }
  1163. else
  1164. {
  1165. const uword in_col1 = col_span.a;
  1166. const uword in_col2 = col_span.b;
  1167. return ( (in_row < n_rows) && (in_col1 <= in_col2) && (in_col2 < n_cols) );
  1168. }
  1169. }
  1170. template<typename oT>
  1171. arma_inline
  1172. arma_warn_unused
  1173. bool
  1174. field<oT>::in_range(const span& row_span, const span& col_span) const
  1175. {
  1176. arma_extra_debug_sigprint();
  1177. const uword in_row1 = row_span.a;
  1178. const uword in_row2 = row_span.b;
  1179. const uword in_col1 = col_span.a;
  1180. const uword in_col2 = col_span.b;
  1181. const bool rows_ok = row_span.whole ? true : ( (in_row1 <= in_row2) && (in_row2 < n_rows) );
  1182. const bool cols_ok = col_span.whole ? true : ( (in_col1 <= in_col2) && (in_col2 < n_cols) );
  1183. return ( (rows_ok == true) && (cols_ok == true) );
  1184. }
  1185. template<typename oT>
  1186. arma_inline
  1187. arma_warn_unused
  1188. bool
  1189. field<oT>::in_range(const uword in_row, const uword in_col, const SizeMat& s) const
  1190. {
  1191. const uword l_n_rows = n_rows;
  1192. const uword l_n_cols = n_cols;
  1193. if( (in_row >= l_n_rows) || (in_col >= l_n_cols) || ((in_row + s.n_rows) > l_n_rows) || ((in_col + s.n_cols) > l_n_cols) )
  1194. {
  1195. return false;
  1196. }
  1197. else
  1198. {
  1199. return true;
  1200. }
  1201. }
  1202. template<typename oT>
  1203. arma_inline
  1204. arma_warn_unused
  1205. bool
  1206. field<oT>::in_range(const uword in_row, const uword in_col, const uword in_slice) const
  1207. {
  1208. return ( (in_row < n_rows) && (in_col < n_cols) && (in_slice < n_slices) );
  1209. }
  1210. template<typename oT>
  1211. arma_inline
  1212. arma_warn_unused
  1213. bool
  1214. field<oT>::in_range(const span& row_span, const span& col_span, const span& slice_span) const
  1215. {
  1216. arma_extra_debug_sigprint();
  1217. const uword in_row1 = row_span.a;
  1218. const uword in_row2 = row_span.b;
  1219. const uword in_col1 = col_span.a;
  1220. const uword in_col2 = col_span.b;
  1221. const uword in_slice1 = slice_span.a;
  1222. const uword in_slice2 = slice_span.b;
  1223. const bool rows_ok = row_span.whole ? true : ( (in_row1 <= in_row2 ) && (in_row2 < n_rows ) );
  1224. const bool cols_ok = col_span.whole ? true : ( (in_col1 <= in_col2 ) && (in_col2 < n_cols ) );
  1225. const bool slices_ok = slice_span.whole ? true : ( (in_slice1 <= in_slice2) && (in_slice2 < n_slices) );
  1226. return ( (rows_ok == true) && (cols_ok == true) && (slices_ok == true) );
  1227. }
  1228. template<typename oT>
  1229. arma_inline
  1230. arma_warn_unused
  1231. bool
  1232. field<oT>::in_range(const uword in_row, const uword in_col, const uword in_slice, const SizeCube& s) const
  1233. {
  1234. const uword l_n_rows = n_rows;
  1235. const uword l_n_cols = n_cols;
  1236. const uword l_n_slices = n_slices;
  1237. if( (in_row >= l_n_rows) || (in_col >= l_n_cols) || (in_slice >= l_n_slices) || ((in_row + s.n_rows) > l_n_rows) || ((in_col + s.n_cols) > l_n_cols) || ((in_slice + s.n_slices) > l_n_slices) )
  1238. {
  1239. return false;
  1240. }
  1241. else
  1242. {
  1243. return true;
  1244. }
  1245. }
  1246. template<typename oT>
  1247. inline
  1248. arma_cold
  1249. bool
  1250. field<oT>::save(const std::string name, const file_type type, const bool print_status) const
  1251. {
  1252. arma_extra_debug_sigprint();
  1253. std::string err_msg;
  1254. const bool save_okay = field_aux::save(*this, name, type, err_msg);
  1255. if( (print_status == true) && (save_okay == false) )
  1256. {
  1257. if(err_msg.length() > 0)
  1258. {
  1259. arma_debug_warn("field::save(): ", err_msg, name);
  1260. }
  1261. else
  1262. {
  1263. arma_debug_warn("field::save(): couldn't write to ", name);
  1264. }
  1265. }
  1266. return save_okay;
  1267. }
  1268. template<typename oT>
  1269. inline
  1270. arma_cold
  1271. bool
  1272. field<oT>::save(std::ostream& os, const file_type type, const bool print_status) const
  1273. {
  1274. arma_extra_debug_sigprint();
  1275. std::string err_msg;
  1276. const bool save_okay = field_aux::save(*this, os, type, err_msg);
  1277. if( (print_status == true) && (save_okay == false) )
  1278. {
  1279. if(err_msg.length() > 0)
  1280. {
  1281. arma_debug_warn("field::save(): ", err_msg, "[ostream]");
  1282. }
  1283. else
  1284. {
  1285. arma_debug_warn("field::save(): couldn't write to [ostream]");
  1286. }
  1287. }
  1288. return save_okay;
  1289. }
  1290. template<typename oT>
  1291. inline
  1292. arma_cold
  1293. bool
  1294. field<oT>::load(const std::string name, const file_type type, const bool print_status)
  1295. {
  1296. arma_extra_debug_sigprint();
  1297. std::string err_msg;
  1298. const bool load_okay = field_aux::load(*this, name, type, err_msg);
  1299. if( (print_status == true) && (load_okay == false) )
  1300. {
  1301. if(err_msg.length() > 0)
  1302. {
  1303. arma_debug_warn("field::load(): ", err_msg, name);
  1304. }
  1305. else
  1306. {
  1307. arma_debug_warn("field::load(): couldn't read from ", name);
  1308. }
  1309. }
  1310. if(load_okay == false)
  1311. {
  1312. (*this).reset();
  1313. }
  1314. return load_okay;
  1315. }
  1316. template<typename oT>
  1317. inline
  1318. arma_cold
  1319. bool
  1320. field<oT>::load(std::istream& is, const file_type type, const bool print_status)
  1321. {
  1322. arma_extra_debug_sigprint();
  1323. std::string err_msg;
  1324. const bool load_okay = field_aux::load(*this, is, type, err_msg);
  1325. if( (print_status == true) && (load_okay == false) )
  1326. {
  1327. if(err_msg.length() > 0)
  1328. {
  1329. arma_debug_warn("field::load(): ", err_msg, "[istream]");
  1330. }
  1331. else
  1332. {
  1333. arma_debug_warn("field::load(): couldn't read from [istream]");
  1334. }
  1335. }
  1336. if(load_okay == false)
  1337. {
  1338. (*this).reset();
  1339. }
  1340. return load_okay;
  1341. }
  1342. template<typename oT>
  1343. inline
  1344. arma_cold
  1345. bool
  1346. field<oT>::quiet_save(const std::string name, const file_type type) const
  1347. {
  1348. arma_extra_debug_sigprint();
  1349. return (*this).save(name, type, false);
  1350. }
  1351. template<typename oT>
  1352. inline
  1353. arma_cold
  1354. bool
  1355. field<oT>::quiet_save(std::ostream& os, const file_type type) const
  1356. {
  1357. arma_extra_debug_sigprint();
  1358. return (*this).save(os, type, false);
  1359. }
  1360. template<typename oT>
  1361. inline
  1362. arma_cold
  1363. bool
  1364. field<oT>::quiet_load(const std::string name, const file_type type)
  1365. {
  1366. arma_extra_debug_sigprint();
  1367. return (*this).load(name, type, false);
  1368. }
  1369. template<typename oT>
  1370. inline
  1371. arma_cold
  1372. bool
  1373. field<oT>::quiet_load(std::istream& is, const file_type type)
  1374. {
  1375. arma_extra_debug_sigprint();
  1376. return (*this).load(is, type, false);
  1377. }
  1378. //! construct a field from a given field
  1379. template<typename oT>
  1380. inline
  1381. void
  1382. field<oT>::init(const field<oT>& x)
  1383. {
  1384. arma_extra_debug_sigprint();
  1385. if(this != &x)
  1386. {
  1387. const uword x_n_rows = x.n_rows;
  1388. const uword x_n_cols = x.n_cols;
  1389. const uword x_n_slices = x.n_slices;
  1390. init(x_n_rows, x_n_cols, x_n_slices);
  1391. field& t = *this;
  1392. if(x_n_slices == 1)
  1393. {
  1394. for(uword ucol=0; ucol < x_n_cols; ++ucol)
  1395. for(uword urow=0; urow < x_n_rows; ++urow)
  1396. {
  1397. t.at(urow,ucol) = x.at(urow,ucol);
  1398. }
  1399. }
  1400. else
  1401. {
  1402. for(uword uslice=0; uslice < x_n_slices; ++uslice)
  1403. for(uword ucol=0; ucol < x_n_cols; ++ucol )
  1404. for(uword urow=0; urow < x_n_rows; ++urow )
  1405. {
  1406. t.at(urow,ucol,uslice) = x.at(urow,ucol,uslice);
  1407. }
  1408. }
  1409. }
  1410. }
  1411. template<typename oT>
  1412. inline
  1413. void
  1414. field<oT>::init(const uword n_rows_in, const uword n_cols_in)
  1415. {
  1416. (*this).init(n_rows_in, n_cols_in, 1);
  1417. }
  1418. template<typename oT>
  1419. inline
  1420. void
  1421. field<oT>::init(const uword n_rows_in, const uword n_cols_in, const uword n_slices_in)
  1422. {
  1423. arma_extra_debug_sigprint( arma_str::format("n_rows_in = %d, n_cols_in = %d, n_slices_in = %d") % n_rows_in % n_cols_in % n_slices_in );
  1424. #if defined(ARMA_64BIT_WORD)
  1425. const char* error_message = "field::init(): requested size is too large";
  1426. #else
  1427. const char* error_message = "field::init(): requested size is too large; suggest to compile in C++11 mode and/or enable ARMA_64BIT_WORD";
  1428. #endif
  1429. arma_debug_check
  1430. (
  1431. (
  1432. ( (n_rows_in > 0x0FFF) || (n_cols_in > 0x0FFF) || (n_slices_in > 0xFF) )
  1433. ? ( (double(n_rows_in) * double(n_cols_in) * double(n_slices_in)) > double(ARMA_MAX_UWORD) )
  1434. : false
  1435. ),
  1436. error_message
  1437. );
  1438. const uword n_elem_new = n_rows_in * n_cols_in * n_slices_in;
  1439. if(n_elem == n_elem_new)
  1440. {
  1441. // delete_objects();
  1442. // create_objects();
  1443. access::rw(n_rows) = n_rows_in;
  1444. access::rw(n_cols) = n_cols_in;
  1445. access::rw(n_slices) = n_slices_in;
  1446. }
  1447. else
  1448. {
  1449. delete_objects();
  1450. if(n_elem > field_prealloc_n_elem::val)
  1451. {
  1452. delete [] mem;
  1453. }
  1454. if(n_elem_new <= field_prealloc_n_elem::val)
  1455. {
  1456. if(n_elem_new == 0)
  1457. {
  1458. mem = NULL;
  1459. }
  1460. else
  1461. {
  1462. mem = mem_local;
  1463. }
  1464. }
  1465. else
  1466. {
  1467. mem = new(std::nothrow) oT* [n_elem_new];
  1468. arma_check_bad_alloc( (mem == 0), "field::init(): out of memory" );
  1469. }
  1470. access::rw(n_rows) = n_rows_in;
  1471. access::rw(n_cols) = n_cols_in;
  1472. access::rw(n_slices) = n_slices_in;
  1473. access::rw(n_elem) = n_elem_new;
  1474. create_objects();
  1475. }
  1476. }
  1477. template<typename oT>
  1478. inline
  1479. void
  1480. field<oT>::delete_objects()
  1481. {
  1482. arma_extra_debug_sigprint( arma_str::format("n_elem = %d") % n_elem );
  1483. for(uword i=0; i<n_elem; ++i)
  1484. {
  1485. if(mem[i] != 0)
  1486. {
  1487. delete mem[i];
  1488. mem[i] = 0;
  1489. }
  1490. }
  1491. }
  1492. template<typename oT>
  1493. inline
  1494. void
  1495. field<oT>::create_objects()
  1496. {
  1497. arma_extra_debug_sigprint( arma_str::format("n_elem = %d") % n_elem );
  1498. for(uword i=0; i<n_elem; ++i)
  1499. {
  1500. mem[i] = new oT;
  1501. }
  1502. }
  1503. template<typename oT>
  1504. inline
  1505. field<oT>::iterator::iterator(field<oT>& in_M, const bool at_end)
  1506. : M(in_M)
  1507. , i( (at_end == false) ? 0 : in_M.n_elem )
  1508. {
  1509. arma_extra_debug_sigprint();
  1510. }
  1511. template<typename oT>
  1512. inline
  1513. oT&
  1514. field<oT>::iterator::operator*()
  1515. {
  1516. return M[i];
  1517. }
  1518. template<typename oT>
  1519. inline
  1520. typename field<oT>::iterator&
  1521. field<oT>::iterator::operator++()
  1522. {
  1523. ++i;
  1524. return *this;
  1525. }
  1526. template<typename oT>
  1527. inline
  1528. void
  1529. field<oT>::iterator::operator++(int)
  1530. {
  1531. operator++();
  1532. }
  1533. template<typename oT>
  1534. inline
  1535. typename field<oT>::iterator&
  1536. field<oT>::iterator::operator--()
  1537. {
  1538. if(i > 0)
  1539. {
  1540. --i;
  1541. }
  1542. return *this;
  1543. }
  1544. template<typename oT>
  1545. inline
  1546. void
  1547. field<oT>::iterator::operator--(int)
  1548. {
  1549. operator--();
  1550. }
  1551. template<typename oT>
  1552. inline
  1553. bool
  1554. field<oT>::iterator::operator!=(const typename field<oT>::iterator& X) const
  1555. {
  1556. return (i != X.i);
  1557. }
  1558. template<typename oT>
  1559. inline
  1560. bool
  1561. field<oT>::iterator::operator==(const typename field<oT>::iterator& X) const
  1562. {
  1563. return (i == X.i);
  1564. }
  1565. template<typename oT>
  1566. inline
  1567. field<oT>::const_iterator::const_iterator(const field<oT>& in_M, const bool at_end)
  1568. : M(in_M)
  1569. , i( (at_end == false) ? 0 : in_M.n_elem )
  1570. {
  1571. arma_extra_debug_sigprint();
  1572. }
  1573. template<typename oT>
  1574. inline
  1575. field<oT>::const_iterator::const_iterator(const typename field<oT>::iterator& X)
  1576. : M(X.M)
  1577. , i(X.i)
  1578. {
  1579. arma_extra_debug_sigprint();
  1580. }
  1581. template<typename oT>
  1582. inline
  1583. const oT&
  1584. field<oT>::const_iterator::operator*() const
  1585. {
  1586. return M[i];
  1587. }
  1588. template<typename oT>
  1589. inline
  1590. typename field<oT>::const_iterator&
  1591. field<oT>::const_iterator::operator++()
  1592. {
  1593. ++i;
  1594. return *this;
  1595. }
  1596. template<typename oT>
  1597. inline
  1598. void
  1599. field<oT>::const_iterator::operator++(int)
  1600. {
  1601. operator++();
  1602. }
  1603. template<typename oT>
  1604. inline
  1605. typename field<oT>::const_iterator&
  1606. field<oT>::const_iterator::operator--()
  1607. {
  1608. if(i > 0)
  1609. {
  1610. --i;
  1611. }
  1612. return *this;
  1613. }
  1614. template<typename oT>
  1615. inline
  1616. void
  1617. field<oT>::const_iterator::operator--(int)
  1618. {
  1619. operator--();
  1620. }
  1621. template<typename oT>
  1622. inline
  1623. bool
  1624. field<oT>::const_iterator::operator!=(const typename field<oT>::const_iterator& X) const
  1625. {
  1626. return (i != X.i);
  1627. }
  1628. template<typename oT>
  1629. inline
  1630. bool
  1631. field<oT>::const_iterator::operator==(const typename field<oT>::const_iterator& X) const
  1632. {
  1633. return (i == X.i);
  1634. }
  1635. template<typename oT>
  1636. inline
  1637. typename field<oT>::iterator
  1638. field<oT>::begin()
  1639. {
  1640. arma_extra_debug_sigprint();
  1641. return field<oT>::iterator(*this);
  1642. }
  1643. template<typename oT>
  1644. inline
  1645. typename field<oT>::const_iterator
  1646. field<oT>::begin() const
  1647. {
  1648. arma_extra_debug_sigprint();
  1649. return field<oT>::const_iterator(*this);
  1650. }
  1651. template<typename oT>
  1652. inline
  1653. typename field<oT>::const_iterator
  1654. field<oT>::cbegin() const
  1655. {
  1656. arma_extra_debug_sigprint();
  1657. return field<oT>::const_iterator(*this);
  1658. }
  1659. template<typename oT>
  1660. inline
  1661. typename field<oT>::iterator
  1662. field<oT>::end()
  1663. {
  1664. arma_extra_debug_sigprint();
  1665. return field<oT>::iterator(*this, true);
  1666. }
  1667. template<typename oT>
  1668. inline
  1669. typename field<oT>::const_iterator
  1670. field<oT>::end() const
  1671. {
  1672. arma_extra_debug_sigprint();
  1673. return field<oT>::const_iterator(*this, true);
  1674. }
  1675. template<typename oT>
  1676. inline
  1677. typename field<oT>::const_iterator
  1678. field<oT>::cend() const
  1679. {
  1680. arma_extra_debug_sigprint();
  1681. return field<oT>::const_iterator(*this, true);
  1682. }
  1683. template<typename oT>
  1684. inline
  1685. void
  1686. field<oT>::clear()
  1687. {
  1688. reset();
  1689. }
  1690. template<typename oT>
  1691. inline
  1692. bool
  1693. field<oT>::empty() const
  1694. {
  1695. return (n_elem == 0);
  1696. }
  1697. template<typename oT>
  1698. inline
  1699. uword
  1700. field<oT>::size() const
  1701. {
  1702. return n_elem;
  1703. }
  1704. //
  1705. //
  1706. //
  1707. template<typename oT>
  1708. inline
  1709. void
  1710. field_aux::reset_objects(field<oT>& x)
  1711. {
  1712. arma_extra_debug_sigprint();
  1713. x.delete_objects();
  1714. x.create_objects();
  1715. }
  1716. template<typename eT>
  1717. inline
  1718. void
  1719. field_aux::reset_objects(field< Mat<eT> >& x)
  1720. {
  1721. arma_extra_debug_sigprint();
  1722. for(uword i=0; i<x.n_elem; ++i)
  1723. {
  1724. (*(x.mem[i])).reset();
  1725. }
  1726. }
  1727. template<typename eT>
  1728. inline
  1729. void
  1730. field_aux::reset_objects(field< Col<eT> >& x)
  1731. {
  1732. arma_extra_debug_sigprint();
  1733. for(uword i=0; i<x.n_elem; ++i)
  1734. {
  1735. (*(x.mem[i])).reset();
  1736. }
  1737. }
  1738. template<typename eT>
  1739. inline
  1740. void
  1741. field_aux::reset_objects(field< Row<eT> >& x)
  1742. {
  1743. arma_extra_debug_sigprint();
  1744. for(uword i=0; i<x.n_elem; ++i)
  1745. {
  1746. (*(x.mem[i])).reset();
  1747. }
  1748. }
  1749. template<typename eT>
  1750. inline
  1751. void
  1752. field_aux::reset_objects(field< Cube<eT> >& x)
  1753. {
  1754. arma_extra_debug_sigprint();
  1755. for(uword i=0; i<x.n_elem; ++i)
  1756. {
  1757. (*(x.mem[i])).reset();
  1758. }
  1759. }
  1760. inline
  1761. void
  1762. field_aux::reset_objects(field< std::string >& x)
  1763. {
  1764. arma_extra_debug_sigprint();
  1765. for(uword i=0; i<x.n_elem; ++i)
  1766. {
  1767. (*(x.mem[i])).clear();
  1768. }
  1769. }
  1770. //
  1771. //
  1772. //
  1773. template<typename oT>
  1774. inline
  1775. bool
  1776. field_aux::save(const field<oT>&, const std::string&, const file_type, std::string& err_msg)
  1777. {
  1778. arma_extra_debug_sigprint();
  1779. err_msg = " [saving/loading this type of field is currently not supported] filename = ";
  1780. return false;
  1781. }
  1782. template<typename oT>
  1783. inline
  1784. bool
  1785. field_aux::save(const field<oT>&, std::ostream&, const file_type, std::string& err_msg)
  1786. {
  1787. arma_extra_debug_sigprint();
  1788. err_msg = " [saving/loading this type of field is currently not supported] filename = ";
  1789. return false;
  1790. }
  1791. template<typename oT>
  1792. inline
  1793. bool
  1794. field_aux::load(field<oT>&, const std::string&, const file_type, std::string& err_msg)
  1795. {
  1796. arma_extra_debug_sigprint();
  1797. err_msg = " [saving/loading this type of field is currently not supported] filename = ";
  1798. return false;
  1799. }
  1800. template<typename oT>
  1801. inline
  1802. bool
  1803. field_aux::load(field<oT>&, std::istream&, const file_type, std::string& err_msg)
  1804. {
  1805. arma_extra_debug_sigprint();
  1806. err_msg = " [saving/loading this type of field is currently not supported] filename = ";
  1807. return false;
  1808. }
  1809. template<typename eT>
  1810. inline
  1811. bool
  1812. field_aux::save(const field< Mat<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  1813. {
  1814. arma_extra_debug_sigprint();
  1815. switch(type)
  1816. {
  1817. case arma_binary:
  1818. return diskio::save_arma_binary(x, name);
  1819. break;
  1820. case ppm_binary:
  1821. return diskio::save_ppm_binary(x, name);
  1822. break;
  1823. default:
  1824. err_msg = " [unsupported type] filename = ";
  1825. return false;
  1826. }
  1827. }
  1828. template<typename eT>
  1829. inline
  1830. bool
  1831. field_aux::save(const field< Mat<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg)
  1832. {
  1833. arma_extra_debug_sigprint();
  1834. switch(type)
  1835. {
  1836. case arma_binary:
  1837. return diskio::save_arma_binary(x, os);
  1838. break;
  1839. case ppm_binary:
  1840. return diskio::save_ppm_binary(x, os);
  1841. break;
  1842. default:
  1843. err_msg = " [unsupported type] filename = ";
  1844. return false;
  1845. }
  1846. }
  1847. template<typename eT>
  1848. inline
  1849. bool
  1850. field_aux::load(field< Mat<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  1851. {
  1852. arma_extra_debug_sigprint();
  1853. switch(type)
  1854. {
  1855. case auto_detect:
  1856. return diskio::load_auto_detect(x, name, err_msg);
  1857. break;
  1858. case arma_binary:
  1859. return diskio::load_arma_binary(x, name, err_msg);
  1860. break;
  1861. case ppm_binary:
  1862. return diskio::load_ppm_binary(x, name, err_msg);
  1863. break;
  1864. default:
  1865. err_msg = " [unsupported type] filename = ";
  1866. return false;
  1867. }
  1868. }
  1869. template<typename eT>
  1870. inline
  1871. bool
  1872. field_aux::load(field< Mat<eT> >& x, std::istream& is, const file_type type, std::string& err_msg)
  1873. {
  1874. arma_extra_debug_sigprint();
  1875. switch(type)
  1876. {
  1877. case auto_detect:
  1878. return diskio::load_auto_detect(x, is, err_msg);
  1879. break;
  1880. case arma_binary:
  1881. return diskio::load_arma_binary(x, is, err_msg);
  1882. break;
  1883. case ppm_binary:
  1884. return diskio::load_ppm_binary(x, is, err_msg);
  1885. break;
  1886. default:
  1887. err_msg = " [unsupported type] filename = ";
  1888. return false;
  1889. }
  1890. }
  1891. template<typename eT>
  1892. inline
  1893. bool
  1894. field_aux::save(const field< Col<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  1895. {
  1896. arma_extra_debug_sigprint();
  1897. switch(type)
  1898. {
  1899. case arma_binary:
  1900. return diskio::save_arma_binary(x, name);
  1901. break;
  1902. case ppm_binary:
  1903. return diskio::save_ppm_binary(x, name);
  1904. break;
  1905. default:
  1906. err_msg = " [unsupported type] filename = ";
  1907. return false;
  1908. }
  1909. }
  1910. template<typename eT>
  1911. inline
  1912. bool
  1913. field_aux::save(const field< Col<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg)
  1914. {
  1915. arma_extra_debug_sigprint();
  1916. switch(type)
  1917. {
  1918. case arma_binary:
  1919. return diskio::save_arma_binary(x, os);
  1920. break;
  1921. case ppm_binary:
  1922. return diskio::save_ppm_binary(x, os);
  1923. break;
  1924. default:
  1925. err_msg = " [unsupported type] filename = ";
  1926. return false;
  1927. }
  1928. }
  1929. template<typename eT>
  1930. inline
  1931. bool
  1932. field_aux::load(field< Col<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  1933. {
  1934. arma_extra_debug_sigprint();
  1935. switch(type)
  1936. {
  1937. case auto_detect:
  1938. return diskio::load_auto_detect(x, name, err_msg);
  1939. break;
  1940. case arma_binary:
  1941. return diskio::load_arma_binary(x, name, err_msg);
  1942. break;
  1943. case ppm_binary:
  1944. return diskio::load_ppm_binary(x, name, err_msg);
  1945. break;
  1946. default:
  1947. err_msg = " [unsupported type] filename = ";
  1948. return false;
  1949. }
  1950. }
  1951. template<typename eT>
  1952. inline
  1953. bool
  1954. field_aux::load(field< Col<eT> >& x, std::istream& is, const file_type type, std::string& err_msg)
  1955. {
  1956. arma_extra_debug_sigprint();
  1957. switch(type)
  1958. {
  1959. case auto_detect:
  1960. return diskio::load_auto_detect(x, is, err_msg);
  1961. break;
  1962. case arma_binary:
  1963. return diskio::load_arma_binary(x, is, err_msg);
  1964. break;
  1965. case ppm_binary:
  1966. return diskio::load_ppm_binary(x, is, err_msg);
  1967. break;
  1968. default:
  1969. err_msg = " [unsupported type] filename = ";
  1970. return false;
  1971. }
  1972. }
  1973. template<typename eT>
  1974. inline
  1975. bool
  1976. field_aux::save(const field< Row<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  1977. {
  1978. arma_extra_debug_sigprint();
  1979. switch(type)
  1980. {
  1981. case arma_binary:
  1982. return diskio::save_arma_binary(x, name);
  1983. break;
  1984. case ppm_binary:
  1985. return diskio::save_ppm_binary(x, name);
  1986. break;
  1987. default:
  1988. err_msg = " [unsupported type] filename = ";
  1989. return false;
  1990. }
  1991. }
  1992. template<typename eT>
  1993. inline
  1994. bool
  1995. field_aux::save(const field< Row<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg)
  1996. {
  1997. arma_extra_debug_sigprint();
  1998. switch(type)
  1999. {
  2000. case arma_binary:
  2001. return diskio::save_arma_binary(x, os);
  2002. break;
  2003. case ppm_binary:
  2004. return diskio::save_ppm_binary(x, os);
  2005. break;
  2006. default:
  2007. err_msg = " [unsupported type] filename = ";
  2008. return false;
  2009. }
  2010. }
  2011. template<typename eT>
  2012. inline
  2013. bool
  2014. field_aux::load(field< Row<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  2015. {
  2016. arma_extra_debug_sigprint();
  2017. switch(type)
  2018. {
  2019. case auto_detect:
  2020. return diskio::load_auto_detect(x, name, err_msg);
  2021. break;
  2022. case arma_binary:
  2023. return diskio::load_arma_binary(x, name, err_msg);
  2024. break;
  2025. case ppm_binary:
  2026. return diskio::load_ppm_binary(x, name, err_msg);
  2027. break;
  2028. default:
  2029. err_msg = " [unsupported type] filename = ";
  2030. return false;
  2031. }
  2032. }
  2033. template<typename eT>
  2034. inline
  2035. bool
  2036. field_aux::load(field< Row<eT> >& x, std::istream& is, const file_type type, std::string& err_msg)
  2037. {
  2038. arma_extra_debug_sigprint();
  2039. switch(type)
  2040. {
  2041. case auto_detect:
  2042. return diskio::load_auto_detect(x, is, err_msg);
  2043. break;
  2044. case arma_binary:
  2045. return diskio::load_arma_binary(x, is, err_msg);
  2046. break;
  2047. case ppm_binary:
  2048. return diskio::load_ppm_binary(x, is, err_msg);
  2049. break;
  2050. default:
  2051. err_msg = " [unsupported type] filename = ";
  2052. return false;
  2053. }
  2054. }
  2055. template<typename eT>
  2056. inline
  2057. bool
  2058. field_aux::save(const field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  2059. {
  2060. arma_extra_debug_sigprint();
  2061. switch(type)
  2062. {
  2063. case arma_binary:
  2064. return diskio::save_arma_binary(x, name);
  2065. break;
  2066. default:
  2067. err_msg = " [unsupported type] filename = ";
  2068. return false;
  2069. }
  2070. }
  2071. template<typename eT>
  2072. inline
  2073. bool
  2074. field_aux::save(const field< Cube<eT> >& x, std::ostream& os, const file_type type, std::string& err_msg)
  2075. {
  2076. arma_extra_debug_sigprint();
  2077. switch(type)
  2078. {
  2079. case arma_binary:
  2080. return diskio::save_arma_binary(x, os);
  2081. break;
  2082. default:
  2083. err_msg = " [unsupported type] filename = ";
  2084. return false;
  2085. }
  2086. }
  2087. template<typename eT>
  2088. inline
  2089. bool
  2090. field_aux::load(field< Cube<eT> >& x, const std::string& name, const file_type type, std::string& err_msg)
  2091. {
  2092. arma_extra_debug_sigprint();
  2093. switch(type)
  2094. {
  2095. case auto_detect:
  2096. case arma_binary:
  2097. return diskio::load_arma_binary(x, name, err_msg);
  2098. break;
  2099. default:
  2100. err_msg = " [unsupported type] filename = ";
  2101. return false;
  2102. }
  2103. }
  2104. template<typename eT>
  2105. inline
  2106. bool
  2107. field_aux::load(field< Cube<eT> >& x, std::istream& is, const file_type type, std::string& err_msg)
  2108. {
  2109. arma_extra_debug_sigprint();
  2110. switch(type)
  2111. {
  2112. case auto_detect:
  2113. case arma_binary:
  2114. return diskio::load_arma_binary(x, is, err_msg);
  2115. break;
  2116. default:
  2117. err_msg = " [unsupported type] filename = ";
  2118. return false;
  2119. }
  2120. }
  2121. inline
  2122. bool
  2123. field_aux::save(const field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg)
  2124. {
  2125. arma_extra_debug_sigprint();
  2126. arma_ignore(type);
  2127. err_msg.clear();
  2128. return diskio::save_std_string(x, name);
  2129. }
  2130. inline
  2131. bool
  2132. field_aux::save(const field< std::string >& x, std::ostream& os, const file_type type, std::string& err_msg)
  2133. {
  2134. arma_extra_debug_sigprint();
  2135. arma_ignore(type);
  2136. err_msg.clear();
  2137. return diskio::save_std_string(x, os);
  2138. }
  2139. inline
  2140. bool
  2141. field_aux::load(field< std::string >& x, const std::string& name, const file_type type, std::string& err_msg)
  2142. {
  2143. arma_extra_debug_sigprint();
  2144. arma_ignore(type);
  2145. return diskio::load_std_string(x, name, err_msg);
  2146. }
  2147. inline
  2148. bool
  2149. field_aux::load(field< std::string >& x, std::istream& is, const file_type type, std::string& err_msg)
  2150. {
  2151. arma_extra_debug_sigprint();
  2152. arma_ignore(type);
  2153. return diskio::load_std_string(x, is, err_msg);
  2154. }
  2155. #ifdef ARMA_EXTRA_FIELD_MEAT
  2156. #include ARMA_INCFILE_WRAP(ARMA_EXTRA_FIELD_MEAT)
  2157. #endif
  2158. //! @}