From 989a576e9151bc428e62539ad08aed92f8d77c71 Mon Sep 17 00:00:00 2001 From: Michael Stevens Date: Fri, 15 Jul 2005 15:45:34 +0000 Subject: [PATCH] ADD define the vector/matrix_container classes CHANGE drop the template parameters of models, they are often incorrect, missleading and impossible to maintain FIX Vector/ Matrix concepts have array_type and data() as special properties [SVN r30110] --- doc/container_concept.htm | 31 +++++++++-------- doc/expression_concept.htm | 56 +++++++++++++++--------------- doc/iterator_concept.htm | 12 +++---- doc/matrix_expression.htm | 67 +++++++++++++++++++++++++++++------- doc/vector_expression.htm | 70 +++++++++++++++++++++++++++++--------- 5 files changed, 158 insertions(+), 78 deletions(-) diff --git a/doc/container_concept.htm b/doc/container_concept.htm index e4e7ecb9..79c85f22 100644 --- a/doc/container_concept.htm +++ b/doc/container_concept.htm @@ -33,8 +33,9 @@ vectors.

Storage array V::array_type -The type of underlying storage array used to store the elements. The array_type must model -the Storage concept. + +Dense Vector ONLY. The type of underlying storage array used to store the elements. The array_type must model the +Storage concept. @@ -182,8 +183,8 @@ When p == false then existing elements are not preserved and elemen Storage v.data() -v -Returns a reference to the underlying storage + +Dense Vector ONLY. Returns a reference to the underlying storage   @@ -197,9 +198,9 @@ size.

Invariants

Models

Notes

[1] @@ -230,7 +231,7 @@ matrices.

Storage array M::array_type -The type of underlying storage array used to store the elements. The array_type must model +Dense Matrix ONLY. The type of underlying storage array used to store the elements. The array_type must model the Storage concept. @@ -380,9 +381,9 @@ When p == false then existing elements are not preserved and elemen Storage -v.data() -v -Returns a reference to the underlying storage +m.data() + +Dense Matrix ONLY. Returns a reference to the underlying storage   @@ -396,10 +397,10 @@ size.

Invariants

Models

Notes

[1] diff --git a/doc/expression_concept.htm b/doc/expression_concept.htm index c8a28485..edbe653d 100644 --- a/doc/expression_concept.htm +++ b/doc/expression_concept.htm @@ -87,8 +87,8 @@ evaluated scalar expression.

Invariants

Models

Vector Expression

@@ -487,20 +487,20 @@ to v.rend ().

Models

Matrix @@ -1017,18 +1017,18 @@ the distance from m.rbegin2 () to m.rend2

Models

    -
  • matrix_range<M>
    • -
  • matrix_slice<M>
    • -
  • triangular_adaptor<M, F>
    • -
  • symmetric_adaptor<M, F>
    • -
  • banded_adaptor<M>
    • -
  • vector_matrix_binary<E1, E2, F>
    • -
  • matrix_unary1<E, F>
    • -
  • matrix_unary2<E, F>
    • -
  • matrix_binary<E1, E2, F>
    • -
  • matrix_binary_scalar1<E1, E2, F>
    • -
  • matrix_binary_scalar2<E1, E2, F>
    • -
  • matrix_matrix_binary<E1, E2, F>
    • +
  • matrix_range
    • +
  • matrix_slice;
    • +
  • triangular_adaptor
    • +
  • symmetric_adaptor
    • +
  • banded_adaptor
    • +
  • vector_matrix_binary
    • +
  • matrix_unary1
    • +
  • matrix_unary2
    • +
  • matrix_binary
    • +
  • matrix_binary_scalar1
    • +
  • matrix_binary_scalar2
    • +
  • matrix_matrix_binary

Copyright (©) 2000-2002 Joerg Walter, Mathias Koch
diff --git a/doc/iterator_concept.htm b/doc/iterator_concept.htm index 1b681fa0..afb21a97 100644 --- a/doc/iterator_concept.htm +++ b/doc/iterator_concept.htm @@ -292,7 +292,7 @@ operator

Models

    -
  • sparse_vector<T>::iterator
    • +
  • sparse_vector::iterator

Indexed Random Access @@ -523,7 +523,7 @@ it2 + (it1 - it2).

Models

Indexed Bidirectional @@ -920,8 +920,8 @@ it2t.index1 () for all it2t with it2t ()

Models

    -
  • sparse_matrix<T>::iterator1
    • -
  • sparse_matrix<T>::iterator2
    • +
  • sparse_matrix::iterator1
    • +
  • sparse_matrix::iterator2

Indexed Random Access @@ -1148,8 +1148,8 @@ it2 + (it1 - it2).

Models

Copyright (©) 2000-2002 Joerg Walter, Mathias Koch
diff --git a/doc/matrix_expression.htm b/doc/matrix_expression.htm index 09fd7fe2..eef0af40 100644 --- a/doc/matrix_expression.htm +++ b/doc/matrix_expression.htm @@ -12,14 +12,12 @@

Matrix Expressions

-

Matrix -Expression

+

Matrix Expression

Description

The templated class matrix_expression<E> -forms the base for all static derived matrix expression classes -including class matrix itself.

+is required to be a public base of all classes which model the Matrix Expression concept.

Definition

-

Defined in the header matrix_expression.hpp.

+

Defined in the header expression_types.hpp.

Template parameters

@@ -62,8 +60,54 @@ const

Notes

The operator[], row, column, range, slice and project functions have been removed. Use the free functions defined in matrix proxy instead.

-

Matrix -References

+

Matrix Container

+

Description

+

The templated class matrix_container<C> +is required to be a public base of all classes which model the Matrix concept. +This includes the class matrix itself.

+

Definition

+

Defined in the header expression_types.hpp.

+

Template parameters

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

Model of

+

None. Not a Matrix Expression OR Matrix! +

+

Type requirements

+

None.

+

Public base classes

+

matrix_expression<C>

+

Members

+ + + + + + + + + + + + + + + +
MemberDescription
const container_type &operator () () +constReturns a const reference of the container.
container_type &operator () ()Returns a reference of the container.
+

Matrix References

Reference

Description

The templated class matrix_reference<E> @@ -212,8 +256,7 @@ the reversed expression. -

Matrix -Operations

+

Matrix Operations

Unary Operation Description

Description

The templated classes matrix_unary1<E, F> and @@ -759,8 +802,7 @@ int main () { std::cout << m * 2.0 << std::endl; } -

Matrix Vector Operations

+

Matrix Vector Operations

Binary Operation Description

Description

The templated classes matrix_vector_binary1<E1, E2, @@ -1101,8 +1143,7 @@ int main () { std::cout << solve (v, m, lower_tag ()) << std::endl; } -

Matrix Matrix Operations

+

Matrix Matrix Operations

Binary Operation Description

Description

The templated class matrix_matrix_binary<E1, E2, diff --git a/doc/vector_expression.htm b/doc/vector_expression.htm index cc6a3c0a..1ec6759f 100644 --- a/doc/vector_expression.htm +++ b/doc/vector_expression.htm @@ -12,14 +12,12 @@

Vector Expressions

-

Vector -Expression

+

Vector Expression

Description

The templated class vector_expression<E> -forms the base for all static derived vector expression classes -including class vector itself.

+is required to be a public base of all classes which model the Vector Expression concept.

Definition

-

Defined in the header vector_expression.hpp.

+

Defined in the header expression_types.hpp.

Template parameters

@@ -33,11 +31,6 @@ including class vector itself.

- - - - -
The type of the vector expression.  
ABase type of an indirect_array. 

Model of

@@ -68,8 +61,55 @@ const

Notes

The range, slice and project functions have been removed. Use the free functions defined in vector proxy instead.

-

Vector -References

+

Vector Container

+

Description

+

The templated class vector_container<C> +is required to be a public base of all classes which model the Vector concept. +This includes the class vector itself.

+

Definition

+

Defined in the header expression_types.hpp.

+

Template parameters

+ + + + + + + + + + + + + +
ParameterDescriptionDefault
CThe type of the vector container. 
+

Model of

+

None. Not a Vector Expression OR Vector! +

+

Type requirements

+

None.

+

Public base classes

+

vector_expression<C>

+

Members

+ + + + + + + + + + + + + + + +
MemberDescription
const container_type &operator () () +constReturns a const reference of the container.
container_type &operator () ()Returns a reference of the container.
+ +

Vector References

Reference

Description

The templated class vector_reference<E> @@ -171,8 +211,7 @@ the reversed expression. -

Vector -Operations

+

Vector Operations

Unary Operation Description

Description

The templated class vector_unary<E, F> @@ -781,8 +820,7 @@ int main () { std::cout << v * 2.0 << std::endl; } -

Vector -Reductions

+

Vector Reductions

Unary Reductions

Prototypes