Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorCirculant3D

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

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

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

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

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

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. Умножение матриц можно выразить по столбцам:

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

  • Этот оператор является положительно определенным тогда и только тогда, когда 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 Тип DType обрабатываемых этим LinearOperator .
graph_parents Список зависимостей графа этого LinearOperator (устарело)
Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Не вызывайте graph_parents.
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.

data-text="adjoint" id="adjoint" tabindex="0">adjoint

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

adjoint(
    name='adjoint'
)

Возвращает сопряжённую матрицу текущего LinearOperator.

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

Аргументы
name Имя для этого Op.
Возвращает
LinearOperator , представляющий сопряжённую матрицу этого LinearOperator .

data-text="assert_hermitian_spectrum" id="assert_hermitian_spectrum" tabindex="0">assert_hermitian_spectrum

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

assert_hermitian_spectrum(
    name='assert_hermitian_spectrum'
)

Возвращает Op , утверждающий, что у этого оператора спектр Эрмита.

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

Аргументы
name Имя для этого Op .
Возвращает
Op , утверждающий, что у этого оператора спектр Эрмита.

data-text="assert_non_singular" id="assert_non_singular" tabindex="0">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 , если оператор является вырожденным.

data-text="assert_positive_definite" id="assert_positive_definite" tabindex="0">assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

Возвращает Op , утверждающий, что этот оператор положительно определён.

Здесь положительно определённый означает, что квадратичная форма x^H A x имеет положительную вещественную часть для всех ненулевых x. Обратите внимание, что для положительной определённости оператора не требуется, чтобы он был самосопряжённым.

Аргументы
name Имя для этого Op .
Возвращает
Assert Op, который при выполнении вызовет исключение InvalidArgumentError , если оператор не является положительно определённым.

data-text="assert_self_adjoint" id="assert_self_adjoint" tabindex="0">assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

Возвращает Op , утверждающий, что этот оператор самосопряжён.

Здесь проверяется, что этот оператор точно равен своему эрмитовому транспонированию.

Аргументы
name Строковое имя для добавления к созданным операциям.
Возвращает
Assert Op, который при выполнении вызовет исключение InvalidArgumentError , если оператор не является самосопряжённым.

data-text="batch_shape_tensor" id="batch_shape_tensor" tabindex="0">batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

Форма пакетных измерений этого оператора, определённая во время выполнения.

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

Аргументы
name Имя для этого Op .
Возвращает
int32 Tensor

data-text="block_shape_tensor" id="block_shape_tensor" tabindex="0">block_shape_tensor

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

block_shape_tensor()

Форма блочных измерений self.spectrum .

data-text="cholesky" id="cholesky" tabindex="0">cholesky

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

cholesky(
    name='cholesky'
)

Возвращает фактор Холецкого как LinearOperator.

Учитывая A , представляющую этот LinearOperator, если A является положительно определённой самосопряжённой матрицей, возвращает L, где A = L L^T, т. е. разложение Холецкого.

Аргументы
name Имя для этого Op .
Возвращает
LinearOperator , представляющий нижнюю треугольную матрицу в разложении Холецкого.
Исключения
ValueError Если LinearOperator не предполагается положительно определённой и самосопряжённой.

data-text="cond" id="cond" tabindex="0">cond

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

cond(
    name='cond'
)

Возвращает число обусловленности этого линейного оператора.

Аргументы
name Имя для этого Op .
Возвращает
Форма [B1,...,Bb] Tensor той же dtype , что и у self .

data-text="convolution_kernel" id="convolution_kernel" tabindex="0">convolution_kernel

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

convolution_kernel(
    name='convolution_kernel'
)

Ядро свёртки, соответствующее self.spectrum.

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

Аргументы
name Имя для этого Op .
Возвращает
Tensor с формой dtype self.dtype .

data-text="determinant" id="determinant" tabindex="0">determinant

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

determinant(
    name='det'
)

Определитель для каждого члена пакета.

Аргументы
name Имя для этого Op .
Возвращает
Tensor с формой self.batch_shape и теми же dtype , что и у self .
Исключения
NotImplementedError Если self.is_square является False .

data-text="diag_part" id="diag_part" tabindex="0">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.
Возвращает
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.

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

Spec-Zone.ru

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