Merge branch 'update-lapack'

Author: termoshtt

.gitignore

@@ -10,3 +10,7 @@ Cargo.lock
 
 # cargo fmt
 *.bk
+
+# IntelliJ Rust
+.idea
+*.iml

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name    = "ndarray-linalg"
-version = "0.7.1"
+version = "0.8.0"
 authors = ["Toshiki Teramura <toshiki.teramura@gmail.com>"]
 
 description   = "Linear algebra package for rust-ndarray using LAPACK"
@@ -12,35 +12,32 @@ readme        = "README.md"
 categories    = ["algorithms", "science"]
 
 [features]
-default  = ["openblas-static"]
-openblas-shared = ["lapack/openblas"]
-openblas-static = ["lapack/openblas", "openblas-src/static"]
-openblas-system = ["lapack/openblas", "openblas-src/system"]
-netlib-shared   = ["lapack/netlib"]
-netlib-static   = ["lapack/netlib", "netlib-src/static"]
-netlib-system   = ["lapack/netlib", "netlib-src/system"]
-intel-mkl       = ["intel-mkl-src"]
+default   = []
+openblas  = ["openblas-src"]
+netlib    = ["netlib-src"]
+intel-mkl = ["intel-mkl-src"]
 
 [dependencies]
 rand = "0.3"
-derive-new = "0.4"
+derive-new = "0.5"
 procedurals = "0.2"
 num-traits  = "0.1"
-num-complex = "0.1"
-lapack = { version = "0.13", default-features = false }
-lapack-sys = { version = "0.11", default-features = false }
+num-complex = { version = "0.1", default-features = false }
+lapacke = "0.1.4"
 
 [dependencies.ndarray]
 version = "0.10"
 default-features = false
 
 [dependencies.openblas-src]
 version = "0.5.3"
+features = ["static", "cblas", "lapacke"]
 default-features = false
 optional = true
 
 [dependencies.netlib-src]
 version = "0.7.0"
+features = ["static", "cblas", "lapacke", "tmg"]
 default-features = false
 optional = true
 

README.md

@@ -4,29 +4,58 @@ ndarray-linalg
 [![docs.rs](https://docs.rs/ndarray-linalg/badge.svg)](https://docs.rs/ndarray-linalg)
 [![wercker status](https://app.wercker.com/status/f04aeba682ea6e79577e15bd946344a5/s/master "wercker status")](https://app.wercker.com/project/byKey/f04aeba682ea6e79577e15bd946344a5)
 
-Linear algebra package for Rust.
+Linear algebra package for Rust with [rust-ndarray](https://github.com/bluss/rust-ndarray).
 
-Dependencies
--------------
+LAPACKE Backend
+----------------
 
-- [bluss/rust-ndarray](https://github.com/bluss/rust-ndarray)
-- [stainless-steel/lapack](https://github.com/stainless-steel/lapack)
-
-and more (See Cargo.toml).
-
-Feature flags
---------------
+Currently three LAPACKE implementations are supported and tested:
 
 - [OpenBLAS](https://github.com/cmr/openblas-src)
-  - `openblas-static`: use OpenBLAS with static link (default)
-  - `openblas-shared`: use OpenBLAS with shared link
-  - `openblas-system`: use system OpenBLAS (experimental)
 - [Netlib](https://github.com/cmr/netlib-src)
-  - `netlib-static`: use Netlib with static link (default)
-  - `netlib-shared`: use Netlib with shared link
-  - `netlib-system`: use system Netlib (experimental)
 - [Intel MKL](https://github.com/termoshtt/rust-intel-mkl) (non-free license, see the linked page)
-  - `intel-mkl`: use Intel MKL shared link (experimental)
+
+There are two ways to link LAPACKE backend:
+
+### backend features (recommended)
+There are three features corresponding to the backend implementations (`openblas` / `netlib` / `intel-mkl`):
+
+```toml
+[depencdencies]
+ndarray = "0.10"
+ndarray-linalg = { version = "0.8", features = ["openblas"] }
+```
+
+### link backend crate manually
+For the sake of linking flexibility, you can provide LAPACKE implementation (as an `extern crate`) yourself.
+You should link a LAPACKE implementation to a final crate (like binary executable or dylib) only, not to a Rust library.
+
+```toml
+[depencdencies]
+ndarray = "0.10"
+ndarray-linalg = "0.8"
+openblas-src = "0.5" # or another backend of your choice
+
+```
+
+You must add `extern crate` to your code in this case:
+
+```rust
+extern crate ndarray;
+extern crate ndarray_linalg;
+extern crate openblas_src; // or another backend of your choice
+```
+
+### For librarian
+If you creating a library depending on this crate, we encourage you not to link any backend for flexibility:
+
+```toml
+[depencdencies]
+ndarray = "0.10"
+ndarray-linalg = { version = "0.8", default-features = false }
+```
+
+However, if you hope simplicity instead of the flexibility, you can link your favorite backend in the way described above.
 
 Examples
 ---------

examples/eigh.rs

@@ -1,6 +1,8 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+#[cfg(feature = "lapack-src")]
+extern crate lapack_src;
 
 use ndarray::*;
 use ndarray_linalg::*;

examples/solve.rs

@@ -1,6 +1,8 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+#[cfg(feature = "lapack-src")]
+extern crate lapack_src;
 
 use ndarray::*;
 use ndarray_linalg::*;

examples/solveh.rs

@@ -1,6 +1,8 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+#[cfg(feature = "lapack-src")]
+extern crate lapack_src;
 
 use ndarray::*;
 use ndarray_linalg::*;

src/lapack_traits/cholesky.rs

@@ -1,6 +1,6 @@
 //! Cholesky decomposition
 
-use lapack::c;
+use lapacke;
 
 use error::*;
 use layout::MatrixLayout;
@@ -46,7 +46,7 @@ impl Cholesky_ for $scalar {
 }
 }} // end macro_rules
 
-impl_cholesky!(f64, c::dpotrf, c::dpotri, c::dpotrs);
-impl_cholesky!(f32, c::spotrf, c::spotri, c::spotrs);
-impl_cholesky!(c64, c::zpotrf, c::zpotri, c::zpotrs);
-impl_cholesky!(c32, c::cpotrf, c::cpotri, c::cpotrs);
+impl_cholesky!(f64, lapacke::dpotrf, lapacke::dpotri, lapacke::dpotrs);
+impl_cholesky!(f32, lapacke::spotrf, lapacke::spotri, lapacke::spotrs);
+impl_cholesky!(c64, lapacke::zpotrf, lapacke::zpotri, lapacke::zpotrs);
+impl_cholesky!(c32, lapacke::cpotrf, lapacke::cpotri, lapacke::cpotrs);

src/lapack_traits/eigh.rs

@@ -1,6 +1,6 @@
 //! Eigenvalue decomposition for Hermite matrices
 
-use lapack::c;
+use lapacke;
 use num_traits::Zero;
 
 use error::*;
@@ -27,7 +27,7 @@ impl Eigh_ for $scalar {
 }
 }} // impl_eigh!
 
-impl_eigh!(f64, c::dsyev);
-impl_eigh!(f32, c::ssyev);
-impl_eigh!(c64, c::zheev);
-impl_eigh!(c32, c::cheev);
+impl_eigh!(f64, lapacke::dsyev);
+impl_eigh!(f32, lapacke::ssyev);
+impl_eigh!(c64, lapacke::zheev);
+impl_eigh!(c32, lapacke::cheev);

src/lapack_traits/opnorm.rs

@@ -1,7 +1,7 @@
 //! Operator norms of matrices
 
-use lapack::c;
-use lapack::c::Layout::ColumnMajor as cm;
+use lapacke;
+use lapacke::Layout::ColumnMajor as cm;
 
 use layout::MatrixLayout;
 use types::*;
@@ -24,7 +24,7 @@ impl OperatorNorm_ for $scalar {
 }
 }} // impl_opnorm!
 
-impl_opnorm!(f64, c::dlange);
-impl_opnorm!(f32, c::slange);
-impl_opnorm!(c64, c::zlange);
-impl_opnorm!(c32, c::clange);
+impl_opnorm!(f64, lapacke::dlange);
+impl_opnorm!(f32, lapacke::slange);
+impl_opnorm!(c64, lapacke::zlange);
+impl_opnorm!(c32, lapacke::clange);

src/lapack_traits/qr.rs

@@ -1,6 +1,6 @@
 //! QR decomposition
 
-use lapack::c;
+use lapacke;
 use num_traits::Zero;
 use std::cmp::min;
 
@@ -44,7 +44,7 @@ impl QR_ for $scalar {
 }
 }} // endmacro
 
-impl_qr!(f64, c::dgeqrf, c::dorgqr);
-impl_qr!(f32, c::sgeqrf, c::sorgqr);
-impl_qr!(c64, c::zgeqrf, c::zungqr);
-impl_qr!(c32, c::cgeqrf, c::cungqr);
+impl_qr!(f64, lapacke::dgeqrf, lapacke::dorgqr);
+impl_qr!(f32, lapacke::sgeqrf, lapacke::sorgqr);
+impl_qr!(c64, lapacke::zgeqrf, lapacke::zungqr);
+impl_qr!(c32, lapacke::cgeqrf, lapacke::cungqr);