Spec-Zone.ru › TensorFlow 2.3

tf.linalg.LinearOperatorToeplitz

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

LinearOperator действуя как [пакет] матриц Тоepлицa.

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

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

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

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

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

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

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

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

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

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

# 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 Tensors, обрабатываемых этим 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.

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" tabindex="0">assert_self_adjoint

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

assert_self_adjoint(
    name='assert_self_adjoint'
)

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

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

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

data-text="batch_shape_tensor" id="batch_shape_tensor" tabindex="0">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" tabindex="0">cholesky

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

cholesky(
    name='cholesky'
)

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

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

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

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

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

cond(
    name='cond'
)

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

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

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

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

determinant(
    name='det'
)

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

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

data-text="diag_part" id="diag_part" tabindex="0">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" tabindex="0">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" tabindex="0">eigvals

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

eigvals(
    name='eigvals'
)

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

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

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

data-text="inverse" id="inverse" tabindex="0">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" tabindex="0">log_abs_determinant

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

log_abs_determinant(
    name='log_abs_det'
)

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

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

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.
Возвращаемое значение
A 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.
Возвращаемое значение
A 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/LinearOperatorToeplitz

Spec-Zone.ru

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