Spec-Zone.ru › TensorFlow 2.9

tf.linalg.LinearOperatorCirculant3D

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

LinearOperator действуя как вложенная блочная циркулянтная матрица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorCirculant3D

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

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

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

Если A является вложенной блочной циркулянтной, с размерами блоков N0, N1, N2 (N0 * N1 * N2 = 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, N2], (N0 * N1 * N2 = N): Грубо говоря, умножение матриц равно действию умножителя Фурье: A u = IDFT3[ H DFT3[u] ]. Строго говоря, учитывая [N, R] матрицу u, пусть DFT3[u] будет [N0, N1, N2, R] Tensor, определенной путем преобразования формы u в [N0, N1, N2, R] и взятия трехмерного ДПФ по первым трем измерениям. Пусть IDFT3 — обратное к DFT3. Умножение матриц можно выразить по столбцам:

(A u)_r = IDFT3[ H * (DFT3[u])_r ]

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

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

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

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

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

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

Примеры

См. LinearOperatorCirculant и LinearOperatorCirculant2D для примеров.

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

Предположим 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 Ожидается, что этот оператор является положительно определенным, то есть действительная часть всех собственных значений положительна. Мы не требуем, чтобы оператор был самосопряженным, чтобы он был положительно определенным. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix #Extension_for_non_symmetric_matrices
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.

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

Аргументы
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 равно 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
)

© 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/versions/r2.9/api_docs/python/tf/linalg/LinearOperatorCirculant3D

Spec-Zone.ru

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