Skip to content

Commit

Permalink
blis-src-0.2.1, based on BLIS 0.9.0 with configure patch
Browse files Browse the repository at this point in the history
* De-duplicate docs and fix links
  • Loading branch information
jedbrown committed Apr 30, 2022
1 parent cf38470 commit b01cc22
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[submodule "source"]
path = blis-src/upstream
url = https://github.com/jedbrown/blis
url = https://github.com/flame/blis
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This repository contains a Rust package to build and link [BLIS], the BLAS-like

```toml
[dependencies]
blas-src = { version = "0.7", features = ["blis"] }
blas-src = { version = "0.8", features = ["blis"] }
```

To access the full BLIS API, direct use of `extern "C"` is necessary at this time.
Expand Down
6 changes: 2 additions & 4 deletions blis-src/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ authors = [
]
name = "blis-src"
edition = "2018"
version = "0.2.1-alpha.0"
license = "MIT/Apache-2.0"
version = "0.2.1"
license = "MIT OR Apache-2.0"
description = "Rust native linking for BLIS library"
repository = "https://github.com/blas-lapack-rs/blis-src"
keywords = [ "blas", "blis" ]
categories = [ "science" ]
documentation = "http://docs.rs/blis-src"
readme = "../README.md"
links = "blis"
exclude = [
"upstream/docs/",
Expand Down
27 changes: 19 additions & 8 deletions blis-src/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# Blis-sys
# blis-src

This crate provides BLAS and/or CBLAS function using [BLIS](https://github.com/flame/blis).
This crate provides BLAS and/or CBLAS functions using [BLIS](https://github.com/flame/blis).

Features:
## Features:

* `cblas`: includes cblas binding (on by default)
* `cblas`: build the CBLAS interface (enabled by default)
* `static`: prefer static link (be very careful with this one on Apple platforms)
* `system`: do not compile blis, link it from a system-wide installation instead
* `pthreads` or `openmp` or `serial`: choose exactly one to specify the threading mode (`pthreads` by default)
* `system`: do not compile BLIS and instead use a system-provided version (must be in system's default link path).

It does not provides the BLAS or CBLAS functions Rust declarations. It is meant
to use the ones provides by `blas-sys` and `cblas-sys` crates instead.
This package does not provides Rust declarations for BLAS or CBLAS, which
are available in the [`blas-sys`](https://lib.rs/crates/blas-sys) and
[`cblas-sys`](https://lib.rs/crates/cblas-sys) crates. See the [blas
example](https://github.com/blas-lapack-rs/blis-src/blob/main/blis-src/tests/blas_gemm.rs) and [cblas example](https://github.com/blas-lapack-rs/blis-src/blob/main/blis-src/tests/cblas_gemm.rs)
for usage.

See also [blas example](tests/blas_gemm.rs) or [cblas example](tests/cblas_gemm.rs).
Users simply seeking a fast BLAS are encouraged to use
[`blas-sys`](https://lib.rs/crates/blas-src) with the following in
`Cargo.toml`:

```toml
[dependencies]
blas-src = { version = "0.8", features = ["blis"] }
```
26 changes: 1 addition & 25 deletions blis-src/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,28 +1,4 @@
//! # blis-src
//!
//! This crate provides BLAS and/or CBLAS function using [BLIS](https://github.com/flame/blis).
//!
//! Features:
//!
//! * `cblas`: build the CBLAS interface (enabled by default)
//! * `static`: prefer static link (be very careful with this one on Apple platforms)
//! * `pthreads` or `openmp` or `serial`: choose exactly one to specify the threading mode (`pthreads` by default)
//! * `system`: do not compile BLIS and instead use a system-provided version (must be in system's default link path).
//!
//! This package does not provides Rust declarations for BLAS or CBLAS, which
//! are available in the [`blas-sys`](https://lib.rs/crates/blas-sys) and
//! [`cblas-sys`](https://lib.rs/crates/cblas-sys) crates. See the [blas
//! example](../tests/blas_gemm.rs) and [cblas example](../tests/cblas_gemm.rs)
//! for usage.
//!
//! Users simply seeking a fast BLAS are encouraged to use
//! [`blas-sys`](https://lib.rs/crates/blas-src) with the following in
//! `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! blas-src = { version = "0.7", features = ["blis"] }
//! ```
#![doc = include_str!("../README.md")]

#[cfg(test)]
mod tests {
Expand Down

0 comments on commit b01cc22

Please sign in to comment.