Spec-Zone.ru › TensorFlow 1.15

tf.linalg.LinearOperatorCirculant2D

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

LinearOperator, подобно блочно-циркулярной матрице.

Псевдонимы

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

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

tf.compat.v1.linalg.LinearOperatorCirculant2D, `tf.compat.v2.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. Умножение матриц может быть выражено по столбцам:

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

  • Этот оператор положительно определён тогда и только тогда, когда 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 (по умолчанию), вызывающие стороны не должны ожидать ничего.
Аргументы
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 Возвращает сопряжённый оператор.

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

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

Если этот оператор действует как пакетная матрица 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.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли оператор квадратным.
range_dimension Размерность области значений этого оператора.

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

shape TensorShape этого 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 не предполагается положительно определённым и самосопряжённым.

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

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-строка. Если True, выполнить левое умножение на сопряжённое: A^H x.
adjoint_arg Python-строка. Если 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 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. x рассматривается как [пакетный] вектор, что означает, что для каждого набора ведущих измерений последнее измерение определяет вектор. Смотрите документацию класса для определения совместимости.
adjoint Python-строка. Если 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-строка. Если True, решить систему, включающую сопряжённое этого оператора: A^H X = rhs.
adjoint_arg Python-строка. Если 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 ложно.

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.

© 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/r1.15/api_docs/python/tf/linalg/LinearOperatorCirculant2D

Spec-Zone.ru

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