tf.linalg.LinearOperatorIdentity
| Просмотреть исходный код на GitHub |
LinearOperator действуя как [пакетная] квадратная единичная матрица.
Наследуется от: LinearOperator, Module
tf.linalg.LinearOperatorIdentity(
num_rows, batch_shape=None, dtype=None, is_non_singular=True,
is_self_adjoint=True, is_positive_definite=True, is_square=True,
assert_proper_shapes=False, name='LinearOperatorIdentity'
)
Этот оператор действует как [пакетная] единичная матрица A с формой [B1,...,Bb, N, N] для некоторого b >= 0. Первые b индексы индексируют элемент пакета. Для каждого индекса пакета (i1,...,ib), A[i1,...,ib, : :] — это N x N матрица. Эта матрица A не материализуется, но для целей вещания эта форма будет актуальна.
LinearOperatorIdentity инициализируется с num_rows, и необязательно batch_shape, и dtype аргументами. Если batch_shape равно None, этот оператор эффективно пропускает все аргументы. Если batch_shape предоставлено, может произойти вещание, что потребует создания копий.
# Create a 2 x 2 identity matrix.
operator = LinearOperatorIdentity(num_rows=2, dtype=tf.float32)
operator.to_dense()
==> [[1., 0.]
[0., 1.]]
operator.shape
==> [2, 2]
operator.log_abs_determinant()
==> 0.
x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor, same as 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].
# This broadcast does NOT require copying data, since we can infer that y
# will be passed through without changing shape. We are always able to infer
# this if the operator has no batch_shape.
x = operator.solve(y)
==> Shape [3, 2, 4] Tensor, same as y.
# Create a 2-batch of 2x2 identity matrices
operator = LinearOperatorIdentity(num_rows=2, batch_shape=[2])
operator.to_dense()
==> [[[1., 0.]
[0., 1.]],
[[1., 0.]
[0., 1.]]]
# Here, even though the operator has a batch shape, the input is the same as
# the output, so x can be passed through without a copy. The operator is able
# to detect that no broadcast is necessary because both x and the operator
# have statically defined shape.
x = ... Shape [2, 2, 3]
operator.matmul(x)
==> Shape [2, 2, 3] Tensor, same as x
# Here the operator and x have different batch_shape, and are broadcast.
# This requires a copy, since the output is different size than the input.
x = ... Shape [1, 2, 3]
operator.matmul(x)
==> Shape [2, 2, 3] Tensor, equal to [x, 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]
Производительность
Если batch_shape аргумент инициализации равен None:
-
operator.matmul(x)равноO(1) -
operator.solve(x)равноO(1) -
operator.determinant()равноO(1)
Если batch_shape аргумент инициализации предоставлен, и статические проверки не могут исключить необходимости вещания:
-
operator.matmul(x)равноO(D1*...*Dd*N*R) -
operator.solve(x)равноO(D1*...*Dd*N*R) -
operator.determinant()равноO(B1*...*Bb)
Рекомендации по свойствам матриц
Этот 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. Количество строк в соответствующей единичной матрице. |
batch_shape | Необязательное 1-D целое число Tensor. Форма ведущих измерений. Если None, этот оператор не имеет ведущих измерений. |
dtype | Тип данных матрицы, которую представляет этот оператор. |
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 статически определяется как нескалярное или отрицательное. |
ValueError | Если batch_shape статически определяется как не 1-мерное или отрицательное. |
ValueError | Если что-либо из следующего не True: {is_self_adjoint, is_non_singular, is_positive_definite}. |
TypeError | Если num_rows или batch_shape является типом ссылки (например, Variable). |
| Атрибуты | |
|---|---|
H | Возвращает сопряженный оператор текущего LinearOperator. В заданном |
batch_shape | Размерность пакетных измерений этого LinearOperator. Если этот оператор действует как пакетная матрица |
domain_dimension | Размерность (в смысле векторных пространств) области действия этого оператора. Если этот оператор действует как пакетная матрица |
dtype | Размерность обрабатываемых Tensor этим LinearOperator оператором. |
graph_parents | Список зависимостей графа этого LinearOperator оператора. (устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
parameters | Словарь параметров, используемых для создания этого LinearOperator оператора. |
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'
)
Возвращает сопряженный оператор текущего LinearOperator.
В заданном A представляющий этот LinearOperator, верните A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращаемое значение | |
|---|---|
LinearOperator который представляет сопряженный оператор этого 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
| Args | |
|---|---|
name | Имя строки, добавляемое к созданным операциям. |
| Returns | |
|---|---|
Объект Assert Op, который при выполнении вызовет InvalidArgumentError, если оператор является единственным. |
assert_positive_definite
assert_positive_definite(
name='assert_positive_definite'
)
Возвращает объект Op, который проверяет, что этот оператор является положительно определённым.
Здесь положительно определённый означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости оператора не требуется, чтобы он был самосопряжённым.
| Args | |
|---|---|
name | Имя для данного Op. |
| Returns | |
|---|---|
Объект Assert Op, который при выполнении вызовет InvalidArgumentError, если оператор не является положительно определённым. |
assert_self_adjoint
assert_self_adjoint(
name='assert_self_adjoint'
)
Возвращает объект Op, который проверяет, что этот оператор является самосопряжённым.
Здесь проверяется, что этот оператор точно равен своему эрмитовому транспонированию.
| Args | |
|---|---|
name | Имя строки, добавляемое к созданным операциям. |
| Returns | |
|---|---|
Объект Assert Op, который при выполнении вызовет InvalidArgumentError, если оператор не является самосопряжённым. |
batch_shape_tensor
batch_shape_tensor(
name='batch_shape_tensor'
)
Форма размерности пакета этого оператора, определяемая во время выполнения.
Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает объект Tensor, содержащий [B1,...,Bb].
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
int32 Tensor |
cholesky
cholesky(
name='cholesky'
)
Возвращает фактор Холецкого как LinearOperator.
Учитывая A, представляющее этот LinearOperator, если A является положительно определённой самосопряжённой, возвращает L, где A = L L^T, т.е. разложение Холецкого.
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
LinearOperator, представляющий нижнетреугольную матрицу в разложении Холецкого. |
| Raises | |
|---|---|
ValueError | Если LinearOperator не подразумевает положительную определённость и самосопряжённость. |
cond
cond(
name='cond'
)
Возвращает число обусловленности этого линейного оператора.
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
Форма [B1,...,Bb] Tensor того же dtype , что и self. |
determinant
determinant(
name='det'
)
Определитель для каждого члена пакета.
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
Tensor с формой self.batch_shape и тем же dtype , что и self. |
| Raises | |
|---|---|
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.]
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
diag_part | Tensor с тем же dtype , что и self. |
domain_dimension_tensor
domain_dimension_tensor(
name='domain_dimension_tensor'
)
Размерность (в смысле векторных пространств) области действия этого оператора.
Определяется во время выполнения.
Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то это возвращает N.
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
int32 Tensor |
eigvals
eigvals(
name='eigvals'
)
Возвращает собственные значения этого линейного оператора.
Если оператор помечен как самосопряжённый (через is_self_adjoint) это вычисление может быть более эффективным.
Примечание: В настоящее время это поддерживает только самосопряжённые операторы.
| Args | |
|---|---|
name | Имя для этого Op. |
| Returns | |
|---|---|
Форма [B1,...,Bb, N] Tensor того же dtype , что и self. |
inverse
inverse(
name='inverse'
)
Возвращает обратный элемент этого LinearOperator.
Учитывая A представляющее этот LinearOperator, вернуть объект LinearOperator представляющий A^-1.
| Args | |
|---|---|
name | Область именования ops, используемая этим методом. |
| Returns | |
|---|---|
LinearOperator представляющий обратную матрицу. |
| Raises | |
|---|---|
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. |
__matmul__
__matmul__(
other
)
© 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/r2.4/api_docs/python/tf/linalg/LinearOperatorIdentity