Spec-Zone.ru › TensorFlow 2.4

tf.linalg.LinearOperatorCirculant2D

Просмотреть исходный код на GitHub

LinearOperator как блочно-циркулярная матрица.

Наследует от: LinearOperator, Module

Просмотреть псевдонимы

Псевдонимы для миграции

См. Руководство по миграции для получения более подробной информации.

tf.compat.v1.linalg.LinearOperatorCirculant2D

tf.linalg.LinearOperatorCirculant2D(
    spectrum, input_output_dtype=tf.dtypes.complex64, is_non_singular=None,
    is_self_adjoint=None, is_positive_definite=None, is_square=True,
    name='LinearOperatorCirculant2D'
)

Этот оператор действует как блочно-циркулярная матрица A с формой [B1,...,Bb, N, N] для некоторого b >= 0. Первые b индексы индексируют элемент пакета. Для каждого индекса пакета (i1,...,ib), A[i1,...,ib, : :] — это N x N матрица. Эта матрица A не материализуется, но для целей широковещательной передачи эта форма будет уместной.

Описание в терминах блочно-циркулярных матриц

Если A является блочно-циркулярной, с размерами блоков N0, N1 (N0 * N1 = N): A имеет блочно-циркулярную структуру, состоящую из N0 x N0 блоков, причём каждый блок является N1 x N1 циркулярной матрицей.

Например, с W, X, Y, Z каждая циркулярная,

A = |W Z Y X|
    |X W Z Y|
    |Y X W Z|
    |Z Y X W|

Обратите внимание, что A сама по себе, вообще говоря, не будет циркулярной.

Описание в терминах частотного спектра

Существует эквивалентное описание в терминах [пакетного] спектра H и преобразований Фурье. Здесь мы рассматриваем A.shape = [N, N] и игнорируем размерности пакетов.

Если H.shape = [N0, N1], (N0 * N1 = N): Грубо говоря, умножение матриц равно действию множителя Фурье: A u = IDFT2[ H DFT2[u] ]. Точнее, данной [N, R] матрицей u, пусть DFT2[u] будет [N0, N1, R] Tensor, определённой переоформлением u в [N0, N1, R] и взятием двумерного преобразования Фурье по первым двум измерениям. Пусть IDFT2 — обратное к DFT2. Умножение матриц можно выразить по столбцам:

(A u)_r = IDFT2[ H * (DFT2[u])_r ]

Свойства оператора, выведенные из спектра.

  • Этот оператор является положительно определённым тогда и только тогда, когда Real{H} > 0.

Общим свойством преобразований Фурье является соответствие между эрмитовыми функциями и вещественными преобразованиями.

Предположим H.shape = [B1,...,Bb, N0, N1], мы говорим, что H является эрмитовым спектром, если с % обозначающим модульное деление,

H[..., n0 % N0, n1 % N1] = ComplexConjugate[ H[..., (-n0) % N0, (-n1) % N1 ].
  • Этот оператор соответствует вещественной матрице тогда и только тогда, когда H является эрмитовой.
  • Этот оператор является самосопряжённым тогда и только тогда, когда H является вещественным.

См., например, "Цифровая обработка сигналов", Оппенгейм и Шафер.

Пример самосопряжённого положительно определённого оператора

# spectrum is real ==> operator is self-adjoint
# spectrum is positive ==> operator is positive definite
spectrum = [[1., 2., 3.],
            [4., 5., 6.],
            [7., 8., 9.]]

operator = LinearOperatorCirculant2D(spectrum)

# IFFT[spectrum]
operator.convolution_kernel()
==> [[5.0+0.0j, -0.5-.3j, -0.5+.3j],
     [-1.5-.9j,        0,        0],
     [-1.5+.9j,        0,        0]]

operator.to_dense()
==> Complex self adjoint 9 x 9 matrix.

Пример определения в терминах вещественного ядра свёртки,

# convolution_kernel is real ==> spectrum is Hermitian.
convolution_kernel = [[1., 2., 1.], [5., -1., 1.]]
spectrum = tf.signal.fft2d(tf.cast(convolution_kernel, tf.complex64))

# spectrum is shape [2, 3] ==> operator is shape [6, 6]
# spectrum is Hermitian ==> operator is real.
operator = LinearOperatorCirculant2D(spectrum, input_output_dtype=tf.float32)

Производительность

Предположим operator является LinearOperatorCirculant с формой [N, N], и x.shape = [N, R]. Тогда

  • operator.matmul(x) является O(R*N*Log[N])
  • operator.solve(x) является O(R*N*Log[N])
  • operator.determinant() включает в себя операцию размера N reduce_prod.

Если вместо этого operator и x имеют форму [B1,...,Bb, N, N] и [B1,...,Bb, N, R], каждая операция увеличивает сложность на B1*...*Bb.

Подсказки свойств матриц

Этот LinearOperator инициализирован булевыми флагами вида is_X, для X = non_singular, self_adjoint, positive_definite, square. Они имеют следующее значение

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор будет обладать свойством X. Это обещание, которое должно быть выполнено, но не является проверкой во время выполнения. Например, конечная точность с плавающей запятой может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не будет обладать свойством X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны ожидать ничего определённого.
Args
spectrum Форма [B1,...,Bb, N] Tensor. Разрешенные типы: float16, float32, float64, complex64, complex128. Тип может отличаться от input_output_dtype
input_output_dtype dtype для входных/выходных данных.
is_non_singular Ожидается, что этот оператор невырожден.
is_self_adjoint Ожидается, что этот оператор равен своему эрмитовому транспонированию. Если spectrum вещественное, это всегда будет верно.
is_positive_definite Ожидается, что этот оператор является положительно определённым, что означает, что квадратичная форма x^H A x имеет положительную вещественную часть для всех ненулевых x. Обратите внимание, что для того, чтобы оператор был положительно определённым, не требуется, чтобы он был самосопряжённым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix\

Расширение для несимметричных матриц

is_square Ожидается, что этот оператор действует как квадратные [пакетные] матрицы.
name Имя для добавления ко всем операциям, создаваемым этим классом.
Атрибуты
H Возвращает сопряжённый оператор текущего LinearOperator.

Дан A представляющий этот LinearOperator, возвращает A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.

batch_shape Размерность пакетных измерений этого LinearOperator.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает TensorShape([B1,...,Bb]), эквивалентное A.shape[:-2]

block_depth Глубина рекурсивно определённых циркулярных блоков, определяющих этот Operator.

С A плотной записью этого Operator

block_depth = 1 означает, что A симметрично циркулярна. Например,

A = |w z y x|
|x w z y|
|y x w z|
|z y x w|

block_depth = 2 означает, что A — это блочно-симметричная циркулярная матрица с симметрично-циркулярными блоками. Например, с W, X, Y, Z симметрично циркулярными,

A = |W Z Y X|
|X W Z Y|
|Y X W Z|
|Z Y X W|

block_depth = 3 означает, что A — это блочно-симметрично циркулярная матрица с блочно-симметрично циркулярными блоками.

block_shape
domain_dimension Размерность (в смысле векторных пространств) области действия этого оператора.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает N.

dtype Размер Tensors, обрабатываемых этим LinearOperator.
graph_parents Список зависимостей графа этого LinearOperator. (устарело)
Предупреждение: ЭТОТ МЕТОД УСТАРЕЛ. Он будет удалён в будущих версиях. Инструкции по обновлению: не вызывайте graph_parents.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли этот оператор квадратным.
parameters Словарь параметров, используемых для создания этого LinearOperator.
range_dimension Размерность (в смысле векторных пространств) области значений этого оператора.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает M.

shape Диапазон этого LinearOperator.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает TensorShape([B1,...,Bb, M, N]), эквивалентное A.shape.

spectrum
tensor_rank Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.

Если этот оператор действует как пакетная матрица A с A.shape = [B1,...,Bb, M, N], то он возвращает b + 2.

Методы

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'
)

Возвращает сопряжённое значение текущей LinearOperator.

Принимая A, представляющее эту LinearOperator, возвращает A*. Обратите внимание, что вызов self.adjoint() и self.H эквивалентны.

Аргументы
name Имя для этой Op.
Возвращаемое значение
LinearOperator , представляющее сопряжённое значение этой LinearOperator.

assert_hermitian_spectrum

Просмотреть исходный код

assert_hermitian_spectrum(
    name='assert_hermitian_spectrum'
)

Возвращает Op, который проверяет, что этот оператор имеет эрмитовский спектр.

Этот оператор соответствует вещественной матрице тогда и только тогда, когда его спектр эрмитов.

Аргументы
name Имя для этой Op.
Возвращаемое значение
Op , который проверяет, что этот оператор имеет эрмитовский спектр.

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

block_shape_tensor

Просмотреть исходный код

block_shape_tensor()

Форма блочных размерностей self.spectrum.

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.

convolution_kernel

Просмотреть исходный код

convolution_kernel(
    name='convolution_kernel'
)

Ядро свёртки, соответствующее self.spectrum.

n-мерное ДПФ этого ядра является спектром этого оператора в частотной области.

Аргументы
name Имя для этой Op.
Возвращаемое значение
Tensor с dtype self.dtype.

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.

Возвращённое значение 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 ложны.

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 ложны.

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/LinearOperatorCirculant2D

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API