Spec-Zone.ru › TensorFlow

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 x 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>

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

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 (значение по умолчанию), вызывающий код не должен делать никаких предположений.
Аргументы
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 Возвращает сопряжённый оператор текущего LinearOperator.

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

batch_shape TensorShape пакетных измерений этого 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 Tensor.
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 TensorShape этого 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: str = 'adjoint'
) -> 'LinearOperator'

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

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

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

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

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

Возвращает Op, проверяющий, что оператор положительно определён.

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

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

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

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

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

cholesky

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

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

Возвращает разложение Холецкого в виде 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, что и у самого объекта.

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

Возвращает обратный оператор для этого 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 Объект 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 имеет значение False.

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 имеет значение False.

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.

__getitem__

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

__getitem__(
    slices
)

__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/api_docs/python/tf/linalg/LinearOperatorTridiag

Spec-Zone.ru

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