tf.linalg.LinearOperator

Базовый класс, определяющий [пачку] линейного оператора[ов].

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

tf.linalg.LinearOperator(
    dtype,
    graph_parents=None,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name=None,
    parameters=None
)

Подклассы LinearOperator предоставляют доступ к общим методам по (пачке) матрицы без необходимости её материализации. Это позволяет:

• Вычисления без матриц
• Операторы, которые используют преимущества специальной структуры, при этом предоставляя пользователям согласованный API.

Наследование

Чтобы включить публичный метод, подклассы должны реализовать метод с ведущим нижним подчеркиванием. Подпись аргумента должна быть идентичной, за исключением пропуска name="...". Например, чтобы включить matmul(x, adjoint=False, name="matmul"), подкласс должен реализовать _matmul(x, adjoint=False).

Контракт производительности

Подклассы должны реализовывать только методы assert (например, assert_non_singular) если они могут быть выполнены за время меньше O(N^3).

Документация класса должна содержать объяснение вычислительной сложности. Поскольку это библиотека высокой производительности, необходимо обращать внимание на детали, и объяснения могут включать константы, а также нотацию Big-O.

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

Подклассы LinearOperator должны работать с [пачкой] матрицей с совместимой формой. Документация класса должна определять, что подразумевается под совместимой формой. Некоторые подклассы могут не поддерживать пакетную обработку.

Примеры:

x — это пакетная матрица с совместимой формой для matmul если

operator.shape = [B1,...,Bb] + [M, N],  b >= 0,
x.shape =   [B1,...,Bb] + [N, R]

rhs — это пакетная матрица с совместимой формой для solve если

operator.shape = [B1,...,Bb] + [M, N],  b >= 0,
rhs.shape =   [B1,...,Bb] + [M, R]

Пример строки документации для подклассов.

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

Примеры:

some_tensor = ... shape = ????
operator = MyLinOp(some_tensor)

operator.shape()
==> [2, 4, 4]

operator.log_abs_determinant()
==> Shape [2] Tensor

x = ... Shape [2, 4, 5] Tensor

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

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

Этот оператор действует на пакетные матрицы с совместимой формой. ЗАПОЛНИТЕ, ЧТО ПОДРАЗУМЕВАЕТСЯ ПОД СОВМЕСТИМОЙ ФОРМОЙ

Производительность

ЗАПОЛНИТЕ ЭТО

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

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

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

Параметры инициализации

Все подклассы LinearOperator должны передавать аргумент parameters в super().__init__(). Он должен быть dict, содержащим необработанные аргументы, переданные подклассу __init__. Например, MyLinearOperator с инициализатором должен выглядеть так:

def __init__(self, operator, is_square=False, name=None):
   parameters = dict(
       operator=operator,
       is_square=is_square,
       name=name
   )
   ...
   super().__init__(..., parameters=parameters)

Пользователи могут получить доступ к my_linear_operator.parameters, чтобы увидеть все аргументы, переданные в его инициализатор.

Методы

add_to_tensor

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

add_to_tensor(
    x, name='add_to_tensor'
)

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

adjoint

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

adjoint(
    name='adjoint'
)

Возвращает сопряжённый оператор текущего 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'
)

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

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

Возвращает операцию Op, которая проверяет, что этот оператор является самосопряжённым.

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

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

cholesky

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

cholesky(
    name='cholesky'
)

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

Возвращает обратный оператор к этому 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'
)

Преобразуйте матрицу [batch] 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'
)

Преобразуйте [batch] вектор 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().

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

__matmul__

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

__matmul__(
    other
)