Skip to content

Commit 44b70a7

Browse files
committed
add upgrade help in docs
1 parent 2a5ff9e commit 44b70a7

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/src/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,25 @@ Mutable versions [`MVector`](@ref), [`MMatrix`](@ref) and [`MArray`](@ref) are a
1414
as [`SizedArray`](@ref) for annotating standard `Array`s with static size information.
1515
Further, the abstract [`FieldVector`](@ref) can be used to make fast static vectors
1616
out of any uniform Julia "struct".
17+
18+
## Migrating code from Julia v0.6 to Julia v0.7
19+
20+
When upgrading code that is depending on **StaticArrays** the following notes may be helpful
21+
22+
* `chol` has been renamed to `cholesky` and return a factorization object. To obtain the factor
23+
use `C = cholesky(A).U`, just like for regular Julia arrays.
24+
25+
* `lu` now return a factorization object instead of a tuple with `L`, `U`, and `p`.
26+
They can be obtained by destructing via iteration (`L, U, p = lu(A)`) or by
27+
using `getfield` (`F = lu(A); L, U, p = F.L, F.U, F.p`).
28+
29+
* `qr` now return a factorization object instead of a tuple with `Q` and `R`.
30+
They can be obtained by destructing via iteration (`Q, R = qr(A)`) or by
31+
using `getfield` (`F = qr(A); Q, R = F.Q, F.R`)
32+
33+
* `eig` has been renamed to `eigen`, which return a factorization object, rather than
34+
a tuple with `(values, vectors)`. They can be obtained by destructing via iteration
35+
(`values, vectors = eigen(A)`) or by using `getfield`
36+
(`E = eigen(A); values, vectors = E.values, E.vectors`).
37+
38+
* `unshift` and `shift` have been renamed to `pushfirst` and `popfirst`.

0 commit comments

Comments
 (0)