tf.linalg.LinearOperatorZeros
| Просмотреть исходный код на GitHub |
LinearOperator как [блочная] нулевая матрица.
Наследуется от: LinearOperator
tf.linalg.LinearOperatorZeros(
num_rows, num_columns=None, batch_shape=None, dtype=None, is_non_singular=False,
is_self_adjoint=True, is_positive_definite=False, is_square=True,
assert_proper_shapes=False, name='LinearOperatorZeros'
)
Этот оператор действует как [блочная] нулевая матрица A с формой [B1,...,Bb, N, M] для некоторого b >= 0. Первые b индексы индексируют участника блока. Для каждого индекса блока (i1,...,ib), A[i1,...,ib, : :] — это N x M матрица. Эта матрица A не материализована, но для целей вещания эта форма будет актуальна.
LinearOperatorZeros инициализируется с num_rows, и необязательно num_columns,batch_shape, anddtypearguments. Ifnum_columnsisNone, then this operator will be initialized as a square matrix. Ifbatch_shapeisNone, this operator efficiently passes through all arguments. Ifbatch_shape` предоставляется, может произойти вещание, что потребует создания копий.
# Create a 2 x 2 zero matrix.
operator = LinearOperatorZero(num_rows=2, dtype=tf.float32)
operator.to_dense()
==> [[0., 0.]
[0., 0.]]
operator.shape
==> [2, 2]
operator.determinant()
==> 0.
x = ... Shape [2, 4] Tensor
operator.matmul(x)
==> Shape [2, 4] Tensor, same as x.
# Create a 2-batch of 2x2 zero matrices
operator = LinearOperatorZeros(num_rows=2, batch_shape=[2])
operator.to_dense()
==> [[[0., 0.]
[0., 0.]],
[[0., 0.]
[0., 0.]]]
# 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 tf.zeros_like(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 tf.zeros_like([x, x])
Совместимость форм
Этот оператор действует на [блочную] матрицу с совместимой формой. x — это блочная матрица с совместимой формой для matmul и solve если
operator.shape = [B1,...,Bb] + [N, M], with b >= 0 x.shape = [C1,...,Cc] + [M, 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(по умолчанию), у вызывающих функций не должно быть ожиданий ни в ту, ни в другую сторону.
| Аргументы | |
|---|---|
num_rows | Скалярное неотрицательное целое число Tensor. Количество строк в соответствующей нулевой матрице. |
num_columns | Скалярное неотрицательное целое число Tensor. Количество столбцов в соответствующей нулевой матрице. Если None, по умолчанию принимает значение num_rows. |
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 | Если num_columns статически определяется как нескалярное или отрицательное значение. |
ValueError | Если batch_shape статически определяется как не одномерное или отрицательное значение. |
ValueError | Если что-либо из следующего не True: {is_self_adjoint, is_non_singular, is_positive_definite}. |
| Атрибуты | |
|---|---|
H | Возвращает сопряжённый оператор текущего LinearOperator. Учитывая |
batch_shape | Размерность блочных измерений данного LinearOperator. Если этот оператор действует как блочная матрица |
domain_dimension | Размерность (в смысле векторных пространств) области действия этого оператора. Если этот оператор действует как блочная матрица |
dtype | Размер Tensors, обрабатываемых этим LinearOperator. |
graph_parents | Список зависимостей графа данного LinearOperator. (устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
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
| Аргументы | |
|---|---|
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='cholesky'
)
Возвращает фактор Холеского как 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 , что и self. |
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='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'
)
Преобразование [batch] матрицы 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'
)
Преобразование [batch] вектора 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 рассматривается как [batch] вектор, что означает, что для каждой группы ведущих измерений последнее измерение определяет вектор. Определение совместимости см. в документации класса. |
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 обрабатывается как [batch] матрица, что означает, что для каждой группы ведущих измерений последние два измерения определяют матрицу. Определение совместимости см. в документации класса. |
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 равно 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 обрабатывается как [batch] вектор, что означает, что для каждой группы ведущих измерений последнее измерение определяет вектор. Определение совместимости по пакетным измерениям см. в документации класса. |
adjoint | Python bool. Если True, решить систему, включающую сопряжённую матрицу этого оператора: 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.3/api_docs/python/tf/linalg/LinearOperatorZeros