Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorTridiag

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

Унаследован от: LinearOperator

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

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

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

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 не материализуется, но для целей вещания эта форма будет актуальна.

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

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

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] из 4x4 линейных операторов.

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

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

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

adjoint

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

adjoint(
    name='adjoint'
)

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

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

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

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

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

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

Args
name Имя для этого Op.
Returns
Объект Assert Op, который при выполнении вызовет InvalidArgumentError , если оператор не является положительно определённым.

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

Args
name Имя строки, добавляемое к созданным операциям.
Returns
Объект Assert Op, который при выполнении вызовет InvalidArgumentError , если оператор не является самосопряжённым.

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

Args
name Имя для этого Op.
Returns
int32 Tensor

cholesky

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

cholesky(
    name='cholesky'
)

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

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

Args
name Имя для этого Op.
Returns
LinearOperator , представляющее нижнюю треугольную матрицу в разложении Холецкого.
Raises
ValueError Если для LinearOperator не задано предположение о положительной определённости и самосопряжённости.

cond

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

cond(
    name='cond'
)

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

Args
name Имя для этого Op.
Returns
Матрица формы [B1,...,Bb] Tensor того же dtype , что и self.

determinant

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

determinant(
    name='det'
)

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

Args
name Имя для этого Op.
Returns
Tensor с формой self.batch_shape и тем же dtype , что и self.
Raises
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.]
Args
name Имя для этого Op.
Returns
diag_part Tensor с тем же dtype , что и self.

domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

Args
name Имя для этого Op.
Returns
int32 Tensor

eigvals

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

eigvals(
    name='eigvals'
)

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

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

Примечание: В настоящее время поддерживаются только самосопряжённые операторы.
Args
name Имя для этого Op.
Returns
Матрица формы [B1,...,Bb, N] Tensor того же dtype , что и self.

inverse

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

inverse(
    name='inverse'
)

Возвращает обратное значение этого LinearOperator.

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

Args
name Область именования операций, используемая этим методом.
Returns
LinearOperator , представляющий обратную матрицу.
Raises
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 ложно.

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 Python 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
)

© 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.3/api_docs/python/tf/linalg/LinearOperatorTridiag

Spec-Zone.ru

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