tf.linalg.LinearOperatorPermutation

LinearOperator действующий как [пакет] матриц перестановок.

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

tf.linalg.LinearOperatorPermutation(
    perm,
    dtype=tf.dtypes.float32,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name='LinearOperatorPermutation'
)

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

LinearOperatorPermutation инициализируется (пакетом) вектором.

Перестановка определяется целочисленным вектором v, значения которого уникальны и находятся в диапазоне [0, ... n]. Применение перестановки к входной матрице имеет следующий смысл: значение v в индексе i указывает на перемещение v[i]-й строки входной матрицы в i-ю строку. Поскольку все значения уникальны, это приведет к перестановке строк входной матрицы. Обратите внимание, что вектор перестановки v имеет тот же смысл, что и tf.transpose.

# Create a 3 x 3 permutation matrix that swaps the last two columns.
vec = [0, 2, 1]
operator = LinearOperatorPermutation(vec)

operator.to_dense()
==> [[1., 0., 0.]
     [0., 0., 1.]
     [0., 1., 0.]]

operator.shape
==> [3, 3]

# This will be zero.
operator.log_abs_determinant()
==> scalar Tensor

x = ... Shape [3, 4] Tensor
operator.matmul(x)
==> Shape [3, 4] Tensor

Совместимость форм

Этот оператор действует на [пакет] матрицу с совместимой формой. x это пакетная матрица с совместимой формой для matmul и solve, если

operator.shape = [B1,...,Bb] + [N, N],  with b >= 0
x.shape =   [C1,...,Cc] + [N, R],
and [C1,...,Cc] broadcasts with [B1,...,Bb] to [D1,...,Dd]

Подсказки свойств матрицы

Этот LinearOperator инициализируется булевыми флагами формы is_X для X = non_singular, self_adjoint, positive_definite, square. Эти флаги имеют следующий смысл:

• Если is_X == True, вызывающие стороны должны ожидать, что оператор будет обладать свойством X. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность с плавающей точкой может привести к нарушению этих обещаний.
• Если is_X == False, вызывающие стороны должны ожидать, что оператор не будет обладать свойством X.
• Если is_X == None (значение по умолчанию), вызывающие стороны не должны иметь ожиданий.

Методы

add_to_tensor

Просмотр исходного кода

add_to_tensor(
    x, name='add_to_tensor'
)

Добавить матрицу, представленную этим оператором, к x. Эквивалентно A + x.

adjoint

Просмотр исходного кода

adjoint(
    name: str = 'adjoint'
) -> 'LinearOperator'

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

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

assert_non_singular

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

assert_non_singular(
    name='assert_non_singular'
)

Возвращает утверждение, что этот оператор не является вырожденным.

Этот оператор считается невырожденным, если

ConditionNumber < max{100, range_dimension, domain_dimension} * eps,
eps := np.finfo(self.dtype.as_numpy_dtype).eps

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

Возвращает утверждение, что этот оператор является положительно определённым.

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

cholesky

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

cholesky(
    name: str = 'cholesky'
) -> 'LinearOperator'

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

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

cond

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

cond(
    name='cond'
)

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

determinant

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

determinant(
    name='det'
)

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

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.]

domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

eigvals

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

eigvals(
    name='eigvals'
)

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

Если оператор помечен как самосопряжённый (через is_self_adjoint), вычисление может быть более эффективным.

Примечание: В настоящее время поддерживаются только самосопряжённые операторы.

inverse

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

inverse(
    name: str = 'inverse'
) -> 'LinearOperator'

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

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

log_abs_determinant

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

log_abs_determinant(
    name='log_abs_det'
)

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

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]

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]

range_dimension_tensor

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

range_dimension_tensor(
    name='range_dimension_tensor'
)

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

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

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

shape_tensor

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

shape_tensor(
    name='shape_tensor'
)

Форма этого LinearOperator, определяемая во время выполнения.

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

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

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

tensor_rank_tensor

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

tensor_rank_tensor(
    name='tensor_rank_tensor'
)

Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.

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

to_dense

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

to_dense(
    name='to_dense'
)

Возвращает плотная (пакетная) матрица, представляющая этот оператор.

trace

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

trace(
    name='trace'
)

След линейного оператора, равный сумме self.diag_part().

Если оператор квадратный, то это также сумма собственных значений.

__getitem__

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

__getitem__(
    slices
)

__matmul__

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

__matmul__(
    other
)