Skip to content

Commit

Permalink
Update documentation and NEWS.md with LU{Tridiagonal} and GC tracked
Browse files Browse the repository at this point in the history
allocator changes [ci skip]
  • Loading branch information
andreasnoack committed Jul 21, 2015
1 parent fe62c2e commit eb636a0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
9 changes: 8 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,15 @@ Library improvements

* New `vecdot` function, analogous to `vecnorm`, for Euclidean inner products over any iterable container ([#11067]).

* `p = plan_fft(x)` and similar functions now return a `Base.DFT.Plan` object, rather
* `p = plan_fft(x)` and similar functions now return a `Base.DFT.Plan` object, rather
than an anonymous function. Calling it via `p(x)` is deprecated in favor of
`p * x` or `p \ x` (for the inverse), and it can also be used with `A_mul_B!`
to employ pre-allocated output arrays ([#12087]).

* `LU{T,Tridiagonal{T}}` now supports extraction of `L`, `U`, `p`, and `P` factors ([#12137]).

* Allocations in sparse matrix factorizations are now tracked by Julia's garbage collector ([#12034]).

* Strings

* NUL-terminated strings should now be passed to C via the new `Cstring` type, not `Ptr{UInt8}` or `Ptr{Cchar}`,
Expand Down Expand Up @@ -353,6 +357,9 @@ Library improvements
* `mktemp` and `mktempdir` now take an optional argument to set which
directory the temporary file or directory is created in.

* New garbage collector tracked memory allocator functions: `jl_malloc`, `jl_calloc`,
`jl_realloc`, and `jl_free` with libc API ([[#12034]]).

Deprecated or removed
---------------------

Expand Down
10 changes: 5 additions & 5 deletions doc/stdlib/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f
Type of input ``A`` Type of output ``F`` Relationship between ``F`` and ``A``
----------------------- ------------------------- ----------------------------------------
:func:`Matrix` ``LU`` ``F[:L]*F[:U] == A[F[:p], :]``
:func:`Tridiagonal` ``LU{T,Tridiagonal{T}}`` N/A
:func:`Tridiagonal` ``LU{T,Tridiagonal{T}}`` ``F[:L]*F[:U] == A[F[:p], :]``
:func:`SparseMatrixCSC` ``UmfpackLU`` ``F[:L]*F[:U] == (F[:Rs] .* A)[F[:p], F[:q]]``
======================= ========================= ========================================

Expand All @@ -71,10 +71,10 @@ Linear algebra functions in Julia are largely implemented by calling functions f
=========== ======================================= ====== ======================== =============
Component Description ``LU`` ``LU{T,Tridiagonal{T}}`` ``UmfpackLU``
----------- --------------------------------------- ------ ------------------------ -------------
``F[:L]`` ``L`` (lower triangular) part of ``LU`` ✓
``F[:U]`` ``U`` (upper triangular) part of ``LU`` ✓
``F[:p]`` (right) permutation ``Vector`` ✓
``F[:P]`` (right) permutation ``Matrix`` ✓
``F[:L]`` ``L`` (lower triangular) part of ``LU`` ✓
``F[:U]`` ``U`` (upper triangular) part of ``LU`` ✓
``F[:p]`` (right) permutation ``Vector`` ✓
``F[:P]`` (right) permutation ``Matrix`` ✓
``F[:q]`` left permutation ``Vector`` ✓
``F[:Rs]`` ``Vector`` of scaling factors ✓
``F[:(:)]`` ``(L,U,p,q,Rs)`` components ✓
Expand Down

0 comments on commit eb636a0

Please sign in to comment.