tf.linalg.LinearOperatorBlockDiag
Объединяет один или несколько LinearOperators в блочно-диагональную матрицу.
Наследует: LinearOperator, Module
tf.linalg.LinearOperatorBlockDiag(
operators,
is_non_singular=None,
is_self_adjoint=None,
is_positive_definite=None,
is_square=True,
name=None
)
Используется в блокнотах
| Используется в учебных пособиях |
|---|
Этот оператор объединяет один или несколько линейных операторов [op1,...,opJ], создавая новый LinearOperator, матричное представление которого содержит каждый оператор opi на главной диагонали, а в остальных местах — нули.
Совместимость форм
Если opj действует как матрица [пакета] Aj, то op_combined действует как матрица [пакета], образованная размещением каждой матрицы Aj на главной диагонали.
Каждый opj должен представлять матрицу и, следовательно, иметь форму batch_shape_j + [M_j, N_j].
Если opj имеет форму batch_shape_j + [M_j, N_j], то объединённый оператор имеет форму broadcast_batch_shape + [sum M_j, sum N_j], где broadcast_batch_shape — это взаимное вещательное расширение batch_shape_j, j = 1,...,J, при условии, что промежуточные формы пакета совместимы при вещательном расширении.
Аргументы matmul, matvec, solve и solvevec могут быть отдельными объектами Tensor или списками объектов Tensor, интерпретируемых как блоки. Элемент j списка блоков Tensor должен иметь размеры, соответствующие opj для указанного метода. Если на вход передан список блоков, возвращается также список блоков.
Если для opj не гарантируется квадратная форма, методы этого оператора могут завершиться ошибкой из-за того, что объединённый оператор не является квадратным, и/или из-за отсутствия эффективных методов.
# Create a 4 x 4 linear operator combined of two 2 x 2 operators.
operator_1 = LinearOperatorFullMatrix([[1., 2.], [3., 4.]])
operator_2 = LinearOperatorFullMatrix([[1., 0.], [0., 1.]])
operator = LinearOperatorBlockDiag([operator_1, operator_2])
operator.to_dense()
==> [[1., 2., 0., 0.],
[3., 4., 0., 0.],
[0., 0., 1., 0.],
[0., 0., 0., 1.]]
operator.shape
==> [4, 4]
operator.log_abs_determinant()
==> scalar Tensor
x1 = ... # Shape [2, 2] Tensor
x2 = ... # Shape [2, 2] Tensor
x = tf.concat([x1, x2], 0) # Shape [2, 4] Tensor
operator.matmul(x)
==> tf.concat([operator_1.matmul(x1), operator_2.matmul(x2)])
# Create a 5 x 4 linear operator combining three blocks.
operator_1 = LinearOperatorFullMatrix([[1.], [3.]])
operator_2 = LinearOperatorFullMatrix([[1., 6.]])
operator_3 = LinearOperatorFullMatrix([[2.], [7.]])
operator = LinearOperatorBlockDiag([operator_1, operator_2, operator_3])
operator.to_dense()
==> [[1., 0., 0., 0.],
[3., 0., 0., 0.],
[0., 1., 6., 0.],
[0., 0., 0., 2.]]
[0., 0., 0., 7.]]
operator.shape
==> [5, 4]
# Create a [2, 3] batch of 4 x 4 linear operators.
matrix_44 = tf.random.normal(shape=[2, 3, 4, 4])
operator_44 = LinearOperatorFullMatrix(matrix)
# Create a [1, 3] batch of 5 x 5 linear operators.
matrix_55 = tf.random.normal(shape=[1, 3, 5, 5])
operator_55 = LinearOperatorFullMatrix(matrix_55)
# Combine to create a [2, 3] batch of 9 x 9 operators.
operator_99 = LinearOperatorBlockDiag([operator_44, operator_55])
# Create a shape [2, 3, 9] vector.
x = tf.random.normal(shape=[2, 3, 9])
operator_99.matmul(x)
==> Shape [2, 3, 9] Tensor
# Create a blockwise list of vectors.
x = [tf.random.normal(shape=[2, 3, 4]), tf.random.normal(shape=[2, 3, 5])]
operator_99.matmul(x)
==> [Shape [2, 3, 4] Tensor, Shape [2, 3, 5] Tensor]
Производительность
Производительность LinearOperatorBlockDiag при выполнении любой операции равна сумме операций отдельных операторов.
Подсказки о свойствах матрицы
Этот 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#Extension_for_non-symmetric_matrices |
is_square | Ожидается, что этот оператор действует как квадратные матрицы [пакета]. По умолчанию это так; в противном случае будет вызвано исключение ValueError. |
name | Имя этого LinearOperator. По умолчанию используется имя отдельных операторов, объединённых с помощью _o_. |
| Вызывает исключения | |
|---|---|
TypeError | Если у всех операторов разные dtype. |
ValueError | Если operators пуст или не является квадратным. |
| Атрибуты | |
|---|---|
H | Возвращает сопряжённый оператор текущего LinearOperator. Для |
batch_shape | TensorShape измерений пакета этого LinearOperator. Если этот оператор действует как матрица пакета |
domain_dimension | Размерность области определения этого оператора (в смысле векторных пространств). Если этот оператор действует как матрица пакета |
dtype | DType объектов Tensor, обрабатываемых этим LinearOperator. |
graph_parents | Список зависимостей графа этого LinearOperator. (устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
operators | |
parameters | Словарь параметров, использованных для создания этого LinearOperator. |
range_dimension | Размерность области значений этого оператора (в смысле векторных пространств). Если этот оператор действует как матрица пакета |
shape | TensorShape этого LinearOperator. Если этот оператор действует как матрица пакета |
tensor_rank | Ранг матрицы, соответствующей этому оператору (в смысле тензоров). Если этот оператор действует как матрица пакета |
Методы
add_to_tensor
add_to_tensor(
x, name='add_to_tensor'
)
Прибавляет матрицу, представленную этим оператором, к x. Эквивалентно A + x.
| Аргументы | |
|---|---|
x | Tensor с тем же dtype и формой, совместимой при вещательном расширении с self.shape. |
name | Имя для этого Op. |
| Возвращает | |
|---|---|
Tensor с формой вещательного расширения и тем же dtype, что и у self. |
adjoint
adjoint(
name: str = 'adjoint'
) -> 'LinearOperator'
Возвращает сопряжённый оператор текущего LinearOperator.
Для A, представляющего этот LinearOperator, возвращает A*. Обратите внимание, что вызовы self.adjoint() и self.H эквивалентны.
| Аргументы | |
|---|---|
name | Имя для этого Op. |
| Возвращает | |
|---|---|
LinearOperator, представляющий сопряжённый оператор этого LinearOperator. |
assert_non_singular
assert_non_singular(
name='assert_non_singular'
)
Возвращает Op, проверяющий, что этот оператор невырожденный.
Оператор считается невырожденным, если
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: str = 'cholesky'
) -> 'LinearOperator'
Возвращает разложение Холецкого в виде 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, что и у самого объекта. |
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: str = 'inverse'
) -> 'LinearOperator'
Возвращает обратный оператор для этого 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, либо итерируемый объект LinearOperator или Tensor, разбитый на блоки. Определение совместимости форм см. в документации класса. |
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, либо, если x разбит на блоки, список объектов Tensor с формами, которые при объединении образуют [..., M, R]. |
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, либо итерируемый объект из Tensor (для блочно-разбитых операторов). Tensor трактуются как векторы [пакета]: для каждого набора начальных измерений последнее измерение задаёт вектор. Определение совместимости см. в документации класса. |
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, что и у этого оператора, и совместимой формой либо список Tensor (для поблочных операторов). Tensor рассматриваются как [пакетные] матрицы: для каждого набора начальных размерностей последние две размерности определяют матрицу. Определение совместимости см. в описании класса. |
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, что и у этого оператора, либо список Tensor (для поблочных операторов). Tensor рассматриваются как [пакетные] векторы: для каждого набора начальных размерностей последняя размерность определяет вектор. Определение совместимости пакетных размерностей см. в описании класса. |
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. |
__getitem__
__getitem__(
slices
)
__matmul__
__matmul__(
other
)
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/linalg/LinearOperatorBlockDiag