qten.linalg
Package reference for qten.linalg.
linalg
Linear-algebra routines built on top of QTen tensors.
This package contains decomposition algorithms and tensor-aware numerical
helpers that operate on Tensor objects while
preserving symbolic dimension metadata.
Decompositions
Convenience re-exports
normTensor norm helper re-exported fromqten.linalg.tensors.
Exported API
eig
eig(tensor: Tensor) -> EigH
Perform eigendecomposition on general square matrix axes.
This function applies torch.linalg.eig
to the final two dimensions of a
Tensor. The last two dimensions must span
the same Hilbert space up to ray ordering so they can be interpreted as a
square operator. Any leading dimensions are treated as batch dimensions and
are preserved in both outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form square matrices. |
required |
Returns:
| Type | Description |
|---|---|
EigH
|
|
Examples:
result = eig(tensor)
values = result.eigenvalues
vectors = result.eigenvectors
Notes
torch.linalg.eig does not guarantee any ordering of the eigenvalues. This
function sorts eigenvalues lexicographically by (real, imag) and applies
the same reordering to eigenvectors.
The returned tensors satisfy \(A V = V\Lambda\), where \(\Lambda\) is the
diagonal matrix of eigenvalues. If the input matrix is diagonalizable, this
gives the reconstruction \(A = V\Lambda V^{-1}\). In code, \(V\) is
eigenvectors and \(\Lambda\) is the diagonal matrix built from
eigenvalues.
Source code in src/qten/linalg/decompose.py
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 | |
eigh
eigh(tensor: Tensor) -> EigH
Perform Hermitian eigendecomposition on the last two tensor dimensions.
This function applies torch.linalg.eigh
to the matrix axes of a Tensor. The final
two dimensions must span the same Hilbert space up to ray ordering so they
can be interpreted as a Hermitian operator. Any leading dimensions are
treated as batch dimensions and are preserved in both outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form Hermitian matrices. |
required |
Returns:
| Type | Description |
|---|---|
EigH
|
|
Examples:
result = eigh(tensor)
eigenvalues = result.eigenvalues
eigenvectors = result.eigenvectors
Notes
torch.linalg.eigh is differentiable for Hermitian inputs, but the gradients
can be ill-defined or unstable when eigenvalues are degenerate or nearly
degenerate. If you use this in autograd, consider stabilizing the spectrum
(e.g., with a small perturbation) or avoiding backpropagation through
eigenvectors when bands are expected to merge.
The original matrix is recovered by forming a diagonal matrix from
eigenvalues and evaluating \(V\Lambda V^\dagger\). In code, this is
eigenvectors @ W @ eigenvectors.h(-2, -1).
Source code in src/qten/linalg/decompose.py
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
eigvalsh
eigvalsh(tensor: Tensor) -> Tensor
Compute Hermitian eigenvalues on the last two tensor dimensions.
This is the eigenvalues-only companion to
eigh. The last two dimensions must span
the same Hilbert space up to ray ordering and represent a Hermitian
operator. Leading dimensions are treated as batch dimensions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form Hermitian matrices. |
required |
Returns:
| Type | Description |
|---|---|
Tensor
|
Eigenvalues as a |
Examples:
values = eigvalsh(tensor)
Source code in src/qten/linalg/decompose.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |
eigvals
eigvals(tensor: Tensor) -> Tensor
Compute eigenvalues of general square matrix axes.
This is the eigenvalues-only companion to
eig. The last two dimensions must span the
same Hilbert space up to ray ordering and represent a square operator.
Leading dimensions are treated as batch dimensions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form square matrices. |
required |
Returns:
| Type | Description |
|---|---|
Tensor
|
Eigenvalues as a |
Notes
torch.linalg.eigvals does not guarantee any ordering of the eigenvalues.
This function sorts eigenvalues lexicographically by (real, imag).
Examples:
values = eigvals(tensor)
Source code in src/qten/linalg/decompose.py
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | |
qr
qr(tensor: Tensor) -> QR
Perform reduced QR decomposition on the last two tensor dimensions.
This function applies torch.linalg.qr
with mode="reduced" to the matrix axes of the input tensor. The last two
dimensions may be rectangular. Any leading dimensions are treated as batch
dimensions and are preserved in both outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form matrices. |
required |
Returns:
| Type | Description |
|---|---|
QR
|
Examples:
result = qr(tensor)
q = result.Q
r = result.R
Notes
The shared factor axis is represented by an
IndexSpace whose size equals the
reduced QR bond dimension. The original matrix is recovered as \(Q R\), via
Q @ R in code.
Source code in src/qten/linalg/decompose.py
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | |
svd
svd(
tensor: Tensor,
values_as_matrix: bool = False,
full_matrices: bool = False,
) -> SVD
Perform singular value decomposition on the last two tensor dimensions.
This function applies torch.linalg.svd
to the matrix axes of the input tensor and returns symbolic dimensions that
distinguish reduced and full factorizations. The last two dimensions may be
rectangular. Any leading dimensions are treated as batch dimensions and are
preserved in all outputs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
Input tensor whose last two dimensions form matrices. |
required |
values_as_matrix
|
bool
|
If |
`False`
|
full_matrices
|
bool
|
If |
`False`
|
Returns:
| Type | Description |
|---|---|
SVD
|
|
Examples:
result = svd(tensor)
u = result.U
s = result.S
vh = result.Vh
Notes
In reduced mode, factor is the shared singular-value
IndexSpace. In full mode,
left_factor and right_factor are sized to the full row and column
spaces of the input matrix axes. The original matrix is recovered as
\(U\Sigma V^\dagger\), using U @ Sigma @ Vh in code. Here Sigma is
either the returned S tensor (values_as_matrix=True) or the diagonal
matrix formed from the returned singular-value vector.
Source code in src/qten/linalg/decompose.py
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 | |
norm
norm(
tensor: TensorType,
ord: int | float | str | None = None,
dim: int | tuple[int, int] | None = None,
) -> TensorType
Compute a vector or matrix norm with metadata-aware dimension reduction.
This forwards to torch.linalg.norm for the numeric computation, then
removes the reduced axes from the symbolic output dims.
See Also
torch.linalg.norm
Official PyTorch reference for the underlying numeric operation.
torch.linalg.vector_norm
Clearer vector-only norm API in PyTorch.
torch.linalg.matrix_norm
Clearer matrix-only norm API in PyTorch.
Behavior
The interpretation of ord depends on dim:
dimis anint: compute a vector norm along that axis.dimis a 2-tuple: compute a matrix norm over those two axes.dim is None: follow PyTorch'storch.linalg.normrules. In particular,ord=Noneflattens the tensor and computes a vector 2-norm, whileord != Noneexpects PyTorch's documented 1D/2D behavior.
Supported ord values
Vector-norm forms (dim is an int)
- None
- 0
- any finite int or float
- float("inf")
- -float("inf")
Matrix-norm forms (dim is a 2-tuple)
- None
- "fro"
- "nuc"
- 1, -1
- 2, -2
- float("inf")
- -float("inf")
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
tensor
|
Tensor
|
The tensor to reduce. |
required |
ord
|
Optional[Union[int, float, str]]
|
Order of the norm forwarded to Common examples:
- |
None
|
dim
|
Optional[Union[int, Tuple[int, int]]]
|
Reduction axis or axes.
|
None
|
Returns:
| Type | Description |
|---|---|
TensorType
|
Tensor containing the requested norm values with reduced axes removed
from |
Raises:
| Type | Description |
|---|---|
IndexError
|
If any requested reduction axis is out of range for the tensor rank. |
ValueError
|
If |
Source code in src/qten/linalg/tensors.py
3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 | |