Симметричная матрица

Описание

Шаблонный класс 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;
}

Будет выведено на экран:

[3,3]((0,3,6),(3,4,7),(6,7,8))
[3,3]((0,1,2),(1,4,5),(2,5,8))

Определение

Определена в заголовочном файле symmetric.hpp.

Параметры шаблона

Параметр	Описание	Значение по умолчанию
`T`	Тип объектов, размещаемых в матрице.
`F1`	Функциональный элемент, описывающий тип симметричной матрицы. [1]	`lower`
`F2`	Функция, определяющая организацию хранения. [2]	`row_major`
`A`	Тип адаптированного (присоединенного) массива. [3]	`unbounded_array<T>`

Функции-члены

Member	Description
`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`	Возвращает `const` ссылку на элемент в i-ой строке и j-ом столбце.
`reference operator () (size_type i, size_type j)`	Возвращает ссылку на элемент в i-ой строке и 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)`	Вставляет значение `t` в `j`-ый столбец `i`-ой строки.
`void erase (size_type i, size_type j)`	Удаляет значение `t` в `j`-ом столбце `i`-ой строки.
`void clear ()`	Очищает матрицу.
`const_iterator1 begin1 () const`	Возвращает `const_iterator1`, указывающий на начало `symmetric_matrix`.
`const_iterator1 end1 () const`	Возвращает `const_iterator1`, указывающий на конец `symmetric_matrix`.
`iterator1 begin1 ()`	Возвращает `iterator1`, указывающий на начало `symmetric_matrix`.
`iterator1 end1 ()`	Возвращает `iterator1`, указывающий на конец `symmetric_matrix`.
`const_iterator2 begin2 () const`	Возвращает `const_iterator2`, указывающий на начало `symmetric_matrix`.
`const_iterator2 end2 () const`	Возвращает `const_iterator2`, указывающий на конец `symmetric_matrix`.
`iterator2 begin2 ()`	Возвращает `iterator2`, указывающий на начало `symmetric_matrix`.
`iterator2 end2 ()`	Возвращает `iterator2`, указывающий на конец `symmetric_matrix`.
`const_reverse_iterator1 rbegin1 () const`	Возвращает `const_reverse_iterator1`, указывающий на начало инвертированной (обратной) `symmetric_matrix`.
`const_reverse_iterator1 rend1 () const`	Возвращает `const_reverse_iterator1`, указывающий на конец инвертированной (обратной) `symmetric_matrix`.
`reverse_iterator1 rbegin1 ()`	Возвращает `reverse_iterator1`, указывающий на начало инвертированной (обратной) `symmetric_matrix`.
`reverse_iterator1 rend1 ()`	Возвращает `reverse_iterator1`, указывающий на конец инвертированной (обратной) `symmetric_matrix`.
`const_reverse_iterator2 rbegin2 () const`	Возвращает `const_reverse_iterator2`, указывающий на начало инвертированной (обратной) `symmetric_matrix`.
`const_reverse_iterator2 rend2 () const`	Возвращает `const_reverse_iterator2`, указывающий на конец инвертированной (обратной) `symmetric_matrix`.
`reverse_iterator2 rbegin2 ()`	Возвращает `reverse_iterator2`, указывающий на начало инвертированной (обратной) `symmetric_matrix`.
`reverse_iterator2 rend2 ()`	Возвращает `reverse_iterator2`, указывающий на конец инвертированной (обратной) `symmetric_matrix`.

Примечание

[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;
}

Будет выведено на экран:

[3,3]((0,3,6),(3,4,7),(6,7,8))
[3,3]((0,1,2),(1,4,5),(2,5,8))

Определение

Определен в заголовочном файле symmetric.hpp.

Параметры шаблона

Параметр	Описание	Значение по умолчанию
`M`	Тип адаптированной (присоединенной) матрицы.
`F`	Функциональный элемент, описывающий тип треугольного адаптера. [1]	`lower`

Функции-члены

Функция-член	Описание
`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`	Возвращает `const` ссылку на элемент в `i`-ой стоке и `j`-ом столбцы.
`reference operator () (size_type i, size_type j)`	Возвращает ссылку на элемент в `i`-ой стоке и `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`	Возвращает `const_iterator1`, указывающий на начало `symmetric_adaptor`.
`const_iterator1 end1 () const`	Возвращает `const_iterator1`, указывающий на конец `symmetric_adaptor`.
`iterator1 begin1 ()`	Возвращает `iterator1`, указывающий на начало `symmetric_adaptor`.
`iterator1 end1 ()`	Возвращает `iterator1`, указывающий на конец `symmetric_adaptor`.
`const_iterator2 begin2 () const`	Возвращает `const_iterator2`, указывающий на начало `symmetric_adaptor`.
`const_iterator2 end2 () const`	Возвращает `const_iterator2`, указывающий на конец `symmetric_adaptor`.
`iterator2 begin2 ()`	Возвращает `iterator2`, указывающий на начало `symmetric_adaptor`.
`iterator2 end2 ()`	Возвращает `iterator2`, указывающий на конец `symmetric_adaptor`.
`const_reverse_iterator1 rbegin1 () const`	Возвращает `const_reverse_iterator1`, указывающий на начало инвертированного (обратного) `symmetric_adaptor`.
`const_reverse_iterator1 rend1 () const`	Возвращает `const_reverse_iterator1`, указывающий на конец инвертированного (обратного) `symmetric_adaptor`.
`reverse_iterator1 rbegin1 ()`	Возвращает `reverse_iterator1`, указывающий на начало инвертированного (обратного) `symmetric_adaptor`.
`reverse_iterator1 rend1 ()`	Возвращает `reverse_iterator1`, указывающий на конец инвертированного (обратного) `symmetric_adaptor`.
`const_reverse_iterator2 rbegin2 () const`	Возвращает `const_reverse_iterator2`, указывающий на начало инвертированного (обратного) `symmetric_adaptor`.
`const_reverse_iterator2 rend2 () const`	Возвращает `const_reverse_iterator2`, указывающий на конец инвертированного (обратного) `symmetric_adaptor`.
`reverse_iterator2 rbegin2 ()`	Возвращает `reverse_iterator2`, указывающий на начало инвертированного (обратного) `symmetric_adaptor`.
`reverse_iterator2 rend2 ()`	Возвращает `reverse_iterator2`, указывающий на конец инвертированного (обратного) `symmetric_adaptor`.

Notes

[1] Поддерживаемые параметры типов симметричных адаптеров: lower и upper.

Copyright (©) 2000-2002 Joerg Walter, Mathias Koch
Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided ``as is'' without express or implied warranty, and with no claim as to its suitability for any purpose.

Перевод с оригинала: Кулиш. В. И. 2006 год.