Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorLowerTriangular

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

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

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

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

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

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

tf.compat.v1.linalg.LinearOperatorLowerTriangular

tf.linalg.LinearOperatorLowerTriangular(
    tril, is_non_singular=None, is_self_adjoint=None, is_positive_definite=None,
    is_square=None, name='LinearOperatorLowerTriangular'
)

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

LinearOperatorLowerTriangular инициализируется Tensor с размерами [B1,...,Bb, N, N]. Верхний треугольник последних двух измерений игнорируется.

# Create a 2 x 2 lower-triangular linear operator.
tril = [[1., 2.], [3., 4.]]
operator = LinearOperatorLowerTriangular(tril)

# The upper triangle is ignored.
operator.to_dense()
==> [[1., 0.]
     [3., 4.]]

operator.shape
==> [2, 2]

operator.log_abs_determinant()
==> scalar Tensor

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

# Create a [2, 3] batch of 4 x 4 linear operators.
tril = tf.random.normal(shape=[2, 3, 4, 4])
operator = LinearOperatorLowerTriangular(tril)

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

Этот оператор действует на [пакетной] матрице с совместимой формой. x является пакетной матрицей с совместимой формой для matmul и solve если

operator.shape = [B1,...,Bb] + [N, N],  with b >= 0
x.shape =        [B1,...,Bb] + [N, R],  with R >= 0.

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

Предположим, что operator является LinearOperatorLowerTriangular формы [N, N], а x.shape = [N, R]. Тогда

  • operator.matmul(x) включает в себя N^2 * R умножений.
  • operator.solve(x) включает N * R размера N обратных подстановок.
  • operator.determinant() включает в себя размер N reduce_prod.

Если вместо этого 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 (по умолчанию), вызывающие стороны не должны иметь ожиданий ни в ту, ни в другую сторону.
Аргументы
tril Форма [B1,...,Bb, N, N] с b >= 0, N >= 0. Нижняя треугольная часть tril определяет этот оператор. Строго верхний треугольник игнорируется.
is_non_singular Ожидается, что этот оператор является невырожденным. Этот оператор является невырожденным тогда и только тогда, когда все его диагональные элементы отличны от нуля.
is_self_adjoint Ожидается, что этот оператор равен своему эрмитовому транспонированию. Этот оператор является самосопряженным только в том случае, если он является диагональным с вещественными диагональными элементами. В этом случае рекомендуется использовать LinearOperatorDiag.
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.
Возможные исключения
ValueError Если is_square является False.
Атрибуты
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 Размерность DType Tensor обрабатываемого этим 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, представляющий сопряжённый оператор 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. Обратите внимание, что для положительной определенности мы не требуем, чтобы оператор был самосопряжённым.

END_OF_DOCUMENT_MARKER
Аргументы
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'
)

Преобразовать матрицу [batch] 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'
)

Преобразовать [batch] вектор 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 рассматривается как [batch] вектор, то есть для каждой группы ведущих измерений последнее измерение определяет вектор. См. строку документации класса для определения совместимости.
adjoint Python bool. Если adjoint, умножить слева на сопряжённую матрицу: A^H x.
name Имя для этого Op.
Возвращаемое значение
Tensor с формой [..., M] и теми же dtype что и self.

range_dimension_tensor

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

range_dimension_tensor(
    name='range_dimension_tensor'
)

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

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

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

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

shape_tensor

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

shape_tensor(
    name='shape_tensor'
)

Форма этого LinearOperator, определяемая во время выполнения.

Если этот оператор действует как матрица [batch] 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 (batch) системы уравнений: 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 рассматривается как [batch] матрица, то есть для каждой группы ведущих измерений последние два измерения определяют матрицу. См. строку документации класса для определения совместимости.
adjoint Python bool. Если True, решить систему, используя сопряжённый оператор: 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 рассматривается как [batch] вектор, то есть для каждой группы ведущих измерений последнее измерение определяет вектор. См. строку документации класса для определения совместимости по batch измерениям.
adjoint Python bool. Если 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'
)

Ранг (в смысле тензоров) матрицы, соответствующей этому оператору.

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

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

to_dense

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

to_dense(
    name='to_dense'
)

Возвращает плотную (batch) матрицу, представляющую этот оператор.

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/LinearOperatorLowerTriangular

Spec-Zone.ru

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