tf.linalg.LinearOperatorDiag
| Просмотреть исходный код на GitHub |
LinearOperator действуя как [пакетная] квадратная диагональная матрица.
Наследуется от: LinearOperator
tf.linalg.LinearOperatorDiag(
diag, is_non_singular=None, is_self_adjoint=None, is_positive_definite=None,
is_square=None, name='LinearOperatorDiag'
)
Этот оператор действует как [пакетная] диагональная матрица A с формой [B1,...,Bb, N, N] для некоторого b >= 0. Первые b индексы индексируют элемент пакета. Для каждого индекса пакета (i1,...,ib), A[i1,...,ib, : :] представляет собой N x N матрицу. Эта матрица A не материализуется, но для целей вещания эта форма будет релевантна.
LinearOperatorDiag инициализируется (пакетным) вектором.
# Create a 2 x 2 diagonal linear operator.
diag = [1., -1.]
operator = LinearOperatorDiag(diag)
operator.to_dense()
==> [[1., 0.]
[0., -1.]]
operator.shape
==> [2, 2]
operator.log_abs_determinant()
==> scalar Tensor
x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor
# Create a [2, 3] batch of 4 x 4 linear operators.
diag = tf.random.normal(shape=[2, 3, 4])
operator = LinearOperatorDiag(diag)
# Create a shape [2, 1, 4, 2] vector. Note that this shape is compatible
# since the batch dimensions, [2, 1], are broadcast to
# operator.batch_shape = [2, 3].
y = tf.random.normal(shape=[2, 1, 4, 2])
x = operator.solve(y)
==> operator.matmul(x) = y
Совместимость форм
Этот оператор действует на [пакетную] матрицу с совместимой формой. 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]
Производительность
Предположим, что operator — LinearOperatorDiag формы [N, N], и x.shape = [N, R]. Тогда
-
operator.matmul(x)включает в себяN * Rумножений. -
operator.solve(x)включает в себяNделений иN * Rумножений. -
operator.determinant()включает в себя размерNreduce_prod.
Если вместо этого operator и x имеют форму [B1,...,Bb, N, N] и [B1,...,Bb, N, R], сложность каждого оператора увеличивается на B1*...*Bb.
Подсказки свойств матриц
Этот LinearOperator инициализируется булевыми флагами вида is_X, для X = non_singular, self_adjoint, positive_definite, square. У них следующее значение:
- Если
is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойствомX. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность с плавающей запятой может привести к нарушению этих обещаний. - Если
is_X == False, вызывающие стороны должны ожидать, что оператор не обладает свойствомX. - Если
is_X == None(по умолчанию), вызывающие стороны не должны иметь никаких ожиданий ни по одному из вариантов.
| Аргументы | |
|---|---|
diag | Форма [B1,...,Bb, N] Tensor с b >= 0 N >= 0. Диагональ оператора. Допустимые типы данных: float16, float32, float64, complex64, complex128. |
is_non_singular | Ожидать, что этот оператор невырожден. |
is_self_adjoint | Ожидать, что этот оператор равен своему эрмитовому транспонированию. Если diag.dtype вещественный, это автоматически устанавливается в True. |
is_positive_definite | Ожидать, что этот оператор положительно определен, что означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определенности оператора не требуется, чтобы он был самосопряженным. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices |
is_square | Ожидать, что этот оператор действует как квадратные [пакетные] матрицы. |
name | Имя для этого LinearOperator. |
| Возникающие исключения | |
|---|---|
TypeError | Если diag.dtype — недопустимый тип. |
ValueError | Если diag.dtype вещественный, а is_self_adjoint не True. |
| Атрибуты | |
|---|---|
H | Возвращает сопряженный оператор текущего LinearOperator. Учитывая |
batch_shape | Размерность пакетных измерений этого LinearOperator. Если этот оператор действует как пакетная матрица |
diag | |
domain_dimension | Размерность (в смысле векторных пространств) области определения этого оператора. Если этот оператор действует как пакетная матрица |
dtype | Размерность (в смысле тензоров) матриц, обрабатываемых этим оператором. |
graph_parents | Список зависимостей графика от этого оператора. |
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли оператор квадратным. |
range_dimension | Размерность (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакетная матрица |
shape | Размерность этого оператора. Если этот оператор действует как пакетная матрица |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как пакетная матрица |
Методы
add_to_tensor
add_to_tensor(
x, name='add_to_tensor'
)
Добавить матрицу, представленную этим оператором, к x. Эквивалентно A + x.
| Аргументы | |
|---|---|
x | Tensor с той же dtype и формой, совместимой с вещанием к self.shape. |
name | Имя для этого оператора. |
| Возвращаемое значение | |
|---|---|
Матрица с расширенной формой и тем же типом данных, что и self. |
adjoint
adjoint(
name='adjoint'
)
Возвращает сопряжённый оператор текущего LinearOperator.
Учитывая A , представляющий этот LinearOperator, верните A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.
| Аргументы | |
|---|---|
name | Имя для этого оператора. |
| Возвращаемое значение | |
|---|---|
| Оператор, представляющий сопряжение этого оператора. |
assert_non_singular
assert_non_singular(
name='assert_non_singular'
)
Возвращает оператор, который проверяет, что этот оператор невырожден.
Этот оператор считается невырожденным, если
ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps
| Аргументы | |
|---|---|
name | Имя для создаваемых операций. |
| Возвращаемое значение | |
|---|---|
| Оператор, который, при выполнении, вызовет исключение, если оператор вырожден. |
assert_positive_definite
assert_positive_definite(
name='assert_positive_definite'
)
Возвращает оператор, который проверяет, что этот оператор положительно определён.
Здесь положительная определенность означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x.
| Аргументы | |
|---|---|
name | Имя для этой Op. |
| Возвращаемое значение | |
|---|---|
Объект Assert Op, который при выполнении вызовет InvalidArgumentError, если оператор не является положительно определённым. |
assert_self_adjoint
assert_self_adjoint(
name='assert_self_adjoint'
)
Возвращает оператор, который проверяет, что этот оператор является самосопряжённым.
Здесь проверяется, что этот оператор точно равен своему эрмитовому сопряжению.
| Аргументы | |
|---|---|
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='cholesky'
)
Возвращает фактор Холецкого как LinearOperator.
Учитывая A, представляющий этот LinearOperator, если A является положительно определённым самосопряжённым оператором, возвращает L, где A = L L^T, т. е. разложение Холецкого.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращаемое значение | |
|---|---|
LinearOperator , представляющий нижнюю треугольную матрицу в разложении Холецкого. |
| Исключения | |
|---|---|
ValueError | Если LinearOperator не предполагается положительно определённым и самосопряжённым. |
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 что и у self. |
domain_dimension_tensor
domain_dimension_tensor(
name='domain_dimension_tensor'
)
Размерность (в смысле векторных пространств) области действия этого оператора.
Определяется во время выполнения.
Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает N.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращаемое значение | |
|---|---|
int32 Tensor |
inverse
inverse(
name='inverse'
)
Возвращает обратный оператор для данного 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-значение. Если True, левое умножение на сопряжённое: A^H x. |
adjoint_arg | Python-значение. Если 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 matric 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, решить систему, включающую сопряжённый оператор: 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 ложно. |
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, решить систему, включающую сопряжённый оператор: A^H X = rhs. |
name | Область имён для операций, добавленных этим методом. |
| Возвращаемое значение | |
|---|---|
Tensor с формой [...,N] и теми же dtype что и rhs. |
| Исключения | |
|---|---|
NotImplementedError | Если self.is_non_singular или is_square ложно. |
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. |
© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r1.15/api_docs/python/tf/linalg/LinearOperatorDiag