]>
Commit | Line | Data |
---|---|---|
92f5a8d4 | 1 | Boost.uBLAS Linear Algebra Library |
7c673cae | 2 | ===== |
92f5a8d4 | 3 | Boost.uBLAS is part of the [Boost C++ Libraries](http://github.com/boostorg). It is directed towards scientific computing on the level of basic linear algebra constructions with matrices and vectors and their corresponding abstract operations. |
7c673cae | 4 | |
7c673cae | 5 | |
92f5a8d4 TL |
6 | ## Documentation |
7 | uBLAS is documented at [boost.org](https://www.boost.org/doc/libs/1_69_0/libs/numeric/ublas/doc/index.html). | |
8 | The development has a [wiki page](https://github.com/uBLAS/ublas/wiki). | |
9 | The tensor extension has a separate [wiki page](https://github.com/BoostGSoC18/tensor/wiki). | |
7c673cae | 10 | |
92f5a8d4 TL |
11 | ## License |
12 | Distributed under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt). | |
7c673cae | 13 | |
92f5a8d4 TL |
14 | ## Properties |
15 | * Header-only | |
16 | * Tensor extension requires C++17 compatible compiler, compiles with | |
17 | * gcc 7.3.0 | |
18 | * clang 6.0 | |
19 | * msvc 14.1 | |
20 | * Unit-tests require Boost.Test | |
21 | ||
22 | ## Build Status | |
23 | ||
24 | Branch | Travis | Appveyor | codecov.io | Docs | | |
25 | :-------------: | ------ | -------- | ---------- | ---- | | |
26 | [`master`](https://github.com/boostorg/ublas/tree/master) | [![Build Status](https://travis-ci.org/boostorg/ublas.svg?branch=master)](https://travis-ci.org/boostorg/ublas) | [![Build status](https://ci.appveyor.com/api/projects/status/ctu3wnfowa627ful/branch/master?svg=true)](https://ci.appveyor.com/project/stefanseefeld/ublas/branch/master) | [![codecov](https://codecov.io/gh/boostorg/ublas/branch/master/graph/badge.svg)](https://codecov.io/gh/boostorg/ublas/branch/master) | [![Documentation](https://img.shields.io/badge/docs-develop-brightgreen.svg)](http://www.boost.org/doc/libs/release/libs/numeric) | |
27 | [`develop`](https://github.com/boostorg/ublas/tree/develop) | [![Build Status](https://travis-ci.org/boostorg/ublas.svg?branch=develop)](https://travis-ci.org/boostorg/ublas) | [![Build status](https://ci.appveyor.com/api/projects/status/ctu3wnfowa627ful/branch/develop?svg=true)](https://ci.appveyor.com/project/stefanseefeld/ublas/branch/develop) | [![codecov](https://codecov.io/gh/boostorg/ublas/branch/develop/graph/badge.svg)](https://codecov.io/gh/boostorg/ublas/branch/develop) | [![Documentation](https://img.shields.io/badge/docs-develop-brightgreen.svg)](http://www.boost.org/doc/libs/release/libs/numeric) | |
28 | ||
29 | ||
30 | ## Directories | |
31 | ||
32 | | Name | Purpose | | |
33 | | ----------- | ------------------------------ | | |
34 | | `doc` | documentation | | |
35 | | `examples` | example files | | |
36 | | `include` | headers | | |
37 | | `test` | unit tests | | |
38 | | `benchmarks`| timing and benchmarking | | |
39 | ||
40 | ## More information | |
41 | ||
42 | * Ask questions in [stackoverflow](http://stackoverflow.com/questions/ask?tags=c%2B%2B,boost,boost-ublas) with `boost-ublas` or `ublas` tags. | |
43 | * Report [bugs](https://github.com/boostorg/ublas/issues) and be sure to mention Boost version, platform and compiler you're using. A small compilable code sample to reproduce the problem is always good as well. | |
44 | * Submit your patches as pull requests against **develop** branch. Note that by submitting patches you agree to license your modifications under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt). | |
45 | * Developer discussions about the library are held on the [Boost developers mailing list](https://lists.boost.org/mailman/listinfo.cgi/ublas). Be sure to read the [discussion policy](http://www.boost.org/community/policy.html) before posting and add the `[ublas]` tag at the beginning of the subject line | |
46 | * For any other questions, you can contact David, Stefan or Cem: david.bellot-AT-gmail-DOT-com, cem.bassoy-AT-gmail-DOT-com stefan-AT-seefeld-DOT-name |