From f2934e3c8a3ec6039faf34b6d7ebceaf38cc6ad0 Mon Sep 17 00:00:00 2001 From: Toon Knapen Date: Thu, 6 Jan 2005 10:03:41 +0000 Subject: [PATCH] merged doc in uBLAS CVS to boost CVS svn path=/trunk/boost/libs/numeric/ublas/; revision=26634 --- doc/banded.htm | 6 +- doc/hermitian.htm | 6 +- doc/index.htm | 98 +++++++++++----------- doc/matrix.htm | 14 ++-- doc/matrix_expression.htm | 161 +++++++----------------------------- doc/matrix_proxy.htm | 108 +++++++++++++----------- doc/matrix_sparse.htm | 2 +- doc/operations_overview.htm | 6 +- doc/overview.htm | 2 +- doc/products.htm | 2 +- doc/samples/map_array.cpp | 2 +- doc/storage_sparse.htm | 2 +- doc/symmetric.htm | 6 +- doc/triangular.htm | 6 +- doc/types_overview.htm | 2 +- doc/vector.htm | 110 ++++++++++++++++++++++-- doc/vector_expression.htm | 112 +++++-------------------- doc/vector_proxy.htm | 54 +++++++----- doc/vector_sparse.htm | 2 +- 19 files changed, 326 insertions(+), 375 deletions(-) diff --git a/doc/banded.htm b/doc/banded.htm index 47de8ae9..743e2435 100644 --- a/doc/banded.htm +++ b/doc/banded.htm @@ -10,7 +10,7 @@ Banded Matrix -

boost.png +

c++boost.gif Banded Matrix

Banded Matrix

@@ -352,11 +352,11 @@ int main () {

Model of

-

Matrix Expression +

Matrix Expression .

Type requirements

None, except for those imposed by the requirements of Matrix Expression .

+"expression_concept.htm#matrix_expression">Matrix Expression .

Public base classes

matrix_expression<banded_adaptor<M> >

diff --git a/doc/hermitian.htm b/doc/hermitian.htm index c69ee346..54451c6f 100644 --- a/doc/hermitian.htm +++ b/doc/hermitian.htm @@ -10,7 +10,7 @@ Hermitian Matrix -

boost.png +

c++boost.gif Hermitian Matrix

Hermitian Matrix

@@ -374,11 +374,11 @@ int main () {

Model of

-

Matrix Expression +

Matrix Expression .

Type requirements

None, except for those imposed by the requirements of Matrix Expression .

+"expression_concept.htm#matrix_expression">Matrix Expression .

Public base classes

matrix_expression<hermitian_adaptor<M, F> >

diff --git a/doc/index.htm b/doc/index.htm index 428211a6..ad5e150f 100644 --- a/doc/index.htm +++ b/doc/index.htm @@ -10,7 +10,7 @@ Boost Basic Linear Algebra -

boost.png +

c++boost.gif Basic Linear Algebra

uBLAS is a C++ template class library that provides BLAS level 1, 2, 3 functionality @@ -46,51 +46,38 @@ suite.

  • Overview of Matrix and Vector Operations
    • -
  • Expression Concepts +
  • uBLAS Concept definitions
    • -
  • Matrix Expressions +
  • Matrix Expressions
    • +
  • Storage + +
    • +
  • Sparse Storage + +
  • Operations & Functions

    Supported Platforms

    The original development platform for uBLAS we used MSVC 6.0 -with Dinkumware STL. Other compilers known to accept the library -are

    +with Dinkumware STL. Compilers known to accept the library +are:

    For possible problems please consider to consult the Boost regression tests.

    @@ -228,8 +230,8 @@ regression tests.

    "http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Effective_UBLAS"> Effective uBLAS wiki for up to date information and contributions.

    -

    There is also an active uBLAS mailing list where uBLAS specific +

    There is also an active uBLAS development mailing list where user and development questions are answered.

    uBLAS and Boost Project

    uBLAS development takes place via a two tier structure. Active diff --git a/doc/matrix.htm b/doc/matrix.htm index dbecef7f..a9f5c0e5 100644 --- a/doc/matrix.htm +++ b/doc/matrix.htm @@ -10,7 +10,7 @@ Matrix -

    boost.png +

    c++boost.gif Matrix

    Matrix

    Description

    @@ -332,11 +332,11 @@ int main () {

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<identity_matrix<T> >

    @@ -476,11 +476,11 @@ int main () {

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<zero_matrix<T> >

    Members

    @@ -619,11 +619,11 @@ int main () {

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<scalar_matrix<T> >

    diff --git a/doc/matrix_expression.htm b/doc/matrix_expression.htm index 1e15b30b..e9b1ac7e 100644 --- a/doc/matrix_expression.htm +++ b/doc/matrix_expression.htm @@ -10,7 +10,7 @@ Matrix Expressions -

    boost.png +

    c++boost.gif Matrix Expressions

    Matrix Expression

    @@ -36,7 +36,8 @@ including class matrix itself.

    Model of

    -

    None.

    +

    None. Not a Matrix Expression! +

    Type requirements

    None.

    Public base classes

    @@ -61,104 +62,6 @@ const

    Matrix References

    -

    Constant Reference

    -

    Description

    -

    The templated class matrix_const_reference<E> -contains a constant reference to a matrix expression.

    -

    Definition

    -

    Defined in the header matrix_expression.hpp.

    -

    Template parameters

    - - - - - - - - - - - - - -
    ParameterDescriptionDefault
    EThe type of the matrix expression. 
    -

    Model of

    -

    Matrix Expression -.

    -

    Type requirements

    -

    None, except for those imposed by the requirements of Matrix Expression .

    -

    Public base classes

    -

    matrix_expression<matrix_const_reference<E> ->

    -

    Members

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    MemberDescription
    matrix_const_reference (const expression_type -&e)Constructs a constant reference of the expression.
    size_type size1 () constReturns the number of rows.
    size_type size2 () constReturns the number of columns.
    const_reference operator () (size_type i, size_type j) -constReturns the value of the j-th element in the -i-th row.
    const_iterator1 begin1 () constReturns a const_iterator1 pointing to the -beginning of the expression.
    const_iterator1 end1 () constReturns a const_iterator1 pointing to the end of -the expression.
    const_iterator2 begin2 () constReturns a const_iterator2 pointing to the -beginning of the expression.
    const_iterator2 end2 () constReturns a const_iterator2 pointing to the end of -the expression.
    const_reverse_iterator1 rbegin1 () constReturns a const_reverse_iterator1 pointing to the -beginning of the reversed expression.
    const_reverse_iterator1 rend1 () constReturns a const_reverse_iterator1 pointing to the -end of the reversed expression.
    const_reverse_iterator2 rbegin2 () constReturns a const_reverse_iterator2 pointing to the -beginning of the reversed expression.
    const_reverse_iterator2 rend2 () constReturns a const_reverse_iterator2 pointing to the -end of the reversed expression.

    Reference

    Description

    The templated class matrix_reference<E> @@ -181,11 +84,11 @@ contains a reference to a matrix expression.

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<matrix_reference<E> >

    @@ -337,11 +240,11 @@ operations.

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<matrix_unary1<E, F> > and matrix_expression<matrix_unary2<E, F> @@ -475,7 +378,7 @@ conjugate of the transpose of a matrix expression.

    Type requirements

    • E is a model of Matrix Expression .
      • +"expression_concept.htm#matrix_expression">Matrix Expression .

    Preconditions

    None.

    @@ -533,11 +436,11 @@ describes a binary matrix operation.

    Model of

    -

    Matrix Expression +

    Matrix Expression .

    Type requirements

    None, except for those imposed by the requirements of Matrix Expression .

    +"expression_concept.htm#matrix_expression">Matrix Expression .

    Public base classes

    matrix_expression<matrix_binary<E1, E2, F> >.

    @@ -642,9 +545,9 @@ matrix expressions.

    Type requirements

    • E1 is a model of Matrix Expression .
      • +"expression_concept.htm#matrix_expression">Matrix Expression .
    • E2 is a model of Matrix Expression .
      • +"expression_concept.htm#matrix_expression">Matrix Expression .

    Preconditions