Migrate to lapacke library, drop linking Cargo features

alexbool · alexbool · commit 83715b9a62ce · 2017-12-03T19:07:31.000+03:00
Also bumped version to 0.8
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,7 @@ Cargo.lock
 
 # cargo fmt
 *.bk
+
+# IntelliJ Rust
+.idea
+*.iml
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,9 @@
+[workspace]
+members = ["lapacke-provider", "integration-tests"]
+
 [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"
@@ -11,40 +14,17 @@ license       = "MIT"
 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"]
-
 [dependencies]
 rand = "0.3"
 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"
-default-features = false
-optional = true
-
-[dependencies.netlib-src]
-version = "0.7.0"
-default-features = false
-optional = true
-
-[dependencies.intel-mkl-src]
-version = "0.2.5"
-default-features = false
-optional = true
+[dev-dependencies]
+lapacke-provider = { path = "lapacke-provider", features = ["openblas-src"] }
diff --git a/README.md b/README.md
@@ -10,23 +10,38 @@ Dependencies
 -------------
 
 - [bluss/rust-ndarray](https://github.com/bluss/rust-ndarray)
-- [stainless-steel/lapack](https://github.com/stainless-steel/lapack)
+- [blas-lapack-rs/lapacke](https://github.com/blas-lapack-rs/lapacke)
 
 and more (See Cargo.toml).
 
-Feature flags
---------------
+Choosing LAPACKE implementation
+--------------------------------
+
+For the sake of linking flexibility, you must provide LAPACKE implementation (as an `extern crate`) yourself.
+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)
+
+You should link a LAPACKE implementation to a final crate (like binary executable or dylib) only, not to a Rust library.
+Example:
+
+`Cargo.toml`:
+```toml
+[depencdencies]
+ndarray = "0.10"
+ndarray-linalg = "0.8"
+openblas-src = "0.5" # or another backend of your choice
+
+```
+
+`main.rs`:
+```rust
+extern crate ndarray;
+extern crate ndarray_linalg;
+extern crate openblas_src; // or another backend of your choice
+```
 
 Examples
 ---------
diff --git a/examples/eigh.rs b/examples/eigh.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/examples/solve.rs b/examples/solve.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/examples/solveh.rs b/examples/solveh.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/Cargo.toml b/integration-tests/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "integration-tests"
+version = "0.1.0"
+authors = ["Alexander Bulaev <alexbool@yandex-team.ru>"]
+description = "Support crate for testing ndarray-linalg"
+publish = false
+
+[features]
+default  = ["openblas-src"]
+openblas-src  = ["lapacke-provider/openblas-src"]
+netlib-src    = ["lapacke-provider/netlib-src"]
+intel-mkl-src = ["lapacke-provider/intel-mkl-src"]
+
+[dependencies]
+lapacke-provider = { path = "../lapacke-provider" }
+
+[dev-dependencies]
+ndarray = { version = "*", default-features = false }
+ndarray-linalg = { path = ".." }
+num-traits = "*"
diff --git a/integration-tests/src/lib.rs b/integration-tests/src/lib.rs
@@ -0,0 +1 @@
+extern crate lapacke_provider;
diff --git a/integration-tests/tests/assert.rs b/integration-tests/tests/assert.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 #[test]
 fn assert() {
diff --git a/integration-tests/tests/cholesky.rs b/integration-tests/tests/cholesky.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/convert.rs b/integration-tests/tests/convert.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/det.rs b/integration-tests/tests/det.rs
@@ -2,6 +2,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/deth.rs b/integration-tests/tests/deth.rs
@@ -2,6 +2,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/diag.rs b/integration-tests/tests/diag.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/eigh.rs b/integration-tests/tests/eigh.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/inv.rs b/integration-tests/tests/inv.rs
@@ -3,6 +3,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/layout.rs b/integration-tests/tests/layout.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/normalize.rs b/integration-tests/tests/normalize.rs
@@ -3,6 +3,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/opnorm.rs b/integration-tests/tests/opnorm.rs
@@ -3,6 +3,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/qr.rs b/integration-tests/tests/qr.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/solve.rs b/integration-tests/tests/solve.rs
@@ -2,6 +2,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/solveh.rs b/integration-tests/tests/solveh.rs
@@ -3,6 +3,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/svd.rs b/integration-tests/tests/svd.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/trace.rs b/integration-tests/tests/trace.rs
@@ -1,6 +1,7 @@
 
 extern crate ndarray;
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/triangular.rs b/integration-tests/tests/triangular.rs
@@ -2,6 +2,7 @@
 extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/integration-tests/tests/vector.rs b/integration-tests/tests/vector.rs
@@ -3,6 +3,7 @@ extern crate ndarray;
 #[macro_use]
 extern crate ndarray_linalg;
 extern crate num_traits;
+extern crate lapacke_provider;
 
 use ndarray::*;
 use ndarray_linalg::*;
diff --git a/lapacke-provider/Cargo.toml b/lapacke-provider/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name    = "lapacke-provider"
+version = "0.1.0"
+authors = ["Toshiki Teramura <toshiki.teramura@gmail.com>", "Alexander Bulaev <aleks.bulaev@gmail.com>"]
+description = "Support crate for testing ndarray-linalg with a particular LAPACKE backend"
+publish = false
+
+[features]
+default = ["openblas-src"]
+
+[dependencies.openblas-src]
+version = "0.5.3"
+default-features = false
+features = ["lapacke"]
+optional = true
+
+[dependencies.netlib-src]
+version = "0.7.0"
+default-features = false
+features = ["lapacke"]
+optional = true
+
+[dependencies.intel-mkl-src]
+version = "0.2.5"
+default-features = false
+optional = true
diff --git a/lapacke-provider/src/lib.rs b/lapacke-provider/src/lib.rs
@@ -0,0 +1,8 @@
+#[cfg(feature = "openblas-src")]
+extern crate openblas_src;
+
+#[cfg(feature = "netlib-src")]
+extern crate netlib_src;
+
+#[cfg(feature = "intel-mkl-src")]
+extern crate intel_mkl_src;
diff --git a/src/cholesky.rs b/src/cholesky.rs
@@ -9,7 +9,7 @@
 //! Using the Cholesky decomposition of `A` for various operations, where `A`
 //! is a Hermitian (or real symmetric) positive definite matrix:
 //!
-//! ```
+//! ```no_run
 //! #[macro_use]
 //! extern crate ndarray;
 //! extern crate ndarray_linalg;
diff --git a/src/lapack_traits/cholesky.rs b/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);
diff --git a/src/lapack_traits/eigh.rs b/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);
diff --git a/src/lapack_traits/opnorm.rs b/src/lapack_traits/opnorm.rs
diff --git a/src/lapack_traits/qr.rs b/src/lapack_traits/qr.rs
diff --git a/src/lapack_traits/solve.rs b/src/lapack_traits/solve.rs
diff --git a/src/lapack_traits/solveh.rs b/src/lapack_traits/solveh.rs
diff --git a/src/lapack_traits/svd.rs b/src/lapack_traits/svd.rs
diff --git a/src/lapack_traits/triangular.rs b/src/lapack_traits/triangular.rs
diff --git a/src/layout.rs b/src/layout.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/solve.rs b/src/solve.rs
diff --git a/src/solveh.rs b/src/solveh.rs
diff --git a/wercker.yml b/wercker.yml
