tf.linalg.LinearOperatorCirculant3D
| Просмотреть исходный код на GitHub |
LinearOperator как блочно-циркулярная матрица.
Наследуется от: LinearOperator, Module
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] и взятия трехмерного DFT по первым трем измерениям. Пусть 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является вещественным.
См., например, "Discrete-Time Signal Processing", Oppenheim и Schafer.
Примеры
См. 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()включает в себя размерNreduce_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 | Возвращает сопряженный оператор. Дан |
batch_shape | Размерность пакетных измерений этого оператора. Если этот оператор действует как пакетная матрица |
block_depth | Глубина рекурсивно определенных циркулярных блоков, определяющих этот оператор. С
A = |w z y x| |x w z y| |y x w z| |z y x w|
A = |W Z Y X| |X W Z Y| |Y X W Z| |Z Y X W|
|
block_shape | |
domain_dimension | Размерность (в смысле векторных пространств) области определения этого оператора. Если этот оператор действует как пакетная матрица |
dtype | Форма обрабатываемых Tensor в этом операторе. |
graph_parents | Список зависимостей графа этого оператора. (устарело) |
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли оператор квадратным. |
parameters | Словарь параметров, используемых для инициализации этого оператора. |
range_dimension | Размерность (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакетная матрица |
shape | Форма этого оператора. Если этот оператор действует как пакетная матрица |
spectrum | |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как пакетная матрица |
Методы
add_to_tensor
add_to_tensor(
x, name='add_to_tensor'
)
Добавляет матрицу, представленную этим оператором, к x. Эквивалентно A + x.
| Аргументы | |
|---|---|
x | Tensor с той же dtype и формой, совместимой с вещанием для self.shape |
name | Имя для этого оператора. |
| Возвращает | |
|---|---|
A 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.
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='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 с той же формой, что и у этого оператора. 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
)
© 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.4/api_docs/python/tf/linalg/LinearOperatorCirculant3D