Spec-Zone.ru › TensorFlow 2.4

tf.linalg.LinearOperatorCirculant

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

LinearOperator действующий как циркулянтная матрица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorCirculant

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

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

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

Циркулянт означает, что элементы A генерируются одним вектором, ядром свертки h: A_{mn} := h_{m-n mod N}. При h = [w, x, y, z],

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

Это означает, что результат матричного умножения v = Au имеет Lth столбец, заданный циклической сверткой между h и Lth столбцом u.

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

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

DFT[ h[n] ] = H[k] := sum_{n = 0}^{N - 1} h_n e^{-i 2pi k n / N}
IDFT[ H[k] ] = h[n] = N^{-1} sum_{k = 0}^{N - 1} H_k e^{i 2pi k n / N}

Из этих определений мы видим, что

H[0] = sum_{n = 0}^{N - 1} h_n
H[1] = "the first positive frequency"
H[N - 1] = "the first negative frequency"

Грубо говоря, при поэлементном умножении * матричное умножение равно действию множителя Фурье: A u = IDFT[ H * DFT[u] ]. Точно говоря, при заданной матрице [N, R] u, пусть DFT[u] — матрица [N, R] со столбцом rth, равным ДПФ rth столбца u. Определим IDFT аналогично. Матричное умножение может быть выражено по столбцам:

(A u)_r = IDFT[ H * (DFT[u])_r ]

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

Пусть U — kth единичный вектор, а U = IDFT[u]. Вышеприведенные формулы показывают, что A U = H_k * U. Мы заключаем, что элементы H являются собственными значениями этого оператора. Следовательно

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

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

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

H[..., n % N] = ComplexConjugate[ H[..., (-n) % N] ]

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

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

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

# spectrum is real ==> operator is self-adjoint
# spectrum is positive ==> operator is positive definite
spectrum = [6., 4, 2]

operator = LinearOperatorCirculant(spectrum)

# IFFT[spectrum]
operator.convolution_kernel()
==> [4 + 0j, 1 + 0.58j, 1 - 0.58j]

operator.to_dense()
==> [[4 + 0.0j, 1 - 0.6j, 1 + 0.6j],
     [1 + 0.6j, 4 + 0.0j, 1 - 0.6j],
     [1 - 0.6j, 1 + 0.6j, 4 + 0.0j]]

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

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

# spectrum is Hermitian ==> operator is real.
# spectrum is shape [3] ==> operator is shape [3, 3]
# We force the input/output type to be real, which allows this to operate
# like a real matrix.
operator = LinearOperatorCirculant(spectrum, input_output_dtype=tf.float32)

operator.to_dense()
==> [[ 1, 1, 2],
     [ 2, 1, 1],
     [ 1, 2, 1]]

Пример эрмитова спектра

# spectrum is shape [3] ==> operator is shape [3, 3]
# spectrum is Hermitian ==> operator is real.
spectrum = [1, 1j, -1j]

operator = LinearOperatorCirculant(spectrum)

operator.to_dense()
==> [[ 0.33 + 0j,  0.91 + 0j, -0.24 + 0j],
     [-0.24 + 0j,  0.33 + 0j,  0.91 + 0j],
     [ 0.91 + 0j, -0.24 + 0j,  0.33 + 0j]

Пример принуждения вещественного dtype при эрмитовом спектре

# spectrum is shape [4] ==> operator is shape [4, 4]
# spectrum is real ==> operator is self-adjoint
# spectrum is Hermitian ==> operator is real
# spectrum has positive real part ==> operator is positive-definite.
spectrum = [6., 4, 2, 4]

# Force the input dtype to be float32.
# Cast the output to float32.  This is fine because the operator will be
# real due to Hermitian spectrum.
operator = LinearOperatorCirculant(spectrum, input_output_dtype=tf.float32)

operator.shape
==> [4, 4]

operator.to_dense()
==> [[4, 1, 0, 1],
     [1, 4, 1, 0],
     [0, 1, 4, 1],
     [1, 0, 1, 4]]

# convolution_kernel = tf.signal.ifft(spectrum)
operator.convolution_kernel()
==> [4, 1, 0, 1]

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

Предположим 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 (по умолчанию), вызывающие стороны не должны ожидать ничего.

Ссылки:

Обзор матриц Топлица и Циркулянт: Грей, 2006 (pdf)

Аргументы
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 DType Tensor , обрабатываемые этим 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.

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

Аргументы
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 Область именования 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. См. строку документа класса для определения совместимости.
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.
Возвращаемое значение
A 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 равно 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 обрабатывается как [пакетный] вектор, что означает, что для каждого набора ведущих измерений последнее измерение определяет вектор. См. строку документации класса для определения совместимости относительно пакетных измерений.
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.4/api_docs/python/tf/linalg/LinearOperatorCirculant

Spec-Zone.ru

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