Boost C++ 库

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

对称矩阵

描述

模板类 symmetric_matrix<T, F1, F2, A> 是对称矩阵的基础容器适配器。对于一个 (n x n ) 维对称矩阵和 0 <= i < n, 0 <= j < n 成立 s_{i, j} = s_{j, i}。对称矩阵的存储是紧凑的。

示例

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

int main () {
    using namespace boost::numeric::ublas;
    symmetric_matrix<double, lower> ml (3, 3);
    for (unsigned i = 0; i < ml.size1 (); ++ i)
        for (unsigned j = 0; j <= i; ++ j)
            ml (i, j) = 3 * i + j;
    std::cout << ml << std::endl;
    symmetric_matrix<double, upper> mu (3, 3);
    for (unsigned i = 0; i < mu.size1 (); ++ i)
        for (unsigned j = i; j < mu.size2 (); ++ j)
            mu (i, j) = 3 * i + j;
    std::cout << mu << std::endl;
}

定义

定义于头文件 symmetric.hpp。

模板参数

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

模型

Matrix .

类型要求

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

公共基类

matrix_container<symmetric_matrix<T, F1, F2, A> >

成员

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

注释

[1] 对称矩阵类型支持的参数为 lower 和 upper。

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

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

对称适配器

描述

模板类 symmetric_adaptor<M, F> 是用于其他矩阵的对称矩阵适配器。

示例

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

int main () {
    using namespace boost::numeric::ublas;
    matrix<double> m (3, 3);
    symmetric_adaptor<matrix<double>, lower> sal (m);
    for (unsigned i = 0; i < sal.size1 (); ++ i)
        for (unsigned j = 0; j <= i; ++ j)
            sal (i, j) = 3 * i + j;
    std::cout << sal << std::endl;
    symmetric_adaptor<matrix<double>, upper> sau (m);
    for (unsigned i = 0; i < sau.size1 (); ++ i)
        for (unsigned j = i; j < sau.size2 (); ++ j)
            sau (i, j) = 3 * i + j;
    std::cout << sau << std::endl;
}

定义

定义于头文件 symmetric.hpp。

模板参数

参数	描述	默认值
`M`	适配矩阵的类型。
`F`	描述对称适配器类型的 Functor。 [1]	`lower`

模型

矩阵表达式 .

类型要求

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

公共基类

matrix_expression<symmetric_adaptor<M, F> >

成员

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

注释

[1] 对称适配器类型支持的参数为 lower 和 upper。

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