|TensorFlow 1 version||View source on GitHub|
LinearOperator acting like a [batch] of Householder transformations.
Compat aliases for migration
See Migration guide for more details.
tf.linalg.LinearOperatorHouseholder( reflection_axis, is_non_singular=None, is_self_adjoint=None, is_positive_definite=None, is_square=None, name='LinearOperatorHouseholder' )
This operator acts like a [batch] of householder reflections with shape
[B1,...,Bb, N, N] for some
b >= 0. The first
b indices index a
batch member. For every batch index
A[i1,...,ib, : :] is
N x N matrix. This matrix
A is not materialized, but for
purposes of broadcasting this shape will be relevant.
LinearOperatorHouseholder is initialized with a (batch) vector.
A Householder reflection, defined via a vector
v, which reflects points
R^n about the hyperplane orthogonal to
v and through the origin.
# 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
This operator acts on [batch] matrix with compatible shape.
x is a batch matrix with compatible shape for
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]
Matrix property hints
LinearOperator is initialized with boolean flags of the form
X = non_singular, self_adjoint, positive_definite, square.
These have the following meaning:
is_X == True, callers should expect the operator to have the property
X. This is a promise that should be fulfilled, but is not a runtime assert. For example, finite floating point precision may result in these promises being violated.
is_X == False, callers should expect the operator to not have
is_X == None(the default), callers should have no expectation either way.
||Expect that this operator is non-singular.|
||Expect that this operator is equal to its hermitian transpose. This is autoset to true|
Expect that this operator is positive definite,
meaning the quadratic form
||Expect that this operator acts like square [batch] matrices. This is autoset to true.|
A name for this
Returns the adjoint of the current
If this operator acts like the batch matrix