1 //  Copyright (c) 2010-2011 David Bellot
2 //
3 //  Distributed under the Boost Software License, Version 1.0. (See
4 //  accompanying file LICENSE_1_0.txt or copy at
5 //  http://www.boost.org/LICENSE_1_0.txt)
6 
7 /** \mainpage BOOST uBLAS: a Linear Algebra Library
8  *
9  * This is the API Reference Documentation.
10  *
11  * \section main_classes Main classes
12  *
13  * \subsection listvector Vectors
14  * - \link #boost::numeric::ublas::vector                    vector \endlink
15  * - \link #boost::numeric::ublas::bounded_vector            bounded_vector \endlink
16  * - \link #boost::numeric::ublas::zero_vector                zero_vector \endlink
17  * - \link #boost::numeric::ublas::unit_vector                unit_vector \endlink
18  * - \link #boost::numeric::ublas::scalar_vector            scalar_vector \endlink
19  * - \link #boost::numeric::ublas::c_vector                c_vector \endlink
20  * - \link #boost::numeric::ublas::vector_slice                vector_slice \endlink
21  * - \link #boost::numeric::ublas::vector_range                vector_range \endlink
22  * - \link #boost::numeric::ublas::vector_indirect            vector_indirect \endlink
23  * - \link #boost::numeric::ublas::mapped_vector            mapped_vector \endlink
24  * - \link #boost::numeric::ublas::compressed_vector            compressed_vector \endlink
25  * - \link #boost::numeric::ublas::coordinate_vector            coordinate_vector \endlink
26  * - \link #boost::numeric::ublas::matrix_row                matrix_row \endlink
27  * - \link #boost::numeric::ublas::matrix_column            matrix_column \endlink
28  *
29  * \subsection listmatrix Matrices
30  * - \link #boost::numeric::ublas::matrix                    matrix \endlink
31  * - \link #boost::numeric::ublas::banded_matrix            banded_matrix \endlink
32  * - \link #boost::numeric::ublas::diagonal_matrix            diagonal_matrix \endlink
33  * - \link #boost::numeric::ublas::banded_adaptor            banded_adaptor \endlink
34  * - \link #boost::numeric::ublas::diagonal_adaptor            diagonal_adaptor \endlink
35  * - \link #boost::numeric::ublas::hermitian_matrix            hermitian_matrix \endlink
36  * - \link #boost::numeric::ublas::hermitian_adaptor            hermitian_adaptor \endlink
37  * - \link #boost::numeric::ublas::symmetric_matrix            symmetric_matrix \endlink
38  * - \link #boost::numeric::ublas::symmetric_adaptor            symmetric_adaptor \endlink
39  * - \link #boost::numeric::ublas::triangular_matrix            triangular_matrix \endlink
40  * - \link #boost::numeric::ublas::triangular_adaptor            triangular_adaptor \endlink
41  * - \link #boost::numeric::ublas::vector_of_vector            vector_of_vector \endlink
42  * - \link #boost::numeric::ublas::bounded_matrix            bounded_matrix \endlink
43  * - \link #boost::numeric::ublas::zero_matrix                 zero_matrix  \endlink
44  * - \link #boost::numeric::ublas::identity_matrix            identity_matrix \endlink
45  * - \link #boost::numeric::ublas::scalar_matrix             scalar_matrix  \endlink
46  * - \link #boost::numeric::ublas::c_matrix                c_matrix \endlink
47  * - \link #boost::numeric::ublas::matrix_vector_range        matrix_vector_range \endlink
48  * - \link #boost::numeric::ublas::matrix_vector_slice        matrix_vector_slice \endlink
49  * - \link #boost::numeric::ublas::matrix_vector_indirect        matrix_vector_indirect \endlink
50  * - \link #boost::numeric::ublas::matrix_range                matrix_range \endlink
51  * - \link #boost::numeric::ublas::matrix_slice                matrix_slice \endlink
52  * - \link #boost::numeric::ublas::matrix_indirect            matrix_indirect \endlink
53  * - \link #boost::numeric::ublas::mapped_matrix            mapped_matrix \endlink
54  * - \link #boost::numeric::ublas::mapped_vector_of_mapped_vector    mapped_vector_of_mapped_vector \endlink
55  * - \link #boost::numeric::ublas::compressed_matrix            compressed_matrix \endlink
56  * - \link #boost::numeric::ublas::coordinate_matrix            coordinate_matrix \endlink
57  * - \link #boost::numeric::ublas::generalized_vector_of_vector    generalized_vector_of_vector \endlink
58  */
59