tf.linalg.LinearOperatorKronecker
| Просмотреть исходный код на GitHub |
Произведение Кронекера между двумя LinearOperators.
Наследуется от: LinearOperator, Module
tf.linalg.LinearOperatorKronecker(
operators, is_non_singular=None, is_self_adjoint=None,
is_positive_definite=None, is_square=None, name=None
)
Этот оператор комбинирует один или несколько линейных операторов [op1,...,opJ], создавая новый оператор LinearOperator, представляющий произведение Кронекера: op1 x op2 x .. opJ (скобки опущены, так как произведение Кронекера ассоциативно).
Если opj имеет форму batch_shape_j + [M_j, N_j], то составной оператор будет иметь форму, равную broadcast_batch_shape + [prod M_j, prod N_j], где произведение берется по всем операторам.
# Create a 4 x 4 linear operator composed of two 2 x 2 operators.
operator_1 = LinearOperatorFullMatrix([[1., 2.], [3., 4.]])
operator_2 = LinearOperatorFullMatrix([[1., 0.], [2., 1.]])
operator = LinearOperatorKronecker([operator_1, operator_2])
operator.to_dense()
==> [[1., 0., 2., 0.],
[2., 1., 4., 2.],
[3., 0., 4., 0.],
[6., 3., 8., 4.]]
operator.shape
==> [4, 4]
operator.log_abs_determinant()
==> scalar Tensor
x = ... Shape [4, 2] Tensor
operator.matmul(x)
==> Shape [4, 2] Tensor
# Create a [2, 3] batch of 4 x 5 linear operators.
matrix_45 = tf.random.normal(shape=[2, 3, 4, 5])
operator_45 = LinearOperatorFullMatrix(matrix)
# Create a [2, 3] batch of 5 x 6 linear operators.
matrix_56 = tf.random.normal(shape=[2, 3, 5, 6])
operator_56 = LinearOperatorFullMatrix(matrix_56)
# Compose to create a [2, 3] batch of 20 x 30 operators.
operator_large = LinearOperatorKronecker([operator_45, operator_56])
# Create a shape [2, 3, 20, 2] vector.
x = tf.random.normal(shape=[2, 3, 6, 2])
operator_large.matmul(x)
==> Shape [2, 3, 30, 2] Tensor
Производительность
Производительность LinearOperatorKronecker при любом действии равна сумме производительности отдельных операторов.
Свойства матрицы
Этот LinearOperator инициализируется булевыми флагами вида is_X, для X = non_singular, self_adjoint, positive_definite, square. Они имеют следующее значение:
- Если
is_X == True, вызывающие стороны должны ожидать, что оператор будет обладать свойствомX. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность с плавающей запятой может привести к нарушению этих обещаний. - Если
is_X == False, вызывающие стороны должны ожидать, что оператор не будет обладать свойствомX. - Если
is_X == None(значение по умолчанию), у вызывающих сторон не должно быть ожиданий в обоих направлениях.
| Аргументы | |
|---|---|
operators | Итерируемый список объектов LinearOperator, каждый из которых имеет одинаковую размерность dtype и совместимую форму, представляющих факторы Кронекера. |
is_non_singular | Ожидается, что этот оператор невырожден. |
is_self_adjoint | Ожидается, что этот оператор равен своему эрмитовому сопряжению. |
is_positive_definite | Ожидается, что этот оператор положительно определён, что означает, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости оператора не требуется, чтобы он был самосопряжённым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix\ Расширение для несимметричных матриц |
is_square | Ожидается, что этот оператор действует как квадратные [пакетные] матрицы. |
name | Имя для этого LinearOperator. По умолчанию имена отдельных операторов объединяются с _x_. |
| Исключения | |
|---|---|
TypeError | Если все операторы не имеют одинаковую размерность dtype. |
ValueError | Если operators пусто. |
| Атрибуты | |
|---|---|
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 в зависимости от того, является ли этот оператор квадратным. |
operators | |
parameters | Словарь параметров, используемых для создания этого LinearOperator. |
range_dimension | Размерность (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакетная матрица |
shape | Размерность пакета этого LinearOperator. Если этот оператор действует как пакетная матрица |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как пакетная матрица |
Методы
add_to_tensor
add_to_tensor(
x, name='add_to_tensor'
)
Добавить матрицу, представленную этим оператором, к x. Эквивалентно A + x.
| Аргументы | |
|---|---|
x | Тензор с той же размерностью dtype и формой, совместимой для трансляции с self.shape. |
name | Имя для этого Op. |
| Возвращаемое значение | |
|---|---|
Тензор с расширенной формой и той же размерностью 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'
)
Возвращает оператор, который утверждает, что этот оператор положительно определён.
Здесь положительно определённое означает, что квадратичная форма 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 , которая не намекает на положительную определённость и самосопряжённость. |
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'
)
Преобразует [пакетную] матрицу 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.
Возвращаемое значение будет близко к точному решению, если 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.
Возвращаемое значение будет близко к точному решению, если 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. |
__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/LinearOperatorKronecker