tf.linalg.LinearOperatorScaledIdentity
| Просмотреть исходный код на GitHub |
LinearOperator действующий как масштабированная [пакетная] единичная матрица A = c I.
tf.linalg.LinearOperatorScaledIdentity(
num_rows, multiplier, is_non_singular=None, is_self_adjoint=None,
is_positive_definite=None, is_square=True, assert_proper_shapes=False,
name='LinearOperatorScaledIdentity'
)
Этот оператор действует как масштабированная [пакетная] единичная матрица A с формой [B1,...,Bb, N, N] для некоторого b >= 0. Первые b индексы индексируют элемент пакета. Для каждого индекса пакета (i1,...,ib), A[i1,...,ib, : :] является масштабированной версией N x N единичной матрицы.
LinearOperatorIdentity инициализируется num_rows, и multiplier (a Tensor ) формы [B1,...,Bb]. N устанавливается на num_rows, и multiplier определяет масштаб для каждого элемента пакета.
# Create a 2 x 2 scaled identity matrix.
operator = LinearOperatorIdentity(num_rows=2, multiplier=3.)
operator.to_dense()
==> [[3., 0.]
[0., 3.]]
operator.shape
==> [2, 2]
operator.log_abs_determinant()
==> 2 * Log[3]
x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> 3 * x
y = tf.random.normal(shape=[3, 2, 4])
# Note that y.shape is compatible with operator.shape because operator.shape
# is broadcast to [3, 2, 2].
x = operator.solve(y)
==> 3 * x
# Create a 2-batch of 2x2 identity matrices
operator = LinearOperatorIdentity(num_rows=2, multiplier=5.)
operator.to_dense()
==> [[[5., 0.]
[0., 5.]],
[[5., 0.]
[0., 5.]]]
x = ... Shape [2, 2, 3]
operator.matmul(x)
==> 5 * x
# Here the operator and x have different batch_shape, and are broadcast.
x = ... Shape [1, 2, 3]
operator.matmul(x)
==> 5 * x
Совместимость форм
Этот оператор действует на [пакетную] матрицу с совместимой формой. 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.matmul(x)являетсяO(D1*...*Dd*N*R) -
operator.solve(x)являетсяO(D1*...*Dd*N*R) -
operator.determinant()являетсяO(D1*...*Dd)
Подсказки о свойствах матрицы
Этот LinearOperator инициализируется булевыми флагами вида is_X, для X = non_singular, self_adjoint, positive_definite, square. Они имеют следующее значение
- Если
is_X == True, вызывающие стороны должны ожидать, что оператор будет иметь свойствоX. Это обещание, которое должно быть выполнено, но это не утверждение во время выполнения. Например, конечная точность плавающей запятой может привести к нарушению этих обещаний. - Если
is_X == False, вызывающие стороны должны ожидать, что оператор не будет иметьX. - Если
is_X == None(по умолчанию), вызывающие стороны не должны иметь ожиданий.
| Аргументы | |
|---|---|
num_rows | Скалярное неотрицательное целое число Tensor. Количество строк в соответствующей единичной матрице. |
multiplier | Tensor формы [B1,...,Bb], или [] (скаляр). |
is_non_singular | Ожидать, что этот оператор не является вырожденным. |
is_self_adjoint | Ожидать, что этот оператор равен своему эрмитовому транспонированию. |
is_positive_definite | Ожидать, что этот оператор является положительно определенным, что означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определенности нам не требуется, чтобы оператор был самосопряженным. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices |
is_square | Ожидать, что этот оператор действует как квадратные [пакетные] матрицы. |
assert_proper_shapes | Python bool. Если False, выполняются только статические проверки, чтобы инициализация и аргументы методов имели правильную форму. Если True, и статические проверки являются неубедительными, добавляются утверждения в граф. |
name | Имя для этого LinearOperator |
| Возможные исключения | |
|---|---|
ValueError | Если num_rows статически определяется как нескалярное или отрицательное. |
| Атрибуты | |
|---|---|
H | Возвращает сопряженный оператор. Учитывая |
batch_shape | Размерность пакетных измерений этого LinearOperator. Если этот оператор действует как пакетная матрица |
domain_dimension | Размеры (в смысле векторных пространств) области действия этого оператора. Если этот оператор действует как пакетная матрица |
dtype | Размерность (в смысле тензоров) матрицы, соответствующей этому оператору. |
graph_parents | Список зависимостей графа этого LinearOperator. |
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли оператор квадратным. |
multiplier | [Пакетный] скаляр Tensor, c в cI. |
range_dimension | Размеры (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакетная матрица |
shape | Ранг этого LinearOperator. Если этот оператор действует как пакетная матрица |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как пакетная матрица |
Методы
add_to_tensor
add_to_tensor(
mat, name='add_to_tensor'
)
Добавить матрицу, представленную этим оператором, к mat. Эквивалентно I + mat.
| Аргументы | |
|---|---|
mat | Tensor с той же dtype и формой, согласующейся с self. |
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с расширенной формой и той же dtype что и self. |
adjoint
adjoint(
name='adjoint'
)
Возвращает сопряженный оператор.
Учитывая A представляющий этот LinearOperator, вернуть A*. Обратите внимание, что вызовы self.adjoint() и self.H эквивалентны.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
LinearOperator , представляющий сопряженный оператор. |
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 | Строка для имени создаваемых операций. |
| Возвращает | |
|---|---|
Утверждение Op, которое, при выполнении, вызовет исключение InvalidArgumentError , если оператор вырожден. |
assert_positive_definite
assert_positive_definite(
name='assert_positive_definite'
)
Возвращает утверждение, что оператор является положительно определённым.
Здесь положительная определенность означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определенности нам не требуется, чтобы оператор был самосопряженным.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
An Assert Op, that, when run, will raise an InvalidArgumentError if the operator is not positive definite. |
assert_self_adjoint
assert_self_adjoint(
name='assert_self_adjoint'
)
Возвращает an Op, который утверждает, что данный оператор является самосопряжённым.
Здесь мы проверяем, что данный оператор точно равен своему эрмитовому транспонированию.
| Аргументы | |
|---|---|
name | Имя строки, добавляемое к создаваемым операциям. |
| Возвращает | |
|---|---|
An Assert Op, that, when run, will raise an InvalidArgumentError if the operator is not self-adjoint. |
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 | A 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 bool. Если True, умножаем слева на сопряжённый оператор: A^H x. |
adjoint_arg | Python bool. Если True, вычисляем A x^H , где x^H - это эрмитово транспонирование (транспонирование и комплексное сопряжение). |
name | Имя для данного Op. |
| Возвращает | |
|---|---|
A 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. |
| Возвращаемое значение | |
|---|---|
A 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 | Область имён Python для использования с операциями, добавленными этим методом. |
| Возвращаемое значение | |
|---|---|
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 | Область имён Python для использования с операциями, добавленными этим методом. |
| Возвращаемое значение | |
|---|---|
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/LinearOperatorScaledIdentity