tf.linalg.LinearOperatorHouseholder
LinearOperator действует как пакет преобразований Хаусхолдера.
Наследует от: LinearOperator, Module
tf.linalg.LinearOperatorHouseholder(
reflection_axis,
is_non_singular=None,
is_self_adjoint=None,
is_positive_definite=None,
is_square=None,
name='LinearOperatorHouseholder'
)
Этот оператор действует как пакет отражений Хаусхолдера с формой [B1,...,Bb, N, N] для некоторого b >= 0. Первые b индексов задают индекс элемента пакета. Для каждого индекса пакета (i1,...,ib), A[i1,...,ib, : :] является матрицей N x N. Эта матрица A не материализуется, однако для целей broadcasting эта форма имеет значение.
LinearOperatorHouseholder инициализируется вектором (пакетом векторов).
Отражение Хаусхолдера, заданное вектором v, отражает точки в R^n относительно гиперплоскости, перпендикулярной v и проходящей через начало координат.
# Create a 2 x 2 householder transform.
vec = [1 / np.sqrt(2), 1. / np.sqrt(2)]
operator = LinearOperatorHouseholder(vec)
operator.to_dense()
==> [[0., -1.]
[-1., -0.]]
operator.shape
==> [2, 2]
operator.log_abs_determinant()
==> scalar Tensor
x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor
Совместимость форм
Этот оператор действует на матрицу (пакет матриц) совместимой формы. x — матрица-пакет совместимой формы для matmul и solve, если
operator.shape = [B1,...,Bb] + [N, N], with b >= 0 x.shape = [C1,...,Cc] + [N, R], and [C1,...,Cc] broadcasts with [B1,...,Bb] to [D1,...,Dd]
Подсказки о свойствах матрицы
Этот LinearOperator инициализируется булевыми флагами вида is_X для X = non_singular, self_adjoint, positive_definite, square. Они имеют следующий смысл:
- Если
is_X == True, ожидается, что оператор обладает свойствомX. Это обещание, которое должно выполняться, но оно не является проверкой во время выполнения. Например, ограниченная точность чисел с плавающей запятой может привести к нарушению этих обещаний. - Если
is_X == False, ожидается, что оператор не обладает свойствомX. - Если
is_X == None(значение по умолчанию), ожидать какого-либо результата не следует.
| Аргументы | |
|---|---|
reflection_axis | Форма [B1,...,Bb, N] Tensor с b >= 0 N >= 0. Вектор, задающий гиперплоскость, относительно которой выполняется отражение. Допустимые типы данных: float16, float32, float64, complex64, complex128. |
is_non_singular | Ожидается, что этот оператор невырожденный. |
is_self_adjoint | Ожидается, что этот оператор равен своему эрмитово-сопряжённому. Автоматически устанавливается в значение true |
is_positive_definite | Ожидается, что этот оператор положительно определён, то есть квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости мы не требуем, чтобы оператор был самосопряжённым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices Автоматически устанавливается в значение false. |
is_square | Ожидается, что этот оператор действует как квадратные матрицы (пакет матриц). Автоматически устанавливается в значение true. |
name | Имя для этого LinearOperator. |
| Исключения | |
|---|---|
ValueError | is_self_adjoint не является True, is_positive_definite не является False или is_square не является True. |
| Атрибуты | |
|---|---|
H | Возвращает присоединённый оператор к текущему LinearOperator. Для |
batch_shape | TensorShape пакетных измерений этого LinearOperator. Если этот оператор действует как матрица-пакет |
domain_dimension | Размерность (в смысле векторных пространств) области определения этого оператора. Если этот оператор действует как матрица-пакет |
dtype | DType обрабатываемых этим LinearOperator Tensor. |
graph_parents | Список зависимостей графа для этого LinearOperator. (Устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
parameters | Словарь параметров, использованных для создания этого LinearOperator. |
range_dimension | Размерность (в смысле векторных пространств) образа этого оператора. Если этот оператор действует как матрица-пакет |
reflection_axis | |
shape | TensorShape этого LinearOperator. Если этот оператор действует как матрица-пакет |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как матрица-пакет |
Методы
add_to_tensor
add_to_tensor(
x, name='add_to_tensor'
)
Добавляет матрицу, представленную этим оператором, к x. Эквивалентно A + x.
| Аргументы | |
|---|---|
x | Tensor с тем же dtype и формой, совместимой с broadcasting с self.shape. |
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с формой, полученной broadcasting, и тем же dtype, что и у self. |
adjoint
adjoint(
name: str = 'adjoint'
) -> 'LinearOperator'
Возвращает присоединённый оператор к текущему LinearOperator.
Для A, представляющего этот LinearOperator, возвращает A*. Обратите внимание, что вызовы self.adjoint() и self.H эквивалентны.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
LinearOperator, представляющий присоединённый оператор к этому LinearOperator. |
assert_non_singular
assert_non_singular(
name='assert_non_singular'
)
Возвращает Op, проверяющий, что оператор невырожденный.
Оператор считается невырожденным, если
ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps
| Аргументы | |
|---|---|
name | Строковое имя, добавляемое в начало имён создаваемых операций. |
| Возвращает | |
|---|---|
Assert Op, выполнение которого вызовет InvalidArgumentError, если оператор вырожден. |
assert_positive_definite
assert_positive_definite(
name='assert_positive_definite'
)
Возвращает Op, проверяющий, что оператор положительно определён.
Здесь положительная определённость означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости мы не требуем, чтобы оператор был самосопряжённым.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Assert Op, выполнение которого вызовет InvalidArgumentError, если оператор не является положительно определённым. |
assert_self_adjoint
assert_self_adjoint(
name='assert_self_adjoint'
)
Возвращает Op, проверяющий, что оператор самосопряжённый.
Здесь мы проверяем, что этот оператор точно равен своему эрмитово-сопряжённому.
| Аргументы | |
|---|---|
name | Строковое имя, добавляемое в начало имён создаваемых операций. |
| Возвращает | |
|---|---|
Assert Op, выполнение которого вызовет InvalidArgumentError, если оператор не является самосопряжённым. |
batch_shape_tensor
batch_shape_tensor(
name='batch_shape_tensor'
)
Форма пакетных измерений этого оператора, определяемая во время выполнения.
Если этот оператор действует как матрица-пакет A с A.shape = [B1,...,Bb, M, N], этот метод возвращает Tensor, содержащий [B1,...,Bb].
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
int32 Tensor |
cholesky
cholesky(
name: str = 'cholesky'
) -> 'LinearOperator'
Возвращает разложение Холецкого в виде LinearOperator.
Для A, представляющего этот LinearOperator, если A положительно определён и самосопряжён, возвращает L, где A = L L^T, то есть разложение Холецкого.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
LinearOperator, представляющий нижнюю треугольную матрицу разложения Холецкого. |
| Исключения | |
|---|---|
ValueError | Если для LinearOperator не указано, что он положительно определён и самосопряжён. |
cond
cond(
name='cond'
)
Возвращает число обусловленности этого линейного оператора.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Форма [B1,...,Bb] Tensor с тем же dtype, что и у self. |
determinant
determinant(
name='det'
)
Определитель для каждого элемента пакета.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с формой self.batch_shape и тем же dtype, что и у self. |
| Исключения | |
|---|---|
NotImplementedError | Если self.is_square является False. |
diag_part
diag_part(
name='diag_part'
)
Эффективно получает диагональную часть (пакет диагональных частей) этого оператора.
Если форма этого оператора — [B1,...,Bb, M, N], метод возвращает Tensor diagonal формы [B1,...,Bb, min(M, N)], где diagonal[b1,...,bb, i] = self.to_dense()[b1,...,bb, i, i].
my_operator = LinearOperatorDiag([1., 2.]) # Efficiently get the diagonal my_operator.diag_part() ==> [1., 2.] # Equivalent, but inefficient method tf.linalg.diag_part(my_operator.to_dense()) ==> [1., 2.]
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
diag_part | Tensor с тем же dtype, что и у текущего объекта. |
domain_dimension_tensor
domain_dimension_tensor(
name='domain_dimension_tensor'
)
Размерность (в смысле векторных пространств) области определения этого оператора.
Определяется во время выполнения.
Если этот оператор действует как матрица-пакет A с A.shape = [B1,...,Bb, M, N], этот метод возвращает N.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
int32 Tensor |
eigvals
eigvals(
name='eigvals'
)
Возвращает собственные значения этого линейного оператора.
Если оператор помечен как самосопряжённый (с помощью is_self_adjoint), вычисление может быть эффективнее.
Примечание: В настоящее время поддерживаются только самосопряжённые операторы.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Форма [B1,...,Bb, N] Tensor с тем же dtype, что и у self. |
inverse
inverse(
name: str = 'inverse'
) -> 'LinearOperator'
Возвращает обратный оператор для этого LinearOperator.
Для A, представляющего этот LinearOperator, возвращает LinearOperator, представляющий A^-1.
| Аргументы | |
|---|---|
name | Пространство имён, используемое для операций, добавляемых этим методом. |
| Возвращает | |
|---|---|
LinearOperator, представляющий обратную матрицу. |
| Исключения | |
|---|---|
ValueError | Если для LinearOperator не указано, что он является non_singular. |
log_abs_determinant
log_abs_determinant(
name='log_abs_det'
)
Логарифм абсолютного значения определителя для каждого элемента пакета.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с формой self.batch_shape и тем же dtype, что и у self. |
| Исключения | |
|---|---|
NotImplementedError | Если self.is_square является False. |
matmul
matmul(
x, adjoint=False, adjoint_arg=False, name='matmul'
)
Преобразует матрицу (пакет матриц) x умножением слева: x --> Ax.
# Make an operator acting like batch matrix A. Assume A.shape = [..., M, N] operator = LinearOperator(...) operator.shape = [..., M, N] X = ... # shape [..., N, R], batch matrix, R > 0. Y = operator.matmul(X) Y.shape ==> [..., M, R] Y[..., :, r] = sum_j A[..., :, j] X[j, r]
| Аргументы | |
|---|---|
x | LinearOperator или Tensor совместимой формы и с тем же dtype, что и у self. Определение совместимости см. в документации класса. |
adjoint | Объект Python типа bool. Если True, умножает слева на присоединённый оператор: A^H x. |
adjoint_arg | Объект Python типа bool. Если True, вычисляет A x^H, где x^H — эрмитово-сопряжённая матрица (транспонирование и комплексное сопряжение). |
name | Имя для этого Op. |
| Возвращает | |
|---|---|
LinearOperator или Tensor с формой [..., M, R] и тем же dtype, что и у self. |
matvec
matvec(
x, adjoint=False, name='matvec'
)
Преобразует вектор (пакет векторов) x умножением слева: x --> Ax.
# Make an operator acting like batch matrix A. Assume A.shape = [..., M, N] operator = LinearOperator(...) X = ... # shape [..., N], batch vector Y = operator.matvec(X) Y.shape ==> [..., M] Y[..., :] = sum_j A[..., :, j] X[..., j]
| Аргументы | |
|---|---|
x | Tensor совместимой формы и с тем же dtype, что и у self. x рассматривается как вектор (пакет векторов): для каждого набора ведущих измерений последнее измерение задаёт вектор. Определение совместимости см. в документации класса. |
adjoint | Объект Python типа bool. Если True, умножает слева на присоединённый оператор: A^H x. |
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с формой [..., M] и тем же dtype, что и у self. |
range_dimension_tensor
range_dimension_tensor(
name='range_dimension_tensor'
)
Размерность (в смысле векторных пространств) образа этого оператора.
Определяется во время выполнения.
Если этот оператор действует как матрица-пакет A с A.shape = [B1,...,Bb, M, N], этот метод возвращает M.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
int32 Tensor |
shape_tensor
shape_tensor(
name='shape_tensor'
)
Форма этого LinearOperator, определяемая во время выполнения.
Если этот оператор действует как матрица-пакет A с A.shape = [B1,...,Bb, M, N], этот метод возвращает Tensor, содержащий [B1,...,Bb, M, N], что эквивалентно tf.shape(A).
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
int32 Tensor |
solve
solve(
rhs, adjoint=False, adjoint_arg=False, name='solve'
)
Решает (точно или приближённо) системы уравнений R (пакет систем): A X = rhs.
Возвращаемое Tensor будет близко к точному решению, если A хорошо обусловлена. В противном случае степень близости будет различаться. Подробности см. в строке документации класса.
Примеры:
# Make an operator acting like batch matrix A. Assume A.shape = [..., M, N] operator = LinearOperator(...) operator.shape = [..., M, N] # Solve R > 0 linear systems for every member of the batch. RHS = ... # shape [..., M, R] X = operator.solve(RHS) # X[..., :, r] is the solution to the r'th linear system # sum_j A[..., :, j] X[..., j, r] = RHS[..., :, r] operator.matmul(X) ==> RHS
| Аргументы | |
|---|---|
rhs | Tensor с тем же dtype, что и у этого оператора, и совместимой формой. rhs рассматривается как [пакетная] матрица: для каждого набора ведущих измерений последние два измерения задают матрицу. Определение совместимости см. в строке документации класса. |
adjoint | Объект Python bool. Если True, решить систему с использованием сопряжённого оператора этого LinearOperator: A^H X = rhs. |
adjoint_arg | Объект Python bool. Если True, решить A X = rhs^H, где rhs^H — эрмитово транспонирование (транспонирование и комплексное сопряжение). |
name | Пространство имён для операций, добавляемых этим методом. |
| Возвращает | |
|---|---|
Tensor с формой [...,N, R] и тем же dtype, что и у rhs. |
| Вызывает исключение | |
|---|---|
NotImplementedError | Если self.is_non_singular или is_square имеет значение False. |
solvevec
solvevec(
rhs, adjoint=False, name='solve'
)
Решить одно уравнение с максимально возможной точностью: A X = rhs.
Возвращаемое Tensor будет близко к точному решению, если A хорошо обусловлена. В противном случае степень близости будет различаться. Подробности см. в строке документации класса.
Примеры:
# Make an operator acting like batch matrix A. Assume A.shape = [..., M, N] operator = LinearOperator(...) operator.shape = [..., M, N] # Solve one linear system for every member of the batch. RHS = ... # shape [..., M] X = operator.solvevec(RHS) # X is the solution to the linear system # sum_j A[..., :, j] X[..., j] = RHS[..., :] operator.matvec(X) ==> RHS
| Аргументы | |
|---|---|
rhs | Tensor с тем же dtype, что и у этого оператора. rhs рассматривается как [пакетный] вектор: для каждого набора ведущих измерений последнее измерение задаёт вектор. Определение совместимости пакетных измерений см. в строке документации класса. |
adjoint | Объект Python bool. Если True, решить систему с использованием сопряжённого оператора этого LinearOperator: A^H X = rhs. |
name | Пространство имён для операций, добавляемых этим методом. |
| Возвращает | |
|---|---|
Tensor с формой [...,N] и тем же dtype, что и у rhs. |
| Вызывает исключение | |
|---|---|
NotImplementedError | Если self.is_non_singular или is_square имеет значение False. |
tensor_rank_tensor
tensor_rank_tensor(
name='tensor_rank_tensor'
)
Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.
Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], этот метод возвращает b + 2.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
int32 Tensor, определяемый во время выполнения. |
to_dense
to_dense(
name='to_dense'
)
Возвращает плотную (пакетную) матрицу, представляющую этот оператор.
trace
trace(
name='trace'
)
След линейного оператора, равный сумме self.diag_part().
Если оператор квадратный, это также сумма собственных значений.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Форма [B1,...,Bb] Tensor с тем же dtype, что и у self. |
__getitem__
__getitem__(
slices
)
__matmul__
__matmul__(
other
)
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/linalg/LinearOperatorHouseholder