Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorCirculant3D

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

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

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

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

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

tf.compat.v1.linalg.LinearOperatorCirculant3D

tf.linalg.LinearOperatorCirculant3D(
    spectrum: tf.Tensor,
    input_output_dtype=tf.dtypes.complex64,
    is_non_singular: bool = None,
    is_self_adjoint: bool = None,
    is_positive_definite: bool = None,
    is_square: bool = 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, N0, N1, N2] 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 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: str = 'adjoint'
) -> 'LinearOperator'

Возвращает присоединённую матрицу текущего 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: str = 'cholesky'
) -> 'LinearOperator'

Возвращает фактор Холецкого в виде 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: str = 'inverse'
) -> 'LinearOperator'

Возвращает обратный LinearOperator.

Учитывая A, представляющую этот LinearOperator, возвратите LinearOperator, представляющую A^-1.

Аргументы
name Область именования scope для операций, добавленных этим методом.
Возвращает
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.

__getitem__

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

__getitem__(
    slices
)

__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/api_docs/python/tf/linalg/LinearOperatorCirculant3D

Spec-Zone.ru

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