Spec-Zone.ru › TensorFlow 1.15

tf.linalg.LinearOperatorCirculant3D

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

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

Псевдонимы

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

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

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

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

  • Этот оператор является положительно определенным тогда и только тогда, когда 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

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

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 Размерность 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 Размерность этого 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.

Args
name Имя для этого Op.
Returns
int32 Tensor

inverse

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

inverse(
    name='inverse'
)

Возвращает обратную матрицу для этого LinearOperator.

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

Args
name Область имен для использования операциями, добавленными этим методом.
Returns
LinearOperator , представляющее обратную матрицу.
Raises
ValueError Если LinearOperator не указано, что оно является non_singular.

log_abs_determinant

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

log_abs_determinant(
    name='log_abs_det'
)

Логарифм абсолютного значения определителя для каждого элемента пакет.

Args
name Имя для этого Op.
Returns
Tensor с формой self.batch_shape и теми же dtype , что и self.
Raises
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]
Args
x LinearOperator или Tensor с совместимой формой и теми же dtype , что и self. См. документацию класса для определения совместимости.
adjoint Python bool. Если True, умножить слева на сопряжённую: A^H x.
adjoint_arg Python bool. Если True, вычислить A x^H , где x^H - это эрмитово транспонирование (транспонирование и комплексное сопряжение).
name Имя для этого Op.
Returns
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]
Args
x Tensor с совместимой формой и теми же dtype , что и self. x рассматривается как [пакет] вектор, означающий, что для каждого набора ведущих измерений последнее измерение определяет вектор. См. документацию класса для определения совместимости.
adjoint Python bool. Если True, умножить слева на сопряжённую: A^H x.
name Имя для этого Op.
Returns
Tensor с формой [..., M] и теми же dtype , что и self.

range_dimension_tensor

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

range_dimension_tensor(
    name='range_dimension_tensor'
)

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

Определяется во время выполнения.

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

Args
name Имя для этого Op.
Returns
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).

Args
name Имя для этого Op.
Returns
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
Args
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 Область имен для использования операциями, добавленными этим методом.
Returns
Tensor с формой [...,N, R] и теми же dtype , что и rhs.
Raises
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.

© 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/LinearOperatorCirculant3D

Spec-Zone.ru

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