Spec-Zone.ru › TensorFlow

tf.linalg.LinearOperatorHouseholder

LinearOperator действуя как [пакет] преобразований Хаусхолдера.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorHouseholder

tf.linalg.LinearOperatorHouseholder(
    reflection_axis,
    is_non_singular=None,
    is_self_adjoint=None,
    is_positive_definite=None,
    is_square=None,
    name='LinearOperatorHouseholder'
)

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

LinearOperatorHouseholder инициализируется с вектором (пакета).

Отражение Хаусхолдера, определённое с помощью вектора v, отражает точки в R^n относительно гиперплоскости, ортогональной v и проходящей через начало координат.

# Create a 2 x 2 householder transform.
vec = [1 / np.sqrt(2), 1. / np.sqrt(2)]
operator = LinearOperatorHouseholder(vec)

operator.to_dense()
==> [[0.,  -1.]
     [-1., -0.]]

operator.shape
==> [2, 2]

operator.log_abs_determinant()
==> scalar Tensor

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

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

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

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

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

  • Если is_X == True, вызывающие стороны должны ожидать, что оператор обладает свойством X. Это обещание, которое должно быть выполнено, но это не проверка во время выполнения. Например, конечная точность плавающей точки может привести к нарушению этих обещаний.
  • Если is_X == False, вызывающие стороны должны ожидать, что оператор не обладает свойством X.
  • Если is_X == None (по умолчанию), вызывающие стороны не должны иметь ожиданий.
Аргументы
reflection_axis Форма [B1,...,Bb, N] Tensor с b >= 0 N >= 0. Вектор, определяющий гиперплоскость для отражения. Допустимые типы данных: float16, float32, float64, complex64, complex128.
is_non_singular Ожидать, что этот оператор является невырожденным.
is_self_adjoint Ожидать, что этот оператор равен своему эрмитовому сопряжению. Автоматически устанавливается в значение true.
is_positive_definite Ожидать, что этот оператор является положительно определённым, то есть квадратичная форма x^H A x имеет положительную действительную часть для всех ненулевых x. Обратите внимание, что для положительной определённости оператора не требуется, чтобы он был эрмитовым. См.: https://en.wikipedia.org/wiki/Positive-definite_matrix#Extension_for_non-symmetric_matrices. Автоматически устанавливается в значение false.
is_square Ожидать, что этот оператор действует как квадратные [пакетные] матрицы. Автоматически устанавливается в значение true.
name Имя для этого LinearOperator.
Возникают исключения
ValueError is_self_adjoint не является True, is_positive_definite не является False или is_square не является 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]

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.

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

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

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

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

assert_positive_definite

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

assert_positive_definite(
    name='assert_positive_definite'
)

Возвращает утверждение, что этот оператор положительно определён.

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

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

assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

Возвращает утверждение, что этот оператор самосопряжён.

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

Аргументы
name Имя строки, добавляемое к созданным операциям.
Возвращаемое значение
Утверждение `Operation`, которое, при выполнении, вызовет исключение, если оператор не самосопряжён.

batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

Аргументы
name Имя для этого оператора.
Возвращаемое значение
Тензор формы Tensor

cholesky

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

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

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

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

Аргументы
name Имя для этого оператора.
Возвращаемое значение
Тензор, представляющий нижнюю треугольную матрицу в разложении Холецкого.
Исключения
ValueError Если оператор не предполагается положительно определённым и самосопряжённым.

cond

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

cond(
    name='cond'
)

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

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

determinant

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

determinant(
    name='det'
)

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

Аргументы
name Имя для этого оператора.
Возвращаемое значение
Тензор с формой self.batch_shape и такой же размерностью, как у self.
Исключения
NotImplementedError Если self.is_square является False.

diag_part

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

diag_part(
    name='diag_part'
)

Эффективно получить [пакетную] диагональную часть этого оператора.

Если у этого оператора форма [B1,...,Bb, M, N], это возвращает тензор 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 Имя для этого оператора.
Возвращаемое значение
diag_part Тензор с той же размерностью, что и у оператора.

domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

Аргументы
name Имя для этого оператора.
Возвращаемое значение
Число Tensor

eigvals

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

eigvals(
    name='eigvals'
)

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

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

Примечание: В настоящее время поддерживаются только самосопряжённые операторы.
Аргументы
name Имя для этого оператора.
Возвращаемое значение
Тензор формы Tensor с той же размерностью, что и у self.

inverse

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

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

Возвращает обратный оператор.

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

Аргументы
name Область именования операций, используемая этим методом.
Возвращаемое значение
LinearOperator, представляющую обратную матрицу.
Исключения
ValueError Если LinearOperator не указано, что является non_singular.

log_abs_determinant

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

log_abs_determinant(
    name='log_abs_det'
)

Логарифм абсолютного значения определителя для каждого члена пакетa.

Аргументы
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-выражение. Если True, умножить слева на сопряжённое: A^H x.
adjoint_arg Python-выражение. Если 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-выражение. Если 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-выражение. Если True, решить систему, вовлекая сопряжённый оператор: A^H X = rhs.
adjoint_arg Python-выражение. Если 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-выражение. Если True, решить систему, вовлекая сопряжённый оператор: 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/LinearOperatorHouseholder

Spec-Zone.ru

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