Boost C++ 库

...世界上最受推崇和设计最精良的 C++ 库项目之一。 — Herb Sutter 和 Andrei Alexandrescu, C++ 编码标准

带状矩阵

描述

模板类 banded_matrix<T, F, A> 是带状矩阵的基础容器适配器。对于一个 (m x n) 维带状矩阵，具有 l 条下对角线和 u 条上对角线，且 0 <= i < m, 0 <= j < n 成立 b_{i, j} = 0，如果 i > j + l 或 i < j - u。带状矩阵的存储是紧凑的。

示例

#include <boost/numeric/ublas/banded.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    banded_matrix<double> m (3, 3, 1, 1);
    for (signed i = 0; i < signed (m.size1 ()); ++ i)
        for (signed j = std::max (i - 1, 0); j < std::min (i + 2, signed (m.size2 ())); ++ j)
            m (i, j) = 3 * i + j;
    std::cout << m << std::endl;
}

定义

定义于头文件 banded.hpp 中。

模板参数

参数	描述	默认值
`T`	存储在矩阵中的对象的类型。
`F`	描述存储组织的 Functor。[1]	`row_major`
`A`	适配数组的类型。[2]	`unbounded_array<T>`

模型

矩阵 .

类型要求

无，除了矩阵的要求所施加的那些。

公共基类

matrix_container<banded_matrix<T, F, A> >

成员

成员	描述
`banded_matrix ()`	分配一个未初始化的 `banded_matrix`，它包含零行零个元素。
`banded_matrix (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0)`	分配一个未初始化的 `banded_matrix`，它在具有 `size1` 行和 `size2` 个元素的矩阵的主对角线周围包含 `(lower + 1 + upper)` 条对角线。
`banded_matrix (const banded_matrix &m)`	复制构造函数。
`template<class AE> banded_matrix (const matrix_expression<AE> &ae)`	扩展复制构造函数。
`void resize (size_type size1, size_type size2, size_type lower = 0, size_type upper = 0, bool preserve = true)`	重新分配一个 `banded_matrix`，使其在具有 `size1` 行和 `size2` 个元素的矩阵的主对角线周围包含 `(lower + 1 + upper)` 条对角线。当指定时，`banded_matrix` 的现有元素将被保留。
`size_type size1 () const`	返回行数。
`size_type size2 () const`	返回列数。
`size_type lower () const`	返回主对角线下方对角线的数量。
`size_type upper () const`	返回主对角线上方对角线的数量。
`const_reference operator () (size_type i, size_type j) const`	返回 `i`-th 行中第 `j`-th 个元素的 `const` 引用。
`reference operator () (size_type i, size_type j)`	返回 `i`-th 行中第 `j`-th 个元素的引用。
`banded_matrix &operator = (const banded_matrix &m)`	赋值运算符。
`banded_matrix &assign_temporary (banded_matrix &m)`	分配一个临时对象。可能会更改带状矩阵 `m`。
`template<class AE> banded_matrix &operator = (const matrix_expression<AE> &ae)`	扩展赋值运算符。
`template<class AE> banded_matrix &assign (const matrix_expression<AE> &ae)`	将矩阵表达式赋值给带状矩阵。赋值的左侧和右侧应相互独立。
`template<class AE> banded_matrix &operator += (const matrix_expression<AE> &ae)`	复合赋值运算符。将矩阵表达式加到带状矩阵上。
`template<class AE> banded_matrix &plus_assign (const matrix_expression<AE> &ae)`	将矩阵表达式加到带状矩阵上。赋值的左侧和右侧应相互独立。
`template<class AE> banded_matrix &operator -= (const matrix_expression<AE> &ae)`	复合赋值运算符。从带状矩阵中减去矩阵表达式。
`template<class AE> banded_matrix &minus_assign (const matrix_expression<AE> &ae)`	从带状矩阵中减去矩阵表达式。赋值的左侧和右侧应相互独立。
`template<class AT> banded_matrix &operator *= (const AT &at)`	复合赋值运算符。将带状矩阵与标量相乘。
`template<class AT> banded_matrix &operator /= (const AT &at)`	复合赋值运算符。将带状矩阵除以标量。
`void swap (banded_matrix &m)`	交换带状矩阵的内容。
`void insert (size_type i, size_type j, const_reference t)`	在 `i`-th 行的第 `j`-th 个元素处插入值 `t`。
`void erase (size_type i, size_type j)`	删除 `i`-th 行的第 `j`-th 个元素处的值。
`void clear ()`	清空矩阵。
`const_iterator1 begin1 () const`	返回一个指向 `banded_matrix` 开头的 `const_iterator1`。
`const_iterator1 end1 () const`	返回一个指向 `banded_matrix` 结尾的 `const_iterator1`。
`iterator1 begin1 ()`	返回一个指向 `banded_matrix` 开头的 `iterator1`。
`iterator1 end1 ()`	返回一个指向 `banded_matrix` 结尾的 `iterator1`。
`const_iterator2 begin2 () const`	返回一个指向 `banded_matrix` 开头的 `const_iterator2`。
`const_iterator2 end2 () const`	返回一个指向 `banded_matrix` 结尾的 `const_iterator2`。
`iterator2 begin2 ()`	返回一个指向 `banded_matrix` 开头的 `iterator2`。
`iterator2 end2 ()`	返回一个指向 `banded_matrix` 结尾的 `iterator2`。
`const_reverse_iterator1 rbegin1 () const`	返回一个指向反向 `banded_matrix` 开头的 `const_reverse_iterator1`。
`const_reverse_iterator1 rend1 () const`	返回一个指向反向 `banded_matrix` 结尾的 `const_reverse_iterator1`。
`reverse_iterator1 rbegin1 ()`	返回一个指向反向 `banded_matrix` 开头的 `reverse_iterator1`。
`reverse_iterator1 rend1 ()`	返回一个指向反向 `banded_matrix` 结尾的 `reverse_iterator1`。
`const_reverse_iterator2 rbegin2 () const`	返回一个指向反向 `banded_matrix` 开头的 `const_reverse_iterator2`。
`const_reverse_iterator2 rend2 () const`	返回一个指向反向 `banded_matrix` 结尾的 `const_reverse_iterator2`。
`reverse_iterator2 rbegin2 ()`	返回一个指向反向 `banded_matrix` 开头的 `reverse_iterator2`。
`reverse_iterator2 rend2 ()`	返回一个指向反向 `banded_matrix` 结尾的 `reverse_iterator2`。

注释

[1] 存储组织支持的参数为 row_major 和 column_major。

[2] 适配数组支持的参数为 unbounded_array<T>、bounded_array<T> 和 std::vector<T>。

带状适配器

描述

模板类 banded_adaptor<M> 是其他矩阵的带状矩阵适配器。

示例

#include <boost/numeric/ublas/banded.hpp>
#include <boost/numeric/ublas/io.hpp>

int main () {
    using namespace boost::numeric::ublas;
    matrix<double> m (3, 3);
    banded_adaptor<matrix<double> > ba (m, 1, 1);
    for (signed i = 0; i < signed (ba.size1 ()); ++ i)
        for (signed j = std::max (i - 1, 0); j < std::min (i + 2, signed (ba.size2 ())); ++ j)
            ba (i, j) = 3 * i + j;
    std::cout << ba << std::endl;
}

定义

定义于头文件 banded.hpp 中。

模板参数

参数	描述	默认值
`M`	适配矩阵的类型。

模型

矩阵表达式 .

类型要求

无，除了矩阵表达式的要求所施加的那些。

公共基类

matrix_expression<banded_adaptor<M> >

成员

成员	描述
`banded_adaptor (matrix_type &data, size_type lower = 0, size_type upper = 0)`	构造一个 `banded_adaptor`，它在矩阵的主对角线周围包含 `(lower + 1 + upper)` 条对角线。
`banded_adaptor (const banded_adaptor &m)`	复制构造函数。
`template<class AE> banded_adaptor (const matrix_expression<AE> &ae)`	扩展复制构造函数。
`size_type size1 () const`	返回行数。
`size_type size2 () const`	返回列数。
`size_type lower () const`	返回主对角线下方对角线的数量。
`size_type upper () const`	返回主对角线上方对角线的数量。
`const_reference operator () (size_type i, size_type j) const`	返回 `i`-th 行中第 `j`-th 个元素的 `const` 引用。
`reference operator () (size_type i, size_type j)`	返回 `i`-th 行中第 `j`-th 个元素的引用。
`banded_adaptor &operator = (const banded_adaptor &m)`	赋值运算符。
`banded_adaptor &assign_temporary (banded_adaptor &m)`	分配一个临时对象。可能会更改带状适配器 `m`。
`template<class AE> banded_adaptor &operator = (const matrix_expression<AE> &ae)`	扩展赋值运算符。
`template<class AE> banded_adaptor &assign (const matrix_expression<AE> &ae)`	将矩阵表达式赋值给带状适配器。赋值的左侧和右侧应相互独立。
`template<class AE> banded_adaptor &operator += (const matrix_expression<AE> &ae)`	复合赋值运算符。将矩阵表达式加到带状适配器上。
`template<class AE> banded_adaptor &plus_assign (const matrix_expression<AE> &ae)`	将矩阵表达式加到带状适配器上。赋值的左侧和右侧应相互独立。
`template<class AE> banded_adaptor &operator -= (const matrix_expression<AE> &ae)`	复合赋值运算符。从带状适配器中减去矩阵表达式。
`template<class AE> banded_adaptor &minus_assign (const matrix_expression<AE> &ae)`	从带状适配器中减去矩阵表达式。赋值的左侧和右侧应相互独立。
`template<class AT> banded_adaptor &operator *= (const AT &at)`	复合赋值运算符。将带状适配器与标量相乘。
`template<class AT> banded_adaptor &operator /= (const AT &at)`	复合赋值运算符。将带状适配器除以标量。
`void swap (banded_adaptor &m)`	交换带状适配器的内容。
`const_iterator1 begin1 () const`	返回一个指向 `banded_adaptor` 开头的 `const_iterator1`。
`const_iterator1 end1 () const`	返回一个指向 `banded_adaptor` 结尾的 `const_iterator1`。
`iterator1 begin1 ()`	返回一个指向 `banded_adaptor` 开头的 `iterator1`。
`iterator1 end1 ()`	返回一个指向 `banded_adaptor` 结尾的 `iterator1`。
`const_iterator2 begin2 () const`	返回一个指向 `banded_adaptor` 开头的 `const_iterator2`。
`const_iterator2 end2 () const`	返回一个指向 `banded_adaptor` 结尾的 `const_iterator2`。
`iterator2 begin2 ()`	返回一个指向 `banded_adaptor` 开头的 `iterator2`。
`iterator2 end2 ()`	返回一个指向 `banded_adaptor` 结尾的 `iterator2`。
`const_reverse_iterator1 rbegin1 () const`	返回一个指向反向 `banded_adaptor` 开头的 `const_reverse_iterator1`。
`const_reverse_iterator1 rend1 () const`	返回一个指向反向 `banded_adaptor` 结尾的 `const_reverse_iterator1`。
`reverse_iterator1 rbegin1 ()`	返回一个指向反向 `banded_adaptor` 开头的 `reverse_iterator1`。
`reverse_iterator1 rend1 ()`	返回一个指向反向 `banded_adaptor` 结尾的 `reverse_iterator1`。
`const_reverse_iterator2 rbegin2 () const`	返回一个指向反向 `banded_adaptor` 开头的 `const_reverse_iterator2`。
`const_reverse_iterator2 rend2 () const`	返回一个指向反向 `banded_adaptor` 结尾的 `const_reverse_iterator2`。
`reverse_iterator2 rbegin2 ()`	返回一个指向反向 `banded_adaptor` 开头的 `reverse_iterator2`。
`reverse_iterator2 rend2 ()`	返回一个指向反向 `banded_adaptor` 结尾的 `reverse_iterator2`。

版权 (©) 2000-2002 Joerg Walter, Mathias Koch
使用、修改和分发受 Boost 软件许可协议 1.0 版的约束。（请参阅随附文件 LICENSE_1_0.txt 或在 https://boost.ac.cn/LICENSE_1_0.txt 复制）。