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: str = 'adjoint'
) -> 'LinearOperator'

Возвращает сопряжённый оператор текущего LinearOperator.

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

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

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], то возвращает Tensor, содержащее [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
)