tf.linalg.LinearOperatorHouseholder
| Просмотреть исходный код на GitHub |
LinearOperator действуя как [пакет] преобразований Хаусхолдера.
Наследует от: LinearOperator
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 | Возвращает сопряженный оператор текущего LinearOperator. В данном случае |
batch_shape | Размеры пакетных измерений этого LinearOperator. Если этот оператор действует как пакетная матрица |
domain_dimension | Размерность (в смысле векторных пространств) области определения этого оператора. Если этот оператор действует как пакетная матрица |
dtype | Размерность Tensor, обрабатываемых этим LinearOperator. |
graph_parents | Список зависимостей графа этого LinearOperator. (устарело)
|
is_non_singular | |
is_positive_definite | |
is_self_adjoint | |
is_square | Возвращает True/False в зависимости от того, является ли этот оператор квадратным. |
range_dimension | Размерность (в смысле векторных пространств) области значений этого оператора. Если этот оператор действует как пакетная матрица |
reflection_axis | |
shape | Ранг этого LinearOperator. Если этот оператор действует как пакетная матрица |
tensor_rank | Ранг (в смысле тензоров) матрицы, соответствующей этому оператору. Если этот оператор действует как пакетная матрица |
Методы
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'
)
Возвращает сопряженный оператор текущего 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 | Имя строки для добавления к созданным операциям. |
| Возвращаемое значение | |
|---|---|
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'
)
Возвращает объект 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='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 | 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. |
__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/LinearOperatorHouseholder