tf.linalg.LinearOperatorBlockDiag
| Просмотреть исходный код на GitHub |
Объединяет один или несколько LinearOperators в блочно-диагональную матрицу.
Наследуется от: LinearOperator
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 действует как [batch] квадратная матрица Aj, то op_combined действует как [batch] квадратная матрица, образованная расположением каждой матрицы Aj на главной диагонали.
Каждый opj должен представлять квадратную матрицу и, следовательно, иметь форму batch_shape_j + [M_j, M_j].
Если у opj форма batch_shape_j + [M_j, M_j], то объединённый оператор имеет форму broadcast_batch_shape + [sum M_j, sum M_j], где broadcast_batch_shape является взаимным расширением batch_shape_j, j = 1,...,J, предполагая, что промежуточные формы пакетов расширяются. Даже если объединённая форма определена корректно, методы объединённого оператора могут завершиться неудачно из-за отсутствия возможностей вещания в методах определяющих операторов.
Аргументы matmul, matvec, solve, и solvevec могут быть отдельными Tensor или списками Tensor , интерпретируемыми как блоки. j-й элемент блочного списка Tensor должен иметь размеры, соответствующие 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 [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 | Ожидается, что этот оператор действует как квадратные [batch] матрицы. Это выполняется по умолчанию и в противном случае вызовет ValueError . |
name | Имя для данного LinearOperator. По умолчанию имена отдельных операторов соединяются с _o_. |
| Возможные ошибки | |
|---|---|
TypeError | Если у всех операторов нет одинаковой dtype. |
ValueError | Если operators пусто или не является квадратной. |
| Атрибуты | |
|---|---|
H | Возвращает сопряжённый оператор. Учитывая |
batch_shape | Размерность пакетов этого LinearOperator. Если этот оператор действует как пакет матриц |
domain_dimension | Размеры (в смысле векторных пространств) области действия этого оператора. Если этот оператор действует как пакет матриц |
dtype | Количество Tensor , обработанных этим LinearOperator. |
graph_parents | Список графовых зависимостей этого LinearOperator. (устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
operators | |
range_dimension | Размеры (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакет матриц |
shape | Ранг этого 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='adjoint'
)
Возвращает сопряжённый оператор.
Учитывая 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'
)
Возвращает 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 | Область именования ops, используемых этим методом. |
| Возвращает | |
|---|---|
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. |
__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/LinearOperatorBlockDiag