Spec-Zone.ru › TensorFlow 2.9

tf.linalg.LinearOperatorTridiag

LinearOperator действуя как [пакетный] квадратная треугольная матрица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorTridiag

tf.linalg.LinearOperatorTridiag(
    diagonals,
    diagonals_format=_COMPACT,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name='LinearOperatorTridiag'
)

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

Пример использования:

Создайте треугольный линейный оператор 3 × 3.

superdiag = [3., 4., 5.]
diag = [1., -1., 2.]
subdiag = [6., 7., 8]
operator = tf.linalg.LinearOperatorTridiag(
   [superdiag, diag, subdiag],
   diagonals_format='sequence')
operator.to_dense()
<tf.Tensor: shape=(3, 3), dtype=float32, numpy=
array([[ 1.,  3.,  0.],
       [ 7., -1.,  4.],
       [ 0.,  8.,  2.]], dtype=float32)>
operator.shape
TensorShape([3, 3])

Скалярный тензорный вывод.

operator.log_abs_determinant()
<tf.Tensor: shape=(), dtype=float32, numpy=4.3307333>

Создайте [2, 3] пакет 4 × 4 линейных операторов.

diagonals = tf.random.normal(shape=[2, 3, 3, 4])
operator = tf.linalg.LinearOperatorTridiag(
  diagonals,
  diagonals_format='compact')

Создайте вектор формы [2, 1, 4, 2]. Обратите внимание, что эта форма совместима, так как размерности пакета [2, 1] транслируются в operator.batch_shape = [2, 3].

y = tf.random.normal(shape=[2, 1, 4, 2])
x = operator.solve(y)
x
<tf.Tensor: shape=(2, 3, 4, 2), dtype=float32, numpy=...,
dtype=float32)>

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

Этот оператор действует на [пакетной] матрице с совместимой формой. 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].

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

Предположим, что operator — это LinearOperatorTridiag формы [N, N], и x.shape = [N, R]. Тогда

  • operator.matmul(x) займет время O(N * R).
  • operator.solve(x) займет время O(N * R).

Если вместо этого 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 (по умолчанию), вызывающие стороны не должны ожидать ничего определённого.
Args
diagonals Tensor или список Tensor в зависимости от diagonals_format.

Если diagonals_format=sequence, это список из трёх Tensor с формой [B1, ..., Bb, N], b >= 0, N >= 0, представляющих наддиагональ, диагональ и поддиагональ соответственно. Обратите внимание, что наддиагональ дополняется элементом в последней позиции, а поддиагональ — элементом в первой позиции.

Если diagonals_format=matrix это [B1, ... Bb, N, N] формы Tensor представляющий полную треугольную матрицу.

Если diagonals_format=compact это [B1, ... Bb, 3, N] формы Tensor с второй от последней размерностью, индексирующей наддиагональ, диагональ и поддиагональ соответственно. Обратите внимание, что наддиагональ дополняется элементом в последней позиции, а поддиагональ — элементом в первой позиции.

Во всех случаях эти Tensor — все с плавающей точкой.

diagonals_format один из matrix, sequence, или compact. По умолчанию compact.
is_non_singular Ожидать, что этот оператор не является вырожденным.
is_self_adjoint Ожидать, что этот оператор равен своей эрмитовой транспонированной. Если diag.dtype действителен, это автоматически устанавливается в True
is_positive_definite Ожидать, что этот оператор является положительно определённым, означающим, что квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости оператора не требуется, чтобы он был самосопряжённым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices
is_square Ожидать, что этот оператор действует как квадратные [пакетные] матрицы.
name Имя для этого LinearOperator.
Возможные ошибки
TypeError Если diag.dtype не является допустимым типом.
ValueError Если diag.dtype действителен, и is_self_adjoint не True.
Атрибуты
H Возвращает сопряжённый оператор.

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

batch_shape Размерность пакета этого LinearOperator.

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

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

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

dtype Размерность обрабатываемых Tensor этим LinearOperator.
graph_parents Список графовых зависимостей этого LinearOperator. (устарело)
Устарело: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена в будущей версии. Инструкции по обновлению: Не вызывайте graph_parents.
is_non_singular
is_positive_definite
is_self_adjoint
is_square Возвращает True/False в зависимости от того, является ли оператор квадратным.
parameters Словарь параметров, используемых для создания этого LinearOperator.
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.

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.

Args
x Tensor с той же dtype и формой, транслируемой к self.shape
name Имя для этого Op.
Возвращает
Tensor с формой трансляции и той же dtype что у self.

adjoint

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

adjoint(
    name='adjoint'
)

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

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

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

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
Аргументы
name Имя строки для добавления к созданным операциям.
Возвращает
Операция Assert Op, которая при выполнении поднимет исключение InvalidArgumentError если оператор является одиночным.

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

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

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

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

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

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

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

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.

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 Питон bool. Если True, выполните левое умножение на сопряжённое: A^H x.
adjoint_arg Питон 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 Питон 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 Питон bool. Если True, решить систему, включающую сопряжённый оператор LinearOperator: A^H X = rhs.
adjoint_arg Питон 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 Питон 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
)

© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/linalg/LinearOperatorTridiag

Spec-Zone.ru

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