Spec-Zone.ru › TensorFlow 2.4

tf.linalg.LinearOperatorToeplitz

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

LinearOperator подобно [пакету] матриц Тоepлица.

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

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

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

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

tf.compat.v1.linalg.LinearOperatorToeplitz

tf.linalg.LinearOperatorToeplitz(
    col, row, is_non_singular=None, is_self_adjoint=None, is_positive_definite=None,
    is_square=None, name='LinearOperatorToeplitz'
)

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

Описание в терминах матриц Тоepлица

Матрица Тоepлица означает, что A имеет постоянные диагонали. Таким образом, A можно сгенерировать с помощью двух векторов. Один представляет первую колонку матрицы, а другой — первую строку.

Ниже приведен пример 4x4:

A = |a b c d|
    |e a b c|
    |f e a b|
    |g f e a|

Пример оператора Тоepлица.

# Create a 3 x 3 Toeplitz operator.
col = [1., 2., 3.]
row = [1., 4., -9.]
operator = LinearOperatorToeplitz(col, row)

operator.to_dense()
==> [[1., 4., -9.],
     [2., 1., 4.],
     [3., 2., 1.]]

operator.shape
==> [3, 3]

operator.log_abs_determinant()
==> scalar Tensor

x = ... Shape [3, 4] Tensor
operator.matmul(x)
==> Shape [3, 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 (по умолчанию), вызывающие стороны не должны иметь никаких ожиданий.
Аргументы
col Форма [B1,...,Bb, N] Tensor с b >= 0 N >= 0. Первый столбец оператора. Допустимые типы данных: float16, float32, float64, complex64, complex128. Обратите внимание, что первый элемент col предполагается равным первому элементу row.
row Форма [B1,...,Bb, N] Tensor с b >= 0 N >= 0. Первая строка оператора. Допустимые типы данных: float16, float32, float64, complex64, complex128. Обратите внимание, что первый элемент row предполагается равным первому элементу col.
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.
Атрибуты
H Возвращает сопряженный оператор текущего LinearOperator.

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

batch_shape Размерность пакетных измерений этого LinearOperator.

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

col
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 в зависимости от того, является ли этот оператор квадратным.
parameters Словарь параметров, используемых для создания этого LinearOperator.
range_dimension Размерность (в смысле векторных пространств) области значений этого оператора.

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

row
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'
)

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

data-text="assert_self_adjoint" id="assert_self_adjoint">assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

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

data-text="batch_shape_tensor" id="batch_shape_tensor">batch_shape_tensor

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

batch_shape_tensor(
    name='batch_shape_tensor'
)

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

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

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

data-text="cholesky" id="cholesky">cholesky

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

cholesky(
    name='cholesky'
)

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

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

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

data-text="cond" id="cond">cond

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

cond(
    name='cond'
)

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

Аргументы
name Имя для этой Op
Возвращает
Форма [B1,...,Bb] Tensor того же dtype что и self.

data-text="determinant" id="determinant">determinant

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

determinant(
    name='det'
)

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

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

data-text="diag_part" id="diag_part">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.

data-text="domain_dimension_tensor" id="domain_dimension_tensor">domain_dimension_tensor

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

domain_dimension_tensor(
    name='domain_dimension_tensor'
)

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

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

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

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

data-text="eigvals" id="eigvals">eigvals

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

eigvals(
    name='eigvals'
)

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

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

Примечание: В настоящее время это поддерживается только для самосопряжённых операторов.

Аргументы
name Имя для этой Op
Возвращает
Форма [B1,...,Bb, N] Tensor с тем же dtype что и self.

data-text="inverse" id="inverse">inverse

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

inverse(
    name='inverse'
)

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

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

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

data-text="log_abs_determinant" id="log_abs_determinant">log_abs_determinant

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

log_abs_determinant(
    name='log_abs_det'
)

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

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

data-text="matmul" id="matmul">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 Питон bool. Если True, умножить слева на сопряжённую: A^H x.
adjoint_arg Питон 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 Питон 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.

Возвращаемое значение будет близко к точному решению, если 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 Питон bool. Если True, решить систему, включающую сопряжённую величину этого LinearOperator: A^H X = rhs.
adjoint_arg Питон 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.

Возвращаемое значение будет близко к точному решению, если 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 Питон 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.4/api_docs/python/tf/linalg/LinearOperatorToeplitz

Spec-Zone.ru

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