Banded MatrixBanded MatrixThe templated class banded_matrix<T, F, A> is
the base container adaptor for banded matrices. For a (m x
@@ -316,7 +316,7 @@ parameters for the adapted array are
unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .
The templated class banded_adaptor<M> is a
banded matrix adaptor for other matrices.
Bounded Array StorageThe templated class bounded_array<T, N, ALLOC> implements a bounded storage array. The bounded array is similar to a C++ array type in that its maximum size is bounded by N and is allocated on the stack instead of the heap. Similarly a bounded_array requires no secondary storage and ALLOC is only used to specify size_type and difference_type.
Container ConceptsA Vector describes common aspects of dense, packed and sparse vectors.
@@ -211,7 +211,7 @@ Theoperator[] is added purely for convenience
and compatibility with the std::vector. In uBLAS however,
generally operator() is used for indexing because this can be
used for both vectors and matrices.
-A Matrix describes common aspects of dense, packed and sparse matrices.
diff --git a/doc/expression_concept.htm b/doc/expression_concept.htm index f1b1cb3a..545c3b78 100644 --- a/doc/expression_concept.htm +++ b/doc/expression_concept.htm @@ -12,7 +12,7 @@Expression ConceptsA Scalar Expression is an expression convertible to a scalar type.
@@ -92,7 +92,7 @@ evaluated scalar expression.vector_scalar_unaryvector_scalar_binaryA Vector Expression is an expression evaluatable to a vector.
Vector Expression provides an v.rend ().
A Matrix Expression is an expression evaluatable to a matrix.
Matrix Expression provides an
The templated class The templated class An Iterator is a restricted pointer-like object pointing into a
vector or matrix container. An Indexed Bidirectional Iterator is an iterator of a container
that can be dereferenced, incremented, decremented and carries
@@ -296,8 +296,8 @@ operator
An Indexed Random Access Iterator is an iterator of a container
that can be dereferenced, moved forward, moved backward and carries
@@ -526,8 +526,8 @@ it2 + (it1 - it2).
An Indexed Bidirectional Column/Row Iterator is an iterator of a
container that can be dereferenced, incremented, decremented and
@@ -923,8 +923,8 @@ it2t.index1 () for all An Indexed Random Access Column/Row Iterator is an iterator of a
container that can be dereferenced, incremented, decremented and
diff --git a/doc/matrix.htm b/doc/matrix.htm
index 0c909c79..69e31eed 100644
--- a/doc/matrix.htm
+++ b/doc/matrix.htm
@@ -15,7 +15,7 @@
The templated class [1] Supported parameters
+ [1] Supported parameters
for the storage organization are [2] Common parameters
+ [2] Common parameters
for the storage array are The templated class The templated class The templated class The templated class The The templated class The templated class The templated classes The templated classes The templated class The templated class The templated class The templated class The templated class The templated class The templated class The templated class [1] Supported
+ [1] Supported
parameters for the storage organization are [2] Supported
+ [2] Supported
parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the storage organization are
[2]
+ [2]
Supported parameters for the index base are [3]
+ [3]
Supported parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the storage organization are
[2]
+ [2]
Supported parameters for the index base are [3]
+ [3]
Supported parameters for the adapted array are
Accessing submatrices and subvectors via proxies using If you know for sure that the left hand expression and the right
hand expression have no common storage, then assignment has
diff --git a/doc/overview.htm b/doc/overview.htm
index 60fce76c..ce7bb638 100644
--- a/doc/overview.htm
+++ b/doc/overview.htm
@@ -13,7 +13,7 @@
It would be nice if every kind of numeric software could
be written in C++ without loss of efficiency, but unless something
can be found that achieves this without compromising the C++ type
@@ -265,7 +265,7 @@ development cycle. Switching from debug mode to release mode is
controlled by the Every C++ library supporting linear algebra will be measured
against the long-standing Fortran package BLAS. We now describe how
diff --git a/doc/range.htm b/doc/range.htm
index 5e4224c5..37213bee 100644
--- a/doc/range.htm
+++ b/doc/range.htm
@@ -12,7 +12,7 @@
The class The class Storage is a variable-size container whose elements are arranged in a strict linear order.
Storage extends the STL Container concept with some STL Sequence-like functionality. The main difference with
@@ -154,4 +154,4 @@ each element value may be a previously assigned value or default construced valu
})(jQuery);
-
\ No newline at end of file
+
diff --git a/doc/storage_sparse.htm b/doc/storage_sparse.htm
index a16e1097..b4899d9b 100644
--- a/doc/storage_sparse.htm
+++ b/doc/storage_sparse.htm
@@ -15,7 +15,7 @@
The templated class std::map The templated class At any time the The templated class [1]
+ [1]
Supported parameters for the type of the symmetric matrix are
[2]
+ [2]
Supported parameters for the storage organization are
[3]
+ [3]
Supported parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the type of the symmetric adaptor are
The templated class [1]
+ [1]
Supported parameters for the type of the triangular matrix are
[2]
+ [2]
Supported parameters for the storage organization are
[3]
+ [3]
Supported parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the type of the triangular adaptor are
The templated class The templated class [1] Common parameters
+ [1] Common parameters
for the Storage array are The templated class The templated class The templated class The templated class The The templated class The templated class The templated class The templated class The templated class The templated class [1] Supported
+ [1] Supported
parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the index base are [2]
+ [2]
Supported parameters for the adapted array are
The templated class [1]
+ [1]
Supported parameters for the index base are [2]
+ [2]
Supported parameters for the adapted array are
matrix_vector_binary2Matrix Expression
+Matrix Expression
Description
-Hermitian MatrixHermitian Matrix
+Hermitian Matrix
Description
hermitian_matrix<T, F1, F2,
A> is the base container adaptor for hermitian matrices.
@@ -323,7 +323,7 @@ Supported parameters for the adapted array are
unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .Hermitian Adaptor
+Hermitian Adaptor
Description
hermitian_adaptor<M, F>
is a hermitian matrix adaptor for other matrices.Indexed Bidirectional Iterator
+Indexed Bidirectional Iterator
Description
-sparse_vector::iteratorIndexed Random Access Iterator
+Indexed Random Access Iterator
Description
-vector::iteratorIndexed Bidirectional Column/Row Iterator
+Indexed Bidirectional Column/Row Iterator
Description
it2t with it2t ()
sparse_matrix::iterator1sparse_matrix::iterator2Indexed Random Access Column/Row Iterator
+Indexed Random Access Column/Row Iterator
Description
-MatrixMatrix
+Matrix
Description
matrix<T, F, A> is the
base container adaptor for dense matrices. For a (m x
@@ -298,14 +298,14 @@ the reversed matrix.
Notes
-row_major and
column_major.unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .Identity Matrix
+Identity Matrix
Description
identity_matrix<T, ALLOC>
represents identity matrices. For a (m x n)-dimensional
@@ -455,7 +455,7 @@ end of the reversed identity_matrix.
-Zero Matrix
+Zero Matrix
Description
zero_matrix<T, ALLOC> represents
zero matrices. For a (m x n)-dimensional zero matrix and
@@ -601,7 +601,7 @@ end of the reversed zero_matrix.
-Scalar Matrix
+Scalar Matrix
Description
scalar_matrix<T, ALLOC>
represents scalar matrices. For a (m x n)-dimensional
diff --git a/doc/matrix_expression.htm b/doc/matrix_expression.htm
index 3960dec6..7f0b80fe 100644
--- a/doc/matrix_expression.htm
+++ b/doc/matrix_expression.htm
@@ -15,7 +15,7 @@
-Matrix ExpressionsMatrix Expression
+Matrix Expression
Description
matrix_expression<E>
is required to be a public base of all classes which model the Matrix Expression concept.Notes
operator[], row, column, range, slice and project functions have been removed. Use the free functions defined in matrix proxy instead.Matrix Container
+Matrix Container
Description
matrix_container<C>
is required to be a public base of all classes which model the Matrix concept.
@@ -110,7 +110,7 @@ const
-Matrix References
+Matrix References
Reference
Description
matrix_reference<E>
@@ -259,7 +259,7 @@ the reversed expression.
-Matrix Operations
+Matrix Operations
Unary Operation Description
Description
matrix_unary1<E, F> and
@@ -805,7 +805,7 @@ int main () {
std::cout << m * 2.0 << std::endl;
}
-Matrix Vector Operations
+Matrix Vector Operations
Binary Operation Description
Description
matrix_vector_binary1<E1, E2,
@@ -1146,7 +1146,7 @@ int main () {
std::cout << solve (v, m, lower_tag ()) << std::endl;
}
-Matrix Matrix Operations
+Matrix Matrix Operations
Binary Operation Description
Description
matrix_matrix_binary<E1, E2,
diff --git a/doc/matrix_proxy.htm b/doc/matrix_proxy.htm
index 56e774d9..a9ac949c 100644
--- a/doc/matrix_proxy.htm
+++ b/doc/matrix_proxy.htm
@@ -15,7 +15,7 @@
-
-Matrix ProxiesMatrix Row
+Matrix Row
Description
matrix_row<M> allows
addressing a row of a matrix.Matrix Column
+Matrix Column
Description
matrix_column<M> allows
addressing a column of a matrix.Vector Range
+Vector Range
Description
matrix_vector_range<M>
allows addressing a sub vector of a matrix.matrix_vector_range.
-Vector Slice
+Vector Slice
Description
matrix_vector_slice<M>
allows addressing a sliced sub vector of a matrix.matrix_vector_slice.
-Matrix Range
+Matrix Range
Description
matrix_range<M> allows
addressing a sub matrix of a matrix.Matrix Slice
+Matrix Slice
Description
matrix_slice<M> allows
addressing a sliced sub matrix of a matrix.
-Sparse MatriciesMapped Matrix
+Mapped Matrix
Description
mapped_matrix<T, F, A> is
the base container adaptor for sparse matricies using element maps.
@@ -311,15 +311,15 @@ the reversed mapped_matrix.
Notes
-row_major
and column_major.map_array<std::size_t, T> and
map_std<std::size_t, T>. The latter is
equivalent to std::map<std::size_t, T>.Compressed Matrix
+Compressed Matrix
Description
compressed_matrix<T, F, IB, IA,
TA> is the base container adaptor for compressed
@@ -628,18 +628,18 @@ the reversed compressed_matrix.
Notes
-row_major and column_major.0 and
1 at least.unbounded_array<> ,
bounded_array<> and
std::vector<> .Coordinate Matrix
+Coordinate Matrix
Description
coordinate_matrix<T, F, IB, IA,
TA> is the base container adaptor for compressed
@@ -954,13 +954,13 @@ the reversed coordinate_matrix.
Notes
-row_major and column_major.0 and
1 at least.unbounded_array<> ,
bounded_array<> and
diff --git a/doc/operations_overview.htm b/doc/operations_overview.htm
index ecb7ace1..77f8722e 100644
--- a/doc/operations_overview.htm
+++ b/doc/operations_overview.htm
@@ -42,7 +42,7 @@
are slices, e.g.
-slice(0, 1, 3)Basic Linear Algebra
+Basic Linear Algebra
standard operations: addition, subtraction, multiplication by a
scalar
@@ -81,7 +81,7 @@ w = conj(u); w = real(u); w = imag(u);
C = trans(A); C = conj(A); C = herm(A); C = real(A); C = imag(A);
Advanced functions
+Advanced functions
norms
@@ -129,7 +129,7 @@ opb_prod(A, B, C, false); // C += A * B
may give a speedup if A has less columns than rows,
because the product is computed as a sum of outer products.Submatrices, Subvectors
+Submatrices, Subvectors
project functions:
w = project(u, r); // the subvector of u specifed by the index range r
@@ -181,7 +181,7 @@ the column with a slice with stride 0 thus:
slice(0,0,2));
Speed improvements
+Speed improvements
Matrix / Vector assignment
-uBLAS OverviewRationale
+Rationale
NDEBUG preprocessor symbol of
<cassert>.Functionality
+Functionality
-Range and Slice StorageRange<SizeType,DistanceType>
+Range<SizeType,DistanceType>
Description
range specifies a range of indicies. The range is a sequence of indices
from a start value to stop value. The indices increase by one and exlude the stop value.
@@ -104,7 +104,7 @@ end of the reversed range.
start () <= stop ()Slice<SizeType,DistanceType>
+Slice<SizeType,DistanceType>
Description
slice specifies a 'slice' of indicies. Slices are more general
then ranges, the stride allows the sequence of indicies to increase and decrease by the specified amount between element.
diff --git a/doc/storage_concept.htm b/doc/storage_concept.htm
index 4d52a699..9d70eaeb 100644
--- a/doc/storage_concept.htm
+++ b/doc/storage_concept.htm
@@ -15,7 +15,7 @@
-Storage conceptStorage concept
+Storage concept
Description
-Sparse StorageDefault Standard Map
+Default Standard Map
Description
map_std<I, T, ALLOC> provides a
wrapper for the standard library associative container
@@ -69,7 +69,7 @@ int main () {
Container.Public base classes
Map Array
+Map Array
Description
map_array<I, T, ALLOC> implements a std::map like associative container as a sorted array. It therefore some of the Associative Container interface without having the same semantics as an std::map.
map_array has a capacity up to which new element can be inserted.
diff --git a/doc/symmetric.htm b/doc/symmetric.htm
index 27af0390..0f0d1f1a 100644
--- a/doc/symmetric.htm
+++ b/doc/symmetric.htm
@@ -15,7 +15,7 @@
-Symmetric MatrixSymmetric Matrix
+Symmetric Matrix
Description
symmetric_matrix<T, F1, F2,
A> is the base container adaptor for symmetric matrices.
@@ -60,19 +60,19 @@ int main () {
F1Functor describing the type of the symmetric matrix. [1]
+"#symmetric_matrix_1">[1]
lower
F2Functor describing the storage organization. [2]
+"#symmetric_matrix_2">[2]
row_major
@@ -302,18 +302,18 @@ the reversed AThe type of the adapted array. [3]
+>[3]
unbounded_array<T>symmetric_matrix.
Notes
-lower and upper.row_major and column_major.unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .Symmetric Adaptor
+Symmetric Adaptor
Description
symmetric_adaptor<M, F>
is a symmetric matrix adaptor for other matrices.symmetric_adaptor.
Notes
-lower and upper.
diff --git a/doc/triangular.htm b/doc/triangular.htm
index 5e0a4ddf..782d9948 100644
--- a/doc/triangular.htm
+++ b/doc/triangular.htm
@@ -15,7 +15,7 @@
-Triangular MatrixTriangular Matrix
+Triangular Matrix
Description
triangular_matrix<T, F1, F2,
A> is the base container adaptor for triangular matrices.
@@ -317,19 +317,19 @@ the reversed triangular_matrix.
Notes
-lower , unit_lower, upper
and unit_upper .row_major and column_major.unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .Triangular Adaptor
+Triangular Adaptor
Description
triangular_adaptor<M, F>
is a triangular matrix adaptor for other matrices.triangular_adaptor.
Notes
-lower , unit_lower, upper
and unit_upper .
-Unbounded Array StorageUnbounded Array
+Unbounded Array
Description
unbounded_array<T, ALLOC> implements a unbounded storage array using an allocator.
The unbounded array is similar to a std::vector in that in can grow in size beyond any fixed bound.
diff --git a/doc/vector.htm b/doc/vector.htm
index ed73dc1f..69862084 100644
--- a/doc/vector.htm
+++ b/doc/vector.htm
@@ -15,7 +15,7 @@
-VectorVector
+Vector
Description
vector<T, A> is the base
container adaptor for dense vectors. For a n-dimensional
@@ -347,11 +347,11 @@ the reversed vector.
Notes
-unbounded_array<T> ,
bounded_array<T> and
std::vector<T> .Unit Vector
+Unit Vector
Description
unit_vector<T, ALLOC> represents
canonical unit vectors. For the k-th
@@ -485,7 +485,7 @@ end of the reversed unit_vector.
-Zero Vector
+Zero Vector
Description
zero_vector<T, ALLOC> represents
zero vectors. For a n-dimensional zero vector and 0
@@ -610,7 +610,7 @@ end of the reversed zero_vector.
-Scalar Vector
+Scalar Vector
Description
scalar_vector<T, ALLOC>
represents scalar vectors. For a n-dimensional scalar
diff --git a/doc/vector_expression.htm b/doc/vector_expression.htm
index 82c207f9..80a50c96 100644
--- a/doc/vector_expression.htm
+++ b/doc/vector_expression.htm
@@ -15,7 +15,7 @@
-Vector ExpressionsVector Expression
+Vector Expression
Description
vector_expression<E>
is required to be a public base of all classes which model the Vector Expression concept.Notes
range, slice and project functions have been removed. Use the free functions defined in vector proxy instead.Vector Container
+Vector Container
Description
vector_container<C>
is required to be a public base of all classes which model the Vector concept.
@@ -112,7 +112,7 @@ const
-Vector References
+Vector References
Reference
Description
vector_reference<E>
@@ -214,7 +214,7 @@ the reversed expression.
-Vector Operations
+Vector Operations
Unary Operation Description
Description
vector_unary<E, F>
@@ -823,7 +823,7 @@ int main () {
std::cout << v * 2.0 << std::endl;
}
-Vector Reductions
+Vector Reductions
Unary Reductions
Prototypes
diff --git a/doc/vector_proxy.htm b/doc/vector_proxy.htm
index b5193224..45c70a9a 100644
--- a/doc/vector_proxy.htm
+++ b/doc/vector_proxy.htm
@@ -15,7 +15,7 @@
-
-Vector ProxiesVector Range
+Vector Range
Description
vector_range<V> allows
addressing a sub-range of a vector's element.Vector Slice
+Vector Slice
Description
vector_slice<V> allows
addressing a slice of a vector.
-Sparse VectorMapped Vector
+Mapped Vector
Description
mapped_vector<T, A> is
the base container adaptor for sparse vectors using element maps. For a
@@ -253,12 +253,12 @@ the reversed mapped_vector.
Notes
-map_array<std::size_t, T> and
map_std<std::size_t, T>. The latter is
equivalent to std::map<std::size_t, T>.Compressed Vector
+Compressed Vector
Description
compressed_vector<T, IB, IA,
TA> is the base container adaptor for compressed vectors.
@@ -509,15 +509,15 @@ the reversed compressed_vector.
Notes
-0 and
1 at least.unbounded_array<> ,
bounded_array<> and
std::vector<> .Coordinate Vector
+Coordinate Vector
Description
coordinate_vector<T, IB, IA,
TA> is the base container adaptor for compressed vectors.
@@ -774,10 +774,10 @@ the reversed coordinate_vector.
Notes
-0 and
1 at least.unbounded_array<> ,
bounded_array<> and