The Matrix Template Library
Condensed Table of Contents
  1. Containers
    1. Concepts
    2. Type Generators
    3. Type Selectors
    4. Classes
    5. Adaptors
    6. Functions
    7. Tags
  1. Iterators
    1. Concepts
    2. Functions
    3. Classes
    4. Adaptors
  1. Algorithms
  2. Function Objects
  3. FAST Library
  4. BLAIS LIbrary
  5. MTL to LAPACK Interface
  6. Utilities
  7. Bibliography
  8. Categorized index
Detailed Table of Contents
1. Containers
  1. Concepts
    1. ColumnMatrix A Column-Oriented MTL Matrix
    2. DiagonalMatrix A Diagonally-Oriented Matrix
    3. MTL_Object_Model The MTL Object Memory Model
    4. Matrix The MTL Matrix Concept
    5. RowMatrix A Row-Oriented MTL Matrix
    6. TwoDStorage The MTL TwoD Storage Concept
    7. Vector The MTL Vector Concept
  2. Container type generators
    1. band_view Band View Matrix Type Constructor
    2. block_view Block View Matrix Type Constructor
    3. matrix Matrix type generators class.
    4. symmetric_view Symmetric View Matrix Type Constructor
    5. tri_view Triangle View Creation Helper Fuctor
    6. triangle_view Triangle View Matrix Type Constructor
  3. Container type selectors
  4. Container classes
    1. array2D Array 2-D Container
    2. compressed1D Compressed Sparse Vector
    3. external2D External2D Storage Type
    4. external_vec External 1-D Container
    5. generic_dense2D Generic Dense 2-D Container
    6. partitioned Dense2D Storage Type
  5. Container adaptors
    1. block2D Block View TwoD Storage
    2. linalg_vec Linalg Vector Adaptor
    3. scaled1D Scaled Container
    4. scaled2D Scaled 2D container adaptor
    5. sparse1D Sparse 1-D Container Adaptor
    6. strided1D Strided Vector Adaptor
  6. Container functions
    1. scaled Shortcut for Creating a Scaled Argument
    2. strided Shortcut for Creating a Strided Argument
    3. blocked Blocked Matrix Generator
    4. blocked Blocked Matrix Generator
    5. rows Access the row-wise view of the matrix
    6. columns Access the column-wise view of the matrix
    7. trans Swap the orientation of a matrix.
  7. Container tags
    1. column_matrix_traits Column Matrix Traits
    2. diagonal_matrix_traits Diagonal Matrix Traits
    3. linalg_traits Linear Algebra Object (Matrix and Vector) Traits
    4. matrix_traits The "traits" class for MTL matrices.
    5. not_strideable Identifies matrices that can not be used with the rows and columns functions
    6. row_matrix_traits Row Matrix Traits
    7. strideable Identifies matrices that can be used with the rows and columns functions
2. Iterators
  1. Concepts
    1. IndexedIterator IndexedIterator
  2. Iterator functions
    1. trans_iter Helper function for creating a transforming iterator
  3. Iterator classes
    1. compressed_iter Compressed Storage Iterator
  4. Iterator adaptors
    1. dense_iterator dense iterator
    2. scale_iterator scale iterator
    3. sparse_iterator Sparse Vector Iterator
    4. strided_iterator strided iterator
    5. transform_iterator Tranforming Iterator
3. Algorithms
  1. sum Sum: s <- sum_i(x(i))
  2. scale Scale: A <- alpha*A or x <- alpha x
  3. set_diagonal Set Diagonal: A(i,i) <- alpha
  4. two_norm Two Norm: s <- sqrt(sum_i(|x(i)^2|))
  5. sum_squares Sum of the Squares
  6. one_norm One Norm: s <- sum(|x_i|) or s <- max_j(sum_i(|A(i,j)|))
  7. infinity_norm Infinity Norm: s <- max_i(sum_j(|A(i,j)|)) or s <- max_i(|x(i)|)
  8. max_index Max Index: i <- index of max(|x(i)|)
  9. max_abs_index Maximum Absolute Index: i <- index of max(|x(i)|)
  10. min_index Minimum Index: i <- index of min(x(i))
  11. min_abs_index Minimum Absolute Index: i <- index of min(|x(i)|)
  12. max Max Value: s <- max(x(i))
  13. min Min Value: s <- min(x_i)
  14. transpose Transpose in Place: A <- A^T
  15. conj_transpose Transpose in Place: A <- A^T
  16. transpose Transpose: B <- A^T
  17. mult Multiplication: z <- A x + y
  18. _mult Matrix Vector Multiplication: y <- A x
  19. tri_solve Triangular Solve: x <- T^{-1} * x
  20. tri_solve Triangular Solve: B <- A^{-1} * B or B <- B * A^{-1}
  21. rank_one_update Rank One Update: A <- A + x * y^T
  22. rank_one_conj Rank One Update with conj(): A <- A + x * conj(y^T)
  23. rank_two_update Rank Two Update: A <- A + x * y^T + y * x^T
  24. rank_two_conj Rank Two Update with conj(): A <- A + x * conj(y^T) + y * conj(x^T)
  25. scatter Scatter y <- x
  26. gather Gather y <- x
  27. copy Copy: B <- A or y <- x
  28. __add Add: z <- x + y
  29. add Add: w <- x + y + z
  30. add Add: B <- A + B or y <- x + y
  31. ele_mult Element-wise Multiplication: z <- x O* y
  32. ele_mult Element-wise Multiply: B <- A O* B
  33. ele_div Element-wise Division: z <- x O/ y
  34. swap Swap: B <-> A or y <-> x
  35. dot Dot Product: s <- x . y + s
  36. dot Dot Product: s <- x . y
  37. dot Dot Product (extended precision): s <- x . y + s
  38. dot_conj Dot Conjugate: s <- x . conj(y) + s
  39. dot_conj Dot Conjugate: s <- x . conj(y)
  40. lu_factor LU Factorization of a general (dense) matrix
  41. lu_solve LU Solve
  42. lu_inverse LU Inverse
4. Function Objects
  1. givens_rotation Givens Plane Rotation
  2. givens_rotation__2 The specialization for complex numbers.
  3. givens_rotation__3 The specialization for complex numbers.
  4. givens_rotation__4 The specialization for complex numbers.
  5. modified_givens Modified Givens Transformation
5. Fixed Algorithm Size Template (FAST) Library
  1. Functions
    1. copy Copy
    2. transform Transform (one input iterator)
    3. transform Transform (two input iterators)
    4. fill Fill
    5. swap_ranges Swap Ranges
    6. accumulate Accumulate (with default operation)
    7. accumulate Accumulate (with user-supplied operation)
    8. inner_product Inner Product (user supplied operators)
    9. inner_product Inner Product (with default operators)
  2. Classes
6. Basic Linear Algebra Instruction Set (BLAIS) Library
  1. add Add y <- x + y
  2. copy Copy y <- x
  3. copy__2 Copy B <- A
  4. dot Dot Product s <- x . y
  5. mult Multiplication y <- A x + y
  6. mult__2 Multiplication C <- A * B
  7. rank_one Rank One Update A <- A + x * y^T
  8. set Set elements of vector x to alpha
  9. set__2 Set matrix A to alpha
7. MTL to LAPACK Interface
  1. Type Generators
    1. lapack_matrix Lapack Matrix
  2. Functions
    1. gecon Estimate the reciprocal of the condition number of a general matrix.
    2. geev Compute the eigenvalues.
    3. geqpf QR Factorization with Column Pivoting.
    4. geqrf QR Factorization of a General Matrix
    5. gesv Solution to a linear system in a general matrix.
    6. getrf LU factorization of a general matrix A.
    7. getrs Solution to a system using LU factorization
    8. geequ Equilibrate and reduce condition number.
    9. gelqf Compute an LQ factorization.
    10. orglq Generate a matrix Q with orthonormal rows.
    11. orgqr Generate a matrix Q with orthonormal columns.
8. Utilities
  1. Concepts
    1. Indexer Maps from Matrix coordinates to TwoD coordinates
    2. Offset Maps from TwoD coordinates to linear memory
  2. Functions
    1. read_dense_matlab Read a Dense Real Matrix from a Matlab file (.mat)
    2. write_dense_matlab Write a Dense Real Matrix to a Matlab file (.mat)
    3. read_sparse_matlab Read a Sparse Real Matrix from a Matlab file (.mat)
    4. write_sparse_matlab Write a Sparse Real Matrix to a Matlab file (.mat)
  3. Classes
    1. banded_offset Banded Offset Class
    2. banded_view_offset Banded View Offset Class
    3. dimension The Dimension Class
    4. harwell_boeing_stream A Matrix File Input Stream for Harwell-Boeing Matrix Files
    5. matrix_market_stream A Matrix File Input Stream for Matrix Market Files
    6. packed_offset Packed Offset Class
    7. rect_offset Rectangular Offset Class
    8. strided_band_view_offset Strided Band View Offset Class
    9. strided_banded_offset Strided Banded Offset
    10. strided_offset Strided Rectangular Offset Class
    11. strided_packed_offset Strided Packed Offset Class
9. Bibliography

10. Categorized index

[MTL Home] Copyright © 1998,1999 University of Notre Dame. All Rights Reserved.