MathNet.Numerics.Data.Matlab.xml 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>MathNet.Numerics.Data.Matlab</name>
  5. </assembly>
  6. <members>
  7. <member name="M:MathNet.Numerics.Data.Matlab.Adler32.Compute(System.Byte[])">
  8. <summary>
  9. Computes the Adler-32 checksum of the given data.
  10. </summary>
  11. <param name="data">The data to create the checksum.</param>
  12. <returns>The checksum</returns>
  13. </member>
  14. <member name="T:MathNet.Numerics.Data.Matlab.ArrayClass">
  15. <summary>
  16. Enumeration for the MATLAB array types
  17. </summary>
  18. </member>
  19. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Unknown">
  20. <summary>
  21. mxUNKNOWN CLASS
  22. </summary>
  23. </member>
  24. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Cell">
  25. <summary>
  26. mxCELL CLASS
  27. </summary>
  28. </member>
  29. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Structure">
  30. <summary>
  31. mxSTRUCT CLASS
  32. </summary>
  33. </member>
  34. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Object">
  35. <summary>
  36. mxOBJECT CLASS
  37. </summary>
  38. </member>
  39. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Character">
  40. <summary>
  41. mxCHAR CLASS
  42. </summary>
  43. </member>
  44. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Sparse">
  45. <summary>
  46. mxSPARSE CLASS
  47. </summary>
  48. </member>
  49. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Double">
  50. <summary>
  51. mxDOUBLE CLASS
  52. </summary>
  53. </member>
  54. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Single">
  55. <summary>
  56. mxSINGLE CLASS
  57. </summary>
  58. </member>
  59. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Int8">
  60. <summary>
  61. mxINT8 CLASS
  62. </summary>
  63. </member>
  64. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.UInt8">
  65. <summary>
  66. mxUINT8 CLASS
  67. </summary>
  68. </member>
  69. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Int16">
  70. <summary>
  71. mxINT16 CLASS
  72. </summary>
  73. </member>
  74. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.UInt16">
  75. <summary>
  76. mxUINT16 CLASS
  77. </summary>
  78. </member>
  79. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Int32">
  80. <summary>
  81. mxINT32 CLASS
  82. </summary>
  83. </member>
  84. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.UInt32">
  85. <summary>
  86. mxUINT32 CLASS
  87. </summary>
  88. </member>
  89. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Int64">
  90. <summary>
  91. mxINT64 CLASS
  92. </summary>
  93. </member>
  94. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.UInt64">
  95. <summary>
  96. mxUINT64 CLASS
  97. </summary>
  98. </member>
  99. <member name="F:MathNet.Numerics.Data.Matlab.ArrayClass.Function">
  100. <summary>
  101. mxFUNCTION CLASS
  102. </summary>
  103. </member>
  104. <member name="T:MathNet.Numerics.Data.Matlab.ArrayFlags">
  105. <summary>
  106. MATLAB Array Flags
  107. </summary>
  108. </member>
  109. <member name="F:MathNet.Numerics.Data.Matlab.ArrayFlags.Complex">
  110. <summary>
  111. Complex flag
  112. </summary>
  113. </member>
  114. <member name="F:MathNet.Numerics.Data.Matlab.ArrayFlags.Global">
  115. <summary>
  116. Global flag
  117. </summary>
  118. </member>
  119. <member name="F:MathNet.Numerics.Data.Matlab.ArrayFlags.Logical">
  120. <summary>
  121. Logical flag
  122. </summary>
  123. </member>
  124. <member name="T:MathNet.Numerics.Data.Matlab.DataType">
  125. <summary>
  126. MATLAB data types
  127. </summary>
  128. </member>
  129. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Unknown">
  130. <summary>
  131. Unkown type
  132. </summary>
  133. </member>
  134. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Int8">
  135. <summary>
  136. miINT8 type
  137. </summary>
  138. </member>
  139. <member name="F:MathNet.Numerics.Data.Matlab.DataType.UInt8">
  140. <summary>
  141. miUINT8 type
  142. </summary>
  143. </member>
  144. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Int16">
  145. <summary>
  146. miINT16 type
  147. </summary>
  148. </member>
  149. <member name="F:MathNet.Numerics.Data.Matlab.DataType.UInt16">
  150. <summary>
  151. miUINT16 type
  152. </summary>
  153. </member>
  154. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Int32">
  155. <summary>
  156. miINT32 type
  157. </summary>
  158. </member>
  159. <member name="F:MathNet.Numerics.Data.Matlab.DataType.UInt32">
  160. <summary>
  161. miUINT32 type
  162. </summary>
  163. </member>
  164. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Single">
  165. <summary>
  166. miSINGLE type
  167. </summary>
  168. </member>
  169. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Double">
  170. <summary>
  171. miDOUBLE type
  172. </summary>
  173. </member>
  174. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Int64">
  175. <summary>
  176. miINT64 type
  177. </summary>
  178. </member>
  179. <member name="F:MathNet.Numerics.Data.Matlab.DataType.UInt64">
  180. <summary>
  181. miUINT6 4type
  182. </summary>
  183. </member>
  184. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Matrix">
  185. <summary>
  186. miMATRIX type
  187. </summary>
  188. </member>
  189. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Compressed">
  190. <summary>
  191. miCOMPRESSED type
  192. </summary>
  193. </member>
  194. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Utf8">
  195. <summary>
  196. miUTF8 type
  197. </summary>
  198. </member>
  199. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Utf16">
  200. <summary>
  201. miUTF16 type
  202. </summary>
  203. </member>
  204. <member name="F:MathNet.Numerics.Data.Matlab.DataType.Utf32">
  205. <summary>
  206. miUTF32 type
  207. </summary>
  208. </member>
  209. <member name="T:MathNet.Numerics.Data.Matlab.Formatter">
  210. <summary>
  211. Format a MATLAB file.
  212. </summary>
  213. </member>
  214. <member name="F:MathNet.Numerics.Data.Matlab.Formatter.HeaderText">
  215. <summary>
  216. The file header value
  217. </summary>
  218. </member>
  219. <member name="F:MathNet.Numerics.Data.Matlab.Formatter.SmallBlockSize">
  220. <summary>
  221. Small Block Size
  222. </summary>
  223. </member>
  224. <member name="F:MathNet.Numerics.Data.Matlab.Formatter.LargeBlockSize">
  225. <summary>
  226. Large Block Size
  227. </summary>
  228. </member>
  229. <member name="M:MathNet.Numerics.Data.Matlab.Formatter.FormatFile(System.IO.Stream,System.Collections.Generic.IEnumerable{MathNet.Numerics.Data.Matlab.MatlabMatrix})">
  230. <summary>
  231. Writes all matrix blocks to a stream.
  232. </summary>
  233. </member>
  234. <member name="M:MathNet.Numerics.Data.Matlab.Formatter.FormatMatrix``1(MathNet.Numerics.LinearAlgebra.Matrix{``0},System.String)">
  235. <summary>
  236. Format a matrix block byte array
  237. </summary>
  238. </member>
  239. <member name="M:MathNet.Numerics.Data.Matlab.Formatter.PackCompressedBlock(System.Byte[],MathNet.Numerics.Data.Matlab.DataType)">
  240. <summary>
  241. Packs a compressed block
  242. </summary>
  243. </member>
  244. <member name="T:MathNet.Numerics.Data.Matlab.MatlabMatrix">
  245. <summary>
  246. MATLAB Matrix Data Element
  247. </summary>
  248. </member>
  249. <member name="P:MathNet.Numerics.Data.Matlab.MatlabMatrix.Data">
  250. <summary>Sub-elements of the matrix data element (not including the data element tag)</summary>
  251. </member>
  252. <member name="P:MathNet.Numerics.Data.Matlab.MatlabMatrix.Name">
  253. <summary>Name of the matrix</summary>
  254. </member>
  255. <member name="P:MathNet.Numerics.Data.Matlab.MatlabMatrix.ByteSize">
  256. <summary>Size of the matrix in bytes</summary>
  257. </member>
  258. <member name="T:MathNet.Numerics.Data.Matlab.MatlabReader">
  259. <summary>
  260. Creates matrices from MATLAB Level-5 Mat files.
  261. </summary>
  262. </member>
  263. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.List(System.IO.Stream)">
  264. <summary>
  265. List all compatible matrices from a MATLAB file stream.
  266. </summary>
  267. </member>
  268. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.List(System.String)">
  269. <summary>
  270. List all compatible matrices from a MATLAB file.
  271. </summary>
  272. </member>
  273. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.Unpack``1(MathNet.Numerics.Data.Matlab.MatlabMatrix)">
  274. <summary>
  275. Unpacks the matrix of a MATLAB matrix data object.
  276. </summary>
  277. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  278. </member>
  279. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.Read``1(System.IO.Stream,System.String)">
  280. <summary>
  281. Read the first or a specific matrix from a MATLAB file stream.
  282. </summary>
  283. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  284. </member>
  285. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.Read``1(System.String,System.String)">
  286. <summary>
  287. Read the first or a specific matrix from a MATLAB file.
  288. </summary>
  289. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  290. </member>
  291. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.ReadAll``1(System.IO.Stream,System.String[])">
  292. <summary>
  293. Read all matrices or those with matching name from a MATLAB file stream.
  294. </summary>
  295. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  296. </member>
  297. <member name="M:MathNet.Numerics.Data.Matlab.MatlabReader.ReadAll``1(System.String,System.String[])">
  298. <summary>
  299. Read all matrices or those with matching name from a MATLAB file.
  300. </summary>
  301. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  302. </member>
  303. <member name="T:MathNet.Numerics.Data.Matlab.MatlabWriter">
  304. <summary>
  305. Writes matrices to a MATLAB Level-5 Mat file.
  306. </summary>
  307. </member>
  308. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Pack``1(MathNet.Numerics.LinearAlgebra.Matrix{``0},System.String)">
  309. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  310. </member>
  311. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.IO.Stream,MathNet.Numerics.LinearAlgebra.Matrix{``0},System.String)">
  312. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  313. </member>
  314. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.String,MathNet.Numerics.LinearAlgebra.Matrix{``0},System.String)">
  315. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  316. </member>
  317. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.IO.Stream,System.Collections.Generic.IList{MathNet.Numerics.LinearAlgebra.Matrix{``0}},System.Collections.Generic.IList{System.String})">
  318. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  319. </member>
  320. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.String,System.Collections.Generic.IList{MathNet.Numerics.LinearAlgebra.Matrix{``0}},System.Collections.Generic.IList{System.String})">
  321. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  322. </member>
  323. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.IO.Stream,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,MathNet.Numerics.LinearAlgebra.Matrix{``0}}})">
  324. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  325. </member>
  326. <member name="M:MathNet.Numerics.Data.Matlab.MatlabWriter.Write``1(System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,MathNet.Numerics.LinearAlgebra.Matrix{``0}}})">
  327. <typeparam name="T">The data type of the Matrix. It can be either: double, float, Complex, or Complex32.</typeparam>
  328. </member>
  329. <member name="T:MathNet.Numerics.Data.Matlab.Parser">
  330. <summary>
  331. Parse a MATLAB file
  332. </summary>
  333. </member>
  334. <member name="F:MathNet.Numerics.Data.Matlab.Parser.LittleEndianIndicator">
  335. <summary>
  336. Little Endian Indicator
  337. </summary>
  338. </member>
  339. <member name="F:MathNet.Numerics.Data.Matlab.Parser.SmallBlockSize">
  340. <summary>
  341. Small Block Size
  342. </summary>
  343. </member>
  344. <member name="F:MathNet.Numerics.Data.Matlab.Parser.LargeBlockSize">
  345. <summary>
  346. Large Block Size
  347. </summary>
  348. </member>
  349. <member name="M:MathNet.Numerics.Data.Matlab.Parser.ParseFile(System.IO.Stream)">
  350. <summary>
  351. Extracts all matrix blocks in a format we support from a stream.
  352. </summary>
  353. </member>
  354. <member name="M:MathNet.Numerics.Data.Matlab.Parser.ParseMatrix``1(System.Byte[])">
  355. <summary>
  356. Parse a matrix block byte array
  357. </summary>
  358. </member>
  359. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateDenseMatrix``1(System.IO.BinaryReader,System.Boolean,System.Int32,System.Int32)">
  360. <summary>
  361. Populates a dense matrix.
  362. </summary>
  363. <param name="reader">The reader to read from.</param>
  364. <param name="complex">if set to <c>true</c> if the MATLAB complex flag is set.</param>
  365. <param name="rows">The number of rows.</param>
  366. <param name="columns">The number of columns.</param>
  367. <returns>Returns a populated dense matrix.</returns>
  368. </member>
  369. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateSparseMatrix``1(System.IO.BinaryReader,System.Boolean,System.Int32,System.Int32)">
  370. <summary>
  371. Populates a sparse matrix.
  372. </summary>
  373. <param name="reader">The reader.</param>
  374. <param name="complex">if set to <c>true</c> if the MATLAB complex flag is set.</param>
  375. <param name="rows">The number of rows.</param>
  376. <param name="columns">The number of columns.</param>
  377. <returns>A populated sparse matrix.</returns>
  378. </member>
  379. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateDoubleArray(System.IO.BinaryReader,System.Double[],MathNet.Numerics.Data.Matlab.DataType)">
  380. <summary>
  381. Populates the double dense matrix.
  382. </summary>
  383. </member>
  384. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateSingleArray(System.IO.BinaryReader,System.Single[],MathNet.Numerics.Data.Matlab.DataType)">
  385. <summary>
  386. Populates the float dense matrix.
  387. </summary>
  388. </member>
  389. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateComplexArray(System.IO.BinaryReader,System.Numerics.Complex[],System.Boolean,MathNet.Numerics.Data.Matlab.DataType,System.Int32@,System.Boolean@)">
  390. <summary>
  391. Populates the complex dense matrix.
  392. </summary>
  393. </member>
  394. <member name="M:MathNet.Numerics.Data.Matlab.Parser.PopulateComplex32Array(System.IO.BinaryReader,MathNet.Numerics.Complex32[],System.Boolean,MathNet.Numerics.Data.Matlab.DataType,System.Int32@,System.Boolean@)">
  395. <summary>
  396. Populates the complex32 dense matrix.
  397. </summary>
  398. </member>
  399. <member name="M:MathNet.Numerics.Data.Matlab.Parser.UnpackCompressedBlock(System.Byte[],MathNet.Numerics.Data.Matlab.DataType@)">
  400. <summary>
  401. Unpacks a compressed block.
  402. </summary>
  403. <param name="compressed">The compressed data.</param>
  404. <param name="type">The type data type contained in the block.</param>
  405. <returns>The decompressed block.</returns>
  406. </member>
  407. </members>
  408. </doc>