fnindex.txt 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. FUNCTION INDEX
  2. ==============
  3. In the descriptions below, matrices are represented by capital letters,
  4. vectors by lower case letters and scalars by alpha.
  5. Function Description
  6. band2mat() Convert band matrix to dense matrix
  7. bd_free() Deallocate (destroy) band matrix
  8. bd_get() Allocate and initialise band matrix
  9. bd_transp() Transpose band matrix
  10. bd_resize() Resize band matrix
  11. bdLDLfactor() Band LDL^T factorisation
  12. bdLDLsolve() Solve Ax=b using band LDL^T factors
  13. bdLUfactor() Band LU factorisation
  14. bdLUsolve() Solve Ax=b using band LU factors
  15. bisvd() SVD of bi-diagonal matrix
  16. BKPfactor() Bunch-Kaufman-Parlett factorisation
  17. BKPsolve() Bunch-Kaufman-Parlett solver
  18. catch() Catch a raised error (macro)
  19. catchall() Catch any raised error (macro)
  20. catch_FPE() Catch floating point error (sets flag)
  21. CHfactor() Dense Cholesky factorisation
  22. CHsolve() Cholesky solver
  23. d_save() Save real in MATLAB format
  24. Dsolve() Solve Dx=y , D diagonal
  25. ERRABORT() Abort on error (sets flag, macro)
  26. ERREXIT() Exit on error (sets flag, macro)
  27. error() Raise an error (macro, see ev_err())
  28. err_list_attach() Attach new list of errors
  29. err_list_free() Discard list of errors
  30. err_is_list_attached() Checks for an error list
  31. ev_err() Raise an error (function)
  32. fft() Computes Fast Fourier Transform
  33. finput() Input a simple data item from a stream
  34. fprompter() Print prompt to stderr
  35. get_col() Extract a column from a matrix
  36. get_row() Extract a row from a matrix
  37. givens() Compute Givens parameters
  38. hhtrcols() Compute AP^T where P is a Householder matrix
  39. hhtrrows() Compute PA where P is a Householder matrix
  40. hhtrvec() Compute Px where P is a Householder matrix
  41. hhvec() Compute parameters for a Householder matrix
  42. ifft() Computes inverse FFT
  43. in_prod() Inner product of vectors
  44. input() Input a simple data item from stdin (macro)
  45. iter_arnoldi() Arnoldi iterative method
  46. iter_arnoldi_iref() Arnoldi iterative method with refinement
  47. iter_ATx() Set A^T in ITER structure
  48. iter_Ax() Set A in ITER structure
  49. iter_Bx() Set preconditioner in ITER structure
  50. iter_cg() Conjugate gradients iterative method
  51. iter_cgne() Conjugate gradients for normal equations
  52. iter_cgs() CGS iterative method
  53. iter_copy() Copy ITER data structures
  54. iter_copy2() Shallow copy of ITER data structures
  55. iter_dump() Dump ITER data structure to a stream
  56. iter_free() Free (deallocate) ITER structure
  57. iter_get() Allocate ITER structure
  58. iter_gmres() GMRES iterative method
  59. iter_lanczos() Lanczos iterative method
  60. iter_lanczos2() Lanczos method with Cullum and Willoughby extensions
  61. iter_lsqr() LSQR iterative method
  62. iter_mgcr() MGCR iterative method
  63. iter_resize() Resize vectors in an ITER data structure
  64. iter_spcg() Sparse matrix CG method
  65. iter_spcgne() Sparse matrix CG method for normal equations
  66. iter_spcgs() Sparse matrix CGS method
  67. iter_spgmres() Sparse matrix GMRES method
  68. iter_splsqr() Sparse matrix LSQR method
  69. iter_spmgcr() Sparse matrix MGCR method
  70. iv_add() Add integer vectors
  71. iv_copy() Copy integer vector
  72. iv_dump() Dump integer vector to a stream
  73. iv_finput() Input integer vector from a stream
  74. iv_foutput() Output integer vector to a stream
  75. IV_FREE() Free (deallocate) an integer vector (macro)
  76. iv_free() Free (deallocate) integer vector (function)
  77. iv_free_vars() Free a list of integer vectors
  78. iv_get() Allocate and initialise an integer vector
  79. iv_get_vars() Allocate list of integer vectors
  80. iv_input() Input integer vector from stdin (macro)
  81. iv_output() Output integer vector to stdout (macro)
  82. iv_resize() Resize an integer vector
  83. iv_resize_vars() Resize a list of integer vectors
  84. iv_sub() Subtract integer vectors
  85. LDLfactor() LDL^T factorisation
  86. LDLsolve() LDL^T solver
  87. LDLupdate() Update LDL^T factorisation
  88. Lsolve() Solve Lx=y , L lower triangular
  89. LTsolve() Solve L^Tx=y , L lower triangular
  90. LUcondest() Estimate a condition number using LU factors
  91. LUfactor() Compute LU factors with implicit scaled partial pivoting
  92. LUsolve() Solve Ax=b using LU factors
  93. LUTsolve() Solve A^Tx=b usng LU factors
  94. m_add() Add matrices
  95. makeQ() Form Q matrix for QR factorisation
  96. makeR() Form R matrix for QR factorisation
  97. mat2band() Extract band matrix from dense matrix
  98. MCHfactor() Modified Cholesky factorisation
  99. (actually factors A+D, D diagonal, instead of A)
  100. m_copy() Copy dense matrix
  101. m_dump() Dump matrix data structure to a stream
  102. mem_attach_list() Adds a new family of types
  103. mem_bytes() Notify change in memory usage (macro)
  104. mem_bytes_list() Notify change in memory usage
  105. mem_free_list() Frees a family of types
  106. mem_info_bytes() Number of bytes used by a type
  107. mem_info_numvar() Number of structures of a type
  108. mem_info_file() Print memory info to a stream
  109. mem_info_is_on() Is memory data being accumulated?
  110. mem_info_on() Turns memory info system on/off
  111. mem_is_list_attached() Is list of types attached?
  112. mem_numvar() Notify change in number of structures allocated (macro)
  113. mem_numvar_list() Notify change in number of structures allocated
  114. mem_stat_dump() Prints information on registered workspace
  115. mem_stat_free() Frees (deallocates) static workspace
  116. mem_stat_mark() Sets mark for workspace
  117. MEM_STAT_REG() Register static workspace (macro)
  118. mem_stat_show_mark() Current workspace group
  119. m_exp() Computes matrix exponential
  120. m_finput() Input matrix from a stream
  121. m_foutput() Output matrix to a stream
  122. M_FREE() Free (deallocate) a matrix (macro)
  123. m_free() Free (deallocate) matrix (function)
  124. m_free_vars() Free a list of matrices
  125. m_get() Allocate and initialise a matrix
  126. m_get_vars() Allocate list of matrices
  127. m_ident() Sets matrix to identity matrix
  128. m_input() Input matrix from stdin (macro)
  129. m_inverse() Invert matrix
  130. m_load() Load matrix in MATLAB format
  131. m_mlt() Multiplies matrices
  132. mmtr_mlt() Computes AB^T
  133. m_norm1() Computes ||A||_1 of a matrix
  134. m_norm_frob() Computes the Frobenius norm of a matrix
  135. m_norm_inf() Computes ||A||_inf of a matrix
  136. m_ones() Set matrix to all 1's
  137. m_output() Output matrix to stdout (macro)
  138. m_poly() Computes a matrix polynomial
  139. m_pow() Computes integer power of a matrix
  140. mrand() Generates pseudo-random real number
  141. m_rand() Randomise entries of a matrix
  142. mrandlist() Generates array of pseudo-random numbers
  143. m_resize() Resize matrix
  144. m_resize_vars() Resize a list of matrices
  145. m_save() Save matrix in MATLAB format
  146. m_sub() Subtract matrices
  147. m_transp() Transpose matrix
  148. mtrm_mlt() Computes A^TB
  149. mv_mlt() Computes Ax
  150. mv_mltadd() Computes y <- Ax+y
  151. m_zero() Zero a matrix
  152. ON_ERROR() Error handler (macro)
  153. prompter() Print prompt message to stdout
  154. px_cols() Permute the columns of a matrix
  155. px_copy() Copy permutation
  156. px_dump() Dump permutation data structure to a stream
  157. px_finput() Input permutation from a stream
  158. px_foutput() Output permutation to a stream
  159. PX_FREE() Free (deallocate) a permutation (macro)
  160. px_free() Free (deallocate) permutation (function)
  161. px_free_vars() Free a list of permutations
  162. px_get() Allocate and initialise a permutation
  163. px_get_vars() Allocate a list of permutations
  164. px_ident() Sets permutation to identity
  165. px_input() Input permutation from stdin (macro)
  166. px_inv() Invert permutation
  167. pxinv_vec() Computes P^Tx where P is a permutation matrix
  168. pxinv_zvec() Computes P^Tx where P is a permutation matrix (complex)
  169. px_mlt() Multiply permutations
  170. px_output() Output permutation to stdout (macro)
  171. px_resize() Resize a permutation
  172. px_resize_vars() Resize a list of permutations
  173. px_rows() Permute the rows of a matrix
  174. px_sign() Returns the sign of the permutation
  175. px_transp() Transpose a pair of entries
  176. px_vec() Computes Px where P is a permutation matrix
  177. px_zvec() Computes Px where P is a permutation matrix (complex)
  178. QRCPfactor() QR factorisation with column pivoting
  179. QRfactor() QR factorisation
  180. QRsolve() Solve Ax=b using QR factorisation
  181. QRTsolve() Solve A^Tx=b using QR factorisation
  182. QRupdate() Update explicit QR factors
  183. rot_cols() Apply Givens rotation to the columns of a matrix
  184. rot_rows() Apply Givens rotation to the rows of a matrix
  185. rot_vec() Apply Givens rotation to a vector
  186. rot_zvec() Apply complex Givens rotation to a vector
  187. schur() Compute real Schur form
  188. schur_evals() Compute eigenvalues from the real Schur form
  189. schur_vecs() Compute eigenvectors from the real Schur form
  190. set_col() Set the column of a matrix to a given vector
  191. set_err_flag() Control behaviour of ev_err()
  192. set_row() Set the row of a matrix to a given vector
  193. sm_mlt() Scalar-matrix multiplication
  194. smrand() Set seed for mrand()
  195. spBKPfactor() Sparse symmetric indefinite factorsiation
  196. spBKPsolve() Sparse symmetric indefinite solver
  197. spCHfactor() Sparse Cholesky factorisation
  198. spCHsolve() Sparse Cholesky solver
  199. spCHsymb() Symbolic sparse Cholesky factorisation
  200. (no floating point operations)
  201. sp_col_access() Sets up column access paths for a sparse matrix
  202. sp_compact() Eliminates zero entries in a sparse matrix
  203. sp_copy() Copies a sparse matrix
  204. sp_copy2() Copies a sparse matrix into another
  205. sp_diag_access() Sets up diagonal access paths for a sparse matrix
  206. sp_dump() Dump sparse matrix data structure to a stream
  207. sp_finput() Input sparse matrix from a stream
  208. sp_foutput() Output a sparse matrix to a stream
  209. sp_free() Free (deallocate) a sparse matrix
  210. sp_get() Allocate and initialise a sparse matrix
  211. sp_get_val() Get the (i,j) entry of a sparse matrix
  212. spICHfactor() Sparse incomplete Cholesky factorisation
  213. sp_input() Input a sparse matrix form stdin
  214. spLUfactor() Sparse LU factorisation using partial pivoting
  215. spLUsolve() Solves Ax=b using sparse LU factors
  216. spLUTsolve() Solves A^Tx=b using sparse LU factors
  217. sp_mv_mlt() Computes Ax for sparse A
  218. sp_output() Outputs a sparse matrix to a stream (macro)
  219. sp_resize() Resize a sparse matrix
  220. sprow_add() Adds a pair of sparse rows
  221. sprow_foutput() Output sparse row to a stream
  222. sprow_get() Allocate and initialise a sparse row
  223. sprow_get_idx() Get location of an entry in a sparse row
  224. sprow_merge() Merge two sparse rows
  225. sprow_mltadd() Sparse row vector multiply-and-add
  226. sprow_set_val() Set an entry in a sparse row
  227. sprow_smlt() Multiplies a sparse row by a scalar
  228. sprow_sub() Subtracts a sparse row from another
  229. sprow_xpd() Expand a sparse row
  230. sp_set_val() Set the (i,j) entry of a sparse matrix
  231. sp_vm_mlt() Compute x^TA for sparse A
  232. sp_zero() Zero (but do not remove) all entries of a sparse matrix
  233. svd() Compute the SVD of a matrix
  234. sv_mlt() Scalar-vector multiply
  235. symmeig() Compute eigenvalues/vectors of a symmetric matrix
  236. tracecatch() Catch and re-raise errors (macro)
  237. trieig() Compute eigenvalues/vectors of a symmetric tridiagonal matrix
  238. Usolve() Solve Ux=b where U is upper triangular
  239. UTsolve() Solve U^Tx=b where U is upper triangular
  240. v_add() Add vectors
  241. v_conv() Convolution product of vectors
  242. v_copy() Copy vector
  243. v_dump() Dump vector data structure to a stream
  244. v_finput() Input vector from a stream
  245. v_foutput() Output vector to a stream
  246. V_FREE() Free (deallocate) a vector (macro)
  247. v_free() Free (deallocate) vector (function)
  248. v_free_vars() Free a list of vectors
  249. v_get() Allocate and initialise a vector
  250. v_get_vars() Allocate list of vectors
  251. v_input() Input vector from stdin (macro)
  252. v_lincomb() Compute sum of a_i x_i for an array of vectors
  253. v_linlist() Compute sum of a_i x_i for a list of vectors
  254. v_map() Apply function componentwise to a vector
  255. v_max() Computes max vector entry and index
  256. v_min() Computes min vector entry and index
  257. v_mltadd() Computes y <- alpha*x+y for vectors x , y
  258. vm_mlt() Computes x^TA
  259. vm_mltadd() Computes y^T <- y^T+x^TA
  260. v_norm1() Computes ||x||_1 for a vector
  261. v_norm2() Computes ||x||_2 (the Euclidean norm) of a vector
  262. v_norm_inf() Computes ||x||_inf for a vector
  263. v_ones() Set vector to all 1's
  264. v_output() Output vector to stdout (macro)
  265. v_pconv() Periodic convolution of two vectors
  266. v_rand() Randomise entries of a vector
  267. v_resize() Resize a vector
  268. v_resize_vars() Resize a list of vectors
  269. v_save() Save a vector in MATLAB format
  270. v_slash() Computes componentwise ratio of vectors
  271. v_sort() Sorts vector components
  272. v_star() Componentwise vector product
  273. v_sub() Subtract two vectors
  274. v_sum() Sum of components of a vector
  275. v_zero() Zero a vector
  276. zabs() Complex absolute value (modulus)
  277. zadd() Add complex numbers
  278. zconj() Conjugate complex number
  279. zdiv() Divide complex numbers
  280. zexp() Complex exponential
  281. z_finput() Read complex number from file or stream
  282. z_foutput() Prints complex number to file or stream
  283. zgivens() Compute complex Givens' rotation
  284. zhhtrcols() Apply Householder transformation: PA (complex)
  285. zhhtrrows() Apply Householder transformation: AP (complex)
  286. zhhtrvec() Apply Householder transformation: Px (complex)
  287. zhhvec() Compute Householder transformation
  288. zin_prod() Complex inner product
  289. z_input() Read complex number from stdin
  290. zinv() Computes 1/z (complex)
  291. zLAsolve() Solve L^*x=b , L complex lower triangular
  292. zlog() Complex logarithm
  293. zLsolve() Solve Lx=b , L complex lower triangular
  294. zLUAsolve() Solve A^*x=b using complex LU factorisation
  295. (A^* - adjoint of A, A is complex)
  296. zLUcondest() Complex LU condition estimate
  297. zLUfactor() Complex LU factorisation
  298. zLUsolve() Solve Ax=b using complex LU factorisation
  299. zm_add() Add complex matrices
  300. zm_adjoint() Computes adjoint of complex matrix
  301. zmake() Construct complex number from real and imaginary parts
  302. zmakeQ() Construct Q matrix for complex QR
  303. zmakeR() Construct R matrix for complex QR
  304. zmam_mlt() Computes A^*B (complex)
  305. zm_dump() Dump complex matrix to stream
  306. zm_finput() Input complex matrix from stream
  307. ZM_FREE() Free (deallocate) complex matrix (macro)
  308. zm_free() Free (deallocate) complex matrix (function)
  309. zm_free_vars() Free a list of complex matrices
  310. zm_get() Allocate complex matrix
  311. zm_get_vars() Allocate a list of complex matrices
  312. zm_input() Input complex matrix from stdin
  313. zm_inverse() Compute inverse of complex matrix
  314. zm_load() Load complex matrix in MATLAB format
  315. zmlt() Multiply complex numbers
  316. zmma_mlt() Computes AB^* (complex)
  317. zm_mlt() Multiply complex matrices
  318. zm_norm1() Complex matrix 1-norm
  319. zm_norm_frob() Complex matrix Frobenius norm
  320. zm_norm_inf() Complex matrix infinity-norm
  321. zm_rand() Randomise complex matrix
  322. zm_resize() Resize complex matrix
  323. zm_resize_vars() Resize a list of complex matrices
  324. zm_save() Save complex matrix in MATLAB format
  325. zm_sub() Subtract complex matrices
  326. zmv_mlt() Complex matrix-vector multiply
  327. zmv_mltadd() Complex matrix-vector multiply and add
  328. zm_zero() Zero complex matrix
  329. zneg() Computes -z (complex)
  330. z_output() Print complex number to stdout
  331. zQRCPfactor() Complex QR factorisation with column pivoting
  332. zQRCPsolve() Solve Ax = b using complex QR factorisation
  333. zQRfactor() Complex QR factorisation
  334. zQRAsolve() Solve A^*x = b using complex QR factorisation
  335. zQRsolve() Solve Ax = b using complex QR factorisation
  336. zrot_cols() Complex Givens' rotation of columns
  337. zrot_rows() Complex Givens' rotation of rows
  338. z_save() Save complex number in MATLAB format
  339. zschur() Complex Schur factorisation
  340. zset_col() Set column of complex matrix
  341. zset_row() Set row of complex matrix
  342. zsm_mlt() Complex scalar-matrix product
  343. zsqrt() Square root z (complex)
  344. zsub() Subtract complex numbers
  345. zUAsolve() Solve U^*x=b , U complex upper triangular
  346. zUsolve() Solve Ux=b , U complex upper triangular
  347. zv_add() Add complex vectors
  348. zv_copy() Copy complex vector
  349. zv_dump() Dump complex vector to a stream
  350. zv_finput() Input complex vector from a stream
  351. ZV_FREE() Free (deallocate) complex vector (macro)
  352. zv_free() Free (deallocate) complex vector (function)
  353. zv_free_vars() Free a list of complex vectors
  354. zv_get() Allocate complex vector
  355. zv_get_vars() Allocate a list of complex vectors
  356. zv_input() Input complex vector from a stdin
  357. zv_lincomb() Compute sum of a_i x_i for an array of vectors
  358. zv_linlist() Compute sum of a_i x_i for a list of vectors
  359. zv_map() Apply function componentwise to a complex vector
  360. zv_mlt() Complex scalar-vector product
  361. zv_mltadd() Complex scalar-vector multiply and add
  362. zvm_mlt() Computes A^*x (complex)
  363. zvm_mltadd() Computes A^*x+y (complex)
  364. zv_norm1() Complex vector 1-norm vnorm1()
  365. zv_norm2() Complex vector 2-norm (Euclidean norm)
  366. zv_norm_inf() Complex vector infinity- (or supremum) norm
  367. zv_rand() Randomise complex vector
  368. zv_resize() Resize complex vector
  369. zv_resize_vars() Resize a list of complex vectors
  370. zv_save() Save complex vector in MATLAB format
  371. zv_slash() Componentwise ratio of complex vectors
  372. zv_star() Componentwise product of complex vectors
  373. zv_sub() Subtract complex vectors
  374. zv_sum() Sum of components of a complex vector
  375. zv_zero() Zero complex vector
  376. Low level routines
  377. Function Description
  378. __add__() Add arrays
  379. __ip__() Inner product of arrays
  380. MEM_COPY() Copy memory (macro)
  381. MEM_ZERO() Zero memory (macro)
  382. __mltadd__() Forms x+ alpha*y for arrays
  383. __smlt__() Scalar-vector multiplication for arrays
  384. __sub__() Subtract an array from another
  385. __zadd__() Add complex arrays
  386. __zconj__() Conjugate complex array
  387. __zero__() Zero an array
  388. __zip__() Complex inner product of arrays
  389. __zmlt__() Complex array scalar product
  390. __zmltadd__() Complex array saxpy
  391. __zsub__() Subtract complex arrays
  392. __zzero__() Zero a complex array